• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KTextEditor

KTextEditor::AnnotationInterface

KTextEditor::AnnotationInterface Class Reference
[Document Extension Interfaces]

A Document extension interface for handling Annotations. More...

#include <annotationinterface.h>

Inheritance diagram for KTextEditor::AnnotationInterface:
KTextEditor::AnnotationViewInterface

List of all members.

Public Member Functions

virtual AnnotationModel * annotationModel () const =0
virtual void setAnnotationModel (AnnotationModel *model)=0
virtual ~AnnotationInterface ()

Detailed Description

A Document extension interface for handling Annotations.

Introduction

The AnnotationInterface is designed to provide line annotation information for a document. This interface provides means to associate a document with a annotation model, which provides some annotation information for each line in the document.

Setting a model for a Document makes the model data available for all views. If you only want to provide annotations in exactly one view, you can use the AnnotationViewInterface directly. See the AnnotationViewInterface for further details. To summarize, the two use cases are

  • (1) show annotations in all views. This means you set an AnnotationModel with this interface, and then call setAnnotationBorderVisible() for each view.
  • (2) show annotations only in one view. This means to not use this interface. Instead, use the AnnotationViewInterface, which inherits this interface. This means you set a model for the specific View.

If you set a model to the Document and the View, the View's model has higher priority.

Accessing the AnnotationInterface

The AnnotationInterface is an extension interface for a Document, i.e. the Document inherits the interface provided that the used KTextEditor library implements the interface. Use qobject_cast to access the interface:

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

 if( iface ) {
     // the implementation supports the interface
     // do stuff
 }

Using the AnnotationInterface

Since:
4.1
See also:
KTextEditor::AnnotationModel, KTextEditor::AnnotationViewInterface

Definition at line 149 of file annotationinterface.h.


Constructor & Destructor Documentation

virtual KTextEditor::AnnotationInterface::~AnnotationInterface (  )  [inline, virtual]

Definition at line 152 of file annotationinterface.h.


Member Function Documentation

virtual AnnotationModel* KTextEditor::AnnotationInterface::annotationModel (  )  const [pure virtual]

returns the currently set AnnotationModel or 0 if there's none set

Returns:
the current AnnotationModel
virtual void KTextEditor::AnnotationInterface::setAnnotationModel ( AnnotationModel *  model  )  [pure virtual]

Sets a new AnnotationModel for this document to provide annotation information for each line.

Parameters:
model the new AnnotationModel

The documentation for this class was generated from the following file:
  • annotationinterface.h

KTextEditor

Skip menu "KTextEditor"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal