KOrg::PrintPlugin Class Reference

#include <printplugin.h>

Inheritance diagram for KOrg::PrintPlugin:

Public Types
typedef QList< PrintPlugin * >	List

Public Member Functions
	PrintPlugin ()
virtual	~PrintPlugin ()
QWidget *	configWidget (QWidget *w)
virtual QWidget *	createConfigWidget (QWidget *)=0
virtual QPrinter::Orientation	defaultOrientation ()
virtual QString	description ()=0
virtual void	doLoadConfig ()
virtual void	doPrint (QPrinter *printer)=0
virtual void	doSaveConfig ()
virtual bool	enabled ()
virtual QString	groupName ()=0
virtual QString	info () const =0
virtual void	readSettingsWidget ()
virtual KCalCore::Incidence::List	selectedIncidences () const
virtual void	setCalendar (const Akonadi::ETMCalendar::Ptr &cal)
virtual void	setConfig (KConfig *cfg)
virtual void	setDateRange (const QDate &from, const QDate &to)
virtual void	setKOrgCoreHelper (KOrg::CoreHelper *helper)
virtual void	setSelectedIncidences (KCalCore::Incidence::List inc)
virtual void	setSettingsWidget ()
virtual int	sortID ()

Static Public Member Functions
static int	interfaceVersion ()
static QString	serviceType ()

Protected Attributes
Akonadi::ETMCalendar::Ptr	mCalendar
KConfig *	mConfig
QPointer< QWidget >	mConfigWidget
KOrg::CoreHelper *	mCoreHelper
QDate	mFromDate
QPrinter *	mPrinter
KCalCore::Incidence::List	mSelectedIncidences
QDate	mToDate

Detailed Description

Base class for KOrganizer printing classes.

Each sub class represents one calendar print format.

Definition at line 62 of file printplugin.h.

Member Typedef Documentation

typedef QList<PrintPlugin*> KOrg::PrintPlugin::List

Definition at line 69 of file printplugin.h.

Constructor & Destructor Documentation

KOrg::PrintPlugin::PrintPlugin ( )

inline

Definition at line 65 of file printplugin.h.

virtual KOrg::PrintPlugin::~PrintPlugin ( )

inlinevirtual

Definition at line 67 of file printplugin.h.

Member Function Documentation

QWidget* KOrg::PrintPlugin::configWidget ( QWidget *  w )

inline

Definition at line 116 of file printplugin.h.

virtual QWidget* KOrg::PrintPlugin::createConfigWidget ( QWidget *  )

pure virtual

Implemented in CalPrintTodos, CalPrintMonth, CalPrintWeek, CalPrintDay, CalPrintPluginBase, CalPrintIncidence, CalPrintWhatsNext, CalPrintItemList, CalPrintYear, and CalPrintJournal.

virtual QPrinter::Orientation KOrg::PrintPlugin::defaultOrientation ( )

inlinevirtual

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 CalPrintMonth, CalPrintWeek, CalPrintIncidence, and CalPrintYear.

Definition at line 139 of file printplugin.h.

virtual QString KOrg::PrintPlugin::description ( )

pure virtual

Returns short description of print format.

Implemented in CalPrintTodos, CalPrintMonth, CalPrintWeek, CalPrintDay, CalPrintIncidence, CalPrintItemList, CalPrintWhatsNext, CalPrintJournal, and CalPrintYear.

virtual void KOrg::PrintPlugin::doLoadConfig ( )

inlinevirtual

Load complete config.

Reimplemented in CalPrintPluginBase.

Definition at line 145 of file printplugin.h.

virtual void KOrg::PrintPlugin::doPrint ( QPrinter *  printer )

pure virtual

Actually do the printing.

Implemented in CalPrintPluginBase.

virtual void KOrg::PrintPlugin::doSaveConfig ( )

inlinevirtual

Save complete config.

Reimplemented in CalPrintPluginBase.

Definition at line 149 of file printplugin.h.

virtual bool KOrg::PrintPlugin::enabled ( )

inlinevirtual

Returns true if the plugin should be enabled; false otherwise.

Reimplemented in CalPrintTodos, CalPrintMonth, CalPrintWeek, CalPrintDay, CalPrintIncidence, CalPrintWhatsNext, CalPrintItemList, CalPrintJournal, and CalPrintYear.

Definition at line 114 of file printplugin.h.

virtual QString KOrg::PrintPlugin::groupName ( )

pure virtual

Returns KConfig group name where store settings.

Implemented in CalPrintTodos, CalPrintMonth, CalPrintWeek, CalPrintDay, CalPrintIncidence, CalPrintJournal, and CalPrintYear.

virtual QString KOrg::PrintPlugin::info ( ) const

pure virtual

Returns long description of print format.

Implemented in CalPrintTodos, CalPrintMonth, CalPrintWeek, CalPrintDay, CalPrintIncidence, CalPrintItemList, CalPrintWhatsNext, CalPrintJournal, and CalPrintYear.

static int KOrg::PrintPlugin::interfaceVersion ( )

inlinestatic

Definition at line 70 of file printplugin.h.

virtual void KOrg::PrintPlugin::readSettingsWidget ( )

inlinevirtual

Read settings from configuration widget and apply them to current object.

Reimplemented in CalPrintTodos, CalPrintMonth, CalPrintWeek, CalPrintDay, CalPrintIncidence, CalPrintWhatsNext, CalPrintItemList, CalPrintJournal, and CalPrintYear.

Definition at line 155 of file printplugin.h.

virtual KCalCore::Incidence::List KOrg::PrintPlugin::selectedIncidences ( ) const

inlinevirtual

Definition at line 85 of file printplugin.h.

static QString KOrg::PrintPlugin::serviceType ( )

inlinestatic

Definition at line 72 of file printplugin.h.

virtual void KOrg::PrintPlugin::setCalendar ( const Akonadi::ETMCalendar::Ptr &  cal )

inlinevirtual

Definition at line 80 of file printplugin.h.

virtual void KOrg::PrintPlugin::setConfig ( KConfig *  cfg )

inlinevirtual

Definition at line 78 of file printplugin.h.

virtual void KOrg::PrintPlugin::setDateRange ( const QDate &  from, const QDate &  to  )

inlinevirtual

Set date range which should be printed.

Reimplemented in CalPrintMonth, CalPrintWeek, CalPrintDay, CalPrintWhatsNext, CalPrintItemList, CalPrintJournal, and CalPrintYear.

Definition at line 165 of file printplugin.h.

virtual void KOrg::PrintPlugin::setKOrgCoreHelper ( KOrg::CoreHelper *  helper )

inlinevirtual

Reimplemented in CalPrintPluginBase.

Definition at line 75 of file printplugin.h.

virtual void KOrg::PrintPlugin::setSelectedIncidences ( KCalCore::Incidence::List  inc )

inlinevirtual

Definition at line 82 of file printplugin.h.

virtual void KOrg::PrintPlugin::setSettingsWidget ( )

inlinevirtual

Set configuration widget to reflect settings of current object.

Reimplemented in CalPrintTodos, CalPrintMonth, CalPrintWeek, CalPrintDay, CalPrintIncidence, CalPrintWhatsNext, CalPrintItemList, CalPrintJournal, and CalPrintYear.

Definition at line 160 of file printplugin.h.

virtual int KOrg::PrintPlugin::sortID ( )

inlinevirtual

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 CalPrintTodos, CalPrintMonth, CalPrintWeek, CalPrintDay, CalPrintIncidence, CalPrintWhatsNext, CalPrintItemList, CalPrintJournal, and CalPrintYear.

Definition at line 109 of file printplugin.h.

Member Data Documentation

Akonadi::ETMCalendar::Ptr KOrg::PrintPlugin::mCalendar

protected

Definition at line 181 of file printplugin.h.

KConfig* KOrg::PrintPlugin::mConfig

protected

Definition at line 183 of file printplugin.h.

QPointer<QWidget> KOrg::PrintPlugin::mConfigWidget

protected

Definition at line 176 of file printplugin.h.

KOrg::CoreHelper* KOrg::PrintPlugin::mCoreHelper

protected

Definition at line 177 of file printplugin.h.

QDate KOrg::PrintPlugin::mFromDate

protected

Definition at line 172 of file printplugin.h.

QPrinter* KOrg::PrintPlugin::mPrinter

protected

The printer object.

This will only be available in the doPrint method of the selected plugin

Definition at line 180 of file printplugin.h.

KCalCore::Incidence::List KOrg::PrintPlugin::mSelectedIncidences

protected

Definition at line 182 of file printplugin.h.

QDate KOrg::PrintPlugin::mToDate

protected

Definition at line 173 of file printplugin.h.

---

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

• printplugin.h