KDE PIM / Developers / API Docs / korganizer

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>

Inherits QWidget.

Inherited by KOEventView, KOJournalView, KOProjectView, KOTodoView, and KOWhatsNextView.

List of all members.

Public Slots

Signals

Public Member Functions

Protected Attributes


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


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.

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

Destructor.

Views will do view-specific cleanups here.


Member Function Documentation

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

Return calendar object of this view.

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 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.

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 &  incidenceList  )  [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.

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::setIncidenceChanger IncidenceChangerBase *  changer  )  [inline, virtual, slot]
 

Assign a new incidence change helper object.

Reimplemented in KOAgendaView, KOJournalView, and KOTodoView.

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

Write all unsaved data back to calendar store.

Reimplemented in KOJournalView.

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.

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

Clear selection.

The incidenceSelected signal is not emitted.

Reimplemented in KOAgendaView, KOListView, KOMonthView, and KOTodoView.

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.

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

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

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.

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::toggleAlarmSignal Incidence *   )  [signal]
 

instructs the receiver to toggle the alarms of the Incidence.

void KOrg::BaseView::dissociateOccurrenceSignal Incidence *  ,
const QDate & 
[signal]
 

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

void KOrg::BaseView::dissociateFutureOccurrenceSignal Incidence *  ,
const QDate & 
[signal]
 

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

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 const 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 const 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 const QDateTime &  ,
const 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: