KateBuffer
#include <katebuffer.h>

Signals | |
void | respellCheckBlock (int start, int end) |
void | tagLines (KTextEditor::LineRange lineRange) |
![]() | |
void | cleared () |
void | editingFinished () |
void | editingStarted () |
void | lineUnwrapped (int line) |
void | lineWrapped (const KTextEditor::Cursor position) |
void | loaded (const QString &filename, bool encodingErrors) |
void | saved (const QString &filename) |
void | textInserted (const KTextEditor::Cursor position, const QString &text) |
void | textRemoved (KTextEditor::Range range, const QString &text) |
Public Member Functions | |
KateBuffer (KTextEditor::DocumentPrivate *doc) | |
~KateBuffer () override | |
bool | brokenEncoding () const |
bool | canEncode () |
void | clear () override |
KTextEditor::Range | computeFoldingRangeForStartLine (int startLine) |
int | count () const |
bool | editChanged () const |
void | editEnd () |
void | editStart () |
int | editTagEnd () const |
bool | editTagFrom () const |
int | editTagStart () const |
void | ensureHighlighted (int line, int lookAhead=64) |
KateHighlighting * | highlight () |
void | invalidateHighlighting () |
std::pair< bool, bool > | isFoldingStartingOnLine (int startLine) |
int | lineLength (int lineno) const |
int | longestLineLoaded () const |
bool | openFile (const QString &m_file, bool enforceTextCodec) |
Kate::TextLine | plainLine (int lineno) |
bool | saveFile (const QString &m_file) |
void | setHighlight (int hlMode) |
void | setTabWidth (int w) |
int | tabWidth () const |
bool | tooLongLinesWrapped () const |
void | unwrapLine (int line) override |
void | updateHighlighting () |
void | wrapLine (const KTextEditor::Cursor position) override |
![]() | |
TextBuffer (KTextEditor::DocumentPrivate *parent, int blockSize=64, bool alwaysUseKAuth=false) | |
~TextBuffer () override | |
void | debugPrint (const QString &title) const |
const QByteArray & | digest () const |
KTextEditor::DocumentPrivate * | document () const |
bool | editingChangedBuffer () const |
bool | editingChangedNumberOfLines () const |
int | editingLastLines () const |
qint64 | editingLastRevision () const |
int | editingMaximalLineChanged () const |
int | editingMinimalLineChanged () const |
int | editingTransactions () const |
KEncodingProber::ProberType | encodingProberType () const |
EndOfLineMode | endOfLineMode () const |
QTextCodec * | fallbackTextCodec () const |
virtual bool | finishEditing () |
bool | generateByteOrderMark () const |
TextHistory & | history () |
virtual void | insertText (const KTextEditor::Cursor position, const QString &text) |
void | invalidateRanges () |
TextLine | line (int line) const |
int | lineLength (int line) const |
int | lines () const |
virtual bool | load (const QString &filename, bool &encodingErrors, bool &tooLongLinesWrapped, int &longestLineLoaded, bool enforceTextCodec) |
bool | rangePointerValid (TextRange *range) const |
QVector< TextRange * > | rangesForLine (int line, KTextEditor::View *view, bool rangesWithAttributeOnly) const |
virtual void | removeText (KTextEditor::Range range) |
qint64 | revision () const |
virtual bool | save (const QString &filename) |
void | setDigest (const QByteArray &checksum) |
void | setEncodingProberType (KEncodingProber::ProberType proberType) |
void | setEndOfLineMode (EndOfLineMode endOfLineMode) |
void | setFallbackTextCodec (QTextCodec *codec) |
void | setGenerateByteOrderMark (bool generateByteOrderMark) |
void | setLineLengthLimit (int lineLengthLimit) |
void | setTextCodec (QTextCodec *codec) |
virtual bool | startEditing () |
QString | text () const |
QTextCodec * | textCodec () const |
![]() | |
QObject (QObject *parent) | |
bool | blockSignals (bool block) |
const QObjectList & | children () const const |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const |
void | deleteLater () |
void | destroyed (QObject *obj) |
bool | disconnect (const char *signal, const QObject *receiver, const char *method) const const |
bool | disconnect (const QObject *receiver, const char *method) const const |
void | dumpObjectInfo () |
void | dumpObjectInfo () const const |
void | dumpObjectTree () |
void | dumpObjectTree () const const |
QList< QByteArray > | dynamicPropertyNames () const const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegExp ®Exp, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QString &name, Qt::FindChildOptions options) const const |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
bool | isWidgetType () const const |
bool | isWindowType () const const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () const const |
QVariant | property (const char *name) const const |
Q_CLASSINFO (Name, Value) | |
Q_DISABLE_COPY (Class) | |
Q_DISABLE_COPY_MOVE (Class) | |
Q_DISABLE_MOVE (Class) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
Q_NAMESPACE Q_NAMESPACE | |
Q_NAMESPACE_EXPORT (EXPORT_MACRO) | |
Q_OBJECT Q_OBJECT | |
Q_PROPERTY (...) | |
Q_REVISION Q_REVISION | |
Q_SET_OBJECT_NAME (Object) | |
Q_SIGNAL Q_SIGNAL | |
Q_SIGNALS Q_SIGNALS | |
Q_SLOT Q_SLOT | |
Q_SLOTS Q_SLOTS | |
T | qFindChild (const QObject *obj, const QString &name) |
QList< T > | qFindChildren (const QObject *obj, const QRegExp ®Exp) |
QList< T > | qFindChildren (const QObject *obj, const QString &name) |
T | qobject_cast (const QObject *object) |
T | qobject_cast (QObject *object) |
QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT | |
void | removeEventFilter (QObject *obj) |
void | setObjectName (const QString &name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds time, Qt::TimerType timerType) |
QThread * | thread () const const |
Additional Inherited Members | |
![]() | |
enum | EndOfLineMode { eolUnknown = -1, eolUnix = 0, eolDos = 1, eolMac = 2 } |
![]() | |
objectName | |
![]() | |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, Functor functor) |
bool | disconnect (const QMetaObject::Connection &connection) |
bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method) |
bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
bool | disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
QString | trUtf8 (const char *sourceText, const char *disambiguation, int n) |
![]() | |
typedef | QObjectList |
![]() | |
virtual void | childEvent (QChildEvent *event) |
virtual void | connectNotify (const QMetaMethod &signal) |
virtual void | customEvent (QEvent *event) |
virtual void | disconnectNotify (const QMetaMethod &signal) |
bool | isSignalConnected (const QMetaMethod &signal) const const |
int | receivers (const char *signal) const const |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
Detailed Description
The KateBuffer class maintains a collections of lines.
Definition at line 30 of file katebuffer.h.
Constructor & Destructor Documentation
◆ KateBuffer()
|
explicit |
Create an empty buffer.
- Parameters
-
doc parent document
(with one block with one empty line)
Definition at line 35 of file katebuffer.cpp.
◆ ~KateBuffer()
|
overridedefault |
Goodbye buffer.
Cleanup on destruction.
Member Function Documentation
◆ brokenEncoding()
|
inline |
Did encoding errors occur on load?
- Returns
- encoding errors occurred on load?
Definition at line 118 of file katebuffer.h.
◆ canEncode()
bool KateBuffer::canEncode | ( | ) |
Can the current codec handle all chars.
- Returns
- chars can be encoded
Definition at line 180 of file katebuffer.cpp.
◆ clear()
|
overridevirtual |
Clear the buffer.
Reimplemented from Kate::TextBuffer.
Definition at line 97 of file katebuffer.cpp.
◆ computeFoldingRangeForStartLine()
KTextEditor::Range KateBuffer::computeFoldingRangeForStartLine | ( | int | startLine | ) |
For a given line, compute the folding range that starts there to be used to fold e.g.
from the icon border
- Parameters
-
startLine start line
- Returns
- folding range starting at the given line or invalid range when there is no folding start or
startLine
is not valid
Definition at line 438 of file katebuffer.cpp.
◆ count()
|
inline |
Return the total number of lines in the buffer.
Definition at line 188 of file katebuffer.h.
◆ editChanged()
|
inline |
were there changes in the current running editing session?
- Returns
- changes done?
Definition at line 68 of file katebuffer.h.
◆ editEnd()
void KateBuffer::editEnd | ( | ) |
finish some editing action
Definition at line 60 of file katebuffer.cpp.
◆ editStart()
void KateBuffer::editStart | ( | ) |
start some editing action
Definition at line 53 of file katebuffer.cpp.
◆ editTagEnd()
|
inline |
◆ editTagFrom()
|
inline |
◆ editTagStart()
|
inline |
◆ ensureHighlighted()
void KateBuffer::ensureHighlighted | ( | int | line, |
int | lookAhead = 64 |
||
) |
Update highlighting of given line line
, if needed.
If line
is already highlighted, this function does nothing. If line
is not highlighted, all lines up to line + lookAhead are highlighted.
- Parameters
-
lookAhead also highlight these following lines
Definition at line 229 of file katebuffer.cpp.
◆ invalidateHighlighting()
void KateBuffer::invalidateHighlighting | ( | ) |
Invalidate highlighting of whole buffer.
Definition at line 308 of file katebuffer.cpp.
◆ isFoldingStartingOnLine()
std::pair< bool, bool > KateBuffer::isFoldingStartingOnLine | ( | int | startLine | ) |
For a given line, compute if folding starts here.
- Parameters
-
startLine start line
- Returns
- does folding start here and is it indentation based?
Definition at line 393 of file katebuffer.cpp.
◆ openFile()
bool KateBuffer::openFile | ( | const QString & | m_file, |
bool | enforceTextCodec | ||
) |
Open a file, use the given filename.
- Parameters
-
m_file filename to open enforceTextCodec enforce to use only the set text codec
- Returns
- success
Definition at line 111 of file katebuffer.cpp.
◆ plainLine()
|
inline |
Return line lineno
.
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 158 of file katebuffer.h.
◆ saveFile()
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 202 of file katebuffer.cpp.
◆ setHighlight()
void KateBuffer::setHighlight | ( | int | hlMode | ) |
Use highlight
for highlighting.
highlight
may be 0 in which case highlighting will be disabled.
Definition at line 279 of file katebuffer.cpp.
◆ tagLines
|
signal |
Emitted when the highlighting of a certain range has changed.
◆ tooLongLinesWrapped()
|
inline |
Too long lines wrapped on load?
- Returns
- too long lines wrapped on load?
Definition at line 127 of file katebuffer.h.
◆ unwrapLine()
|
overridevirtual |
Unwrap given line.
- Parameters
-
line line to unwrap
Reimplemented from Kate::TextBuffer.
Definition at line 258 of file katebuffer.cpp.
◆ updateHighlighting()
void KateBuffer::updateHighlighting | ( | ) |
Update highlighting of the lines in last edit transaction.
Definition at line 80 of file katebuffer.cpp.
◆ wrapLine()
|
overridevirtual |
Wrap line at given cursor position.
- Parameters
-
position line/column as cursor where to wrap
Reimplemented from Kate::TextBuffer.
Definition at line 248 of file katebuffer.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Tue Feb 7 2023 03:56:06 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.