KateView Class Reference

Inheritance diagram for KateView:

Kate::View List of all members.

Detailed Description

Definition at line 57 of file kateview.h.


Public Slots

void paste ()
void cut ()
void copy () const
void copyHTML ()
void exportAsHTML ()
QPoint cursorCoordinates ()
void cursorPosition (uint *l, uint *c)
void cursorPositionReal (uint *l, uint *c)
bool setCursorPosition (uint line, uint col)
bool setCursorPositionReal (uint line, uint col)
uint cursorLine ()
uint cursorColumn ()
uint cursorColumnReal ()
void showArgHint (QStringList arg1, const QString &arg2, const QString &arg3)
void showCompletionBox (QValueList< KTextEditor::CompletionEntry > arg1, int offset=0, bool cs=true)
bool setSelection (const KateTextCursor &start, const KateTextCursor &end)
bool setSelection (uint startLine, uint startCol, uint endLine, uint endCol)
bool clearSelection ()
bool clearSelection (bool redraw, bool finishedChangingSelection=true)
bool hasSelection () const
QString selection () const
bool removeSelectedText ()
bool selectAll ()
int selStartLine ()
int selStartCol ()
int selEndLine ()
int selEndCol ()
bool blockSelectionMode ()
bool setBlockSelectionMode (bool on)
bool toggleBlockSelectionMode ()
void flush ()
saveResult save ()
saveResult saveAs ()
void indent ()
void unIndent ()
void cleanIndent ()
void align ()
void comment ()
void uncomment ()
void killLine ()
void uppercase ()
void lowercase ()
void capitalize ()
void joinLines ()
void keyReturn ()
void backspace ()
void deleteWordLeft ()
void keyDelete ()
void deleteWordRight ()
void transpose ()
void cursorLeft ()
void shiftCursorLeft ()
void cursorRight ()
void shiftCursorRight ()
void wordLeft ()
void shiftWordLeft ()
void wordRight ()
void shiftWordRight ()
void home ()
void shiftHome ()
void end ()
void shiftEnd ()
void up ()
void shiftUp ()
void down ()
void shiftDown ()
void scrollUp ()
void scrollDown ()
void topOfView ()
void shiftTopOfView ()
void bottomOfView ()
void shiftBottomOfView ()
void pageUp ()
void shiftPageUp ()
void pageDown ()
void shiftPageDown ()
void top ()
void shiftTop ()
void bottom ()
void shiftBottom ()
void toMatchingBracket ()
void shiftToMatchingBracket ()
void gotoLine ()
void gotoLineNumber (int linenumber)
int getEol ()
void setEol (int eol)
void find ()
void find (const QString &, long, bool add=true)
void replace ()
void replace (const QString &, const QString &, long)
void findAgain (bool back)
void findAgain ()
void findPrev ()
void setFoldingMarkersOn (bool enable)
void setIconBorder (bool enable)
void setLineNumbersOn (bool enable)
void setScrollBarMarks (bool enable)
void showCmdLine (bool enable)
void toggleFoldingMarkers ()
void toggleIconBorder ()
void toggleLineNumbersOn ()
void toggleScrollBarMarks ()
void toggleDynWordWrap ()
void toggleCmdLine ()
void setDynWrapIndicators (int mode)
void applyWordWrap ()
void gotoMark (KTextEditor::Mark *mark)
void slotSelectionChanged ()
void slotNewUndo ()
void slotUpdate ()
void toggleInsert ()
void reloadFile ()
void toggleWWMarker ()
void toggleWriteLock ()
void switchToCmdLine ()
void slotReadWriteChanged ()
void slotSelectionTypeChanged ()

Signals

void cursorPositionChanged ()
void completionAborted ()
void completionDone ()
void argHintHidden ()
void completionDone (KTextEditor::CompletionEntry)
void filterInsertString (KTextEditor::CompletionEntry *, QString *)
void aboutToShowCompletionBox ()
void needTextHint (int line, int col, QString &text)
void selectionChanged ()
void gotFocus (Kate::View *)
void lostFocus (Kate::View *)
void newStatus ()
void dropEventPass (QDropEvent *)
void viewStatusMsg (const QString &msg)

Public Member Functions

 KateView (KateDocument *doc, QWidget *parent=0L, const char *name=0)
 ~KateView ()
KTextEditor::Document * document () const
void installPopup (QPopupMenu *menu)
QPopupMenupopup () const
void enableTextHints (int timeout)
void disableTextHints ()
void setDynWordWrap (bool b)
bool dynWordWrap () const
const KateSuperCursorselStart () const
const KateSuperCursorselEnd () const
bool wrapCursor ()
bool lineColSelected (int line, int col)
bool lineSelected (int line)
bool lineEndSelected (int line, int endCol)
bool lineHasSelected (int line)
bool lineIsSelection (int line)
void tagSelection (const KateTextCursor &oldSelectStart, const KateTextCursor &oldSelectEnd)
void selectWord (const KateTextCursor &cursor)
void selectLine (const KateTextCursor &cursor)
void selectLength (const KateTextCursor &cursor, int length)
void syncSelectionCache ()
void editStart ()
void editEnd (int editTagLineStart, int editTagLineEnd, bool tagFrom)
void editSetCursor (const KateTextCursor &cursor)
bool tagLine (const KateTextCursor &virtualCursor)
bool tagLines (int start, int end, bool realLines=false)
bool tagLines (KateTextCursor start, KateTextCursor end, bool realCursors=false)
void tagAll ()
void clear ()
void repaintText (bool paintOnlyDirty=false)
void updateView (bool changed=false)
bool isOverwriteMode () const
void setOverwriteMode (bool b)
QString currentTextLine ()
QString currentWord ()
void insertText (const QString &text)
bool canDiscard ()
int tabWidth ()
void setTabWidth (int w)
void setEncoding (QString e)
bool isLastView ()
void readSessionConfig (KConfig *)
void writeSessionConfig (KConfig *)
KateRendererrenderer ()
bool iconBorder ()
bool lineNumbersOn ()
bool scrollBarMarks ()
int dynWrapIndicators ()
bool foldingMarkersOn ()
Kate::DocumentgetDoc ()
void setActive (bool b)
bool isActive ()
KateDocumentdoc () const
KActionCollectioneditActionCollection () const
bool setCursorPositionInternal (uint line, uint col, uint tabwidth=1, bool calledExternally=false)
KateViewConfigconfig ()
void updateConfig ()
void updateDocumentConfig ()
void updateRendererConfig ()
void setIMSelectionValue (uint imStartLine, uint imStart, uint imEnd, uint imSelStart, uint imSelEnd, bool m_imComposeEvent)
void getIMSelectionValue (uint *imStartLine, uint *imStart, uint *imEnd, uint *imSelStart, uint *imSelEnd)
bool isIMSelection (int _line, int _column)
bool isIMEdit (int _line, int _column)
bool imComposeEvent () const

Protected Member Functions

void contextMenuEvent (QContextMenuEvent *)
bool checkOverwrite (KURL)

Friends

class KateViewInternal
class KateIconBorder
class KateCodeCompletion

Member Function Documentation

bool KateView::canDiscard (  )  [virtual]

Works exactly like closeURL() of KParts::ReadWritePart.

Reimplemented from Kate::View.

Definition at line 835 of file kateview.cpp.

void KateView::capitalize (  )  [inline, slot]

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

Definition at line 322 of file kateview.h.

void KateView::cleanIndent (  )  [inline, virtual, slot]

Optimizes the selected indentation, replacing tabs and spaces as needed.

Reimplemented from Kate::View.

Definition at line 304 of file kateview.h.

void KateView::comment (  )  [inline, virtual, slot]

Comments out current line.

Reimplemented from Kate::View.

Definition at line 306 of file kateview.h.

KateViewConfig* KateView::config (  )  [inline]

Configuration.

Definition at line 525 of file kateview.h.

void KateView::copyHTML (  )  [slot]

internal use, copy text as HTML to clipboard

Definition at line 1606 of file kateview.cpp.

QString KateView::currentTextLine (  )  [inline, virtual]

Gets the text line where the cursor is on.

Reimplemented from Kate::View.

Definition at line 285 of file kateview.h.

QString KateView::currentWord (  )  [inline, virtual]

Gets the word where the cursor is on.

Reimplemented from Kate::View.

Definition at line 287 of file kateview.h.

void KateView::cursorLeft (  )  [inline, virtual, slot]

Move cursor in the view.

Reimplemented from Kate::View.

Definition at line 335 of file kateview.h.

void KateView::find ( const QString ,
long  ,
bool  add = true 
) [slot]

proxy for KateSearch

Definition at line 1094 of file kateview.cpp.

void KateView::find (  )  [virtual, slot]

Presents a search dialog to the user.

Reimplemented from Kate::View.

Definition at line 1089 of file kateview.cpp.

void KateView::findAgain (  )  [inline, virtual, slot]

Searches for the last searched text forward from cursor position.

Searches forward from current cursor position.

Reimplemented from Kate::View.

Definition at line 384 of file kateview.h.

void KateView::findAgain ( bool  back  )  [virtual, slot]

Searches for the last searched text forward from cursor position.

Parameters:
forward determines the search direction.

Reimplemented from Kate::View.

Definition at line 1109 of file kateview.cpp.

void KateView::findPrev (  )  [inline, virtual, slot]

Searches for the last searched text forward from cursor position.

Searches backward from current cursor position.

Reimplemented from Kate::View.

Definition at line 385 of file kateview.h.

void KateView::flush (  )  [virtual, slot]

Flushes the document of the text widget.

The user is given a chance to save the current document if the current document has been modified.

Reimplemented from Kate::View.

Definition at line 840 of file kateview.cpp.

Kate::Document* KateView::getDoc (  )  [inline, virtual]

Returns a pointer to the document of the view.

Reimplemented from Kate::View.

Definition at line 410 of file kateview.h.

int KateView::getEol (  )  [virtual, slot]

Get the end of line mode (Unix, Macintosh or Dos).

Reimplemented from Kate::View.

Definition at line 941 of file kateview.cpp.

void KateView::gotoLine (  )  [virtual, slot]

Presents a "Goto Line" dialog to the user.

Reimplemented from Kate::View.

Definition at line 899 of file kateview.cpp.

bool KateView::iconBorder (  )  [virtual]

Returns whether iconborder is visible.

Reimplemented from Kate::View.

Definition at line 1012 of file kateview.cpp.

void KateView::indent (  )  [inline, virtual, slot]

Moves the current line or the selection one position to the right.

Reimplemented from Kate::View.

Definition at line 302 of file kateview.h.

void KateView::insertText ( const QString text  )  [inline, virtual]

Insert text at the current cursor position.

Parameters:
mark is unused.

Reimplemented from Kate::View.

Definition at line 289 of file kateview.h.

bool KateView::isLastView (  )  [inline, virtual]

Returns true if this editor is the only owner of its document.

Implements Kate::View.

Definition at line 295 of file kateview.h.

bool KateView::isOverwriteMode (  )  const [virtual]

Set editor mode.

Reimplemented from Kate::View.

Definition at line 725 of file kateview.cpp.

void KateView::joinLines (  )  [slot]

Joins lines touched by the selection.

Definition at line 917 of file kateview.cpp.

void KateView::keyReturn (  )  [inline, virtual, slot]

Some simply key commands.

Reimplemented from Kate::View.

Definition at line 329 of file kateview.h.

bool KateView::lineNumbersOn (  )  [virtual]

Returns:
Wheather line numbers display is on

Reimplemented from Kate::View.

Definition at line 1016 of file kateview.cpp.

void KateView::lowercase (  )  [inline, slot]

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

Definition at line 317 of file kateview.h.

void KateView::readSessionConfig ( KConfig config  )  [virtual]

Reads session config out of the KConfig object.

This also includes the actual cursor position and the bookmarks.

Reimplemented from Kate::View.

Definition at line 930 of file kateview.cpp.

void KateView::replace ( const QString ,
const QString ,
long   
) [slot]

proxy for KateSearch

Definition at line 1104 of file kateview.cpp.

void KateView::replace (  )  [virtual, slot]

Presents a replace dialog to the user.

Reimplemented from Kate::View.

Definition at line 1099 of file kateview.cpp.

KateView::saveResult KateView::save (  )  [virtual, slot]

Saves the file under the current file name.

If the current file name is Untitled, as it is after a call to newFile(), this routine will call saveAs().

Reimplemented from Kate::View.

Definition at line 845 of file kateview.cpp.

KateView::saveResult KateView::saveAs (  )  [virtual, slot]

Allows the user to save the file under a new name.

Reimplemented from Kate::View.

Definition at line 856 of file kateview.cpp.

const KateSuperCursor& KateView::selEnd (  )  const [inline]

accessors to the selection end

Returns:
selection end cursor (read-only)

Definition at line 223 of file kateview.h.

const KateSuperCursor& KateView::selStart (  )  const [inline]

accessors to the selection start

Returns:
selection start cursor (read-only)

Definition at line 217 of file kateview.h.

void KateView::setEol ( int  eol  )  [virtual, slot]

Set the end of line mode (Unix, Macintosh or Dos).

Reimplemented from Kate::View.

Definition at line 946 of file kateview.cpp.

void KateView::setIconBorder ( bool  enable  )  [virtual, slot]

Sets icon border on or off depending on.

Parameters:
enable the flag

Reimplemented from Kate::View.

Definition at line 957 of file kateview.cpp.

void KateView::setIMSelectionValue ( uint  imStartLine,
uint  imStart,
uint  imEnd,
uint  imSelStart,
uint  imSelEnd,
bool  m_imComposeEvent 
)

IM input stuff.

Definition at line 1873 of file kateview.cpp.

void KateView::setLineNumbersOn ( bool  enable  )  [virtual, slot]

Sets display of line numbers on/off depending on enable.

Parameters:
enable the flag

Reimplemented from Kate::View.

Definition at line 967 of file kateview.cpp.

void KateView::setOverwriteMode ( bool  b  )  [virtual]

Get editor mode.

Reimplemented from Kate::View.

Definition at line 817 of file kateview.cpp.

void KateView::toggleIconBorder (  )  [virtual, slot]

Toggles icon border.

Reimplemented from Kate::View.

Definition at line 962 of file kateview.cpp.

void KateView::toggleLineNumbersOn (  )  [virtual, slot]

Toggles display of lineNumbers.

Reimplemented from Kate::View.

Definition at line 972 of file kateview.cpp.

void KateView::uncomment (  )  [inline, virtual, slot]

Removes comment signs in the current line.

Reimplemented from Kate::View.

Definition at line 307 of file kateview.h.

void KateView::unIndent (  )  [inline, virtual, slot]

Moves the current line or the selection one position to the left.

Reimplemented from Kate::View.

Definition at line 303 of file kateview.h.

void KateView::uppercase (  )  [inline, slot]

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

Definition at line 313 of file kateview.h.

void KateView::writeSessionConfig ( KConfig config  )  [virtual]

Writes session config into the KConfig object.

Reimplemented from Kate::View.

Definition at line 935 of file kateview.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys