.TH "KateBufBlock" kde3 "11 Jun 2005" "Version Version 3.4.1" "kate Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KateBufBlock \- The KateBufBlock class contains an amount of data representing a certain number of lines.  

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

.in +1c
.ti -1c
.RI "enum \fBState\fP { \fBstateSwapped\fP =  0, \fBstateClean\fP =  1, \fBstateDirty\fP =  2 }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKateBufBlock\fP (\fBKateBuffer\fP *parent, \fBKateBufBlock\fP *prev=0, \fBKateBufBlock\fP *next=0, KateFileLoader *stream=0)"
.br
.ti -1c
.RI "\fB~KateBufBlock\fP ()"
.br
.ti -1c
.RI "\fBState\fP \fBstate\fP () const "
.br
.ti -1c
.RI "\fBKateTextLine::Ptr\fP \fBline\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 "void \fBmarkDirty\fP ()"
.br
.ti -1c
.RI "uint \fBstartLine\fP () const "
.br
.ti -1c
.RI "void \fBsetStartLine\fP (uint line)"
.br
.ti -1c
.RI "uint \fBendLine\fP () const "
.br
.ti -1c
.RI "uint \fBlines\fP () const "
.br
.ti -1c
.RI "\fBKateBufBlock\fP * \fBprev\fP ()"
.br
.ti -1c
.RI "\fBKateBufBlock\fP * \fBnext\fP ()"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBKateBufBlockList\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
The KateBufBlock class contains an amount of data representing a certain number of lines. 

\fBAuthor:\fP
.RS 4
Waldo Bastian <bastian@kde.org> 
.PP
Christoph Cullmann <cullmann@kde.org> 
.RE
.PP

.PP
Definition at line 49 of file katebuffer.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBKateBufBlock::State\fP"
.PP
state flags 
.PP
Definition at line 80 of file katebuffer.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KateBufBlock::KateBufBlock (\fBKateBuffer\fP * parent, \fBKateBufBlock\fP * prev = \fC0\fP, \fBKateBufBlock\fP * next = \fC0\fP, KateFileLoader * stream = \fC0\fP)"
.PP
Create an empty block. 
.PP
(empty == ONE line) 
.PP
\fBParameters:\fP
.RS 4
\fIparent\fP buffer the block belongs to 
.br
\fIprev\fP previous bufblock in the list 
.br
\fInext\fP next bufblock in the list 
.br
\fIstream\fP stream to load the content from, if any given 
.RE
.PP

.PP
Definition at line 1179 of file katebuffer.cpp.
.PP
References KateBufBlockList::append(), KateBufBlockList::count(), endLine(), KateBufBlockList::first(), KateBuffer::m_loadedBlocks, m_next, m_prev, KateBuffer::maxLoadedBlocks(), QValueVector::push_back(), and swapOut().
.SS "KateBufBlock::~\fBKateBufBlock\fP ()"
.PP
destroy this block and take care of freeing all mem 
.PP
Definition at line 1227 of file katebuffer.cpp.
.PP
References m_next, m_prev, and KateBufBlockList::remove().
.SH "Member Function Documentation"
.PP 
.SS "\fBState\fP KateBufBlock::state () const\fC [inline]\fP"
.PP
returns the current state of this block 
.PP
\fBReturns:\fP
.RS 4
state 
.RE
.PP

.PP
Definition at line 91 of file katebuffer.h.
.SS "\fBKateTextLine::Ptr\fP KateBufBlock::line (uint i)"
.PP
return line \fCi\fP The first line of this block is line 0. 
.PP
if you modifiy this line, please mark the block as dirty 
.PP
\fBParameters:\fP
.RS 4
\fIi\fP line to return 
.RE
.PP
\fBReturns:\fP
.RS 4
line pointer 
.RE
.PP

.PP
Definition at line 1333 of file katebuffer.cpp.
.PP
References KateBufBlockList::append(), KateBufBlockList::isLast(), and KateBuffer::m_loadedBlocks.
.PP
Referenced by KateBuffer::line(), and KateBuffer::plainLine().
.SS "void KateBufBlock::insertLine (uint i, \fBKateTextLine::Ptr\fP line)"
.PP
insert \fCline\fP in front of line \fCi\fP marks the block dirty 
.PP
\fBParameters:\fP
.RS 4
\fIi\fP where to insert 
.br
\fIline\fP line pointer 
.RE
.PP

.PP
Definition at line 1346 of file katebuffer.cpp.
.PP
References QValueVector::begin(), QValueVector::insert(), and markDirty().
.PP
Referenced by KateBuffer::insertLine().
.SS "void KateBufBlock::removeLine (uint i)"
.PP
remove line \fCi\fP marks the block dirty 
.PP
\fBParameters:\fP
.RS 4
\fIi\fP line to remove 
.RE
.PP

.PP
Definition at line 1358 of file katebuffer.cpp.
.PP
References QValueVector::begin(), QValueVector::erase(), and markDirty().
.PP
Referenced by KateBuffer::removeLine().
.SS "void KateBufBlock::markDirty ()"
.PP
mark this block as dirty, will invalidate the swap data insert/removeLine will mark the block dirty itself 
.PP
Definition at line 1370 of file katebuffer.cpp.
.PP
References KateBufBlockList::append(), KateBufBlockList::isLast(), and KateBuffer::m_loadedBlocks.
.PP
Referenced by KateBuffer::changeLine(), insertLine(), and removeLine().
.SS "uint KateBufBlock::startLine () const\fC [inline]\fP"
.PP
startLine 
.PP
\fBReturns:\fP
.RS 4
first line in block 
.RE
.PP

.PP
Definition at line 129 of file katebuffer.h.
.PP
Referenced by KateBuffer::editEnd(), KateBuffer::insertLine(), KateBuffer::line(), KateBuffer::plainLine(), and KateBuffer::removeLine().
.SS "void KateBufBlock::setStartLine (uint line)\fC [inline]\fP"
.PP
update the first line, needed to keep it up to date 
.PP
\fBParameters:\fP
.RS 4
\fIline\fP new startLine 
.RE
.PP

.PP
Definition at line 135 of file katebuffer.h.
.PP
Referenced by KateBuffer::removeLine().
.SS "uint KateBufBlock::endLine () const\fC [inline]\fP"
.PP
first line behind this block 
.PP
\fBParameters:\fP
.RS 4
\fIline\fP behind block 
.RE
.PP

.PP
Definition at line 141 of file katebuffer.h.
.PP
Referenced by KateBuffer::editEnd(), KateBufBlock(), KateBuffer::openFile(), and KateBuffer::removeLine().
.SS "uint KateBufBlock::lines () const\fC [inline]\fP"
.PP
lines in this block 
.PP
\fBReturns:\fP
.RS 4
lines 
.RE
.PP

.PP
Definition at line 147 of file katebuffer.h.
.PP
Referenced by KateBuffer::clear(), KateBuffer::openFile(), and KateBuffer::removeLine().
.SS "\fBKateBufBlock\fP* KateBufBlock::prev ()\fC [inline]\fP"
.PP
prev block 
.PP
\fBReturns:\fP
.RS 4
previous block 
.RE
.PP

.PP
Definition at line 153 of file katebuffer.h.
.PP
Referenced by KateBuffer::removeLine().
.SS "\fBKateBufBlock\fP* KateBufBlock::next ()\fC [inline]\fP"
.PP
next block 
.PP
\fBReturns:\fP
.RS 4
next block 
.RE
.PP

.PP
Definition at line 159 of file katebuffer.h.
.PP
Referenced by KateBuffer::removeLine().

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