KateLayoutCache Class Reference

This class handles Kate's caching of layouting information (in KateLineLayout and KateTextLayout). More...

#include <katelayoutcache.h>

Inheritance diagram for KateLayoutCache:

List of all members.

Public Member Functions
	KateLayoutCache (KateRenderer *renderer, QObject *parent)
bool	acceptDirtyLayouts ()
void	clear ()
int	displayViewLine (const KTextEditor::Cursor &virtualCursor, bool limitToVisible=false)
int	lastViewLine (int realLine)
KateLineLayoutPtr	line (int realLine, int virtualLine=-1)
KateLineLayoutPtr	line (const KTextEditor::Cursor &realCursor)
void	relayoutLines (int startRealLine, int endRealLine)
void	setAcceptDirtyLayouts (bool accept)
void	setViewWidth (int width)
void	setWrap (bool wrap)
KateTextLayout	textLayout (const KTextEditor::Cursor &realCursor)
KateTextLayout	textLayout (uint realLine, int viewLine)
void	updateViewCache (const KTextEditor::Cursor &startPos, int newViewLineCount=-1, int viewLinesScrolled=0)
void	viewCacheDebugOutput () const
KTextEditor::Cursor	viewCacheEnd () const
int	viewCacheLineCount () const
KTextEditor::Cursor	viewCacheStart () const
KateTextLayout &	viewLine (int viewLine)
int	viewLine (const KTextEditor::Cursor &realCursor)
int	viewLineCount (int realLine)
int	viewWidth () const
bool	wrap () const

---

Detailed Description

This class handles Kate's caching of layouting information (in KateLineLayout and KateTextLayout).

This information is used primarily by both the view and the renderer.

We outsource the hardcore layouting logic to the renderer, but other than that, this class handles all manipulation of the layout objects.

This is separate from the renderer 1) for clarity 2) so you can have separate caches for separate views of the same document, even for view and printer (if the renderer is made to support rendering onto different targets).

Warning:

The smart-mutex must be locked whenever this is used

Author:

Hamish Rodda <rodda@kde.org>

Definition at line 79 of file katelayoutcache.h.

---

Constructor & Destructor Documentation

KateLayoutCache::KateLayoutCache	(	KateRenderer *	renderer,
		QObject *	parent
	)		[explicit]

connect to all possible editing primitives

Definition at line 140 of file katelayoutcache.cpp.

---

Member Function Documentation

bool KateLayoutCache::acceptDirtyLayouts

(

)

Definition at line 539 of file katelayoutcache.cpp.

void KateLayoutCache::clear

(

)

Definition at line 496 of file katelayoutcache.cpp.

int KateLayoutCache::displayViewLine	(	const KTextEditor::Cursor &	virtualCursor,
		bool	limitToVisible = false
	)

Definition at line 396 of file katelayoutcache.cpp.

int KateLayoutCache::lastViewLine

(

int

realLine

)

Definition at line 451 of file katelayoutcache.cpp.

KateLineLayoutPtr KateLayoutCache::line	(	int	realLine,
		int	virtualLine = -1
	)

Returns the KateLineLayout for the specified line.

If one does not exist, it will be created and laid out. Layouts which are not directly part of the view will be kept until the cache is full or until they are invalidated by other means (eg. the text changes).

Parameters:

realLine	real line number of the layout to retrieve.
virtualLine	virtual line number. only needed if you think it may have changed (ie. basically internal to KateLayoutCache)

Definition at line 276 of file katelayoutcache.cpp.

KateLineLayoutPtr KateLayoutCache::line

(

const KTextEditor::Cursor &

realCursor

)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 324 of file katelayoutcache.cpp.

void KateLayoutCache::relayoutLines	(	int	startRealLine,
		int	endRealLine
	)

Definition at line 531 of file katelayoutcache.cpp.

void KateLayoutCache::setAcceptDirtyLayouts

(

bool

accept

)

Definition at line 544 of file katelayoutcache.cpp.

void KateLayoutCache::setViewWidth

(

int

width

)

Definition at line 503 of file katelayoutcache.cpp.

void KateLayoutCache::setWrap

(

bool

wrap

)

Definition at line 525 of file katelayoutcache.cpp.

KateTextLayout KateLayoutCache::textLayout

(

const KTextEditor::Cursor &

realCursor

)

Returns the layout describing the text line which is occupied by realCursor.

Definition at line 329 of file katelayoutcache.cpp.

KateTextLayout KateLayoutCache::textLayout	(	uint	realLine,
		int	viewLine
	)

Returns the layout of the specified realLine + viewLine.

if viewLine is -1, return the last.

Definition at line 339 of file katelayoutcache.cpp.

void KateLayoutCache::updateViewCache	(	const KTextEditor::Cursor &	startPos,
		int	newViewLineCount = -1,
		int	viewLinesScrolled = 0
	)

Definition at line 159 of file katelayoutcache.cpp.

void KateLayoutCache::viewCacheDebugOutput

(

)

const

Definition at line 465 of file katelayoutcache.cpp.

KTextEditor::Cursor KateLayoutCache::viewCacheEnd

(

)

const

Definition at line 366 of file katelayoutcache.cpp.

int KateLayoutCache::viewCacheLineCount

(

)

const

Definition at line 356 of file katelayoutcache.cpp.

KTextEditor::Cursor KateLayoutCache::viewCacheStart

(

)

const

Definition at line 361 of file katelayoutcache.cpp.

KateTextLayout & KateLayoutCache::viewLine

(

int

viewLine

)

Returns the layout of the corresponding line in the view.

Definition at line 350 of file katelayoutcache.cpp.

int KateLayoutCache::viewLine

(

const KTextEditor::Cursor &

realCursor

)

This returns the view line upon which realCursor is situated.

The view line is the number of lines in the view from the first line The supplied cursor should be in real lines.

Definition at line 381 of file katelayoutcache.cpp.

int KateLayoutCache::viewLineCount

(

int

realLine

)

Definition at line 460 of file katelayoutcache.cpp.

int KateLayoutCache::viewWidth

(

)

const

Definition at line 371 of file katelayoutcache.cpp.

bool KateLayoutCache::wrap

(

)

const

Definition at line 520 of file katelayoutcache.cpp.

---

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

• katelayoutcache.h
• katelayoutcache.cpp