Kate
KateBuffer Class Reference
The KateBuffer class maintains a collections of lines. More...
#include <katebuffer.h>

Signals | |
void | codeFoldingUpdated () |
void | tagLines (int start, int end) |
Public Member Functions | |
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 () |
KateBuffer (KateDocument *doc) | |
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 |
~KateBuffer () |
Detailed Description
The KateBuffer class maintains a collections of lines.
Definition at line 65 of file katebuffer.h.
Constructor & Destructor Documentation
KateBuffer::KateBuffer | ( | KateDocument * | doc | ) | [explicit] |
Create an empty buffer.
- Parameters:
-
doc parent document
Definition at line 399 of file katebuffer.cpp.
KateBuffer::~KateBuffer | ( | ) |
Member Function Documentation
bool KateBuffer::binary | ( | ) | const [inline] |
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 604 of file katebuffer.cpp.
void KateBuffer::changeLine | ( | int | i | ) |
void KateBuffer::clear | ( | ) |
void KateBuffer::codeFoldingColumnUpdate | ( | int | lineNr | ) |
Definition at line 1293 of file katebuffer.cpp.
void KateBuffer::codeFoldingUpdated | ( | ) | [signal] |
Emittend if codefolding returned with a changed list.
int KateBuffer::count | ( | ) | const [inline] |
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 | ( | ) |
void KateBuffer::editStart | ( | ) |
int KateBuffer::editTagEnd | ( | ) | const [inline] |
bool KateBuffer::editTagFrom | ( | ) | const [inline] |
int KateBuffer::editTagStart | ( | ) | const [inline] |
void KateBuffer::ensureHighlighted | ( | int | line | ) |
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 | |||
) |
void KateBuffer::invalidateHighlighting | ( | ) |
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 518 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 | ) |
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 628 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 896 of file katebuffer.cpp.
void KateBuffer::setTabWidth | ( | int | w | ) |
Definition at line 885 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: