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:

QWidget KOEventView KOJournalView KOProjectView KOTodoView KOWhatsNextView KOAgendaView KOListView List of all members.

Public Slots

virtual void showDates (const QDate &start, const QDate &end)=0
virtual void showEvents (const Event::List &eventList)=0
virtual void updateView ()=0
virtual void flushView ()
virtual void changeEventDisplay (Event *, int)=0
virtual void updateConfig ()
virtual void clearSelection ()

Signals

void incidenceSelected (Incidence *)

Public Methods

 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 63 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 75 of file baseview.h.

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

Destructor.

Views will do view-specific cleanups here.

Definition at line 81 of file baseview.h.


Member Function Documentation

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

Return calendar object of this view.

Definition at line 87 of file baseview.h.

Referenced by KOAgendaView::fillAgenda(), KOListView::showDates(), KOJournalView::showDates(), KOAgendaView::slotTodoDropped(), KOWhatsNextView::updateView(), KOTodoView::updateView(), and KOProjectView::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, KOTodoView, KOWhatsNextView, and KOProjectView.

Referenced by CalendarView::action_mail().

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

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

Referenced by CalendarView::adaptNavigationUnits().

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.

Referenced by CalendarView::action_mail(), CalendarView::adaptNavigationUnits(), and 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, KOTodoView, KOWhatsNextView, and KOProjectView.

virtual void KOrg::BaseView::showEvents const Event::List &    eventList [pure virtual, slot]
 

Show given events.

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

Referenced by CalendarView::changeEventDisplay(), and CalendarView::updateTodoViews().

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.

Referenced by CalendarView::saveCalendar().

virtual void KOrg::BaseView::changeEventDisplay Event *   ,
int   
[pure virtual, slot]
 

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

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

Referenced by CalendarView::changeEventDisplay().

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

Definition at line 189 of file baseview.h.


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.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat May 1 11:38:33 2004 by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2003