interfaces Library API Documentation

KTextEditor Namespace Reference

KTextEditor is KDE's standard text editing KPart interface. More...


Classes

class  KTextEditor::BlockSelectionDCOPInterface
 This is the main interface to the BlockSelectionInterface of KTextEditor. DCOP interface to BlockSelectionInterface. More...
class  KTextEditor::BlockSelectionInterface
 An interface for the Document class which allows the selection method to be changed between selecting rectangular blocks of text and normal mode (all text between the start cursor and the current cursor). More...
class  KTextEditor::ClipboardDCOPInterface
 This is the main interface to the ClipboardInterface of KTextEdit. DCOP interface to ClipboardInterface. More...
class  KTextEditor::ClipboardInterface
 This is an interface for accessing the clipboard through the View class. More...
class  KTextEditor::CompletionEntry
 An item for the completion popup. More...
class  KTextEditor::CodeCompletionInterface
 This is an interface for the KTextEditor::View class. More...
class  KTextEditor::ConfigInterface
 This is an interface for accessing the configuration of the Document and Plugin classes. More...
class  KTextEditor::ConfigInterfaceExtension
 This is an interface to extend the configuration of the Document, Plugin and PluginViewInterface classes. More...
class  KTextEditor::Cursor
 This class represents a text cursor. More...
class  KTextEditor::CursorInterface
 This is an interface for accessing the cursor of the Document class. More...
class  KTextEditor::Document
 The main class representing a text document. More...
class  KTextEditor::DocumentInfoDCOPInterface
 This is the main interface to the DocumentInfoInterface of KTextEdit. DCOP interface to DocumentInfoInterface. More...
class  KTextEditor::DocumentInfoInterface
 This is an interface for accessing information about files open in the Document, Plugin and PluginViewInterface classes. More...
class  KTextEditor::DynWordWrapInterface
 This is an interface for accessing dynamic word wrapping functionality of the View class. More...
class  KTextEditor::EditDCOPInterface
 This is the main interface to the EditInterface of KTextEdit. DCOP interface to EditInterface. More...
class  KTextEditor::EditInterface
 This is the main interface for accessing and modifying text of the Document class. More...
class  KTextEditor::EditInterfaceExt
 This is the main interface for accessing and modifying text of the Document class. More...
class  KTextEditor::Editor
 This is a simplfied version of the Document & View classes Usage: Load it, merge it's gui + be happy Extensibility: Use the Document / View classes if you want advanced features, interfaces, etc. More...
class  KTextEditor::EncodingDCOPInterface
 This is the main interface to the EncodingInterface of KTextEdit. DCOP interface to EncodingInterface. More...
class  KTextEditor::EncodingInterface
 This is an interface to the text encoding of a Document class. More...
class  KTextEditor::HighlightingInterface
 This is an interface for syntax highlighting of a Document. More...
class  KTextEditor::MarkInterface
 This is an interface to enable marks to be made in the iconborder of the Document class. More...
class  KTextEditor::MarkInterfaceExtension
 This is an interface for custom extensions of the MarkInterface. More...
class  KTextEditor::Plugin
 Basic KTextEditor plugin class. More...
class  KTextEditor::PluginViewInterface
 View plugin class. More...
class  KTextEditor::PopupMenuInterface
 This is an interface to provide custom popup menus for a View. More...
class  KTextEditor::PrintDCOPInterface
 This is the main interface to the PrintInterface of KTextEdit. DCOP interface to PrintInterface. More...
class  KTextEditor::PrintInterface
 This is an interface to printing functions of a Document. More...
class  KTextEditor::SearchDCOPInterface
 This is the main interface to the SearchInterface of KTextEdit. DCOP interface to SearchInterface. More...
class  KTextEditor::SearchInterface
 This is an interface to allow searching of a Document. More...
class  KTextEditor::SelectionDCOPInterface
 This is the main interface to the SelectionInterface of KTextEdit. DCOP interface to SelectionInterface. More...
class  KTextEditor::SelectionExtDCOPInterface
 DCOP interface for the SelectionInterfaceExt. More...
class  KTextEditor::SelectionInterface
 This is an interface to text selection for the Document class. More...
class  KTextEditor::SelectionInterfaceExt
 Provide access to seleciton positions. More...
class  KTextEditor::SessionConfigInterface
 This is an interface to session-specific configuration of the Document, Plugin and PluginViewInterface classes. More...
class  KTextEditor::TemplateInterface
 This is an interface for inserting template strings with user editable fields into a document. More...
class  KTextEditor::TextHintInterface
 This is an interface for the KTextEditor::View class. More...
class  KTextEditor::UndoDCOPInterface
 This is the main interface to the UndoInterface of KTextEdit. DCOP interface to UndoInterface. More...
class  KTextEditor::UndoInterface
 This is an interface to undo functionality of a Document. More...
class  KTextEditor::VariableInterface
 This interface is designed to provide access to "document variables", for example variables defined in files like "kate: variable value;" or the emacs style "-*- variable: value -*-". KTextEditor interface to Document Variables. More...
class  KTextEditor::View
 The View class represents a single view of a Document . More...
class  KTextEditor::ViewCursorDCOPInterface
 This is the main interface to the ViewCursorInterface of KTextEdit. DCOP interface to ViewCursorInterface. More...
class  KTextEditor::ViewCursorInterface
 This is an interface to access the text cursor of a View class. More...
class  KTextEditor::ViewStatusMsgDCOPInterface
 This is the main interface to the ViewStatusMsgInterface of KTextEdit. DCOP interface to ViewStatusMsgInterface. More...
class  KTextEditor::ViewStatusMsgInterface
 This is an interface for retrieving status bar messages from the Document class. More...
class  KTextEditor::WordWrapInterface
 This is an interface to control fixed-column word-wrapping of a Document. More...

Functions

KTEXTEDITOR_EXPORT BlockSelectionInterfaceblockSelectionInterface (class Document *doc)
KTEXTEDITOR_EXPORT ClipboardInterfaceclipboardInterface (class View *view)
KTEXTEDITOR_EXPORT CodeCompletionInterfacecodeCompletionInterface (class View *view)
KTEXTEDITOR_EXPORT ConfigInterfaceconfigInterface (Document *doc)
KTEXTEDITOR_EXPORT ConfigInterfaceconfigInterface (Plugin *plugin)
KTEXTEDITOR_EXPORT ConfigInterfaceExtensionconfigInterfaceExtension (Document *doc)
KTEXTEDITOR_EXPORT ConfigInterfaceExtensionconfigInterfaceExtension (Plugin *plugin)
KTEXTEDITOR_EXPORT CursorInterfacecursorInterface (class Document *doc)
KTEXTEDITOR_EXPORT DocumentcreateDocument (const char *libname, QObject *parent=0, const char *name=0)
KTEXTEDITOR_EXPORT DynWordWrapInterfacedynWordWrapInterface (class View *view)
KTEXTEDITOR_EXPORT EditInterfaceeditInterface (class Document *doc)
KTEXTEDITOR_EXPORT EditInterfaceExteditInterfaceExt (class Document *doc)
KTEXTEDITOR_EXPORT EditorcreateEditor (const char *libname, QWidget *parentWidget=0, const char *widgetName=0, QObject *parent=0, const char *name=0)
KTEXTEDITOR_EXPORT EncodingInterfaceencodingInterface (class Document *doc)
KTEXTEDITOR_EXPORT HighlightingInterfacehighlightingInterface (class Document *doc)
KTEXTEDITOR_EXPORT MarkInterfacemarkInterface (class Document *doc)
KTEXTEDITOR_EXPORT MarkInterfaceExtensionmarkInterfaceExtension (class Document *doc)
KTEXTEDITOR_EXPORT PlugincreatePlugin (const char *libname, Document *document=0, const char *name=0)
KTEXTEDITOR_EXPORT PluginViewInterfacepluginViewInterface (Plugin *plugin)
KTEXTEDITOR_EXPORT PopupMenuInterfacepopupMenuInterface (class View *view)
KTEXTEDITOR_EXPORT PrintInterfaceprintInterface (class Document *doc)
KTEXTEDITOR_EXPORT SearchInterfacesearchInterface (class Document *doc)
KTEXTEDITOR_EXPORT SelectionInterfaceselectionInterface (Document *doc)
KTEXTEDITOR_EXPORT SelectionInterfaceselectionInterface (View *view)
KTEXTEDITOR_EXPORT SelectionInterfaceExtselectionInterfaceExt (Document *doc)
KTEXTEDITOR_EXPORT SelectionInterfaceExtselectionInterfaceExt (View *view)
KTEXTEDITOR_EXPORT SessionConfigInterfacesessionConfigInterface (class Document *doc)
KTEXTEDITOR_EXPORT SessionConfigInterfacesessionConfigInterface (class View *view)
KTEXTEDITOR_EXPORT SessionConfigInterfacesessionConfigInterface (class Plugin *plugin)
KTEXTEDITOR_EXPORT TemplateInterfacetemplateInterface (Document *doc)
TextHintInterfacetextHintInterface (View *view)
KTEXTEDITOR_EXPORT UndoInterfaceundoInterface (class Document *doc)
KTEXTEDITOR_EXPORT VariableInterfacevariableInterface (class Document *)
KTEXTEDITOR_EXPORT ViewCursorInterfaceviewCursorInterface (class View *view)
KTEXTEDITOR_EXPORT ViewStatusMsgInterfaceviewStatusMsgInterface (class View *view)
KTEXTEDITOR_EXPORT WordWrapInterfacewordWrapInterface (class Document *doc)

Variables

const char *const BlockSelectionDCOPInterface_ftable [5][3]
const int BlockSelectionDCOPInterface_ftable_hiddens [4]
const char *const ClipboardDCOPInterface_ftable [4][3]
const int ClipboardDCOPInterface_ftable_hiddens [3]
const char *const DocumentInfoDCOPInterface_ftable [5][3]
const int DocumentInfoDCOPInterface_ftable_hiddens [4]
const int EditDCOPInterface_fhash = 11
const char *const EditDCOPInterface_ftable [10][3]
const int EditDCOPInterface_ftable_hiddens [9]
const char *const EncodingDCOPInterface_ftable [4][3]
const int EncodingDCOPInterface_ftable_hiddens [3]
const char *const PrintDCOPInterface_ftable [4][3]
const int PrintDCOPInterface_ftable_hiddens [3]
const int SearchDCOPInterface_fhash = 17
const char *const SearchDCOPInterface_ftable [14][3]
const int SearchDCOPInterface_ftable_hiddens [13]
const char *const SelectionDCOPInterface_ftable [7][3]
const int SelectionDCOPInterface_ftable_hiddens [6]
const char *const SelectionExtDCOPInterface_ftable [5][3]
const int SelectionExtDCOPInterface_ftable_hiddens [4]
const int UndoDCOPInterface_fhash = 11
const char *const UndoDCOPInterface_ftable [11][3]
const int UndoDCOPInterface_ftable_hiddens [10]
const int ViewCursorDCOPInterface_fhash = 11
const char *const ViewCursorDCOPInterface_ftable [11][3]
const int ViewCursorDCOPInterface_ftable_hiddens [10]
const char *const ViewStatusMsgDCOPInterface_ftable [3][3]
const int ViewStatusMsgDCOPInterface_ftable_hiddens [2]


Detailed Description

KTextEditor is KDE's standard text editing KPart interface.

Function Documentation

BlockSelectionInterface * KTextEditor::blockSelectionInterface class Document doc  ) 
 

Access the block selection interface of document.

Parameters:
doc 

Definition at line 68 of file blockselectioninterface.cpp.


Variable Documentation

const char* const KTextEditor::BlockSelectionDCOPInterface_ftable[5][3] [static]
 

Initial value:

 {
    { "uint", "blockSelectionInterfaceNumber()", "blockSelectionInterfaceNumber()" },
    { "bool", "blockSelectionMode()", "blockSelectionMode()" },
    { "bool", "setBlockSelectionMode(bool)", "setBlockSelectionMode(bool on)" },
    { "bool", "toggleBlockSelectionMode()", "toggleBlockSelectionMode()" },
    { 0, 0, 0 }
}

Definition at line 15 of file blockselectiondcopinterface_skel.cpp.

const int KTextEditor::BlockSelectionDCOPInterface_ftable_hiddens[4] [static]
 

Initial value:

 {
    0,
    0,
    0,
    0,
}

Definition at line 22 of file blockselectiondcopinterface_skel.cpp.

const char* const KTextEditor::ClipboardDCOPInterface_ftable[4][3] [static]
 

Initial value:

 {
    { "void", "copy()", "copy()" },
    { "void", "cut()", "cut()" },
    { "void", "paste()", "paste()" },
    { 0, 0, 0 }
}

Definition at line 15 of file clipboarddcopinterface_skel.cpp.

const int KTextEditor::ClipboardDCOPInterface_ftable_hiddens[3] [static]
 

Initial value:

 {
    0,
    0,
    0,
}

Definition at line 21 of file clipboarddcopinterface_skel.cpp.

const char* const KTextEditor::DocumentInfoDCOPInterface_ftable[5][3] [static]
 

Initial value:

 {
    { "QString", "mimeType()", "mimeType()" },
    { "long int", "fileSize()", "fileSize()" },
    { "QString", "niceFileSize()", "niceFileSize()" },
    { "uint", "documentInfoInterfaceNumber()", "documentInfoInterfaceNumber()" },
    { 0, 0, 0 }
}

Definition at line 15 of file documentdcopinfo_skel.cpp.

const int KTextEditor::DocumentInfoDCOPInterface_ftable_hiddens[4] [static]
 

Initial value:

 {
    0,
    0,
    0,
    0,
}

Definition at line 22 of file documentdcopinfo_skel.cpp.

const char* const KTextEditor::EditDCOPInterface_ftable[10][3] [static]
 

Initial value:

 {
    { "QString", "text()", "text()" },
    { "QString", "textLine(uint)", "textLine(uint line)" },
    { "int", "numLines()", "numLines()" },
    { "int", "length()", "length()" },
    { "void", "setText(QString)", "setText(QString text)" },
    { "bool", "insertText(uint,uint,QString)", "insertText(uint line,uint col,QString text)" },
    { "bool", "removeText(uint,uint,uint,uint)", "removeText(uint startLine,uint startCol,uint endLine,uint endCol)" },
    { "bool", "insertLine(uint,QString)", "insertLine(uint line,QString text)" },
    { "bool", "removeLine(uint)", "removeLine(uint line)" },
    { 0, 0, 0 }
}

Definition at line 17 of file editdcopinterface_skel.cpp.

const int KTextEditor::EditDCOPInterface_ftable_hiddens[9] [static]
 

Initial value:

 {
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
}

Definition at line 29 of file editdcopinterface_skel.cpp.

const char* const KTextEditor::EncodingDCOPInterface_ftable[4][3] [static]
 

Initial value:

 {
    { "uint", "encodingInterfaceNumber()", "encodingInterfaceNumber()" },
    { "void", "setEncoding(QString)", "setEncoding(QString e)" },
    { "QString", "encoding()", "encoding()" },
    { 0, 0, 0 }
}

Definition at line 15 of file encodingdcopinterface_skel.cpp.

const int KTextEditor::EncodingDCOPInterface_ftable_hiddens[3] [static]
 

Initial value:

 {
    0,
    0,
    0,
}

Definition at line 21 of file encodingdcopinterface_skel.cpp.

const char* const KTextEditor::PrintDCOPInterface_ftable[4][3] [static]
 

Initial value:

 {
    { "uint", "printInterfaceNumber()", "printInterfaceNumber()" },
    { "bool", "printDialog()", "printDialog()" },
    { "bool", "print()", "print()" },
    { 0, 0, 0 }
}

Definition at line 15 of file printdcopinterface_skel.cpp.

const int KTextEditor::PrintDCOPInterface_ftable_hiddens[3] [static]
 

Initial value:

 {
    0,
    0,
    0,
}

Definition at line 21 of file printdcopinterface_skel.cpp.

const char* const KTextEditor::SearchDCOPInterface_ftable[14][3] [static]
 

Initial value:

 {
    { "bool", "findFirstString(QString,bool)", "findFirstString(QString text,bool caseSensitive)" },
    { "bool", "findNextString(QString,bool)", "findNextString(QString text,bool caseSensitive)" },
    { "bool", "findPreviousString(QString,bool)", "findPreviousString(QString text,bool caseSensitive)" },
    { "bool", "findLastString(QString,bool)", "findLastString(QString text,bool caseSensitive)" },
    { "bool", "findStringAt(uint,uint,QString,bool)", "findStringAt(uint row,uint col,QString text,bool caseSensitive)" },
    { "bool", "findFirstRegExp(QString)", "findFirstRegExp(QString regexp)" },
    { "bool", "findNextRegExp(QString)", "findNextRegExp(QString regexp)" },
    { "bool", "findPreviousRegExp(QString)", "findPreviousRegExp(QString regexp)" },
    { "bool", "findLastRegExp(QString)", "findLastRegExp(QString regexp)" },
    { "bool", "findRegExpAt(uint,uint,QString)", "findRegExpAt(uint row,uint col,QString regexp)" },
    { "uint", "currentMatchLine()", "currentMatchLine()" },
    { "uint", "currentMatchCol()", "currentMatchCol()" },
    { "uint", "currentMatchLength()", "currentMatchLength()" },
    { 0, 0, 0 }
}

Definition at line 17 of file searchdcopinterface_skel.cpp.

const int KTextEditor::SearchDCOPInterface_ftable_hiddens[13] [static]
 

Initial value:

 {
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
}

Definition at line 33 of file searchdcopinterface_skel.cpp.

const char* const KTextEditor::SelectionDCOPInterface_ftable[7][3] [static]
 

Initial value:

 {
    { "bool", "setSelection(uint,uint,uint,uint)", "setSelection(uint startLine,uint startCol,uint endLine,uint endCol)" },
    { "bool", "clearSelection()", "clearSelection()" },
    { "bool", "hasSelection()", "hasSelection()" },
    { "QString", "selection()", "selection()" },
    { "bool", "removeSelectedText()", "removeSelectedText()" },
    { "bool", "selectAll()", "selectAll()" },
    { 0, 0, 0 }
}

Definition at line 15 of file selectiondcopinterface_skel.cpp.

const int KTextEditor::SelectionDCOPInterface_ftable_hiddens[6] [static]
 

Initial value:

 {
    0,
    0,
    0,
    0,
    0,
    0,
}

Definition at line 24 of file selectiondcopinterface_skel.cpp.

const char* const KTextEditor::SelectionExtDCOPInterface_ftable[5][3] [static]
 

Initial value:

 {
    { "int", "selStartLine()", "selStartLine()" },
    { "int", "selStartCol()", "selStartCol()" },
    { "int", "selEndLine()", "selEndLine()" },
    { "int", "selEndCol()", "selEndCol()" },
    { 0, 0, 0 }
}

Definition at line 15 of file selectionextdcopinterface_skel.cpp.

const int KTextEditor::SelectionExtDCOPInterface_ftable_hiddens[4] [static]
 

Initial value:

 {
    0,
    0,
    0,
    0,
}

Definition at line 22 of file selectionextdcopinterface_skel.cpp.

const char* const KTextEditor::UndoDCOPInterface_ftable[11][3] [static]
 

Initial value:

 {
    { "uint", "undoInterfaceNumber()", "undoInterfaceNumber()" },
    { "void", "undo()", "undo()" },
    { "void", "redo()", "redo()" },
    { "void", "clearUndo()", "clearUndo()" },
    { "void", "clearRedo()", "clearRedo()" },
    { "uint", "undoCount()", "undoCount()" },
    { "uint", "redoCount()", "redoCount()" },
    { "uint", "undoSteps()", "undoSteps()" },
    { "void", "setUndoSteps(uint)", "setUndoSteps(uint steps)" },
    { "void", "undoChanged()", "undoChanged()" },
    { 0, 0, 0 }
}

Definition at line 17 of file undodcopinterface_skel.cpp.

const int KTextEditor::UndoDCOPInterface_ftable_hiddens[10] [static]
 

Initial value:

 {
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
}

Definition at line 30 of file undodcopinterface_skel.cpp.

const char* const KTextEditor::ViewCursorDCOPInterface_ftable[11][3] [static]
 

Initial value:

 {
    { "uint", "viewCursorInterfaceNumber()", "viewCursorInterfaceNumber()" },
    { "QPoint", "cursorCoordinates()", "cursorCoordinates()" },
    { "void", "cursorPosition(uint,uint)", "cursorPosition(uint line,uint col)" },
    { "void", "cursorPositionReal(uint,uint)", "cursorPositionReal(uint line,uint col)" },
    { "bool", "setCursorPosition(uint,uint)", "setCursorPosition(uint line,uint col)" },
    { "bool", "setCursorPositionReal(uint,uint)", "setCursorPositionReal(uint line,uint col)" },
    { "uint", "cursorLine()", "cursorLine()" },
    { "uint", "cursorColumn()", "cursorColumn()" },
    { "uint", "cursorColumnReal()", "cursorColumnReal()" },
    { "void", "cursorPositionChanged()", "cursorPositionChanged()" },
    { 0, 0, 0 }
}

Definition at line 17 of file viewcursordcopinterface_skel.cpp.

const int KTextEditor::ViewCursorDCOPInterface_ftable_hiddens[10] [static]
 

Initial value:

 {
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
}

Definition at line 30 of file viewcursordcopinterface_skel.cpp.

const char* const KTextEditor::ViewStatusMsgDCOPInterface_ftable[3][3] [static]
 

Initial value:

 {
    { "uint", "viewStatusMsgInterfaceNumber()", "viewStatusMsgInterfaceNumber()" },
    { "void", "viewStatusMsg(QString)", "viewStatusMsg(QString msg)" },
    { 0, 0, 0 }
}

Definition at line 15 of file viewstatusmsgdcopinterface_skel.cpp.

const int KTextEditor::ViewStatusMsgDCOPInterface_ftable_hiddens[2] [static]
 

Initial value:

 {
    0,
    0,
}

Definition at line 20 of file viewstatusmsgdcopinterface_skel.cpp.

KDE Logo
This file is part of the documentation for interfaces Library Version 3.4.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Aug 2 12:06:51 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003