Document Extension Interfaces

Collaboration diagram for Document Extension Interfaces:

Modules
	Smart Cursors and Ranges
	MovingCursors and MovingRanges

Classes
class	KTextEditor::AnnotationInterface
	A Document extension interface for handling Annotations. More...
struct	KTextEditor::HighlightInterface::AttributeBlock
	An AttributeBlock represents an Attribute with its dimension in a given line. More...
class	KTextEditor::ConfigInterface
	Config interface extension for the Document and View. More...
class	KTextEditor::HighlightInterface
	Highlighting information interface for the Document. More...
class	KTextEditor::MarkInterface
	Mark extension interface for the Document. More...
class	KTextEditor::ModeInterface
	Mode information interface for the Document. More...
class	KTextEditor::ModificationInterface
	External modification extension interface for the Document. More...
class	KTextEditor::ParameterizedSessionConfigInterface
	Parameterized session config interface extension for the Document. More...
class	KTextEditor::SearchInterface
	Search interface extension for the Document. More...
class	KTextEditor::SessionConfigInterface
	Session config interface extension for the Document, View and Plugin. More...
class	KTextEditor::SmartInterface
	A Document extension interface for handling SmartCursors and SmartRanges. More...
class	KTextEditor::VariableInterface
	Variable/Modeline extension interface for the Document. More...

Detailed Description

A KTextEditor implementation may implement a Document extension interface, but it does not need to.

So as a KTextEditor user you have to cast the Document to the desired interface and then check, whether the cast returns NULL or the valid interface.

Use qobject_cast to cast a Document doc into the DesiredExtensionInterface, example:

// doc is of type KTextEditor::Document*
KTextEditor::DesiredExtensionInterface *iface =
    qobject_cast<KTextEditor::DesiredExtensionInterface*>( doc );

if( iface ) {
    // the implementation supports the interface
    // do stuff
}
else
{
    // the implementation does not support the interface
}

See Also

KTextEditor::Document

The following classes are a list of all available Document extension interfaces.