.TH "KateBuffer" kde3 "11 Jun 2005" "Version Version 3.4.1" "kate Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KateBuffer \- The KateBuffer class maintains a collections of lines.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <katebuffer.h>\fP
.PP
Inherits \fBQObject\fP.
.PP
.SS "Public Slots"

.in +1c
.ti -1c
.RI "void \fBcodeFoldingColumnUpdate\fP (unsigned int lineNr)"
.br
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBcodeFoldingUpdated\fP ()"
.br
.ti -1c
.RI "void \fBtagLines\fP (int start, int end)"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKateBuffer\fP (KateDocument *doc)"
.br
.ti -1c
.RI "\fB~KateBuffer\fP ()"
.br
.ti -1c
.RI "void \fBeditStart\fP ()"
.br
.ti -1c
.RI "void \fBeditEnd\fP ()"
.br
.ti -1c
.RI "void \fBclear\fP ()"
.br
.ti -1c
.RI "bool \fBopenFile\fP (const \fBQString\fP &m_file)"
.br
.ti -1c
.RI "bool \fBloadingBorked\fP () const "
.br
.ti -1c
.RI "bool \fBbinary\fP () const "
.br
.ti -1c
.RI "bool \fBcanEncode\fP ()"
.br
.ti -1c
.RI "bool \fBsaveFile\fP (const \fBQString\fP &m_file)"
.br
.ti -1c
.RI "\fBKateTextLine::Ptr\fP \fBline\fP (uint i)"
.br
.ti -1c
.RI "\fBKateTextLine::Ptr\fP \fBplainLine\fP (uint i)"
.br
.ti -1c
.RI "uint \fBcount\fP () const "
.br
.ti -1c
.RI "void \fBchangeLine\fP (uint i)"
.br
.ti -1c
.RI "void \fBinsertLine\fP (uint i, \fBKateTextLine::Ptr\fP line)"
.br
.ti -1c
.RI "void \fBremoveLine\fP (uint i)"
.br
.ti -1c
.RI "uint \fBcountVisible\fP ()"
.br
.ti -1c
.RI "uint \fBlineNumber\fP (uint visibleLine)"
.br
.ti -1c
.RI "uint \fBlineVisibleNumber\fP (uint line)"
.br
.ti -1c
.RI "void \fBlineInfo\fP (KateLineInfo *info, unsigned int line)"
.br
.ti -1c
.RI "uint \fBtabWidth\fP () const "
.br
.ti -1c
.RI "void \fBsetTabWidth\fP (uint w)"
.br
.ti -1c
.RI "void \fBsetHighlight\fP (uint hlMode)"
.br
.ti -1c
.RI "KateHighlighting * \fBhighlight\fP ()"
.br
.ti -1c
.RI "void \fBinvalidateHighlighting\fP ()"
.br
.ti -1c
.RI "KateCodeFoldingTree * \fBfoldingTree\fP ()"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static uint \fBmaxLoadedBlocks\fP ()"
.br
.ti -1c
.RI "static void \fBsetMaxLoadedBlocks\fP (uint count)"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBKateBufBlock\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
The KateBuffer class maintains a collections of lines. 

It allows to maintain state information in a lazy way. It handles swapping out of data using secondary storage.
.PP
It is designed to handle large amounts of text-data efficiently with respect to CPU and memory usage.
.PP
\fBAuthor:\fP
.RS 4
Waldo Bastian <bastian@kde.org> 
.PP
Christoph Cullmann <cullmann@kde.org> 
.RE
.PP

.PP
Definition at line 341 of file katebuffer.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KateBuffer::KateBuffer (KateDocument * doc)"
.PP
Create an empty buffer. 
.PP
\fBParameters:\fP
.RS 4
\fIdoc\fP parent document 
.RE
.PP

.PP
Definition at line 317 of file katebuffer.cpp.
.PP
References clear().
.SS "KateBuffer::~\fBKateBuffer\fP ()"
.PP
Goodbye buffer. 
.PP
Definition at line 344 of file katebuffer.cpp.
.PP
References QValueVector::size().
.SH "Member Function Documentation"
.PP 
.SS "static uint KateBuffer::maxLoadedBlocks ()\fC [inline, static]\fP"
.PP
maximal loaded block count 
.PP
\fBReturns:\fP
.RS 4
max loaded blocks 
.RE
.PP

.PP
Definition at line 352 of file katebuffer.h.
.PP
Referenced by KateBufBlock::KateBufBlock().
.SS "void KateBuffer::setMaxLoadedBlocks (uint count)\fC [static]\fP"
.PP
modifier for max loaded blocks limit 
.PP
\fBParameters:\fP
.RS 4
\fIcount\fP new limit 
.RE
.PP

.PP
Definition at line 79 of file katebuffer.cpp.
.PP
References KMAX.
.SS "void KateBuffer::editStart ()"
.PP
start some editing action 
.PP
Definition at line 355 of file katebuffer.cpp.
.SS "void KateBuffer::editEnd ()"
.PP
finish some editing action 
.PP
Definition at line 368 of file katebuffer.cpp.
.PP
References KateBufBlock::endLine(), and KateBufBlock::startLine().
.SS "void KateBuffer::clear ()"
.PP
Clear the buffer. 
.PP
Definition at line 450 of file katebuffer.cpp.
.PP
References QValueVector::append(), QValueVector::clear(), KateBufBlock::lines(), and QValueVector::size().
.PP
Referenced by KateBuffer(), and openFile().
.SS "bool KateBuffer::openFile (const \fBQString\fP & m_file)"
.PP
Open a file, use the given filename. 
.PP
\fBParameters:\fP
.RS 4
\fIm_file\fP filename to open 
.RE
.PP
\fBReturns:\fP
.RS 4
success 
.RE
.PP

.PP
Definition at line 477 of file katebuffer.cpp.
.PP
References QValueVector::append(), QValueVector::clear(), clear(), endl(), KateBufBlock::endLine(), QValueVector::isEmpty(), kdDebug(), KateBufBlock::lines(), and QValueVector::size().
.SS "bool KateBuffer::loadingBorked () const\fC [inline]\fP"
.PP
was the last loading broken because of not enough tmp disk space ? (will be reseted on successful save of the file, user gets warning if he really wants to do it) 
.PP
\fBReturns:\fP
.RS 4
was loading borked? 
.RE
.PP

.PP
Definition at line 447 of file katebuffer.h.
.SS "bool KateBuffer::binary () const\fC [inline]\fP"
.PP
is this file a binary? 
.PP
\fBReturns:\fP
.RS 4
binary file? 
.RE
.PP

.PP
Definition at line 453 of file katebuffer.h.
.SS "bool KateBuffer::canEncode ()"
.PP
Can the current codec handle all chars. 
.PP
\fBReturns:\fP
.RS 4
chars can be encoded 
.RE
.PP

.PP
Definition at line 559 of file katebuffer.cpp.
.PP
References QTextCodec::canEncode(), endl(), kdDebug(), QTextCodec::name(), and plainLine().
.SS "bool KateBuffer::saveFile (const \fBQString\fP & m_file)"
.PP
Save the buffer to a file, use the given filename + codec + end of line chars (internal use of qtextstream). 
.PP
\fBParameters:\fP
.RS 4
\fIm_file\fP filename to save to 
.RE
.PP
\fBReturns:\fP
.RS 4
success 
.RE
.PP

.PP
Definition at line 583 of file katebuffer.cpp.
.PP
References QFile::close(), QString::fill(), QFile::open(), plainLine(), QTextStream::setCodec(), and QTextStream::setEncoding().
.SS "\fBKateTextLine::Ptr\fP KateBuffer::line (uint i)\fC [inline]\fP"
.PP
Return line \fCi\fP. 
.PP
Definition at line 472 of file katebuffer.h.
.PP
References KateBufBlock::line(), and KateBufBlock::startLine().
.SS "\fBKateTextLine::Ptr\fP KateBuffer::plainLine (uint i)\fC [inline]\fP"
.PP
Return line \fCi\fP without triggering highlighting. 
.PP
Definition at line 494 of file katebuffer.h.
.PP
References KateBufBlock::line(), and KateBufBlock::startLine().
.PP
Referenced by canEncode(), and saveFile().
.SS "uint KateBuffer::count () const\fC [inline]\fP"
.PP
Return the total number of lines in the buffer. 
.PP
Definition at line 506 of file katebuffer.h.
.SS "void KateBuffer::changeLine (uint i)"
.PP
Mark line \fCi\fP as changed ! 
.PP
Definition at line 749 of file katebuffer.cpp.
.PP
References KateBufBlock::markDirty().
.SS "void KateBuffer::insertLine (uint i, \fBKateTextLine::Ptr\fP line)"
.PP
Insert \fCline\fP in front of line \fCi\fP. 
.PP
Definition at line 759 of file katebuffer.cpp.
.PP
References KateBufBlock::insertLine(), and KateBufBlock::startLine().
.SS "void KateBuffer::removeLine (uint i)"
.PP
Remove line \fCi\fP. 
.PP
Definition at line 794 of file katebuffer.cpp.
.PP
References QValueVector::begin(), KateBufBlock::endLine(), QValueVector::erase(), KateBufBlock::lines(), KateBufBlock::next(), KateBufBlock::prev(), KateBufBlock::removeLine(), KateBufBlock::setStartLine(), and KateBufBlock::startLine().
.SS "void KateBuffer::setHighlight (uint hlMode)"
.PP
Use \fChighlight\fP for highlighting. 
.PP
\fChighlight\fP may be 0 in which case highlighting will be disabled. 
.PP
Definition at line 860 of file katebuffer.cpp.
.PP
References invalidateHighlighting().
.SS "void KateBuffer::invalidateHighlighting ()"
.PP
Invalidate highlighting of whole buffer. 
.PP
Definition at line 892 of file katebuffer.cpp.
.PP
Referenced by setHighlight().
.SS "void KateBuffer::codeFoldingUpdated ()\fC [signal]\fP"
.PP
Emittend if codefolding returned with a changed list. 
.PP
.SS "void KateBuffer::tagLines (int start, int end)\fC [signal]\fP"
.PP
Emitted when the highlighting of a certain range has changed. 
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for kate Library from the source code.
