Blokkal
an Extendable KDE Blogging Client
SourceForge.net Logo
Blokkal::Ui::EntryExtensionWidget

Blokkal::Ui::EntryExtensionWidget Class Reference

Base class for extensions to the EditEntryWidget. More...

#include <entryextensionwidget.h>

Inheritance diagram for Blokkal::Ui::EntryExtensionWidget:

List of all members.


Public Types

enum  ExtensionWidget {
  ExtensionWidget0 = 0x01, ExtensionWidget1 = 0x02, ExtensionWidget2 = 0x04, ExtensionWidget3 = 0x08,
  ExtensionWidget4 = 0x10
}

Public Slots

virtual void apply (void)=0
virtual void rollBack (void)=0

Signals

void contentChanged (Blokkal::Ui::EntryExtensionWidget *widget)
void visibilityChanged (void)

Public Member Functions

 EntryExtensionWidget (Entry *entry, Blokkal::Ui::EditEntryWidget *parent)
virtual ~EntryExtensionWidget (void)

Protected Slots

virtual void emitContentChanged (void)

Protected Member Functions

const
Blokkal::Ui::EditEntryWidget * 		editEntryWidget (void) const
Blokkal::Entry * entry (void) const
virtual bool event (QEvent *event)
virtual void postInit (void)

Friends

class EditEntryWidget

Detailed Description

Base class for extensions to the EditEntryWidget.

Widget derived from this class can be used to extend the functionality of the EditEntryWidget to cope with special features of the protocol you are implementing. Make sure you set up your Entry object correctly. After that the extensions will be added automatically.

Author:
Martin Mueller <orvio@orvio.de>

Definition at line 42 of file entryextensionwidget.h.

Member Enumeration Documentation

enum Blokkal::Ui::EntryExtensionWidget::ExtensionWidget

This enumeration is used to identify the extension slots in the EditEntryWidget. If you specify that your entry supports an extension widget, you must reimplement Blokkal::Entry::createExtensionWidget() appropriately. It is entirely up to you how many or what kind of entry manipulation widgets you provide with an extension widget.

See also:
Blokkal::Entry::createExtensionWidget()

Definition at line 54 of file entryextensionwidget.h.

Constructor & Destructor Documentation

Blokkal::Ui::EntryExtensionWidget::EntryExtensionWidget ( Entry *  entry,
Blokkal::Ui::EditEntryWidget *  parent 
)

Constructor

Parameters:
entry the entry this widget will manipulate
parent the parent widget, in this case the EditEntryWidget

Definition at line 39 of file entryextensionwidget.cpp.

Blokkal::Ui::EntryExtensionWidget::~EntryExtensionWidget ( void   )  [virtual]

Destructor

Definition at line 45 of file entryextensionwidget.cpp.

Member Function Documentation

virtual void Blokkal::Ui::EntryExtensionWidget::apply ( void   )  [pure virtual, slot]

Reimplement this slot to update the Entry object to the data in the widget

void Blokkal::Ui::EntryExtensionWidget::contentChanged ( Blokkal::Ui::EntryExtensionWidget *  widget  )  [signal]

This signals is emitted, whenever the content of this widget is changed by the user input.

const Blokkal::Ui::EditEntryWidget * Blokkal::Ui::EntryExtensionWidget::editEntryWidget ( void   )  const [protected]

Returns a pointer to the owning EditEntryWidget

Returns:
a pointer to the owning EditEntryWidget

Definition at line 64 of file entryextensionwidget.cpp.

void Blokkal::Ui::EntryExtensionWidget::emitContentChanged ( void   )  [protected, virtual, slot]

Emits the contentChanged() signal.

Definition at line 55 of file entryextensionwidget.cpp.

Blokkal::Entry * Blokkal::Ui::EntryExtensionWidget::entry ( void   )  const [protected]

Returns a pointer to the Entry object passed to the constructor

Returns:
a pointer to the Entry object passed to the constructor

Definition at line 50 of file entryextensionwidget.cpp.

void Blokkal::Ui::EntryExtensionWidget::postInit ( void   )  [protected, virtual]

Reimplement this method if you need to do something after the EditEntryWidget has been constructed, like connecting to slots or signals of other extension widgets. This method is called once after all other extension widgets have been constructed. The default implementation does nothing.

See also:
EditEntryWidget::extensionWidget()

Definition at line 60 of file entryextensionwidget.cpp.

virtual void Blokkal::Ui::EntryExtensionWidget::rollBack ( void   )  [pure virtual, slot]

Reimplement this slot to set the content of your widget to reflect the data in the Entry object

The documentation for this class was generated from the following files: