korganizer

KOrg::BaseView Class Reference

This class provides an interface for all views being displayed within the main calendar view. More...

#include <baseview.h>

Inheritance diagram for KOrg::BaseView:

KOEventView KOJournalView KOProjectView KOTodoView KOWhatsNextView KOListView KOMonthView KOrg::AgendaView KOTimelineView KOAgendaView KOrg::MultiAgendaView

List of all members.


Public Slots

virtual void showDates (const TQDate &start, const TQDate &end)=0
virtual void showIncidences (const Incidence::List &incidenceList, const TQDate &date)=0
virtual void updateView ()=0
virtual void dayPassed (const TQDate &)
virtual void setIncidenceChanger (IncidenceChangerBase *changer)
virtual void flushView ()
virtual void changeIncidenceDisplay (Incidence *, int)=0
virtual void updateConfig ()
virtual void clearSelection ()
virtual bool eventDurationHint (TQDateTime &, TQDateTime &, bool &)

Signals

void incidenceSelected (Incidence *, const TQDate &)
void showIncidenceSignal (Incidence *, const TQDate &)
void editIncidenceSignal (Incidence *, const TQDate &)
void deleteIncidenceSignal (Incidence *)
void cutIncidenceSignal (Incidence *)
void copyIncidenceSignal (Incidence *)
void pasteIncidenceSignal ()
void toggleAlarmSignal (Incidence *)
void dissociateOccurrenceSignal (Incidence *, const TQDate &)
void dissociateFutureOccurrenceSignal (Incidence *, const TQDate &)
void startMultiModify (const TQString &)
void endMultiModify ()
void newEventSignal (ResourceCalendar *res, const TQString &subResource)
void newEventSignal (ResourceCalendar *res, const TQString &subResource, const TQDate &)
void newEventSignal (ResourceCalendar *res, const TQString &subResource, const TQDateTime &)
void newEventSignal (ResourceCalendar *res, const TQString &subResource, const TQDateTime &, const TQDateTime &)
void newTodoSignal (ResourceCalendar *res, const TQString &subResource, const TQDate &)
void newSubTodoSignal (Todo *)
void newJournalSignal (ResourceCalendar *res, const TQString &subResource, const TQDate &)

Public Member Functions

 BaseView (Calendar *cal, TQWidget *parent=0, const char *name=0)
virtual ~BaseView ()
void setReadOnly (bool readonly)
bool readOnly ()
virtual void setCalendar (Calendar *cal)
virtual Calendarcalendar ()
virtual void setResource (ResourceCalendar *res, const TQString &subResource)
ResourceCalendarresourceCalendar ()
TQString subResourceCalendar () const
virtual Incidence::List selectedIncidences ()=0
virtual DateList selectedIncidenceDates ()=0
virtual TQDateTime selectionStart ()
virtual TQDateTime selectionEnd ()
virtual CalPrinterBase::PrintType printType ()
virtual int currentDateCount ()=0
virtual bool isEventView ()
virtual bool supportsDateNavigation () const

Protected Attributes

IncidenceChangerBase * mChanger

Detailed Description

This class provides an interface for all views being displayed within the main calendar view.

It has functions to update the view, to specify date range and other display parameter and to return selected objects. An important class, which inherits KOBaseView is KOEventView, which provides the interface for all views of event data like the agenda or the month view.

Base class for calendar views

Author:
Preston Brown, Cornelius Schumacher
See also:
KOTodoView, KOEventView, KOListView, KOAgendaView, KOMonthView

Definition at line 59 of file baseview.h.


Constructor & Destructor Documentation

KOrg::BaseView::BaseView ( Calendar cal,
TQWidget *  parent = 0,
const char *  name = 0 
) [inline]

Constructs a view.

Parameters:
cal Pointer to the calendar object from which events will be retrieved for display.
parent parent widget.
name name of this widget.

Definition at line 71 of file baseview.h.

virtual KOrg::BaseView::~BaseView (  )  [inline, virtual]

Destructor.

Views will do view-specific cleanups here.

Definition at line 78 of file baseview.h.


Member Function Documentation

void KOrg::BaseView::setReadOnly ( bool  readonly  )  [inline]

Flag indicating if the view is read-only.

Definition at line 81 of file baseview.h.

virtual Calendar* KOrg::BaseView::calendar (  )  [inline, virtual]

Return calendar object of this view.

Definition at line 88 of file baseview.h.

ResourceCalendar* KOrg::BaseView::resourceCalendar (  )  [inline]

Return resourceCalendar of this view.

Definition at line 99 of file baseview.h.

TQString KOrg::BaseView::subResourceCalendar (  )  const [inline]

Return subResourceCalendar of this view.

Definition at line 104 of file baseview.h.

virtual Incidence::List KOrg::BaseView::selectedIncidences (  )  [pure virtual]

Returns:
a list of selected events. Most views can probably only select a single event at a time, but some may be able to select more than one.

Implemented in KOAgendaView, KOJournalView, KOListView, KOMonthView, KOTimelineView, KOTodoView, KOWhatsNextView, KOrg::MultiAgendaView, and KOProjectView.

virtual DateList KOrg::BaseView::selectedIncidenceDates (  )  [pure virtual]

Returns:
a list of the dates of selected events. Most views can probably only select a single event at a time, but some may be able to select more than one.

Implemented in KOAgendaView, KOJournalView, KOListView, KOMonthView, KOTimelineView, KOTodoView, KOWhatsNextView, and KOrg::MultiAgendaView.

virtual TQDateTime KOrg::BaseView::selectionStart (  )  [inline, virtual]

Returns the start of the selection, or an invalid TQDateTime if there is no selection or the view doesn't support selecting cells.

Reimplemented in KOAgendaView, and KOMonthView.

Definition at line 124 of file baseview.h.

virtual TQDateTime KOrg::BaseView::selectionEnd (  )  [inline, virtual]

Returns the end of the selection, or an invalid TQDateTime if there is no selection or the view doesn't support selecting cells.

Reimplemented in KOAgendaView, and KOMonthView.

Definition at line 130 of file baseview.h.

virtual int KOrg::BaseView::currentDateCount (  )  [pure virtual]

Return number of currently shown dates.

A return value of 0 means no idea.

Implemented in KOAgendaView, KOJournalView, KOListView, KOMonthView, KOTimelineView, KOTodoView, KOWhatsNextView, KOrg::MultiAgendaView, and KOProjectView.

virtual bool KOrg::BaseView::isEventView (  )  [inline, virtual]

Return if this view is a view for displaying events.

Reimplemented in KOEventView.

Definition at line 143 of file baseview.h.

virtual bool KOrg::BaseView::supportsDateNavigation (  )  const [inline, virtual]

Returns true if the view supports navigation through the date navigator ( selecting a date range, changing month, changing year, etc.

)

Reimplemented in KOEventView, and KOWhatsNextView.

Definition at line 148 of file baseview.h.

virtual void KOrg::BaseView::showDates ( const TQDate &  start,
const TQDate &  end 
) [pure virtual, slot]

Show incidences for the given date range.

The date range actually shown may be different from the requested range, depending on the particular requirements of the view.

Parameters:
start Start of date range.
end End of date range.

Implemented in KOAgendaView, KOJournalView, KOListView, KOMonthView, KOTimelineView, KOTodoView, KOWhatsNextView, KOrg::MultiAgendaView, and KOProjectView.

virtual void KOrg::BaseView::showIncidences ( const Incidence::List incidenceList,
const TQDate &  date 
) [pure virtual, slot]

Show given incidences.

Depending on the actual view it might not be possible to show all given events.

Parameters:
incidenceList a list of incidences to show.
date is the TQDate on which the incidences are being shown.

Implemented in KOAgendaView, KOJournalView, KOListView, KOMonthView, KOTodoView, and KOrg::MultiAgendaView.

virtual void KOrg::BaseView::updateView (  )  [pure virtual, slot]

Updates the current display to reflect changes that may have happened in the calendar since the last display refresh.

Implemented in KOAgendaView, KOJournalView, KOListView, KOMonthView, KOTimelineView, KOTodoView, KOWhatsNextView, KOrg::MultiAgendaView, and KOProjectView.

virtual void KOrg::BaseView::setIncidenceChanger ( IncidenceChangerBase *  changer  )  [inline, virtual, slot]

Assign a new incidence change helper object.

Reimplemented in KOAgendaView, KOTodoView, and KOrg::MultiAgendaView.

Definition at line 180 of file baseview.h.

virtual void KOrg::BaseView::flushView (  )  [inline, virtual, slot]

Write all unsaved data back to calendar store.

Reimplemented in KOJournalView.

Definition at line 185 of file baseview.h.

virtual void KOrg::BaseView::changeIncidenceDisplay ( Incidence ,
int   
) [pure virtual, slot]

Updates the current display to reflect the changes to one particular incidence.

Implemented in KOAgendaView, KOJournalView, KOListView, KOMonthView, KOTimelineView, KOTodoView, KOWhatsNextView, KOrg::MultiAgendaView, and KOProjectView.

virtual void KOrg::BaseView::updateConfig (  )  [inline, virtual, slot]

Re-reads the KOrganizer configuration and picks up relevant changes which are applicable to the view.

Reimplemented in KOAgendaView, KOMonthView, KOTodoView, KOrg::MultiAgendaView, and KOProjectView.

Definition at line 196 of file baseview.h.

virtual void KOrg::BaseView::clearSelection (  )  [inline, virtual, slot]

Clear selection.

The incidenceSelected signal is not emitted.

Reimplemented in KOAgendaView, KOListView, KOMonthView, and KOTodoView.

Definition at line 201 of file baseview.h.

virtual bool KOrg::BaseView::eventDurationHint ( TQDateTime &  ,
TQDateTime &  ,
bool &   
) [inline, virtual, slot]

Set the default start/end date/time for new events.

Return true if anything was changed

Reimplemented in KOAgendaView, KOMonthView, KOTimelineView, and KOrg::MultiAgendaView.

Definition at line 206 of file baseview.h.

void KOrg::BaseView::showIncidenceSignal ( Incidence ,
const TQDate &   
) [signal]

instructs the receiver to show the incidence in read-only mode.

void KOrg::BaseView::editIncidenceSignal ( Incidence ,
const TQDate &   
) [signal]

instructs the receiver to begin editing the incidence specified in some manner.

Doesn't make sense to connect to more than one receiver.

void KOrg::BaseView::deleteIncidenceSignal ( Incidence  )  [signal]

instructs the receiver to delete the Incidence in some manner; some possibilities include automatically, with a confirmation dialog box, etc.

Doesn't make sense to connect to more than one receiver.

void KOrg::BaseView::cutIncidenceSignal ( Incidence  )  [signal]

instructs the receiver to cut the Incidence

void KOrg::BaseView::copyIncidenceSignal ( Incidence  )  [signal]

instructs the receiver to copy the incidence

void KOrg::BaseView::pasteIncidenceSignal (  )  [signal]

instructs the receiver to paste the incidence

void KOrg::BaseView::toggleAlarmSignal ( Incidence  )  [signal]

instructs the receiver to toggle the alarms of the Incidence.

void KOrg::BaseView::dissociateOccurrenceSignal ( Incidence ,
const TQDate &   
) [signal]

Dissociate from a recurring incidence the occurrence on the given date to a new incidence.

void KOrg::BaseView::dissociateFutureOccurrenceSignal ( Incidence ,
const TQDate &   
) [signal]

Dissociate from a recurring incidence all occurrences after the given date to a new incidence.

void KOrg::BaseView::newEventSignal ( ResourceCalendar res,
const TQString &  subResource 
) [signal]

instructs the receiver to create a new event.

Doesn't make sense to connect to more than one receiver.

void KOrg::BaseView::newEventSignal ( ResourceCalendar res,
const TQString &  subResource,
const TQDate &   
) [signal]

instructs the receiver to create a new event with the specified beginning time.

Doesn't make sense to connect to more than one receiver.

void KOrg::BaseView::newEventSignal ( ResourceCalendar res,
const TQString &  subResource,
const TQDateTime &   
) [signal]

instructs the receiver to create a new event with the specified beginning time.

Doesn't make sense to connect to more than one receiver.

void KOrg::BaseView::newEventSignal ( ResourceCalendar res,
const TQString &  subResource,
const TQDateTime &  ,
const TQDateTime &   
) [signal]

instructs the receiver to create a new event, with the specified beginning end ending times.

Doesn't make sense to connect to more than one receiver.


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