CalendarSupport::PrintPlugin
#include <printplugin.h>
Public Types | |
using | List = QList<PrintPlugin *> |
Public Member Functions | |
QWidget * | configWidget (QWidget *w) |
virtual QWidget * | createConfigWidget (QWidget *)=0 |
virtual QPageLayout::Orientation | defaultOrientation () const |
virtual QString | description () const =0 |
virtual void | doLoadConfig () |
virtual void | doPrint (QPrinter *printer)=0 |
virtual void | doSaveConfig () |
virtual bool | enabled () const |
virtual QString | groupName () const =0 |
virtual QString | info () const =0 |
virtual void | readSettingsWidget () |
virtual KCalendarCore::Incidence::List | selectedIncidences () const |
virtual void | setCalendar (const KCalendarCore::Calendar::Ptr &cal) |
virtual void | setConfig (KConfig *cfg) |
virtual void | setDateRange (const QDate &from, const QDate &to) |
virtual void | setSelectedIncidences (const KCalendarCore::Incidence::List &inc) |
virtual void | setSettingsWidget () |
virtual int | sortID () const |
Protected Attributes | |
KCalendarCore::Calendar::Ptr | mCalendar |
KConfig * | mConfig = nullptr |
QPointer< QWidget > | mConfigWidget |
QDate | mFromDate |
QPrinter * | mPrinter = nullptr |
KCalendarCore::Incidence::List | mSelectedIncidences |
QDate | mToDate |
Detailed Description
Base class for Calendar printing classes.
Each sub class represents one calendar print format.
Definition at line 32 of file printplugin.h.
Member Typedef Documentation
◆ List
using CalendarSupport::PrintPlugin::List = QList<PrintPlugin *> |
Definition at line 42 of file printplugin.h.
Constructor & Destructor Documentation
◆ PrintPlugin()
|
inline |
Definition at line 35 of file printplugin.h.
Member Function Documentation
◆ configWidget()
Definition at line 98 of file printplugin.h.
◆ createConfigWidget()
Implemented in CalendarSupport::CalPrintPluginBase.
◆ 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.
Definition at line 122 of file printplugin.h.
◆ description()
|
nodiscardpure virtual |
Returns short description of print format.
◆ doLoadConfig()
|
inlinevirtual |
Load complete configuration.
Each implementation calls its parent's implementation to load parent configuration options, then loads its own.
Reimplemented in CalendarSupport::CalPrintPluginBase.
Definition at line 131 of file printplugin.h.
◆ doPrint()
|
pure virtual |
Actually do the printing.
Implemented in CalendarSupport::CalPrintPluginBase.
◆ doSaveConfig()
|
inlinevirtual |
Save complete configuration.
Each implementation saves its own configuration options, then calls its parent's implementation to save parent options.
Reimplemented in CalendarSupport::CalPrintPluginBase.
Definition at line 140 of file printplugin.h.
◆ enabled()
|
inlinenodiscardvirtual |
Returns true if the plugin should be enabled; false otherwise.
Definition at line 93 of file printplugin.h.
◆ groupName()
|
nodiscardpure virtual |
Returns KConfig group name where store settings.
◆ info()
|
nodiscardpure virtual |
Returns long description of print format.
◆ readSettingsWidget()
|
inlinevirtual |
Read settings from configuration widget and apply them to current object.
Definition at line 148 of file printplugin.h.
◆ selectedIncidences()
|
inlinenodiscardvirtual |
Definition at line 59 of file printplugin.h.
◆ setCalendar()
|
inlinevirtual |
Definition at line 49 of file printplugin.h.
◆ setConfig()
|
inlinevirtual |
Definition at line 44 of file printplugin.h.
◆ setDateRange()
|
inlinevirtual |
Set date range which should be printed.
Definition at line 162 of file printplugin.h.
◆ setSelectedIncidences()
|
inlinevirtual |
Definition at line 54 of file printplugin.h.
◆ setSettingsWidget()
|
inlinevirtual |
Set configuration widget to reflect settings of current object.
Definition at line 155 of file printplugin.h.
◆ 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.
Definition at line 85 of file printplugin.h.
Member Data Documentation
◆ mCalendar
|
protected |
Definition at line 177 of file printplugin.h.
◆ mConfig
|
protected |
Definition at line 179 of file printplugin.h.
◆ mConfigWidget
Definition at line 173 of file printplugin.h.
◆ mFromDate
|
protected |
Definition at line 169 of file printplugin.h.
◆ mPrinter
|
protected |
The printer object.
This will only be available in the doPrint method of the selected plugin
Definition at line 176 of file printplugin.h.
◆ mSelectedIncidences
|
protected |
Definition at line 178 of file printplugin.h.
◆ mToDate
|
protected |
Definition at line 170 of file printplugin.h.
The documentation for this class was generated from the following file:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Oct 11 2024 12:19:28 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.