korganizer
KOrg::BaseView Class Reference
#include <baseview.h>
Inheritance diagram for KOrg::BaseView:

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.
- See also:
- KOTodoView, KOEventView, KOListView, KOAgendaView, KOMonthView
Definition at line 57 of file baseview.h.
Public Slots | |
virtual void | showDates (const QDate &start, const QDate &end)=0 |
virtual void | showIncidences (const Incidence::List &incidenceList)=0 |
virtual void | updateView ()=0 |
virtual void | dayPassed (const QDate &) |
virtual void | setIncidenceChanger (IncidenceChangerBase *changer) |
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 | cutIncidenceSignal (Incidence *) |
void | copyIncidenceSignal (Incidence *) |
void | toggleAlarmSignal (Incidence *) |
void | dissociateOccurrenceSignal (Incidence *, const QDate &) |
void | dissociateFutureOccurrenceSignal (Incidence *, const QDate &) |
void | startMultiModify (const QString &) |
void | endMultiModify () |
void | newEventSignal () |
void | newEventSignal (const QDate &) |
void | newEventSignal (const QDateTime &) |
void | newEventSignal (const QDateTime &, const QDateTime &) |
void | newTodoSignal (const QDate &) |
void | newSubTodoSignal (Todo *) |
void | newJournalSignal (const QDate &) |
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 CalPrinterBase::PrintType | printType () |
virtual int | currentDateCount ()=0 |
virtual bool | isEventView () |
Protected Attributes | |
IncidenceChangerBase * | mChanger |
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 69 of file baseview.h.
virtual KOrg::BaseView::~BaseView | ( | ) | [inline, virtual] |
Member Function Documentation
virtual Calendar* KOrg::BaseView::calendar | ( | ) | [inline, virtual] |
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, KOProjectView, and KOTimeSpanView.
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, KOProjectView, and KOTimeSpanView.
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, KOProjectView, and KOTimeSpanView.
virtual bool KOrg::BaseView::isEventView | ( | ) | [inline, virtual] |
Return if this view is a view for displaying events.
Reimplemented in KOEventView.
Definition at line 109 of file baseview.h.
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, KOProjectView, and KOTimeSpanView.
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, KOProjectView, and KOTimeSpanView.
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, KOProjectView, and KOTimeSpanView.
virtual void KOrg::BaseView::setIncidenceChanger | ( | IncidenceChangerBase * | changer | ) | [inline, virtual, slot] |
Assign a new incidence change helper object.
Reimplemented in KOJournalView, and KOTodoView.
Definition at line 140 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 145 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, KOProjectView, and KOTimeSpanView.
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 156 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 161 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 166 of file baseview.h.
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::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::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 occurrence on the given date to a new incidence.
void KOrg::BaseView::dissociateFutureOccurrenceSignal | ( | Incidence * | , | |
const QDate & | ||||
) | [signal] |
Dissociate from a recurring incidence all occurrences 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: