KTextEditor
KTextEditor Namespace Reference
Namespace for the KDE Text Editor Interfaces. More...
Namespaces | |
namespace | Search |
Classes | |
class | AnnotationInterface |
A Document extension interface for handling Annotations. More... | |
class | AnnotationModel |
An model for providing line annotation information. More... | |
class | AnnotationViewInterface |
Annotation interface for the View. More... | |
class | Attribute |
A class which provides customized text decorations. More... | |
class | CodeCompletionInterface |
Code completion extension interface for the View. More... | |
class | CodeCompletionModel |
An item model for providing code completion, and meta information for enhanced presentation. More... | |
class | CodeCompletionModel2 |
You must inherit your completion-model from CodeCompletionModel2 if you want to use a hierarchical structure and want to receive execution-feedback. More... | |
class | CodeCompletionModelControllerInterface |
Controller interface for a CodeCompletionModel. More... | |
class | Command |
An Editor command line command. More... | |
class | CommandExtension |
Extension interface for a Command. More... | |
class | CommandInterface |
Command extension interface for the Editor. More... | |
class | ConfigInterface |
Config interface extension for the View. More... | |
class | ConfigPage |
Config page interface for the Editor. More... | |
class | ContainerInterface |
Class that allows the kpart host to provide some extensions. More... | |
class | CoordinatesToCursorInterface |
Pixel coordinate to Cursor extension interface for the View. More... | |
class | Cursor |
An object which represents a position in a Document. More... | |
class | Document |
A KParts derived class representing a text document. More... | |
class | Editor |
Accessor interface for Editor part. More... | |
class | EditorChooser |
Editor Component Chooser. More... | |
class | Factory |
Accessor to the Editor implementation. More... | |
class | LoadSaveFilterCheckPlugin |
Plugin for load/save filtering. More... | |
class | Mark |
Mark class containing line and mark types. More... | |
class | MarkInterface |
Mark extension interface for the Document. More... | |
class | MdiContainer |
A container for MDI-capable kpart hosts. More... | |
class | ModificationInterface |
External modification extension interface for the Document. More... | |
class | Plugin |
KTextEditor Plugin interface. More... | |
class | Range |
An object representing a section of text, from one Cursor to another. More... | |
class | RangeCommand |
Extension interface for a Command making the exec method take a line range. More... | |
class | SearchInterface |
Search interface extension for the Document. More... | |
class | SessionConfigInterface |
Session config interface extension for the Document, View and Plugin. More... | |
class | SmartCursor |
A Cursor which is bound to a specific Document, and maintains its position. More... | |
class | SmartCursorNotifier |
A class which provides notifications of state changes to a SmartCursor via QObject signals. More... | |
class | SmartCursorWatcher |
A class which provides notifications of state changes to a SmartCursor via virtual inheritance. More... | |
class | SmartInterface |
A Document extension interface for handling SmartCursors and SmartRanges. More... | |
class | SmartRange |
A Range which is bound to a specific Document, and maintains its position. More... | |
class | SmartRangeNotifier |
A class which provides notifications of state changes to a SmartRange via QObject signals. More... | |
class | SmartRangeWatcher |
A class which provides notifications of state changes to a SmartRange via virtual inheritance. More... | |
class | TemplateInterface |
This is an interface for inserting template strings with user editable fields into a document. More... | |
class | TextHintInterface |
This is an interface for the KTextEditor::View class. More... | |
class | VariableInterface |
Variable/Modeline extension interface for the Document. More... | |
class | View |
A text widget with KXMLGUIClient that represents a Document. More... | |
class | ViewBarContainer |
An application providing a centralized place for horizontal view bar containers (eg search bars) has to implement this. More... | |
Functions | |
Plugin * | createPlugin (KService::Ptr service, QObject *parent) |
Editor * | editor (const char *libname) |
Detailed Description
Namespace for the KDE Text Editor Interfaces.These interfaces provide easy access to editor parts for the applications embedding them. At the moment they are at least supported by both the Kate Part and the Yzis Part.
Function Documentation
Create a plugin represented by service
with parent object parent
.
To get the KService object you usually use KServiceTypeTrader. Example
KService::List list = KServiceTypeTrader::self()->query("KTextEditor/Plugin"); foreach(const KService::Ptr &service, list) { // do something with service }
- Returns:
- the plugin or NULL if it could not be loaded
Definition at line 210 of file ktexteditor.cpp.
Editor * KTextEditor::editor | ( | const char * | libname | ) |
Helper function for the EditorChooser.
Usually you do not have to use this function. Instead, use KTextEditor::EditorChooser::editor().
- Parameters:
-
libname library name, for example "katepart"
- Returns:
- the Editor object on success, otherwise NULL
- See also:
- KTextEditor::EditorChooser::editor()
Definition at line 231 of file ktexteditor.cpp.