.TH "KTextEditor" kde3 "11 Jun 2005" "Version Version 3.4.1" "interfaces Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KTextEditor \- KTextEditor is KDE's standard text editing KPart interface.  

.PP
.SH SYNOPSIS
.br
.PP
.SS "Classes"

.in +1c
.ti -1c
.RI "class \fBBlockSelectionDCOPInterface\fP"
.br
.RI "\fIThis is the main interface to the \fBBlockSelectionInterface\fP of \fBKTextEditor\fP. DCOP interface to \fBBlockSelectionInterface\fP. \fP"
.ti -1c
.RI "class \fBBlockSelectionInterface\fP"
.br
.RI "\fIAn interface for the \fBDocument\fP 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). \fP"
.ti -1c
.RI "class \fBClipboardDCOPInterface\fP"
.br
.RI "\fIThis is the main interface to the \fBClipboardInterface\fP of \fBKTextEdit\fP. DCOP interface to \fBClipboardInterface\fP. \fP"
.ti -1c
.RI "class \fBClipboardInterface\fP"
.br
.RI "\fIThis is an interface for accessing the clipboard through the \fBView\fP class. \fP"
.ti -1c
.RI "class \fBCompletionEntry\fP"
.br
.RI "\fIAn item for the completion popup. \fP"
.ti -1c
.RI "class \fBCodeCompletionInterface\fP"
.br
.RI "\fIThis is an interface for the \fBKTextEditor::View\fP class. \fP"
.ti -1c
.RI "class \fBConfigInterface\fP"
.br
.RI "\fIThis is an interface for accessing the configuration of the \fBDocument\fP and \fBPlugin\fP classes. \fP"
.ti -1c
.RI "class \fBConfigInterfaceExtension\fP"
.br
.RI "\fIThis is an interface to extend the configuration of the \fBDocument\fP, \fBPlugin\fP and \fBPluginViewInterface\fP classes. \fP"
.ti -1c
.RI "class \fBCursor\fP"
.br
.RI "\fIThis class represents a text cursor. \fP"
.ti -1c
.RI "class \fBCursorInterface\fP"
.br
.RI "\fIThis is an interface for accessing the cursor of the \fBDocument\fP class. \fP"
.ti -1c
.RI "class \fBDocument\fP"
.br
.RI "\fIThe main class representing a text document. \fP"
.ti -1c
.RI "class \fBDocumentInfoDCOPInterface\fP"
.br
.RI "\fIThis is the main interface to the \fBDocumentInfoInterface\fP of \fBKTextEdit\fP. DCOP interface to \fBDocumentInfoInterface\fP. \fP"
.ti -1c
.RI "class \fBDocumentInfoInterface\fP"
.br
.RI "\fIThis is an interface for accessing information about files open in the \fBDocument\fP, \fBPlugin\fP and \fBPluginViewInterface\fP classes. \fP"
.ti -1c
.RI "class \fBDynWordWrapInterface\fP"
.br
.RI "\fIThis is an interface for accessing dynamic word wrapping functionality of the \fBView\fP class. \fP"
.ti -1c
.RI "class \fBEditDCOPInterface\fP"
.br
.RI "\fIThis is the main interface to the \fBEditInterface\fP of \fBKTextEdit\fP. DCOP interface to \fBEditInterface\fP. \fP"
.ti -1c
.RI "class \fBEditInterface\fP"
.br
.RI "\fIThis is the main interface for accessing and modifying text of the \fBDocument\fP class. \fP"
.ti -1c
.RI "class \fBEditInterfaceExt\fP"
.br
.RI "\fIThis is the main interface for accessing and modifying text of the \fBDocument\fP class. \fP"
.ti -1c
.RI "class \fBEditor\fP"
.br
.RI "\fIThis is a simplfied version of the \fBDocument\fP & \fBView\fP classes Usage: Load it, merge it's gui + be happy Extensibility: Use the \fBDocument\fP / \fBView\fP classes if you want advanced features, interfaces, etc. \fP"
.ti -1c
.RI "class \fBEncodingDCOPInterface\fP"
.br
.RI "\fIThis is the main interface to the \fBEncodingInterface\fP of \fBKTextEdit\fP. DCOP interface to \fBEncodingInterface\fP. \fP"
.ti -1c
.RI "class \fBEncodingInterface\fP"
.br
.RI "\fIThis is an interface to the text encoding of a \fBDocument\fP class. \fP"
.ti -1c
.RI "class \fBHighlightingInterface\fP"
.br
.RI "\fIThis is an interface for syntax highlighting of a \fBDocument\fP. \fP"
.ti -1c
.RI "class \fBMarkInterface\fP"
.br
.RI "\fIThis is an interface to enable marks to be made in the iconborder of the \fBDocument\fP class. \fP"
.ti -1c
.RI "class \fBMarkInterfaceExtension\fP"
.br
.RI "\fIThis is an interface for custom extensions of the \fBMarkInterface\fP. \fP"
.ti -1c
.RI "class \fBPlugin\fP"
.br
.RI "\fIBasic \fBKTextEditor\fP plugin class. \fP"
.ti -1c
.RI "class \fBPluginViewInterface\fP"
.br
.RI "\fI\fBView\fP plugin class. \fP"
.ti -1c
.RI "class \fBPopupMenuInterface\fP"
.br
.RI "\fIThis is an interface to provide custom popup menus for a \fBView\fP. \fP"
.ti -1c
.RI "class \fBPrintDCOPInterface\fP"
.br
.RI "\fIThis is the main interface to the \fBPrintInterface\fP of \fBKTextEdit\fP. DCOP interface to \fBPrintInterface\fP. \fP"
.ti -1c
.RI "class \fBPrintInterface\fP"
.br
.RI "\fIThis is an interface to printing functions of a \fBDocument\fP. \fP"
.ti -1c
.RI "class \fBSearchDCOPInterface\fP"
.br
.RI "\fIThis is the main interface to the \fBSearchInterface\fP of \fBKTextEdit\fP. DCOP interface to \fBSearchInterface\fP. \fP"
.ti -1c
.RI "class \fBSearchInterface\fP"
.br
.RI "\fIThis is an interface to allow searching of a \fBDocument\fP. \fP"
.ti -1c
.RI "class \fBSelectionDCOPInterface\fP"
.br
.RI "\fIThis is the main interface to the \fBSelectionInterface\fP of \fBKTextEdit\fP. DCOP interface to \fBSelectionInterface\fP. \fP"
.ti -1c
.RI "class \fBSelectionExtDCOPInterface\fP"
.br
.RI "\fIDCOP interface for the \fBSelectionInterfaceExt\fP. \fP"
.ti -1c
.RI "class \fBSelectionInterface\fP"
.br
.RI "\fIThis is an interface to text selection for the \fBDocument\fP class. \fP"
.ti -1c
.RI "class \fBSelectionInterfaceExt\fP"
.br
.RI "\fIProvide access to seleciton positions. \fP"
.ti -1c
.RI "class \fBSessionConfigInterface\fP"
.br
.RI "\fIThis is an interface to session-specific configuration of the \fBDocument\fP, \fBPlugin\fP and \fBPluginViewInterface\fP classes. \fP"
.ti -1c
.RI "class \fBTemplateInterface\fP"
.br
.RI "\fIThis is an interface for inserting template strings with user editable fields into a document. \fP"
.ti -1c
.RI "class \fBTextHintInterface\fP"
.br
.RI "\fIThis is an interface for the \fBKTextEditor::View\fP class. \fP"
.ti -1c
.RI "class \fBUndoDCOPInterface\fP"
.br
.RI "\fIThis is the main interface to the \fBUndoInterface\fP of \fBKTextEdit\fP. DCOP interface to \fBUndoInterface\fP. \fP"
.ti -1c
.RI "class \fBUndoInterface\fP"
.br
.RI "\fIThis is an interface to undo functionality of a \fBDocument\fP. \fP"
.ti -1c
.RI "class \fBVariableInterface\fP"
.br
.RI "\fIThis 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 -*-'. \fBKTextEditor\fP interface to \fBDocument\fP Variables. \fP"
.ti -1c
.RI "class \fBView\fP"
.br
.RI "\fIThe \fBView\fP class represents a single view of a \fBDocument\fP . \fP"
.ti -1c
.RI "class \fBViewCursorDCOPInterface\fP"
.br
.RI "\fIThis is the main interface to the \fBViewCursorInterface\fP of \fBKTextEdit\fP. DCOP interface to \fBViewCursorInterface\fP. \fP"
.ti -1c
.RI "class \fBViewCursorInterface\fP"
.br
.RI "\fIThis is an interface to access the text cursor of a \fBView\fP class. \fP"
.ti -1c
.RI "class \fBViewStatusMsgDCOPInterface\fP"
.br
.RI "\fIThis is the main interface to the \fBViewStatusMsgInterface\fP of \fBKTextEdit\fP. DCOP interface to \fBViewStatusMsgInterface\fP. \fP"
.ti -1c
.RI "class \fBViewStatusMsgInterface\fP"
.br
.RI "\fIThis is an interface for retrieving status bar messages from the \fBDocument\fP class. \fP"
.ti -1c
.RI "class \fBWordWrapInterface\fP"
.br
.RI "\fIThis is an interface to control fixed-column word-wrapping of a \fBDocument\fP. \fP"
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBBlockSelectionInterface\fP * \fBblockSelectionInterface\fP (class \fBDocument\fP *doc)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBClipboardInterface\fP * \fBclipboardInterface\fP (class \fBView\fP *view)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBCodeCompletionInterface\fP * \fBcodeCompletionInterface\fP (class \fBView\fP *view)"
.br
.ti -1c
.RI "class KTEXTEDITOR_EXPORT \fBConfigInterface\fP * \fBconfigInterface\fP (\fBDocument\fP *doc)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBConfigInterface\fP * \fBconfigInterface\fP (\fBPlugin\fP *plugin)"
.br
.ti -1c
.RI "class class KTEXTEDITOR_EXPORT \fBConfigInterfaceExtension\fP * \fBconfigInterfaceExtension\fP (\fBDocument\fP *doc)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBConfigInterfaceExtension\fP * \fBconfigInterfaceExtension\fP (\fBPlugin\fP *plugin)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBCursorInterface\fP * \fBcursorInterface\fP (class \fBDocument\fP *doc)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBDocument\fP * \fBcreateDocument\fP (const char *libname, \fBQObject\fP *parent=0, const char *name=0)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBDynWordWrapInterface\fP * \fBdynWordWrapInterface\fP (class \fBView\fP *view)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBEditInterface\fP * \fBeditInterface\fP (class \fBDocument\fP *doc)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBEditInterfaceExt\fP * \fBeditInterfaceExt\fP (class \fBDocument\fP *doc)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBEditor\fP * \fBcreateEditor\fP (const char *libname, \fBQWidget\fP *parentWidget=0, const char *widgetName=0, \fBQObject\fP *parent=0, const char *name=0)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBEncodingInterface\fP * \fBencodingInterface\fP (class \fBDocument\fP *doc)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBHighlightingInterface\fP * \fBhighlightingInterface\fP (class \fBDocument\fP *doc)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBMarkInterface\fP * \fBmarkInterface\fP (class \fBDocument\fP *doc)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBMarkInterfaceExtension\fP * \fBmarkInterfaceExtension\fP (class \fBDocument\fP *doc)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBPlugin\fP * \fBcreatePlugin\fP (const char *libname, \fBDocument\fP *document=0, const char *name=0)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBPluginViewInterface\fP * \fBpluginViewInterface\fP (\fBPlugin\fP *plugin)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBPopupMenuInterface\fP * \fBpopupMenuInterface\fP (class \fBView\fP *view)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBPrintInterface\fP * \fBprintInterface\fP (class \fBDocument\fP *doc)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBSearchInterface\fP * \fBsearchInterface\fP (class \fBDocument\fP *doc)"
.br
.ti -1c
.RI "class KTEXTEDITOR_EXPORT \fBSelectionInterface\fP * \fBselectionInterface\fP (\fBDocument\fP *doc)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBSelectionInterface\fP * \fBselectionInterface\fP (\fBView\fP *view)"
.br
.ti -1c
.RI "class KTEXTEDITOR_EXPORT \fBSelectionInterfaceExt\fP * \fBselectionInterfaceExt\fP (\fBDocument\fP *doc)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBSelectionInterfaceExt\fP * \fBselectionInterfaceExt\fP (\fBView\fP *view)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBSessionConfigInterface\fP * \fBsessionConfigInterface\fP (class \fBDocument\fP *doc)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBSessionConfigInterface\fP * \fBsessionConfigInterface\fP (class \fBView\fP *view)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBSessionConfigInterface\fP * \fBsessionConfigInterface\fP (class \fBPlugin\fP *plugin)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBTemplateInterface\fP * \fBtemplateInterface\fP (\fBDocument\fP *doc)"
.br
.ti -1c
.RI "\fBTextHintInterface\fP * \fBtextHintInterface\fP (\fBView\fP *view)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBUndoInterface\fP * \fBundoInterface\fP (class \fBDocument\fP *doc)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBVariableInterface\fP * \fBvariableInterface\fP (class \fBDocument\fP *)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBViewCursorInterface\fP * \fBviewCursorInterface\fP (class \fBView\fP *view)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBViewStatusMsgInterface\fP * \fBviewStatusMsgInterface\fP (class \fBView\fP *view)"
.br
.ti -1c
.RI "KTEXTEDITOR_EXPORT \fBWordWrapInterface\fP * \fBwordWrapInterface\fP (class \fBDocument\fP *doc)"
.br
.in -1c
.SH "Detailed Description"
.PP 
KTextEditor is KDE's standard text editing KPart interface. 
.SH "Function Documentation"
.PP 
.SS "\fBBlockSelectionInterface\fP * KTextEditor::blockSelectionInterface (class \fBDocument\fP * doc)"
.PP
Access the block selection interface of document. 
.PP
\fBParameters:\fP
.RS 4
\fIdoc\fP .RE
.PP

.PP
Definition at line 68 of file blockselectioninterface.cpp.
.SH "Author"
.PP 
Generated automatically by Doxygen for interfaces Library from the source code.
