KateSmartRange Class Reference

Internal implementation of KTextEditor::SmartRange. More...

#include <katesmartrange.h>

Inheritance diagram for KateSmartRange:

[legend]

List of all members.

Public Types
enum	AttachActions { NoActions = 0x0, TagLines = 0x1, Redraw = 0x2 }
Public Member Functions
void	addDynamic (KateDynamicAnimation *anim)
void	deregisterPointer (KateSmartRangePtr *ptr)
const QList < KateDynamicAnimation * > &	dynamicAnimations () const
bool	feedbackEnabled () const
void	feedbackMostSpecific (KateSmartRange *mostSpecific)
void	feedbackMouseCaretChange (KTextEditor::View *view, bool mouse, bool entered)
bool	hasDynamic ()
bool	isCaretOver ()
bool	isInternal () const
bool	isMouseOver ()
KateDocument *	kateDocument () const
	KateSmartRange (KateSmartCursor *start, KateSmartCursor *end, KTextEditor::SmartRange *parent=0L, KTextEditor::SmartRange::InsertBehaviors insertBehavior=DoNotExpand)
	KateSmartRange (KateDocument *doc, KTextEditor::SmartRange *parent=0L)
	KateSmartRange (const KTextEditor::Range &range, KateDocument *doc, KTextEditor::SmartRange *parent=0L, KTextEditor::SmartRange::InsertBehaviors insertBehavior=DoNotExpand)
KateSmartCursor &	kEnd ()
KateSmartCursor &	kStart ()
KateSmartRange &	operator= (const KTextEditor::Range &r)
void	registerPointer (KateSmartRangePtr *ptr)
void	removeDynamic (KateDynamicAnimation *anim)
void	setCaretOver (bool caretOver)
void	setInternal ()
void	setMouseOver (bool mouseOver)
virtual void	setParentRange (SmartRange *r)
void	shifted ()
void	translated (const KateEditInfo &edit)
void	unbindAndDelete ()
virtual	~KateSmartRange ()
Protected Member Functions
virtual void	checkFeedback ()
virtual KTextEditor::SmartRangeNotifier *	createNotifier ()

---

Detailed Description

Internal implementation of KTextEditor::SmartRange.

Represents a range of text, from the start() to the end().

Also tracks its position and emits useful signals.

Definition at line 63 of file katesmartrange.h.

---

Member Enumeration Documentation

enum KateSmartRange::AttachActions

Enumerator:

NoActions
TagLines
Redraw

Definition at line 100 of file katesmartrange.h.

---

Constructor & Destructor Documentation

KateSmartRange::KateSmartRange	(	const KTextEditor::Range &	range,
		KateDocument *	doc,
		KTextEditor::SmartRange *	parent = 0L,
		KTextEditor::SmartRange::InsertBehaviors	insertBehavior = DoNotExpand
	)

Constructors.

Take posession of start and end.

Definition at line 29 of file katesmartrange.cpp.

KateSmartRange::KateSmartRange	(	KateDocument *	doc,
		KTextEditor::SmartRange *	parent = 0L
	)			[explicit]

overload

Definition at line 39 of file katesmartrange.cpp.

KateSmartRange::KateSmartRange	(	KateSmartCursor *	start,
		KateSmartCursor *	end,
		KTextEditor::SmartRange *	parent = 0L,
		KTextEditor::SmartRange::InsertBehaviors	insertBehavior = DoNotExpand
	)

Definition at line 49 of file katesmartrange.cpp.

KateSmartRange::~KateSmartRange

(

)

[virtual]

Definition at line 59 of file katesmartrange.cpp.

---

Member Function Documentation

void KateSmartRange::addDynamic

(

KateDynamicAnimation *

anim

)

Definition at line 241 of file katesmartrange.cpp.

void KateSmartRange::checkFeedback

(

)

[protected, virtual]

Definition at line 266 of file katesmartrange.cpp.

KTextEditor::SmartRangeNotifier * KateSmartRange::createNotifier

(

)

[protected, virtual]

Definition at line 102 of file katesmartrange.cpp.

void KateSmartRange::deregisterPointer

(

KateSmartRangePtr *

ptr

)

Definition at line 261 of file katesmartrange.cpp.

const QList< KateDynamicAnimation * > & KateSmartRange::dynamicAnimations

(

)

const

Definition at line 251 of file katesmartrange.cpp.

bool KateSmartRange::feedbackEnabled

(

)

const [inline]

Implementation detail.

Defines the level of feedback required for any connected watcher / notifier.

enum FeedbackLevel { / Don't provide any feedback. NoFeedback, / Only provide feedback when the range in question is the most specific, wholly encompassing range to have been changed. MostSpecificContentChanged, / Provide feedback whenever the contents of a range change. ContentChanged, / Provide feedback whenever the position of a range changes. PositionChanged }; Q_DECLARE_FLAGS(FeedbackLevels, FeedbackLevel);

Definition at line 131 of file katesmartrange.h.

void KateSmartRange::feedbackMostSpecific

(

KateSmartRange *

mostSpecific

)

Definition at line 157 of file katesmartrange.cpp.

void KateSmartRange::feedbackMouseCaretChange	(	KTextEditor::View *	view,
		bool	mouse,
		bool	entered
	)

Mouse / caret in or out.

Definition at line 166 of file katesmartrange.cpp.

bool KateSmartRange::hasDynamic

(

)

[inline]

Definition at line 110 of file katesmartrange.h.

bool KateSmartRange::isCaretOver

(

)

[inline]

Definition at line 95 of file katesmartrange.h.

bool KateSmartRange::isInternal

(

)

const [inline]

Definition at line 85 of file katesmartrange.h.

bool KateSmartRange::isMouseOver

(

)

[inline]

Is the mouse over this range? Mouseover must be explicitly set by setMouseOver().

Definition at line 90 of file katesmartrange.h.

KateDocument * KateSmartRange::kateDocument

(

)

const

Accessor for the document this range belongs to (set in constructor).

Definition at line 76 of file katesmartrange.cpp.

KateSmartCursor& KateSmartRange::kEnd

(

)

[inline]

Accessor for the end of the range (set in constructor).

Definition at line 83 of file katesmartrange.h.

KateSmartCursor& KateSmartRange::kStart

(

)

[inline]

Accessor for the start of the range (set in constructor).

Definition at line 81 of file katesmartrange.h.

KateSmartRange& KateSmartRange::operator=

(

const KTextEditor::Range &

r

)

[inline]

Definition at line 146 of file katesmartrange.h.

void KateSmartRange::registerPointer

(

KateSmartRangePtr *

ptr

)

Definition at line 256 of file katesmartrange.cpp.

void KateSmartRange::removeDynamic

(

KateDynamicAnimation *

anim

)

Definition at line 246 of file katesmartrange.cpp.

void KateSmartRange::setCaretOver

(

bool

caretOver

)

[inline]

Definition at line 96 of file katesmartrange.h.

void KateSmartRange::setInternal

(

)

Definition at line 225 of file katesmartrange.cpp.

void KateSmartRange::setMouseOver

(

bool

mouseOver

)

[inline]

Tell this range whether the mouse is somewhere over it.

Parameters:

mouseOver

whether the mouse is over the range or not.

Definition at line 93 of file katesmartrange.h.

void KateSmartRange::setParentRange

(

SmartRange *

r

)

[virtual]

Definition at line 198 of file katesmartrange.cpp.

void KateSmartRange::shifted

(

)

The range has been shifted only.

Definition at line 107 of file katesmartrange.cpp.

void KateSmartRange::translated

(

const KateEditInfo &

edit

)

One or both of the cursors has been changed.

Definition at line 121 of file katesmartrange.cpp.

void KateSmartRange::unbindAndDelete

(

)

Definition at line 215 of file katesmartrange.cpp.

---

The documentation for this class was generated from the following files:

• katesmartrange.h
• katesmartrange.cpp