CalendarSupport::PrintPlugin Class Reference

#include <printplugin.h>

Inheritance diagram for CalendarSupport::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	setSelectedIncidences (KCalCore::Incidence::List inc)
virtual void	setSettingsWidget ()
virtual int	sortID ()
Public Member Functions inherited from CalendarSupport::Plugin
	Plugin ()
virtual	~Plugin ()
virtual void	configure (QWidget *)

Static Public Member Functions
static int	interfaceVersion ()
Static Public Member Functions inherited from CalendarSupport::Plugin
static int	interfaceVersion ()
static QString	serviceType ()

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

Detailed Description

Base class for Calendar printing classes.

Each sub class represents one calendar print format.

Definition at line 56 of file printplugin.h.

Member Typedef Documentation

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

Definition at line 63 of file printplugin.h.

Constructor & Destructor Documentation

CalendarSupport::PrintPlugin::PrintPlugin ( )

inline

Definition at line 59 of file printplugin.h.

virtual CalendarSupport::PrintPlugin::~PrintPlugin ( )

inlinevirtual

Definition at line 61 of file printplugin.h.

Member Function Documentation

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

inline

Definition at line 104 of file printplugin.h.

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

pure virtual

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

virtual QPrinter::Orientation CalendarSupport::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 CalendarSupport::CalPrintMonth, CalendarSupport::CalPrintWeek, CalendarSupport::CalPrintIncidence, and CalendarSupport::CalPrintYear.

Definition at line 127 of file printplugin.h.

virtual QString CalendarSupport::PrintPlugin::description ( )

pure virtual

Returns short description of print format.

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

virtual void CalendarSupport::PrintPlugin::doLoadConfig ( )

inlinevirtual

Load complete config.

Reimplemented in CalendarSupport::CalPrintPluginBase.

Definition at line 133 of file printplugin.h.

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

pure virtual

Actually do the printing.

Implemented in CalendarSupport::CalPrintPluginBase.

virtual void CalendarSupport::PrintPlugin::doSaveConfig ( )

inlinevirtual

Save complete config.

Reimplemented in CalendarSupport::CalPrintPluginBase.

Definition at line 137 of file printplugin.h.

virtual bool CalendarSupport::PrintPlugin::enabled ( )

inlinevirtual

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

Reimplemented in CalendarSupport::CalPrintTodos, CalendarSupport::CalPrintMonth, CalendarSupport::CalPrintWeek, CalendarSupport::CalPrintDay, CalendarSupport::CalPrintIncidence, CalendarSupport::CalPrintJournal, and CalendarSupport::CalPrintYear.

Definition at line 102 of file printplugin.h.

virtual QString CalendarSupport::PrintPlugin::groupName ( )

pure virtual

Returns KConfig group name where store settings.

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

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

pure virtual

Returns long description of print format.

Implements CalendarSupport::Plugin.

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

static int CalendarSupport::PrintPlugin::interfaceVersion ( )

inlinestatic

Definition at line 64 of file printplugin.h.

virtual void CalendarSupport::PrintPlugin::readSettingsWidget ( )

inlinevirtual

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

Reimplemented in CalendarSupport::CalPrintTodos, CalendarSupport::CalPrintMonth, CalendarSupport::CalPrintWeek, CalendarSupport::CalPrintDay, CalendarSupport::CalPrintIncidence, CalendarSupport::CalPrintJournal, and CalendarSupport::CalPrintYear.

Definition at line 143 of file printplugin.h.

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

inlinevirtual

Definition at line 73 of file printplugin.h.

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

inlinevirtual

Definition at line 68 of file printplugin.h.

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

inlinevirtual

Definition at line 66 of file printplugin.h.

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

inlinevirtual

Set date range which should be printed.

Reimplemented in CalendarSupport::CalPrintMonth, CalendarSupport::CalPrintWeek, CalendarSupport::CalPrintDay, CalendarSupport::CalPrintJournal, and CalendarSupport::CalPrintYear.

Definition at line 153 of file printplugin.h.

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

inlinevirtual

Definition at line 70 of file printplugin.h.

virtual void CalendarSupport::PrintPlugin::setSettingsWidget ( )

inlinevirtual

Set configuration widget to reflect settings of current object.

Reimplemented in CalendarSupport::CalPrintTodos, CalendarSupport::CalPrintMonth, CalendarSupport::CalPrintWeek, CalendarSupport::CalPrintDay, CalendarSupport::CalPrintIncidence, CalendarSupport::CalPrintJournal, and CalendarSupport::CalPrintYear.

Definition at line 148 of file printplugin.h.

virtual int CalendarSupport::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 CalendarSupport::CalPrintTodos, CalendarSupport::CalPrintMonth, CalendarSupport::CalPrintWeek, CalendarSupport::CalPrintDay, CalendarSupport::CalPrintIncidence, CalendarSupport::CalPrintJournal, and CalendarSupport::CalPrintYear.

Definition at line 97 of file printplugin.h.

Member Data Documentation

Akonadi::ETMCalendar::Ptr CalendarSupport::PrintPlugin::mCalendar

protected

Definition at line 168 of file printplugin.h.

KConfig* CalendarSupport::PrintPlugin::mConfig

protected

Definition at line 170 of file printplugin.h.

QPointer<QWidget> CalendarSupport::PrintPlugin::mConfigWidget

protected

Definition at line 164 of file printplugin.h.

QDate CalendarSupport::PrintPlugin::mFromDate

protected

Definition at line 160 of file printplugin.h.

QPrinter* CalendarSupport::PrintPlugin::mPrinter

protected

The printer object.

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

Definition at line 167 of file printplugin.h.

KCalCore::Incidence::List CalendarSupport::PrintPlugin::mSelectedIncidences

protected

Definition at line 169 of file printplugin.h.

QDate CalendarSupport::PrintPlugin::mToDate

protected

Definition at line 161 of file printplugin.h.

---

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

• printplugin.h