Kate::TextRange

Kate
TextRange

#include <katetextrange.h>

Inheritance diagram for Kate::TextRange:

Public Member Functions
	TextRange (const TextRange &)=delete

	TextRange (TextBuffer *buffer, KTextEditor::Range range, InsertBehaviors insertBehavior, EmptyBehavior emptyBehavior=AllowEmpty)

	~TextRange () override

const KTextEditor::Attribute::Ptr &	attribute () const override

bool	attributeOnlyForViews () const override

KTextEditor::Document *	document () const override

EmptyBehavior	emptyBehavior () const override

const KTextEditor::MovingCursor &	end () const override

const TextCursor &	endInternal () const

KTextEditor::MovingRangeFeedback *	feedback () const override

bool	hasAttribute () const

InsertBehaviors	insertBehaviors () const override

	operator KTextEditor::Range () const

TextRange &	operator= (const TextRange &)=delete

void	setAttribute (KTextEditor::Attribute::Ptr attribute) override

void	setAttributeOnlyForViews (bool onlyForViews) override

void	setEmptyBehavior (EmptyBehavior emptyBehavior) override

void	setFeedback (KTextEditor::MovingRangeFeedback *feedback) override

void	setInsertBehaviors (InsertBehaviors insertBehaviors) override

void	setRange (KTextEditor::Cursor start, KTextEditor::Cursor end)

void	setRange (KTextEditor::Range range) override

void	setRange (KTextEditor::Range range, KTextEditor::Attribute::Ptr attribute) override

void	setRange (KTextEditor::Range range, KTextEditor::Attribute::Ptr attribute, qreal zDepth) override

void	setView (KTextEditor::View *view) override

void	setZDepth (qreal zDepth) override

bool	spansMultipleBlocks () const

const KTextEditor::MovingCursor &	start () const override

const TextCursor &	startInternal () const

KTextEditor::LineRange	toLineRange () const

const KTextEditor::Range	toRange () const

KTextEditor::View *	view () const override

qreal	zDepth () const override

Public Member Functions inherited from KTextEditor::MovingRange
	MovingRange (const MovingRange &)=delete

virtual	~MovingRange ()

bool	isEmpty () const

	operator Range () const

MovingRange &	operator= (const MovingRange &)=delete

void	setRange (Cursor start, Cursor end)

LineRange	toLineRange () const Q_DECL_NOEXCEPT

const Range	toRange () const

bool	contains (const Range &range) const

bool	contains (Cursor cursor) const

bool	containsLine (int line) const

bool	containsColumn (int column) const

bool	overlaps (const Range &range) const

bool	overlapsLine (int line) const

bool	overlapsColumn (int column) const

bool	onSingleLine () const

int	numberOfLines () const Q_DECL_NOEXCEPT

Additional Inherited Members
Public Types inherited from KTextEditor::MovingRange
enum	EmptyBehavior { AllowEmpty = 0x0 , InvalidateIfEmpty = 0x1 }

enum	InsertBehavior { DoNotExpand = 0x0 , ExpandLeft = 0x1 , ExpandRight = 0x2 }

typedef QFlags< InsertBehavior >	InsertBehaviors

Protected Member Functions inherited from KTextEditor::MovingRange
	MovingRange ()

Detailed Description

Class representing a 'clever' text range.

It will automagically move if the text inside the buffer it belongs to is modified. By intention no subclass of KTextEditor::Range, must be converted manually. A TextRange is allowed to be empty. If you call setInvalidateIfEmpty(true), a TextRange will become automatically invalid as soon as start() == end() position holds.

Definition at line 35 of file katetextrange.h.

Constructor & Destructor Documentation

◆ TextRange() [1/2]

Kate::TextRange::TextRange	(	TextBuffer *	buffer,
		KTextEditor::Range	range,
		InsertBehaviors	insertBehavior,
		EmptyBehavior	emptyBehavior = AllowEmpty )

Construct a text range.

A TextRange is not allowed to be empty, as soon as start == end position, it will become automatically invalid!

Parameters

buffer	parent text buffer
range	The initial text range assumed by the new range.
insertBehavior	Define whether the range should expand when text is inserted adjacent to the range.
emptyBehavior	Define whether the range should invalidate itself on becoming empty.

Definition at line 16 of file katetextrange.cpp.

◆ TextRange() [2/2]

Kate::TextRange::TextRange ( const TextRange & )

delete

No copy constructor, don't allow this to be copied.

◆ ~TextRange()

Kate::TextRange::~TextRange ( )

override

Destruct the text block.

Definition at line 36 of file katetextrange.cpp.

Member Function Documentation

◆ attribute()

const KTextEditor::Attribute::Ptr & Kate::TextRange::attribute ( ) const

inlineoverridevirtual

Gets the active Attribute for this range.

Returns: a pointer to the active attribute

start	new start for this clever range
end	new end for this clever range

range	new range for this clever range
attribute	Attribute to assign to this range. If null, simply removes the previous Attribute.

Class Picker

Quick Links

About KTextEditor

Kate::TextRange

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TextRange() [1/2]

◆ TextRange() [2/2]

◆ ~TextRange()

Member Function Documentation

◆ attribute()

◆ attributeOnlyForViews()

◆ document()

◆ emptyBehavior()

◆ end()

◆ endInternal()

◆ feedback()

◆ hasAttribute()

◆ insertBehaviors()

◆ operator KTextEditor::Range()

◆ operator=()

◆ setAttribute()

◆ setAttributeOnlyForViews()

◆ setEmptyBehavior()

◆ setFeedback()

◆ setInsertBehaviors()

◆ setRange() [1/4]

◆ setRange() [2/4]

◆ setRange() [3/4]

◆ setRange() [4/4]

◆ setView()

◆ setZDepth()

◆ spansMultipleBlocks()

◆ start()

◆ startInternal()

◆ toLineRange()

◆ toRange()

◆ view()

◆ zDepth()