namespace KTextEditor

Public Types

• class BlockSelectionInterface
• class ClipboardInterface
• class ClipboardDCOPInterface
• class CompletionEntry
• class CodeCompletionInterface
• class ConfigInterface
• class Cursor
• class CursorInterface
• class Document
• class DynWordWrapInterface
• class EditInterface
• class EditDCOPInterface
• class Editor
• class HighlightingInterface
• class Mark
• class MarkInterface
• class PopupMenuInterface
• class PrintInterface
• class SearchInterface
• class SearchDCOPInterface
• class SelectionInterface
• class SelectionDCOPInterface
• class UndoInterface
• class View
• class ViewCursorInterface
• class WordWrapInterface

Detailed Description

only for the interface itself - REAL PRIVATE

This is the main interface to the ClipboardInterface of KTextEdit. This will provide a consistant dcop interface to all KDE applications that use it.

An item for the completion popup. text is the completed string, prefix appears in front of it, suffix appears after it. type does not appear in the completion list. prefix, suffix, and type are not part of the inserted text if a completion takes place. comment appears in a tooltip right of the completion list for the currently selected item. userdata can be free formed data, which the user of this interface can use in CodeCompletionInterface::filterInsertString().

This is an interface for the KTextEditor::View class. It can be used to show completion lists, i.e. lists that pop up while a user is typing. The user can then choose from the list or he can just keep typing. The completion list will disappear if an item is chosen, if no completion is available or if the user presses Esc etc. The contents of the list is automatically adapted to the string the user types.

There is another signal, which may be implmemented, but isn't documented here, because it would have been a BIC change and I'm not sure if it is really of need

void completionExtendedComment(CompletionEntry)

This is an interface for the KTextEditor::Document class !!!

This is the main interface to the EditInterface of KTextEdit. This will provide a consistant dcop interface to all KDE applications that use it.

The Editor class is a wrapper around a document and its unique view. This means that KTextEditor::Editor can inherit both interfaces for the Document and View (the view interfaces should be applied to the widget()). KTextEditor::Editor is baseclass of KTextEditor::Document, mostly to give the implementors of both interfaces the chance to use the same class to implement both at once with only minor changes. Please don't cast a KTextEditor::Document to a KTextEditor::Editor and think there must be a widget()!

This is the main interface to the SearchInterface of KTextEdit. This will provide a consistant dcop interface to all KDE applications that use it.

This is the main interface to the SelectionInterface of KTextEdit. This will provide a consistant dcop interface to all KDE applications that use it.

The View class encapsulates a single view into the document.

This is an interface for the KTextEditor::View class !!!