#include <baseview.h>

Inheritance diagram for KOrg::BaseView:

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 Calendar *	calendar ()

virtual void	setResource (ResourceCalendar *res, const TQString &subResource)

ResourceCalendar *	resourceCalendar ()

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

◆ BaseView()

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

◆ ~BaseView()

virtual KOrg::BaseView::~BaseView ( )

inlinevirtual

Destructor.

Views will do view-specific cleanups here.

Definition at line 79 of file baseview.h.

Member Function Documentation

◆ calendar()

virtual Calendar* KOrg::BaseView::calendar ( )

inlinevirtual

Return calendar object of this view.

Definition at line 89 of file baseview.h.

◆ changeIncidenceDisplay

virtual void KOrg::BaseView::changeIncidenceDisplay	(	Incidence *	,
		int
	)

pure virtualslot

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

Implemented in KOTimelineView.

◆ clearSelection

virtual void KOrg::BaseView::clearSelection ( )

inlinevirtualslot

Clear selection.

The incidenceSelected signal is not emitted.

Definition at line 202 of file baseview.h.

◆ copyIncidenceSignal

void KOrg::BaseView::copyIncidenceSignal ( Incidence * )

signal

instructs the receiver to copy the incidence

◆ currentDateCount()

virtual int KOrg::BaseView::currentDateCount ( )

pure virtual

Return number of currently shown dates.

A return value of 0 means no idea.

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

◆ cutIncidenceSignal

void KOrg::BaseView::cutIncidenceSignal ( Incidence * )

signal

instructs the receiver to cut the Incidence

◆ deleteIncidenceSignal

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.

◆ dissociateFutureOccurrenceSignal

void KOrg::BaseView::dissociateFutureOccurrenceSignal	(	Incidence *	,
		const TQDate &
	)

signal

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

◆ dissociateOccurrenceSignal

void KOrg::BaseView::dissociateOccurrenceSignal	(	Incidence *	,
		const TQDate &
	)

signal

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

◆ editIncidenceSignal

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.

◆ eventDurationHint

virtual bool KOrg::BaseView::eventDurationHint	(	TQDateTime &	,
		TQDateTime &	,
		bool &
	)

inlinevirtualslot

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

Return true if anything was changed

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

Definition at line 207 of file baseview.h.

◆ flushView

virtual void KOrg::BaseView::flushView ( )

inlinevirtualslot

Write all unsaved data back to calendar store.

Definition at line 186 of file baseview.h.

◆ isEventView()

virtual bool KOrg::BaseView::isEventView ( )

inlinevirtual

Return if this view is a view for displaying events.

Reimplemented in KOEventView.

Definition at line 144 of file baseview.h.

◆ newEventSignal [1/4]

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.

◆ newEventSignal [2/4]

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.

◆ newEventSignal [3/4]

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.

◆ newEventSignal [4/4]

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.

◆ pasteIncidenceSignal

void KOrg::BaseView::pasteIncidenceSignal ( )

signal

instructs the receiver to paste the incidence

◆ resourceCalendar()

ResourceCalendar* KOrg::BaseView::resourceCalendar ( )

inline

Return resourceCalendar of this view.

Definition at line 100 of file baseview.h.

◆ selectedIncidenceDates()

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 KOrg::MultiAgendaView, KOWhatsNextView, KOTodoView, KOTimelineView, KOMonthView, KOListView, KOJournalView, and KOAgendaView.

◆ selectedIncidences()

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 KOProjectView, KOrg::MultiAgendaView, KOWhatsNextView, KOTodoView, KOTimelineView, KOMonthView, KOListView, KOJournalView, and KOAgendaView.

◆ selectionEnd()

virtual TQDateTime KOrg::BaseView::selectionEnd ( )

inlinevirtual

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 KOMonthView, and KOAgendaView.

Definition at line 131 of file baseview.h.

◆ selectionStart()

virtual TQDateTime KOrg::BaseView::selectionStart ( )

inlinevirtual

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 KOMonthView, and KOAgendaView.

Definition at line 125 of file baseview.h.

◆ setIncidenceChanger

virtual void KOrg::BaseView::setIncidenceChanger ( IncidenceChangerBase * changer )

inlinevirtualslot

Assign a new incidence change helper object.

Reimplemented in KOTodoView.

Definition at line 181 of file baseview.h.

◆ setReadOnly()

void KOrg::BaseView::setReadOnly ( bool readonly )

inline

Flag indicating if the view is read-only.

Definition at line 82 of file baseview.h.

◆ showDates

virtual void KOrg::BaseView::showDates	(	const TQDate &	start,
		const TQDate &	end
	)

pure virtualslot

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

◆ showIncidences

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

pure virtualslot

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.

◆ showIncidenceSignal

void KOrg::BaseView::showIncidenceSignal	(	Incidence *	,
		const TQDate &
	)

signal

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

◆ subResourceCalendar()

TQString KOrg::BaseView::subResourceCalendar ( ) const

inline

Return subResourceCalendar of this view.

Definition at line 105 of file baseview.h.

◆ supportsDateNavigation()

virtual bool KOrg::BaseView::supportsDateNavigation ( ) const

inlinevirtual

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

)

Reimplemented in KOWhatsNextView, and KOEventView.

Definition at line 149 of file baseview.h.

◆ toggleAlarmSignal

void KOrg::BaseView::toggleAlarmSignal ( Incidence * )

signal

instructs the receiver to toggle the alarms of the Incidence.

◆ updateConfig

virtual void KOrg::BaseView::updateConfig ( )

inlinevirtualslot

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

Definition at line 197 of file baseview.h.

◆ updateView

virtual void KOrg::BaseView::updateView ( )

pure virtualslot

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

Implemented in KOTimelineView.

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

baseview.h

korganizer

Public Slots

Signals

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BaseView()

◆ ~BaseView()

Member Function Documentation

◆ calendar()

◆ changeIncidenceDisplay

◆ clearSelection

◆ copyIncidenceSignal

◆ currentDateCount()

◆ cutIncidenceSignal

◆ deleteIncidenceSignal

◆ dissociateFutureOccurrenceSignal

◆ dissociateOccurrenceSignal

◆ editIncidenceSignal

◆ eventDurationHint

◆ flushView

◆ isEventView()

◆ newEventSignal [1/4]

◆ newEventSignal [2/4]

◆ newEventSignal [3/4]

◆ newEventSignal [4/4]

◆ pasteIncidenceSignal

◆ resourceCalendar()

◆ selectedIncidenceDates()

◆ selectedIncidences()

◆ selectionEnd()

◆ selectionStart()

◆ setIncidenceChanger

◆ setReadOnly()

◆ showDates

◆ showIncidences

◆ showIncidenceSignal

◆ subResourceCalendar()

◆ supportsDateNavigation()

◆ toggleAlarmSignal

◆ updateConfig

◆ updateView

korganizer

korganizer