korganizer

#include <printplugin.h>

Inheritance diagram for KOrg::PrintPlugin:
CalPrintPluginBase

Public Types

typedef TQPtrList< PrintPluginList
 

Public Member Functions

virtual void setKOrgCoreHelper (KOrg::CoreHelper *helper)
 
virtual void setConfig (TDEConfig *cfg)
 
virtual void setCalendar (KCal::Calendar *cal)
 
virtual void setSelectedIncidences (KCal::Incidence::List inc)
 
virtual KCal::Incidence::List selectedIncidences () const
 
virtual TQString description ()=0
 
virtual TQString info ()=0
 
virtual int sortID ()
 
virtual bool enabled ()
 
TQWidget * configWidget (TQWidget *w)
 
virtual TQWidget * createConfigWidget (TQWidget *)=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 TQDate &from, const TQDate &to)
 

Static Public Member Functions

static int interfaceVersion ()
 
static TQString serviceType ()
 

Protected Attributes

TQDate mFromDate
 
TQDate mToDate
 
TQWidget * mConfigWidget
 
KOrg::CoreHelper * mCoreHelper
 
KPrinter * mPrinter
 
KCal::CalendarmCalendar
 
KCal::Incidence::List mSelectedIncidences
 
TDEConfig * mConfig
 

Detailed Description

Base class for KOrganizer printing classes.

Each sub class represents one calendar print format.

Definition at line 51 of file printplugin.h.

Member Typedef Documentation

◆ List

typedef TQPtrList<PrintPlugin> KOrg::PrintPlugin::List

Definition at line 58 of file printplugin.h.

Constructor & Destructor Documentation

◆ PrintPlugin()

KOrg::PrintPlugin::PrintPlugin ( )
inline

Definition at line 54 of file printplugin.h.

◆ ~PrintPlugin()

virtual KOrg::PrintPlugin::~PrintPlugin ( )
inlinevirtual

Definition at line 56 of file printplugin.h.

Member Function Documentation

◆ configWidget()

TQWidget * KOrg::PrintPlugin::configWidget ( TQWidget *  w)
inline

Definition at line 93 of file printplugin.h.

◆ createConfigWidget()

virtual TQWidget * KOrg::PrintPlugin::createConfigWidget ( TQWidget *  )
pure virtual

Implemented in CalPrintPluginBase.

◆ defaultOrientation()

virtual KPrinter::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.

Definition at line 116 of file printplugin.h.

◆ description()

virtual TQString KOrg::PrintPlugin::description ( )
pure virtual

Returns short description of print format.

◆ doLoadConfig()

virtual void KOrg::PrintPlugin::doLoadConfig ( )
inlinevirtual

Load complete config.

Reimplemented in CalPrintPluginBase.

Definition at line 121 of file printplugin.h.

◆ doPrint()

virtual void KOrg::PrintPlugin::doPrint ( KPrinter *  printer)
pure virtual

Actually do the printing.

Implemented in CalPrintPluginBase.

◆ doSaveConfig()

virtual void KOrg::PrintPlugin::doSaveConfig ( )
inlinevirtual

Save complete config.

Reimplemented in CalPrintPluginBase.

Definition at line 125 of file printplugin.h.

◆ enabled()

virtual bool KOrg::PrintPlugin::enabled ( )
inlinevirtual

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

Definition at line 91 of file printplugin.h.

◆ info()

virtual TQString KOrg::PrintPlugin::info ( )
pure virtual

Returns long description of print format.

◆ interfaceVersion()

static int KOrg::PrintPlugin::interfaceVersion ( )
inlinestatic

Definition at line 59 of file printplugin.h.

◆ readSettingsWidget()

virtual void KOrg::PrintPlugin::readSettingsWidget ( )
inlinevirtual

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

Definition at line 132 of file printplugin.h.

◆ selectedIncidences()

virtual KCal::Incidence::List KOrg::PrintPlugin::selectedIncidences ( ) const
inlinevirtual

Definition at line 66 of file printplugin.h.

◆ serviceType()

static TQString KOrg::PrintPlugin::serviceType ( )
inlinestatic

Definition at line 60 of file printplugin.h.

◆ setCalendar()

virtual void KOrg::PrintPlugin::setCalendar ( KCal::Calendar cal)
inlinevirtual

Definition at line 64 of file printplugin.h.

◆ setConfig()

virtual void KOrg::PrintPlugin::setConfig ( TDEConfig *  cfg)
inlinevirtual

Definition at line 63 of file printplugin.h.

◆ setDateRange()

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

Set date range which should be printed.

Definition at line 141 of file printplugin.h.

◆ setKOrgCoreHelper()

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

Reimplemented in CalPrintPluginBase.

Definition at line 62 of file printplugin.h.

◆ setSelectedIncidences()

virtual void KOrg::PrintPlugin::setSelectedIncidences ( KCal::Incidence::List  inc)
inlinevirtual

Definition at line 65 of file printplugin.h.

◆ setSettingsWidget()

virtual void KOrg::PrintPlugin::setSettingsWidget ( )
inlinevirtual

Set configuration widget to reflect settings of current object.

Definition at line 136 of file printplugin.h.

◆ sortID()

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.

Definition at line 86 of file printplugin.h.

Member Data Documentation

◆ mCalendar

KCal::Calendar* KOrg::PrintPlugin::mCalendar
protected

Definition at line 157 of file printplugin.h.

◆ mConfig

TDEConfig* KOrg::PrintPlugin::mConfig
protected

Definition at line 159 of file printplugin.h.

◆ mConfigWidget

TQWidget* KOrg::PrintPlugin::mConfigWidget
protected

Definition at line 152 of file printplugin.h.

◆ mCoreHelper

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

Definition at line 153 of file printplugin.h.

◆ mFromDate

TQDate KOrg::PrintPlugin::mFromDate
protected

Definition at line 148 of file printplugin.h.

◆ mPrinter

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.

◆ mSelectedIncidences

KCal::Incidence::List KOrg::PrintPlugin::mSelectedIncidences
protected

Definition at line 158 of file printplugin.h.

◆ mToDate

TQDate KOrg::PrintPlugin::mToDate
protected

Definition at line 149 of file printplugin.h.


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