libkdepim

Komposer::Editor Class Reference

Inheritance diagram for Komposer::Editor:

Komposer::Plugin DefaultEditor List of all members.

Detailed Description

Definition at line 38 of file editor.h.


Public Types

enum  TextType { Plain = 1 << 0, RichText = 1 << 1, HTML = 1 << 2 }

Public Slots

virtual void setText (const QString &txt)=0
virtual void changeSignature (const QString &txt)=0

Public Member Functions

virtual ~Editor ()
virtual QWidget * widget ()=0
int supportedTextFormats () const
virtual QString text () const=0
virtual void select ()
virtual QStringList configModules () const

Protected Member Functions

 Editor (QObject *parent, const char *name, const QStringList &args)

Member Function Documentation

virtual QWidget* Komposer::Editor::widget (  )  [pure virtual]

This is the magic function that all derivatives have to reimplement.

It returns the actual editor component.

Implemented in DefaultEditor.

virtual QString Komposer::Editor::text (  )  const [pure virtual]

Returns the full text inside the editor.

Implemented in DefaultEditor.

void Komposer::Editor::select (  )  [virtual]

This function is called when the plugin is selected by the user before the widget of the KPart belonging to the plugin is raised.

Definition at line 44 of file editor.cpp.

virtual QStringList Komposer::Editor::configModules (  )  const [inline, virtual]

Reimplement this method and return a QStringList of all config modules your application part should offer via Komposer.

Note that the part and the module will have to take care for config syncing themselves. Usually DCOP used for that purpose.

Note:
Make sure you offer the modules in the form: "pathrelativetosettings/mysettings.desktop"

Definition at line 77 of file editor.h.

virtual void Komposer::Editor::setText ( const QString &  txt  )  [pure virtual, slot]

Sets the text of the opened editor.

Most commonly used on replaying. If any text is present if will be deleted.

Implemented in DefaultEditor.

virtual void Komposer::Editor::changeSignature ( const QString &  txt  )  [pure virtual, slot]

Changes currently used signature.

If no signature is present a new one should be appened.

Implemented in DefaultEditor.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys