• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • applications API Reference
  • KDE Home
  • Contact Us
 

Kate

Public Slots | Signals | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
KateView Class Reference

#include <kateview.h>

Inherits View, TextHintInterface, SessionConfigInterface, TemplateInterface2, CodeCompletionInterface, ConfigInterface, AnnotationViewInterface, and CoordinatesToCursorInterface.

Public Slots

void align ()
 
void backspace ()
 
void bottom ()
 
void bottomOfView ()
 
void capitalize ()
 
void changeDictionary ()
 
void cleanIndent ()
 
bool clearSelection ()
 
bool clearSelection (bool redraw, bool finishedChangingSelection=true)
 
void comment ()
 
void copy () const
 
void createSnippet ()
 
void cursorLeft ()
 
void cursorRight ()
 
void cut ()
 
void deleteWordLeft ()
 
void deleteWordRight ()
 
void down ()
 
void end ()
 
void find ()
 
void findNext ()
 
void findPrevious ()
 
void findSelectedBackwards ()
 
void findSelectedForwards ()
 
void gotoLine ()
 
void home ()
 
void indent ()
 
void insertTab ()
 
void joinLines ()
 
void keyDelete ()
 
void keyReturn ()
 
void killLine ()
 
void lowercase ()
 
void pageDown ()
 
void pageUp ()
 
void paste (const QString *textToPaste=0)
 
void reflectOnTheFlySpellCheckStatus (bool enabled)
 
void reloadFile ()
 
bool removeSelectedText ()
 
virtual bool removeSelection ()
 
virtual bool removeSelectionText ()
 
void replace ()
 
void scrollDown ()
 
void scrollUp ()
 
bool selectAll ()
 
void setAddBom (bool enabled)
 
virtual bool setBlockSelection (bool on)
 
void setDynWrapIndicators (int mode)
 
void setEol (int eol)
 
void setFoldingMarkersOn (bool enable)
 
void setIconBorder (bool enable)
 
void setLineNumbersOn (bool enable)
 
void setScrollBarMarks (bool enable)
 
void setScrollBarMiniMap (bool enable)
 
void setScrollBarMiniMapAll (bool enable)
 
void setScrollBarMiniMapWidth (int width)
 
virtual bool setSelection (const KTextEditor::Range &selection)
 
bool setSelection (const KTextEditor::Cursor &c, int i, bool b)
 
void shiftBottom ()
 
void shiftBottomOfView ()
 
void shiftCursorLeft ()
 
void shiftCursorRight ()
 
void shiftDown ()
 
void shiftEnd ()
 
void shiftHome ()
 
void shiftPageDown ()
 
void shiftPageUp ()
 
void shiftToMatchingBracket ()
 
void shiftTop ()
 
void shiftTopOfView ()
 
void shiftUp ()
 
void shiftWordLeft ()
 
void shiftWordRight ()
 
void showSnippetsDialog ()
 
void showViModeEmulatedCommandBar ()
 
void slotClipboardHistoryChanged ()
 
void slotCollapseLevel ()
 
void slotCollapseLocal ()
 
void slotExpandLevel ()
 
void slotExpandLocal ()
 
void slotFoldToplevelNodes ()
 
void slotReadWriteChanged ()
 
void slotUpdateUndo ()
 
void smartNewline ()
 
void switchToCmdLine ()
 
bool toggleBlockSelection ()
 
void toggleComment ()
 
void toggleDynWordWrap ()
 
void toggleFoldingMarkers ()
 
void toggleIconBorder ()
 
void toggleInsert ()
 
void toggleLineNumbersOn ()
 
void toggleScrollBarMarks ()
 
void toggleScrollBarMiniMap ()
 
void toggleScrollBarMiniMapAll ()
 
void toggleViInputMode ()
 
void toggleWriteLock ()
 
void toggleWWMarker ()
 
void toMatchingBracket ()
 
void toNextModifiedLine ()
 
void top ()
 
void topOfView ()
 
void toPrevModifiedLine ()
 
void transpose ()
 
void uncomment ()
 
void unIndent ()
 
void up ()
 
void uppercase ()
 
void userInvokedCompletion ()
 
void wordLeft ()
 
void wordRight ()
 

Signals

void annotationActivated (KTextEditor::View *view, int line)
 
void annotationBorderVisibilityChanged (View *view, bool visible)
 
void annotationContextMenuAboutToShow (KTextEditor::View *view, QMenu *menu, int line)
 
void completionAborted (KTextEditor::View *view)
 
void completionExecuted (KTextEditor::View *view, const KTextEditor::Cursor &position, KTextEditor::CodeCompletionModel *model, const QModelIndex &)
 
void configChanged ()
 
void delayedUpdateOfView ()
 
void displayRangeChanged (KateView *view)
 
void dropEventPass (QDropEvent *)
 
void navigateAccept ()
 
void navigateBack ()
 
void navigateDown ()
 
void navigateLeft ()
 
void navigateRight ()
 
void navigateUp ()
 
void needTextHint (const KTextEditor::Cursor &position, QString &text)
 

Public Member Functions

 KateView (KateDocument *doc, QWidget *parent)
 
 ~KateView ()
 
virtual void abortCompletion ()
 
void activateEditActions ()
 
KTextEditor::AnnotationModel * annotationModel () const
 
virtual bool blockSelection () const
 
KateViewBar * bottomViewBar () const
 
void clear ()
 
KateCommandLineBar * cmdLineBar ()
 
KateCompletionWidget * completionWidget () const
 
KateViewConfig * config ()
 
QStringList configKeys () const
 
QVariant configValue (const QString &key)
 
QMenu * contextMenu () const
 
KTextEditor::Cursor coordinatesToCursor (const QPoint &coord) const
 
QString currentTextLine ()
 
KTextEditor::Cursor cursorPosition () const
 
QPoint cursorPositionCoordinates () const
 
KTextEditor::Cursor cursorPositionVirtual () const
 
bool cursorSelected (const KTextEditor::Cursor &cursor)
 
QPoint cursorToCoordinate (const KTextEditor::Cursor &cursor) const
 
void deactivateEditActions ()
 
QMenu * defaultContextMenu (QMenu *menu=0L) const
 
KateDictionaryBar * dictionaryBar ()
 
void disableTextHints ()
 
KateDocument * doc ()
 
const KateDocument * doc () const
 
KTextEditor::Document * document () const
 
bool dynWordWrap () const
 
int dynWrapIndicators ()
 
void editEnd (int editTagLineStart, int editTagLineEnd, bool tagFrom)
 
void editSetCursor (const KTextEditor::Cursor &cursor)
 
void editStart ()
 
void emitNavigateAccept ()
 
void emitNavigateBack ()
 
void emitNavigateDown ()
 
void emitNavigateLeft ()
 
void emitNavigateRight ()
 
void emitNavigateUp ()
 
void enableTextHints (int timeout)
 
void ensureCursorColumnValid ()
 
bool foldingMarkersOn ()
 
void foldLine (int startLine)
 
virtual void forceCompletion ()
 
ViMode getCurrentViMode () const
 
int getEol () const
 
KateViInputModeManager * getViInputModeManager ()
 
bool iconBorder ()
 
virtual bool insertTemplateTextImplementation (const KTextEditor::Cursor &, const QString &templateString, const QMap< QString, QString > &initialValues)
 
virtual bool insertTemplateTextImplementation (const KTextEditor::Cursor &, const QString &templateString, const QMap< QString, QString > &initialValues, KTextEditor::TemplateScript *templateScript)
 
bool isAnnotationBorderVisible () const
 
virtual bool isAutomaticInvocationEnabled () const
 
virtual bool isCompletionActive () const
 
bool isOverwriteMode () const
 
bool lineEndSelected (const KTextEditor::Cursor &lineEndPos)
 
bool lineHasSelected (int line)
 
bool lineIsSelection (int line)
 
bool lineNumbersOn ()
 
bool lineSelected (int line)
 
KateMessageWidget * messageWidget ()
 
virtual bool mouseTrackingEnabled () const
 
void notifyAboutRangeChange (int startLine, int endLine, bool rangeWithAttribute)
 
void postMessage (KTextEditor::Message *message, QList< QSharedPointer< QAction > > actions)
 
const QSet< Kate::TextRange * > * rangesCaretIn () const
 
const QSet< Kate::TextRange * > * rangesMouseIn () const
 
void readSessionConfig (const KConfigGroup &)
 
virtual void registerCompletionModel (KTextEditor::CodeCompletionModel *model)
 
KateRenderer * renderer ()
 
void repaintText (bool paintOnlyDirty=false)
 
QString replacementPattern () const
 
KateViInputModeManager * resetViInputModeManager ()
 
bool scrollBarMarks ()
 
bool scrollBarMiniMap ()
 
bool scrollBarMiniMapAll ()
 
QString searchPattern () const
 
virtual bool selection () const
 
virtual const KTextEditor::Range & selectionRange () const
 
virtual QString selectionText () const
 
void selectLine (const KTextEditor::Cursor &cursor)
 
void selectWord (const KTextEditor::Cursor &cursor)
 
void sendCompletionAborted ()
 
void sendCompletionExecuted (const KTextEditor::Cursor &position, KTextEditor::CodeCompletionModel *model, const QModelIndex &index)
 
void setAnnotationBorderVisible (bool visible)
 
void setAnnotationModel (KTextEditor::AnnotationModel *model)
 
virtual void setAutomaticInvocationEnabled (bool enabled=true)
 
void setCaretStyle (KateRenderer::caretStyles style, bool repaint=false)
 
void setConfigValue (const QString &key, const QVariant &value)
 
void setContextMenu (QMenu *menu)
 
bool setCursorPosition (KTextEditor::Cursor position)
 
bool setCursorPositionInternal (const KTextEditor::Cursor &position, uint tabwidth=1, bool calledExternally=false)
 
bool setCursorPositionVisual (const KTextEditor::Cursor &position)
 
virtual bool setMouseTrackingEnabled (bool enable)
 
void setReplacementPattern (const QString &replacementPattern)
 
void setSearchPattern (const QString &searchPattern)
 
void slotTextInserted (KTextEditor::View *view, const KTextEditor::Cursor &position, const QString &text)
 
KateSpellingMenu * spellingMenu ()
 
virtual void startCompletion (const KTextEditor::Range &word, KTextEditor::CodeCompletionModel *model)
 
void tagAll ()
 
bool tagLine (const KTextEditor::Cursor &virtualCursor)
 
bool tagLines (int start, int end, bool realLines=false)
 
bool tagLines (KTextEditor::Cursor start, KTextEditor::Cursor end, bool realCursors=false)
 
bool tagLines (KTextEditor::Range range, bool realRange=false)
 
bool tagRange (const KTextEditor::Range &range, bool realLines=false)
 
void tagSelection (const KTextEditor::Range &oldSelection)
 
Kate::TextFolding & textFolding ()
 
KateViewBar * topViewBar () const
 
void unfoldLine (int startLine)
 
virtual void unregisterCompletionModel (KTextEditor::CodeCompletionModel *model)
 
void updateConfig ()
 
void updateDocumentConfig ()
 
void updateRangesIn (KTextEditor::Attribute::ActivationType activationType)
 
void updateRendererConfig ()
 
void updateView (bool changed=false)
 
void updateViModeBarCmd ()
 
void updateViModeBarMode ()
 
EditMode viewEditMode () const
 
QString viewMode () const
 
bool viInputMode () const
 
bool viInputModeStealKeys () const
 
KateViEmulatedCommandBar * viModeEmulatedCommandBar ()
 
bool viRelativeLineNumbers () const
 
int virtualCursorColumn () const
 
KTextEditor::Range visibleRange ()
 
bool wrapCursor () const
 
void writeSessionConfig (KConfigGroup &)
 

Static Public Member Functions

static void blockFix (KTextEditor::Range &range)
 

Public Attributes

KateCompletionWidget * m_completionWidget
 

Protected Slots

void toggleOnTheFlySpellCheck (bool b)
 

Protected Member Functions

void contextMenuEvent (QContextMenuEvent *)
 

Protected Attributes

KateSpellingMenu * m_spellingMenu
 
KToggleAction * m_toggleOnTheFlySpellCheck
 

Detailed Description

Definition at line 77 of file kateview.h.

Constructor & Destructor Documentation

KateView::KateView ( KateDocument *  doc,
QWidget *  parent 
)

Definition at line 121 of file kateview.cpp.

KateView::~KateView ( )

Definition at line 304 of file kateview.cpp.

Member Function Documentation

void KateView::abortCompletion ( )
virtual

Definition at line 2359 of file kateview.cpp.

void KateView::activateEditActions ( )

Definition at line 2323 of file kateview.cpp.

void KateView::align ( )
slot

Definition at line 2507 of file kateview.cpp.

void KateView::annotationActivated ( KTextEditor::View *  view,
int  line 
)
signal
void KateView::annotationBorderVisibilityChanged ( View *  view,
bool  visible 
)
signal
void KateView::annotationContextMenuAboutToShow ( KTextEditor::View *  view,
QMenu *  menu,
int  line 
)
signal
KTextEditor::AnnotationModel * KateView::annotationModel ( ) const

Definition at line 3068 of file kateview.cpp.

void KateView::backspace ( )
slot

Definition at line 2579 of file kateview.cpp.

void KateView::blockFix ( KTextEditor::Range &  range)
static

Definition at line 111 of file kateview.cpp.

bool KateView::blockSelection ( ) const
virtual

Definition at line 2221 of file kateview.cpp.

void KateView::bottom ( )
slot

Definition at line 2773 of file kateview.cpp.

void KateView::bottomOfView ( )
slot

Definition at line 2733 of file kateview.cpp.

KateViewBar * KateView::bottomViewBar ( ) const

Definition at line 3008 of file kateview.cpp.

void KateView::capitalize ( )
slot

Capitalizes the selection (makes each word start with an uppercase) or the word under the cursor.

Definition at line 2561 of file kateview.cpp.

void KateView::changeDictionary ( )
slot

Definition at line 1338 of file kateview.cpp.

void KateView::cleanIndent ( )
slot

Definition at line 2500 of file kateview.cpp.

void KateView::clear ( )

Definition at line 1903 of file kateview.cpp.

bool KateView::clearSelection ( )
slot

Definition at line 1991 of file kateview.cpp.

bool KateView::clearSelection ( bool  redraw,
bool  finishedChangingSelection = true 
)
slot

no selection, nothing to do...

backup old range

invalidate current selection

trigger update of correct area

emit holy signal

be done

Definition at line 1996 of file kateview.cpp.

KateCommandLineBar * KateView::cmdLineBar ( )

Definition at line 3013 of file kateview.cpp.

void KateView::comment ( )
slot

Definition at line 2519 of file kateview.cpp.

void KateView::completionAborted ( KTextEditor::View *  view)
signal
void KateView::completionExecuted ( KTextEditor::View *  view,
const KTextEditor::Cursor &  position,
KTextEditor::CodeCompletionModel *  model,
const QModelIndex &   
)
signal
KateCompletionWidget * KateView::completionWidget ( ) const

Definition at line 2346 of file kateview.cpp.

KateViewConfig* KateView::config ( )
inline

Configuration.

Definition at line 653 of file kateview.h.

void KateView::configChanged ( )
signal
QStringList KateView::configKeys ( ) const

Definition at line 2914 of file kateview.cpp.

QVariant KateView::configValue ( const QString &  key)

Definition at line 2923 of file kateview.cpp.

QMenu * KateView::contextMenu ( ) const

Definition at line 2844 of file kateview.cpp.

void KateView::contextMenuEvent ( QContextMenuEvent *  ev)
protected

Definition at line 1283 of file kateview.cpp.

KTextEditor::Cursor KateView::coordinatesToCursor ( const QPoint &  coord) const

Definition at line 2438 of file kateview.cpp.

void KateView::copy ( ) const
slot

Definition at line 2194 of file kateview.cpp.

void KateView::createSnippet ( )
slot

Definition at line 721 of file kateview.cpp.

QString KateView::currentTextLine ( )

Definition at line 2453 of file kateview.cpp.

void KateView::cursorLeft ( )
slot

Definition at line 2609 of file kateview.cpp.

KTextEditor::Cursor KateView::cursorPosition ( ) const

Definition at line 2423 of file kateview.cpp.

QPoint KateView::cursorPositionCoordinates ( ) const

Definition at line 2443 of file kateview.cpp.

KTextEditor::Cursor KateView::cursorPositionVirtual ( ) const

Definition at line 2428 of file kateview.cpp.

void KateView::cursorRight ( )
slot

Definition at line 2625 of file kateview.cpp.

bool KateView::cursorSelected ( const KTextEditor::Cursor &  cursor)

Definition at line 2083 of file kateview.cpp.

QPoint KateView::cursorToCoordinate ( const KTextEditor::Cursor &  cursor) const

Definition at line 2433 of file kateview.cpp.

void KateView::cut ( )
slot

Definition at line 2183 of file kateview.cpp.

void KateView::deactivateEditActions ( )

Definition at line 2317 of file kateview.cpp.

QMenu * KateView::defaultContextMenu ( QMenu *  menu = 0L) const

Definition at line 2874 of file kateview.cpp.

void KateView::delayedUpdateOfView ( )
signal

Delayed update for view after text ranges changed.

void KateView::deleteWordLeft ( )
slot

Definition at line 2589 of file kateview.cpp.

void KateView::deleteWordRight ( )
slot

Definition at line 2599 of file kateview.cpp.

KateDictionaryBar * KateView::dictionaryBar ( )

Definition at line 3041 of file kateview.cpp.

void KateView::disableTextHints ( )

Definition at line 1525 of file kateview.cpp.

void KateView::displayRangeChanged ( KateView *  view)
signal
KateDocument* KateView::doc ( )
inline

accessor to katedocument pointer

Returns
pointer to document

Definition at line 553 of file kateview.h.

const KateDocument* KateView::doc ( ) const
inline

Definition at line 554 of file kateview.h.

KTextEditor::Document * KateView::document ( ) const

Definition at line 2824 of file kateview.cpp.

void KateView::down ( )
slot

Definition at line 2703 of file kateview.cpp.

void KateView::dropEventPass ( QDropEvent *  )
signal
bool KateView::dynWordWrap ( ) const
inline

Definition at line 244 of file kateview.h.

int KateView::dynWrapIndicators ( )

Definition at line 1507 of file kateview.cpp.

void KateView::editEnd ( int  editTagLineStart,
int  editTagLineEnd,
bool  tagFrom 
)

Definition at line 1866 of file kateview.cpp.

void KateView::editSetCursor ( const KTextEditor::Cursor &  cursor)

Definition at line 1871 of file kateview.cpp.

void KateView::editStart ( )

Definition at line 1861 of file kateview.cpp.

void KateView::emitNavigateAccept ( )
inline

Definition at line 377 of file kateview.h.

void KateView::emitNavigateBack ( )
inline

Definition at line 380 of file kateview.h.

void KateView::emitNavigateDown ( )
inline

Definition at line 374 of file kateview.h.

void KateView::emitNavigateLeft ( )
inline

Definition at line 365 of file kateview.h.

void KateView::emitNavigateRight ( )
inline

Definition at line 368 of file kateview.h.

void KateView::emitNavigateUp ( )
inline

Definition at line 371 of file kateview.h.

void KateView::enableTextHints ( int  timeout)

Definition at line 1520 of file kateview.cpp.

void KateView::end ( )
slot

Definition at line 2683 of file kateview.cpp.

void KateView::ensureCursorColumnValid ( )

Definition at line 1845 of file kateview.cpp.

void KateView::find ( )
slot

Definition at line 1597 of file kateview.cpp.

void KateView::findNext ( )
slot

Definition at line 1627 of file kateview.cpp.

void KateView::findPrevious ( )
slot

Definition at line 1632 of file kateview.cpp.

void KateView::findSelectedBackwards ( )
slot

Definition at line 1612 of file kateview.cpp.

void KateView::findSelectedForwards ( )
slot

Definition at line 1607 of file kateview.cpp.

bool KateView::foldingMarkersOn ( )

Definition at line 1511 of file kateview.cpp.

void KateView::foldLine ( int  startLine)

Try to fold starting at the given line.

This will both try to fold existing folding ranges of this line and to query the highlighting what to fold.

Parameters
startLinestart line to fold at

Definition at line 1110 of file kateview.cpp.

void KateView::forceCompletion ( )
virtual

Definition at line 2364 of file kateview.cpp.

ViMode KateView::getCurrentViMode ( ) const
Returns
the current vi mode

Definition at line 1582 of file kateview.cpp.

int KateView::getEol ( ) const

Definition at line 1385 of file kateview.cpp.

KateViInputModeManager * KateView::getViInputModeManager ( )
Returns
a pointer to the KateViInputModeManager belonging to the view

Definition at line 1587 of file kateview.cpp.

void KateView::gotoLine ( )
slot

Definition at line 1332 of file kateview.cpp.

void KateView::home ( )
slot

Definition at line 2673 of file kateview.cpp.

bool KateView::iconBorder ( )

Definition at line 1491 of file kateview.cpp.

void KateView::indent ( )
slot

Definition at line 2486 of file kateview.cpp.

void KateView::insertTab ( )
slot

Definition at line 2584 of file kateview.cpp.

bool KateView::insertTemplateTextImplementation ( const KTextEditor::Cursor &  c,
const QString &  templateString,
const QMap< QString, QString > &  initialValues 
)
virtual

Definition at line 2275 of file kateview.cpp.

bool KateView::insertTemplateTextImplementation ( const KTextEditor::Cursor &  c,
const QString &  templateString,
const QMap< QString, QString > &  initialValues,
KTextEditor::TemplateScript *  templateScript 
)
virtual

no empty templates

not for read-only docs

get script

the handler will delete itself when necessary

Definition at line 2282 of file kateview.cpp.

bool KateView::isAnnotationBorderVisible ( ) const

Definition at line 3078 of file kateview.cpp.

bool KateView::isAutomaticInvocationEnabled ( ) const
virtual

Definition at line 2379 of file kateview.cpp.

bool KateView::isCompletionActive ( ) const
virtual

Definition at line 2341 of file kateview.cpp.

bool KateView::isOverwriteMode ( ) const

Return values for "save" related commands.

Definition at line 1214 of file kateview.cpp.

void KateView::joinLines ( )
slot

Joins lines touched by the selection.

Definition at line 1344 of file kateview.cpp.

void KateView::keyDelete ( )
slot

Definition at line 2594 of file kateview.cpp.

void KateView::keyReturn ( )
slot

Definition at line 2569 of file kateview.cpp.

void KateView::killLine ( )
slot

Definition at line 2543 of file kateview.cpp.

bool KateView::lineEndSelected ( const KTextEditor::Cursor &  lineEndPos)

Definition at line 2101 of file kateview.cpp.

bool KateView::lineHasSelected ( int  line)

Definition at line 2108 of file kateview.cpp.

bool KateView::lineIsSelection ( int  line)

Definition at line 2113 of file kateview.cpp.

bool KateView::lineNumbersOn ( )

Definition at line 1495 of file kateview.cpp.

bool KateView::lineSelected ( int  line)

Definition at line 2096 of file kateview.cpp.

void KateView::lowercase ( )
slot

Lowercases selected text, or an alphabetic character next to the cursor.

Definition at line 2556 of file kateview.cpp.

KateMessageWidget* KateView::messageWidget ( )
inline

Definition at line 885 of file kateview.h.

bool KateView::mouseTrackingEnabled ( ) const
virtual

Definition at line 2329 of file kateview.cpp.

void KateView::navigateAccept ( )
signal
void KateView::navigateBack ( )
signal
void KateView::navigateDown ( )
signal
void KateView::navigateLeft ( )
signal
void KateView::navigateRight ( )
signal
void KateView::navigateUp ( )
signal
void KateView::needTextHint ( const KTextEditor::Cursor &  position,
QString &  text 
)
signal
void KateView::notifyAboutRangeChange ( int  startLine,
int  endLine,
bool  rangeWithAttribute 
)

Attribute of a range changed or range with attribute changed in given line range.

Parameters
startLinestart line of change
endLineend line of change
rangeWithAttributeattribute changed or is active, this will perhaps lead to repaints

Definition at line 3107 of file kateview.cpp.

void KateView::pageDown ( )
slot

Definition at line 2753 of file kateview.cpp.

void KateView::pageUp ( )
slot

Definition at line 2743 of file kateview.cpp.

void KateView::paste ( const QString *  textToPaste = 0)
slot

Definition at line 2399 of file kateview.cpp.

void KateView::postMessage ( KTextEditor::Message *  message,
QList< QSharedPointer< QAction > >  actions 
)

Used by Document::postMessage().

Definition at line 3254 of file kateview.cpp.

const QSet<Kate::TextRange *>* KateView::rangesCaretIn ( ) const
inline

set of ranges which had the caret inside last time, used for rendering

Returns
set of ranges which had the caret inside last time checked

Definition at line 825 of file kateview.h.

const QSet<Kate::TextRange *>* KateView::rangesMouseIn ( ) const
inline

set of ranges which had the mouse inside last time, used for rendering

Returns
set of ranges which had the mouse inside last time checked

Definition at line 819 of file kateview.h.

void KateView::readSessionConfig ( const KConfigGroup &  config)

Definition at line 1357 of file kateview.cpp.

void KateView::reflectOnTheFlySpellCheckStatus ( bool  enabled)
slot

Definition at line 3096 of file kateview.cpp.

void KateView::registerCompletionModel ( KTextEditor::CodeCompletionModel *  model)
virtual

Definition at line 2369 of file kateview.cpp.

void KateView::reloadFile ( )
slot

Definition at line 1219 of file kateview.cpp.

bool KateView::removeSelectedText ( )
slot

Definition at line 2046 of file kateview.cpp.

virtual bool KateView::removeSelection ( )
inlinevirtualslot

Definition at line 256 of file kateview.h.

virtual bool KateView::removeSelectionText ( )
inlinevirtualslot

Definition at line 258 of file kateview.h.

KateRenderer * KateView::renderer ( )

Definition at line 1664 of file kateview.cpp.

void KateView::repaintText ( bool  paintOnlyDirty = false)

Definition at line 1908 of file kateview.cpp.

void KateView::replace ( )
slot

Definition at line 1617 of file kateview.cpp.

QString KateView::replacementPattern ( ) const

The current replacement string.

This is set by the last search and replace.

Returns
the replacment string or the empty string if not set

Definition at line 2467 of file kateview.cpp.

KateViInputModeManager * KateView::resetViInputModeManager ( )

Replace ViInputModeManager by new one.

Returns
a pointer to the new KateViInputModeManager.

Definition at line 1592 of file kateview.cpp.

bool KateView::scrollBarMarks ( )

Definition at line 1499 of file kateview.cpp.

bool KateView::scrollBarMiniMap ( )

Definition at line 1503 of file kateview.cpp.

bool KateView::scrollBarMiniMapAll ( )
void KateView::scrollDown ( )
slot

Definition at line 2718 of file kateview.cpp.

void KateView::scrollUp ( )
slot

Definition at line 2713 of file kateview.cpp.

QString KateView::searchPattern ( ) const

The current search pattern.

This is set by the last search.

Returns
the search pattern or the empty string if not set

Definition at line 2458 of file kateview.cpp.

bool KateView::selectAll ( )
slot

Definition at line 2075 of file kateview.cpp.

bool KateView::selection ( ) const
virtual

Definition at line 2033 of file kateview.cpp.

const KTextEditor::Range & KateView::selectionRange ( ) const
virtual

Definition at line 2815 of file kateview.cpp.

QString KateView::selectionText ( ) const
virtual

Definition at line 2041 of file kateview.cpp.

void KateView::selectLine ( const KTextEditor::Cursor &  cursor)

Definition at line 2174 of file kateview.cpp.

void KateView::selectWord ( const KTextEditor::Cursor &  cursor)

Definition at line 2154 of file kateview.cpp.

void KateView::sendCompletionAborted ( )

Definition at line 2394 of file kateview.cpp.

void KateView::sendCompletionExecuted ( const KTextEditor::Cursor &  position,
KTextEditor::CodeCompletionModel *  model,
const QModelIndex &  index 
)

Definition at line 2389 of file kateview.cpp.

void KateView::setAddBom ( bool  enabled)
slot

Definition at line 1404 of file kateview.cpp.

void KateView::setAnnotationBorderVisible ( bool  visible)

Definition at line 3073 of file kateview.cpp.

void KateView::setAnnotationModel ( KTextEditor::AnnotationModel *  model)

Definition at line 3061 of file kateview.cpp.

void KateView::setAutomaticInvocationEnabled ( bool  enabled = true)
virtual

Definition at line 2384 of file kateview.cpp.

bool KateView::setBlockSelection ( bool  on)
virtualslot

Definition at line 2226 of file kateview.cpp.

void KateView::setCaretStyle ( KateRenderer::caretStyles  style,
bool  repaint = false 
)

Set the caret's style.

The caret can be a box or a line; see the documentation of KateRenderer::caretStyles for other options.

Parameters
stylethe caret style
repaintwhether to update the caret instantly. This also resets the caret's timer.

Definition at line 2413 of file kateview.cpp.

void KateView::setConfigValue ( const QString &  key,
const QVariant &  value 
)

Definition at line 2958 of file kateview.cpp.

void KateView::setContextMenu ( QMenu *  menu)

Definition at line 2829 of file kateview.cpp.

bool KateView::setCursorPosition ( KTextEditor::Cursor  position)

Definition at line 2418 of file kateview.cpp.

bool KateView::setCursorPositionInternal ( const KTextEditor::Cursor &  position,
uint  tabwidth = 1,
bool  calledExternally = false 
)

Definition at line 1293 of file kateview.cpp.

bool KateView::setCursorPositionVisual ( const KTextEditor::Cursor &  position)

Definition at line 2448 of file kateview.cpp.

void KateView::setDynWrapIndicators ( int  mode)
slot

Definition at line 1209 of file kateview.cpp.

void KateView::setEol ( int  eol)
slot

Definition at line 1390 of file kateview.cpp.

void KateView::setFoldingMarkersOn ( bool  enable)
slot

Definition at line 1481 of file kateview.cpp.

void KateView::setIconBorder ( bool  enable)
slot

Definition at line 1416 of file kateview.cpp.

void KateView::setLineNumbersOn ( bool  enable)
slot

Definition at line 1426 of file kateview.cpp.

bool KateView::setMouseTrackingEnabled ( bool  enable)
virtual

Definition at line 2335 of file kateview.cpp.

void KateView::setReplacementPattern ( const QString &  replacementPattern)

Set the current replacement pattern.

Parameters
replacementPatternthe replacement pattern

Definition at line 2481 of file kateview.cpp.

void KateView::setScrollBarMarks ( bool  enable)
slot

Definition at line 1436 of file kateview.cpp.

void KateView::setScrollBarMiniMap ( bool  enable)
slot

Definition at line 1446 of file kateview.cpp.

void KateView::setScrollBarMiniMapAll ( bool  enable)
slot

Definition at line 1456 of file kateview.cpp.

void KateView::setScrollBarMiniMapWidth ( int  width)
slot

Definition at line 1466 of file kateview.cpp.

void KateView::setSearchPattern ( const QString &  searchPattern)

Set the current search pattern.

Parameters
searchPatternthe search pattern

Definition at line 2476 of file kateview.cpp.

bool KateView::setSelection ( const KTextEditor::Range &  selection)
virtualslot

anything to do?

backup old range

set new range

trigger update of correct area

emit holy signal

be done

Definition at line 1956 of file kateview.cpp.

bool KateView::setSelection ( const KTextEditor::Cursor &  c,
int  i,
bool  b 
)
inlineslot

Definition at line 253 of file kateview.h.

void KateView::shiftBottom ( )
slot

Definition at line 2778 of file kateview.cpp.

void KateView::shiftBottomOfView ( )
slot

Definition at line 2738 of file kateview.cpp.

void KateView::shiftCursorLeft ( )
slot

Definition at line 2617 of file kateview.cpp.

void KateView::shiftCursorRight ( )
slot

Definition at line 2633 of file kateview.cpp.

void KateView::shiftDown ( )
slot

Definition at line 2708 of file kateview.cpp.

void KateView::shiftEnd ( )
slot

Definition at line 2688 of file kateview.cpp.

void KateView::shiftHome ( )
slot

Definition at line 2678 of file kateview.cpp.

void KateView::shiftPageDown ( )
slot

Definition at line 2758 of file kateview.cpp.

void KateView::shiftPageUp ( )
slot

Definition at line 2748 of file kateview.cpp.

void KateView::shiftToMatchingBracket ( )
slot

Definition at line 2788 of file kateview.cpp.

void KateView::shiftTop ( )
slot

Definition at line 2768 of file kateview.cpp.

void KateView::shiftTopOfView ( )
slot

Definition at line 2728 of file kateview.cpp.

void KateView::shiftUp ( )
slot

Definition at line 2698 of file kateview.cpp.

void KateView::shiftWordLeft ( )
slot

Definition at line 2649 of file kateview.cpp.

void KateView::shiftWordRight ( )
slot

Definition at line 2665 of file kateview.cpp.

void KateView::showSnippetsDialog ( )
slot

Definition at line 726 of file kateview.cpp.

void KateView::showViModeEmulatedCommandBar ( )
slot

Definition at line 1560 of file kateview.cpp.

void KateView::slotClipboardHistoryChanged ( )
slot

Definition at line 1259 of file kateview.cpp.

void KateView::slotCollapseLevel ( )
slot

Definition at line 1082 of file kateview.cpp.

void KateView::slotCollapseLocal ( )
slot

Definition at line 1072 of file kateview.cpp.

void KateView::slotExpandLevel ( )
slot

Definition at line 1096 of file kateview.cpp.

void KateView::slotExpandLocal ( )
slot

Definition at line 1077 of file kateview.cpp.

void KateView::slotFoldToplevelNodes ( )
slot

Definition at line 1062 of file kateview.cpp.

void KateView::slotReadWriteChanged ( )
slot

Definition at line 1225 of file kateview.cpp.

void KateView::slotTextInserted ( KTextEditor::View *  view,
const KTextEditor::Cursor &  position,
const QString &  text 
)

Definition at line 2270 of file kateview.cpp.

void KateView::slotUpdateUndo ( )
slot

Definition at line 1264 of file kateview.cpp.

void KateView::smartNewline ( )
slot

Definition at line 2574 of file kateview.cpp.

KateSpellingMenu * KateView::spellingMenu ( )

Definition at line 3102 of file kateview.cpp.

void KateView::startCompletion ( const KTextEditor::Range &  word,
KTextEditor::CodeCompletionModel *  model 
)
virtual

Definition at line 2354 of file kateview.cpp.

void KateView::switchToCmdLine ( )
slot

Definition at line 1652 of file kateview.cpp.

void KateView::tagAll ( )

Definition at line 1898 of file kateview.cpp.

bool KateView::tagLine ( const KTextEditor::Cursor &  virtualCursor)

Definition at line 1878 of file kateview.cpp.

bool KateView::tagLines ( int  start,
int  end,
bool  realLines = false 
)

Definition at line 1888 of file kateview.cpp.

bool KateView::tagLines ( KTextEditor::Cursor  start,
KTextEditor::Cursor  end,
bool  realCursors = false 
)

Definition at line 1893 of file kateview.cpp.

bool KateView::tagLines ( KTextEditor::Range  range,
bool  realRange = false 
)

Definition at line 2312 of file kateview.cpp.

bool KateView::tagRange ( const KTextEditor::Range &  range,
bool  realLines = false 
)

Definition at line 1883 of file kateview.cpp.

void KateView::tagSelection ( const KTextEditor::Range &  oldSelection)

Definition at line 2118 of file kateview.cpp.

Kate::TextFolding& KateView::textFolding ( )
inline

Folding handler for this view.

Returns
folding handler

Definition at line 574 of file kateview.h.

bool KateView::toggleBlockSelection ( )
slot

Definition at line 2256 of file kateview.cpp.

void KateView::toggleComment ( )
slot

Definition at line 2531 of file kateview.cpp.

void KateView::toggleDynWordWrap ( )
slot

Definition at line 1471 of file kateview.cpp.

void KateView::toggleFoldingMarkers ( )
slot

Definition at line 1486 of file kateview.cpp.

void KateView::toggleIconBorder ( )
slot

Definition at line 1421 of file kateview.cpp.

void KateView::toggleInsert ( )
slot

Definition at line 1317 of file kateview.cpp.

void KateView::toggleLineNumbersOn ( )
slot

Definition at line 1431 of file kateview.cpp.

void KateView::toggleOnTheFlySpellCheck ( bool  b)
protectedslot

Definition at line 3091 of file kateview.cpp.

void KateView::toggleScrollBarMarks ( )
slot

Definition at line 1441 of file kateview.cpp.

void KateView::toggleScrollBarMiniMap ( )
slot

Definition at line 1451 of file kateview.cpp.

void KateView::toggleScrollBarMiniMapAll ( )
slot

Definition at line 1461 of file kateview.cpp.

void KateView::toggleViInputMode ( )
slot

Definition at line 1545 of file kateview.cpp.

void KateView::toggleWriteLock ( )
slot

Definition at line 1515 of file kateview.cpp.

void KateView::toggleWWMarker ( )
slot

Definition at line 1476 of file kateview.cpp.

void KateView::toMatchingBracket ( )
slot

Definition at line 2783 of file kateview.cpp.

void KateView::toNextModifiedLine ( )
slot

Definition at line 2804 of file kateview.cpp.

void KateView::top ( )
slot

Definition at line 2763 of file kateview.cpp.

void KateView::topOfView ( )
slot

Definition at line 2723 of file kateview.cpp.

void KateView::toPrevModifiedLine ( )
slot

Definition at line 2793 of file kateview.cpp.

KateViewBar * KateView::topViewBar ( ) const

Accessors to the bars...

Definition at line 3003 of file kateview.cpp.

void KateView::transpose ( )
slot

Definition at line 2604 of file kateview.cpp.

void KateView::uncomment ( )
slot

Definition at line 2526 of file kateview.cpp.

void KateView::unfoldLine ( int  startLine)

Try to unfold all foldings starting at the given line.

Parameters
startLinestart line to unfold at

Definition at line 1125 of file kateview.cpp.

void KateView::unIndent ( )
slot

Definition at line 2493 of file kateview.cpp.

void KateView::unregisterCompletionModel ( KTextEditor::CodeCompletionModel *  model)
virtual

Definition at line 2374 of file kateview.cpp.

void KateView::up ( )
slot

Definition at line 2693 of file kateview.cpp.

void KateView::updateConfig ( )

Definition at line 1669 of file kateview.cpp.

void KateView::updateDocumentConfig ( )

Definition at line 1769 of file kateview.cpp.

void KateView::updateRangesIn ( KTextEditor::Attribute::ActivationType  activationType)

check if ranges changed for mouse in and caret in

Parameters
activationTypetype of activation to check

Definition at line 3169 of file kateview.cpp.

void KateView::updateRendererConfig ( )

Definition at line 1795 of file kateview.cpp.

void KateView::updateView ( bool  changed = false)

Definition at line 1916 of file kateview.cpp.

void KateView::updateViModeBarCmd ( )

Update vi mode statusbar with the (partial) vi command being typed.

Definition at line 1575 of file kateview.cpp.

void KateView::updateViModeBarMode ( )

Update vi mode statusbar according to the current mode.

Definition at line 1568 of file kateview.cpp.

void KateView::uppercase ( )
slot

Uppercases selected text, or an alphabetic character next to the cursor.

Definition at line 2538 of file kateview.cpp.

void KateView::userInvokedCompletion ( )
slot

Definition at line 2998 of file kateview.cpp.

KTextEditor::View::EditMode KateView::viewEditMode ( ) const

Definition at line 1137 of file kateview.cpp.

QString KateView::viewMode ( ) const

normal two modes

if we are in vi mode, this will be overwritten by current vi mode

perhaps append the current keys of a command not finalized

make it bold

append read-only if needed

return full mode

Definition at line 1145 of file kateview.cpp.

bool KateView::viInputMode ( ) const
Returns
boolean indicating whether vi mode is active or not

Definition at line 1530 of file kateview.cpp.

bool KateView::viInputModeStealKeys ( ) const
Returns
boolean indicating whether vi mode will override actions or not

Definition at line 1535 of file kateview.cpp.

KateViEmulatedCommandBar * KateView::viModeEmulatedCommandBar ( )

Definition at line 3051 of file kateview.cpp.

bool KateView::viRelativeLineNumbers ( ) const
Returns
boolean indicating whether relative line numbers should be used or not.

Definition at line 1540 of file kateview.cpp.

int KateView::virtualCursorColumn ( ) const

Return the virtual cursor column, each tab is expanded into the document's tabWidth characters.

If word wrap is off, the cursor may be behind the line's length.

Definition at line 1944 of file kateview.cpp.

KTextEditor::Range KateView::visibleRange ( )

Definition at line 3083 of file kateview.cpp.

void KateView::wordLeft ( )
slot

Definition at line 2641 of file kateview.cpp.

void KateView::wordRight ( )
slot

Definition at line 2657 of file kateview.cpp.

bool KateView::wrapCursor ( ) const

Definition at line 2262 of file kateview.cpp.

void KateView::writeSessionConfig ( KConfigGroup &  config)

Definition at line 1370 of file kateview.cpp.

Member Data Documentation

KateCompletionWidget* KateView::m_completionWidget
mutable

Definition at line 229 of file kateview.h.

KateSpellingMenu* KateView::m_spellingMenu
protected

Definition at line 762 of file kateview.h.

KToggleAction* KateView::m_toggleOnTheFlySpellCheck
protected

Definition at line 761 of file kateview.h.


The documentation for this class was generated from the following files:
  • kateview.h
  • kateview.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sat May 9 2020 03:57:02 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Kate

Skip menu "Kate"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

applications API Reference

Skip menu "applications API Reference"
  •   kate
  •       kate
  •   KTextEditor
  •   Kate
  • Konsole

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal