korganizer Library API Documentation

KOrg::BaseView Class Reference

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

#include <baseview.h>

Inheritance diagram for KOrg::BaseView:

Inheritance graph
[legend]
Collaboration diagram for KOrg::BaseView:

Collaboration graph
[legend]
List of all members.

Public Slots

virtual void showDates (const QDate &start, const QDate &end)=0
virtual void showIncidences (const Incidence::List &eventList)=0
virtual void updateView ()=0
virtual void dayPassed (QDate)
virtual void flushView ()
virtual void changeIncidenceDisplay (Incidence *, int)=0
virtual void updateConfig ()
virtual void clearSelection ()
virtual bool eventDurationHint (QDateTime &, QDateTime &, bool &)

Signals

void incidenceSelected (Incidence *)
void showIncidenceSignal (Incidence *)
void editIncidenceSignal (Incidence *)
void deleteIncidenceSignal (Incidence *)
void toggleAlarmSignal (Incidence *)
void incidenceAdded (Incidence *)
void incidenceChanged (Incidence *, Incidence *, int)
void incidenceChanged (Incidence *, Incidence *)
void incidenceDeleted (Incidence *)
void incidenceToBeDeleted (Incidence *)
void startMultiModify (const QString &)
void endMultiModify ()
void newEventSignal ()
void newEventSignal (QDate)
void newEventSignal (QDateTime)
void newEventSignal (QDateTime, QDateTime)
void newTodoSignal (QDate)
void newSubTodoSignal (Todo *)

Public Member Functions

 BaseView (Calendar *cal, QWidget *parent=0, const char *name=0)
virtual ~BaseView ()
virtual void setCalendar (Calendar *cal)
virtual Calendar * calendar ()
virtual Incidence::List selectedIncidences ()=0
virtual DateList selectedDates ()=0
virtual void printPreview (CalPrinter *, const QDate &, const QDate &)
virtual void print (CalPrinter *)
virtual CalPrinterBase::PrintType printType ()
virtual int currentDateCount ()=0
virtual bool isEventView ()

Detailed Description

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

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.

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

Definition at line 62 of file baseview.h.


Constructor & Destructor Documentation

KOrg::BaseView::BaseView Calendar *  cal,
QWidget 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 74 of file baseview.h.

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

Destructor.

Views will do view-specific cleanups here.

Definition at line 80 of file baseview.h.


Member Function Documentation

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

Return calendar object of this view.

Definition at line 86 of file baseview.h.

Referenced by KOTodoView::changeIncidenceDisplay(), KOAgendaView::fillAgenda(), KOListView::showDates(), KOJournalView::showDates(), KOAgendaView::slotTodoDropped(), KOWhatsNextView::updateView(), KOTodoView::updateView(), KOProjectView::updateView(), KOMonthView::updateView(), and KOJournalView::updateView().

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, KOTodoView, KOWhatsNextView, and KOProjectView.

virtual DateList KOrg::BaseView::selectedDates  )  [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, KOTodoView, KOWhatsNextView, and KOProjectView.

virtual void KOrg::BaseView::printPreview CalPrinter ,
const QDate ,
const QDate
[inline, virtual]
 

Generate a print preview of this event view.

Parameters:
calPrinter Calendar printer object used for printing
fd from date
td to date

Reimplemented in KOAgendaView, KOListView, KOMonthView, KOTodoView, and KOWhatsNextView.

Definition at line 114 of file baseview.h.

virtual void KOrg::BaseView::print CalPrinter  )  [inline, virtual]
 

Print this view.

Parameters:
calPrinter Calendar printer object used for printing

Definition at line 125 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, KOTodoView, KOWhatsNextView, 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 142 of file baseview.h.

Referenced by KOViewManager::showView().

virtual void KOrg::BaseView::showDates const QDate start,
const QDate 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, KOTodoView, KOWhatsNextView, and KOProjectView.

virtual void KOrg::BaseView::showIncidences const Incidence::List &  eventList  )  [pure virtual, slot]
 

Show given incidences.

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

Parameters:
eventList a list of events to show.

Implemented in KOAgendaView, KOJournalView, KOListView, KOMonthView, KOTodoView, KOWhatsNextView, and KOProjectView.

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, KOTodoView, KOWhatsNextView, and KOProjectView.

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

Write all unsaved data back to calendar store.

Reimplemented in KOJournalView.

Definition at line 173 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, KOTodoView, KOWhatsNextView, 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, and KOProjectView.

Definition at line 184 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 189 of file baseview.h.

virtual bool KOrg::BaseView::eventDurationHint QDateTime ,
QDateTime ,
bool & 
[inline, virtual, slot]
 

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

Return true if anything was changed

Reimplemented in KOAgendaView, and KOMonthView.

Definition at line 194 of file baseview.h.

void KOrg::BaseView::showIncidenceSignal Incidence *   )  [signal]
 

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

Referenced by KOEventView::defaultAction(), and KOEventView::eventPopup().

void KOrg::BaseView::editIncidenceSignal Incidence *   )  [signal]
 

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

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

Referenced by KOEventView::defaultAction(), and KOEventView::eventPopup().

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.

Referenced by KOEventView::eventPopup().

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

instructs the receiver to toggle the alarms of the Incidence.

Referenced by KOEventView::eventPopup().

void KOrg::BaseView::newEventSignal  )  [signal]
 

instructs the receiver to create a new event.

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

void KOrg::BaseView::newEventSignal QDate   )  [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 QDateTime   )  [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 QDateTime  ,
QDateTime 
[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:
KDE Logo
This file is part of the documentation for korganizer Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Oct 4 14:43:40 2007 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003