korganizer
KOrg::PrintPlugin Class Reference
#include <printplugin.h>
Inheritance diagram for KOrg::PrintPlugin:

Detailed Description
Base class for KOrganizer printing classes.Each sub class represents one calendar print format.
Definition at line 51 of file printplugin.h.
Public Types | |
typedef QPtrList< PrintPlugin > | List |
Public Member Functions | |
PrintPlugin () | |
virtual | ~PrintPlugin () |
virtual void | setKOrgCoreHelper (KOrg::CoreHelper *helper) |
virtual void | setConfig (KConfig *cfg) |
virtual void | setCalendar (KCal::Calendar *cal) |
virtual void | setSelectedIncidences (KCal::Incidence::List inc) |
virtual KCal::Incidence::List | selectedIncidences () const |
virtual QString | description ()=0 |
virtual QString | info ()=0 |
virtual int | sortID () |
virtual bool | enabled () |
QWidget * | configWidget (QWidget *w) |
virtual QWidget * | createConfigWidget (QWidget *)=0 |
virtual void | doPrint (KPrinter *printer)=0 |
virtual KPrinter::Orientation | defaultOrientation () |
virtual void | doLoadConfig () |
virtual void | doSaveConfig () |
virtual void | readSettingsWidget () |
virtual void | setSettingsWidget () |
virtual void | setDateRange (const QDate &from, const QDate &to) |
Static Public Member Functions | |
static int | interfaceVersion () |
static QString | serviceType () |
Protected Attributes | |
QDate | mFromDate |
QDate | mToDate |
QWidget * | mConfigWidget |
KOrg::CoreHelper * | mCoreHelper |
KPrinter * | mPrinter |
KCal::Calendar * | mCalendar |
KCal::Incidence::List | mSelectedIncidences |
KConfig * | mConfig |
Member Function Documentation
virtual QString KOrg::PrintPlugin::description | ( | ) | [pure virtual] |
Returns short description of print format.
Implemented in CalPrintJournal, CalPrintList, CalPrintWhatsNext, CalPrintYear, CalPrintIncidence, CalPrintDay, CalPrintWeek, CalPrintMonth, and CalPrintTodos.
virtual QString KOrg::PrintPlugin::info | ( | ) | [pure virtual] |
Returns long description of print format.
Implements KOrg::Plugin.
Implemented in CalPrintJournal, CalPrintList, CalPrintWhatsNext, CalPrintYear, CalPrintIncidence, CalPrintDay, CalPrintWeek, CalPrintMonth, and CalPrintTodos.
virtual int KOrg::PrintPlugin::sortID | ( | ) | [inline, virtual] |
Returns the sort ID of the plugin.
This value will be used to identify the config widget in the widget stack, and to sort the plugin name in the print style selection list. If another plugin uses the same ID or a value of -1 is returned, a unique (negative) ID will be automatically generated and thus the position of the plugin in the selection list is undefined.
Reimplemented in CalPrintJournal, CalPrintList, CalPrintWhatsNext, CalPrintYear, CalPrintIncidence, CalPrintDay, CalPrintWeek, CalPrintMonth, and CalPrintTodos.
Definition at line 86 of file printplugin.h.
virtual bool KOrg::PrintPlugin::enabled | ( | ) | [inline, virtual] |
Returns true if the plugin should be enabled; false otherwise.
Reimplemented in CalPrintJournal, CalPrintYear, CalPrintIncidence, CalPrintDay, CalPrintWeek, CalPrintMonth, and CalPrintTodos.
Definition at line 91 of file printplugin.h.
virtual void KOrg::PrintPlugin::doPrint | ( | KPrinter * | printer | ) | [pure virtual] |
virtual KPrinter::Orientation KOrg::PrintPlugin::defaultOrientation | ( | ) | [inline, virtual] |
Orientation of printout.
Default is Portrait. If your plugin wants to use some other orientation as default (e.g. depending on some config settings), implement this function in your subclass and return the desired orientation.
Reimplemented in CalPrintYear, CalPrintIncidence, CalPrintWeek, and CalPrintMonth.
Definition at line 116 of file printplugin.h.
virtual void KOrg::PrintPlugin::doLoadConfig | ( | ) | [inline, virtual] |
Load complete config.
Reimplemented in CalPrintPluginBase.
Definition at line 121 of file printplugin.h.
virtual void KOrg::PrintPlugin::doSaveConfig | ( | ) | [inline, virtual] |
Save complete config.
Reimplemented in CalPrintPluginBase.
Definition at line 125 of file printplugin.h.
virtual void KOrg::PrintPlugin::readSettingsWidget | ( | ) | [inline, virtual] |
Read settings from configuration widget and apply them to current object.
Reimplemented in CalPrintJournal, CalPrintList, CalPrintWhatsNext, CalPrintYear, CalPrintIncidence, CalPrintDay, CalPrintWeek, CalPrintMonth, and CalPrintTodos.
Definition at line 132 of file printplugin.h.
virtual void KOrg::PrintPlugin::setSettingsWidget | ( | ) | [inline, virtual] |
Set configuration widget to reflect settings of current object.
Reimplemented in CalPrintJournal, CalPrintList, CalPrintWhatsNext, CalPrintYear, CalPrintIncidence, CalPrintDay, CalPrintWeek, CalPrintMonth, and CalPrintTodos.
Definition at line 136 of file printplugin.h.
virtual void KOrg::PrintPlugin::setDateRange | ( | const QDate & | from, | |
const QDate & | to | |||
) | [inline, virtual] |
Set date range which should be printed.
Reimplemented in CalPrintJournal, CalPrintList, CalPrintWhatsNext, CalPrintYear, CalPrintDay, CalPrintWeek, and CalPrintMonth.
Definition at line 141 of file printplugin.h.
Member Data Documentation
KPrinter* KOrg::PrintPlugin::mPrinter [protected] |
The printer object.
This will only be available in the doPrint method of the selected plugin
Definition at line 156 of file printplugin.h.
The documentation for this class was generated from the following file: