KateBuffer Class Reference

The KateBuffer class maintains a collections of lines. More...

#include <katebuffer.h>

Inheritance diagram for KateBuffer:

[legend]

List of all members.

Signals
void	codeFoldingUpdated ()
void	respellCheckBlock (int start, int end)
void	tagLines (int start, int end)
Public Member Functions
	KateBuffer (KateDocument *doc)
	~KateBuffer ()
bool	binary () const
bool	brokenUTF8 () const
bool	canEncode ()
void	changeLine (int i)
void	clear ()
void	codeFoldingColumnUpdate (int lineNr)
int	count () const
int	countVisible ()
bool	editChanged () const
void	editEnd ()
void	editStart ()
int	editTagEnd () const
bool	editTagFrom () const
int	editTagStart () const
void	ensureHighlighted (int line)
KateCodeFoldingTree *	foldingTree ()
KateHighlighting *	highlight ()
void	insertLine (int i, KateTextLine::Ptr line)
void	invalidateHighlighting ()
void	lineInfo (KateLineInfo *info, int line)
int	lineNumber (int visibleLine)
int	lineVisibleNumber (int line)
bool	openFile (const QString &m_file)
KateTextLine::Ptr	plainLine (int line)
void	removeLine (int i)
bool	saveFile (const QString &m_file)
void	setHighlight (int hlMode)
void	setTabWidth (int w)
int	tabWidth () const

---

Detailed Description

The KateBuffer class maintains a collections of lines.

Author:

Waldo Bastian <bastian@kde.org>

Christoph Cullmann <cullmann@kde.org>

Definition at line 65 of file katebuffer.h.

---

Constructor & Destructor Documentation

KateBuffer::KateBuffer

(

KateDocument *

doc

)

[explicit]

Create an empty buffer.

Parameters:

doc

parent document

(with one block with one empty line)

Definition at line 461 of file katebuffer.cpp.

KateBuffer::~KateBuffer

(

)

Goodbye buffer.

Cleanup on destruction.

Definition at line 487 of file katebuffer.cpp.

---

Member Function Documentation

bool KateBuffer::binary

(

)

const [inline]

is this file a binary?

Returns:

binary file?

Definition at line 165 of file katebuffer.h.

bool KateBuffer::brokenUTF8

(

)

const [inline]

is this file a broken utf-8? this means: was it opened as utf-8 but contained invalid chars?

Returns:

binary file?

Definition at line 172 of file katebuffer.h.

bool KateBuffer::canEncode

(

)

Can the current codec handle all chars.

Returns:

chars can be encoded

Definition at line 671 of file katebuffer.cpp.

void KateBuffer::changeLine

(

int

i

)

Mark line i as changed !

Definition at line 856 of file katebuffer.cpp.

void KateBuffer::clear

(

)

Clear the buffer.

Definition at line 555 of file katebuffer.cpp.

void KateBuffer::codeFoldingColumnUpdate

(

int

lineNr

)

Definition at line 1375 of file katebuffer.cpp.

void KateBuffer::codeFoldingUpdated

(

)

[signal]

Emittend if codefolding returned with a changed list.

int KateBuffer::count

(

)

const [inline]

Return the total number of lines in the buffer.

Definition at line 214 of file katebuffer.h.

int KateBuffer::countVisible

(

)

[inline]

Definition at line 236 of file katebuffer.h.

bool KateBuffer::editChanged

(

)

const [inline]

were there changes in the current running editing session?

Returns:

changes done?

Definition at line 97 of file katebuffer.h.

void KateBuffer::editEnd

(

)

finish some editing action

Definition at line 513 of file katebuffer.cpp.

void KateBuffer::editStart

(

)

start some editing action

Definition at line 497 of file katebuffer.cpp.

int KateBuffer::editTagEnd

(

)

const [inline]

dirty lines end

Returns:

end line

Definition at line 109 of file katebuffer.h.

bool KateBuffer::editTagFrom

(

)

const [inline]

line inserted/removed?

Returns:

line inserted/removed?

Definition at line 115 of file katebuffer.h.

int KateBuffer::editTagStart

(

)

const [inline]

dirty lines start

Returns:

start line

Definition at line 103 of file katebuffer.h.

void KateBuffer::ensureHighlighted

(

int

line

)

Update highlighting of given line line, if needed.

Definition at line 834 of file katebuffer.cpp.

KateCodeFoldingTree* KateBuffer::foldingTree

(

)

[inline]

Definition at line 264 of file katebuffer.h.

KateHighlighting* KateBuffer::highlight

(

)

[inline]

Definition at line 257 of file katebuffer.h.

void KateBuffer::insertLine	(	int	i,
		KateTextLine::Ptr	line
	)

Insert line in front of line i.

Definition at line 872 of file katebuffer.cpp.

void KateBuffer::invalidateHighlighting

(

)

Invalidate highlighting of whole buffer.

Definition at line 1004 of file katebuffer.cpp.

void KateBuffer::lineInfo	(	KateLineInfo *	info,
		int	line
	)			[inline]

Definition at line 242 of file katebuffer.h.

int KateBuffer::lineNumber

(

int

visibleLine

)

[inline]

Definition at line 238 of file katebuffer.h.

int KateBuffer::lineVisibleNumber

(

int

line

)

[inline]

Definition at line 240 of file katebuffer.h.

bool KateBuffer::openFile

(

const QString &

m_file

)

Open a file, use the given filename.

Parameters:

m_file

filename to open

Returns:

success

Definition at line 580 of file katebuffer.cpp.

KateTextLine::Ptr KateBuffer::plainLine

(

int

line

)

[inline]

Return line line.

Highlighting of returned line might be out-dated, which may be sufficient for pure text manipulation functions, like search/replace. If you require highlighting to be up to date, call ensureHighlighted prior to this method.

Definition at line 195 of file katebuffer.h.

void KateBuffer::removeLine

(

int

i

)

Remove line i.

Definition at line 912 of file katebuffer.cpp.

void KateBuffer::respellCheckBlock	(	int	start,
		int	end
	)			[signal]

bool KateBuffer::saveFile

(

const QString &

m_file

)

Save the buffer to a file, use the given filename + codec + end of line chars (internal use of qtextstream).

Parameters:

m_file

filename to save to

Returns:

success

Definition at line 695 of file katebuffer.cpp.

void KateBuffer::setHighlight

(

int

hlMode

)

Use highlight for highlighting.

highlight may be 0 in which case highlighting will be disabled.

Definition at line 968 of file katebuffer.cpp.

void KateBuffer::setTabWidth

(

int

w

)

Definition at line 957 of file katebuffer.cpp.

int KateBuffer::tabWidth

(

)

const [inline]

Definition at line 244 of file katebuffer.h.

void KateBuffer::tagLines	(	int	start,
		int	end
	)			[signal]

Emitted when the highlighting of a certain range has changed.

---

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

• katebuffer.h
• katebuffer.cpp