korganizer Library API Documentation

KOAgendaView Class Reference

KOAgendaView is the agenda-like view used to display events in an one or multi-day view. More...

#include <koagendaview.h>

Inheritance diagram for KOAgendaView:

KOEventView KOrg::BaseView QWidget List of all members.

Public Slots

virtual void updateView ()
 Updates the current display to reflect changes that may have happened in the calendar since the last display refresh.

virtual void updateConfig ()
 Re-reads the KOrganizer configuration and picks up relevant changes which are applicable to the view.

virtual void showDates (const QDate &start, const QDate &end)
 Show incidences for the given date range.

virtual void showEvents (QPtrList< Event > eventList)
 Show given events.

void changeEventDisplay (Event *, int)
 Updates the current display to reflect the changes to one particular event.

void clearSelection ()
 Clear selection.

void newEvent (int gx, int gy)
void newEvent (int gxStart, int gyStart, int gxEnd, int gyEnd)
void newEventAllDay (int gx, int gy)
void startDrag (Event *)
void readSettings ()
void readSettings (KConfig *)
void writeSettings (KConfig *)
void setContentsPos (int y)
void setExpandedButton (bool expanded)

Signals

void editEventSignal (Event *)
 instructs the receiver to begin editing the event specified in some manner.

void showEventSignal (Event *)
 instructs the receiver to show the event in read-only mode.

void deleteEventSignal (Event *)
 instructs the receiver to delete the event in some manner; some possibilities include automatically, with a confirmation dialog box, etc.

void newEventSignal ()
 instructs the receiver to create a new event.

void newEventSignal (QDate)
 instructs the receiver to create a new event with the specified beginning time.

void newEventSignal (QDateTime)
 instructs the receiver to create a new event with the specified beginning time.

void newEventSignal (QDateTime, QDateTime)
 instructs the receiver to create a new event, with the specified beginning end ending times.

void toggleExpand ()
void eventChanged ()

Public Member Functions

 KOAgendaView (Calendar *cal, QWidget *parent=0, const char *name=0)
virtual int maxDatesHint ()
 Returns maximum number of days supported by the koagendaview.

virtual int currentDateCount ()
 Returns number of currently shown dates.

virtual QPtrList< Incidence > selectedIncidences ()
 returns the currently selected events

virtual DateList selectedDates ()
 returns the currently selected events

void clearView ()
 Remove all events from view.

virtual void printPreview (CalPrinter *calPrinter, const QDate &, const QDate &)
 Generate a print preview of this event view.

QDateTime selectionStart ()
 start-datetime of selection

QDateTime selectionEnd ()
 end-datetime of selection

bool selectedIsAllDay ()
 returns true if selection is for whole day

void deleteSelectedDateTime ()
 make selected start/end invalid


Protected Slots

void updateEventDates (KOAgendaItem *item)
 Update event belonging to agenda item.

void showAgendaPopup (Event *event)
void showAllDayAgendaPopup (Event *event)
void updateEventIndicatorTop (int newY)
void updateEventIndicatorBottom (int newY)
void newTimeSpanSelected (int gxStart, int gyStart, int gxEnd, int gyEnd)
 Updates data for selected timespan.

void newTimeSpanSelectedAllDay (int gxStart, int gyStart, int gxEnd, int gyEnd)
 Updates data for selected timespan for all day event.


Protected Member Functions

void fillAgenda (const QDate &startDate)
 Fill agenda beginning with date startDate.

void fillAgenda ()
 Fill agenda using the current set value for the start date.

void createDayLabels ()
 Create labels for the selected dates.

void setHolidayMasks ()
 Set the masks on the agenda widgets indicating, which days are holidays.


Detailed Description

KOAgendaView is the agenda-like view used to display events in an one or multi-day view.

Definition at line 104 of file koagendaview.h.


Member Function Documentation

int KOAgendaView::maxDatesHint  )  [virtual]
 

Returns maximum number of days supported by the koagendaview.

Implements KOEventView.

Definition at line 480 of file koagendaview.cpp.

int KOAgendaView::currentDateCount  )  [virtual]
 

Returns number of currently shown dates.

Implements KOrg::BaseView.

Definition at line 486 of file koagendaview.cpp.

QPtrList< Incidence > KOAgendaView::selectedIncidences  )  [virtual]
 

returns the currently selected events

Implements KOrg::BaseView.

Definition at line 491 of file koagendaview.cpp.

References QPtrList::append(), and QWidget::event().

DateList KOAgendaView::selectedDates  )  [virtual]
 

returns the currently selected events

Implements KOrg::BaseView.

Definition at line 505 of file koagendaview.cpp.

References QDate::isValid().

void KOAgendaView::clearView  ) 
 

Remove all events from view.

Definition at line 731 of file koagendaview.cpp.

void KOAgendaView::printPreview CalPrinter calPrinter,
const QDate fd,
const QDate td
[virtual]
 

Generate a print preview of this event view.

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

Reimplemented from KOrg::BaseView.

Definition at line 738 of file koagendaview.cpp.

References CalPrinter::preview().

QDateTime KOAgendaView::selectionStart  )  [inline]
 

start-datetime of selection

Definition at line 129 of file koagendaview.h.

Referenced by CalendarView::newEvent().

QDateTime KOAgendaView::selectionEnd  )  [inline]
 

end-datetime of selection

Definition at line 131 of file koagendaview.h.

Referenced by CalendarView::newEvent().

bool KOAgendaView::selectedIsAllDay  )  [inline]
 

returns true if selection is for whole day

Definition at line 133 of file koagendaview.h.

Referenced by CalendarView::newEvent().

void KOAgendaView::deleteSelectedDateTime  ) 
 

make selected start/end invalid

Definition at line 935 of file koagendaview.cpp.

References QDateTime::setDate().

Referenced by fillAgenda(), and KOViewManager::showView().

void KOAgendaView::updateView  )  [virtual, slot]
 

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

Implements KOrg::BaseView.

Definition at line 520 of file koagendaview.cpp.

References fillAgenda().

Referenced by updateConfig().

void KOAgendaView::updateConfig  )  [virtual, slot]
 

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

Reimplemented from KOrg::BaseView.

Definition at line 531 of file koagendaview.cpp.

References createDayLabels(), QWidget::setFixedWidth(), setHolidayMasks(), and updateView().

void KOAgendaView::showDates const QDate start,
const QDate end
[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.

Implements KOrg::BaseView.

Definition at line 602 of file koagendaview.cpp.

References QDate::addDays(), and fillAgenda().

void KOAgendaView::showEvents QPtrList< Event >  eventList  )  [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.

Implements KOrg::BaseView.

Definition at line 619 of file koagendaview.cpp.

void KOAgendaView::changeEventDisplay Event *  ,
int 
[virtual, slot]
 

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

Implements KOrg::BaseView.

Definition at line 624 of file koagendaview.cpp.

References fillAgenda().

void KOAgendaView::clearSelection  )  [virtual, slot]
 

Clear selection.

The incidenceSelected signal is not emitted.

Reimplemented from KOrg::BaseView.

Definition at line 904 of file koagendaview.cpp.

void KOAgendaView::editEventSignal Event *   )  [signal]
 

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

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

Reimplemented from KOEventView.

void KOAgendaView::showEventSignal Event *   )  [signal]
 

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

Reimplemented from KOEventView.

void KOAgendaView::deleteEventSignal Event *   )  [signal]
 

instructs the receiver to delete the event in some manner; some possibilities include automatically, with a confirmation dialog box, etc.

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

Reimplemented from KOEventView.

void KOAgendaView::newEventSignal  )  [signal]
 

instructs the receiver to create a new event.

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

Reimplemented from KOEventView.

void KOAgendaView::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.

Reimplemented from KOEventView.

void KOAgendaView::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.

Reimplemented from KOEventView.

void KOAgendaView::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.

Reimplemented from KOEventView.

void KOAgendaView::fillAgenda const QDate startDate  )  [protected]
 

Fill agenda beginning with date startDate.

Definition at line 632 of file koagendaview.cpp.

References fillAgenda().

void KOAgendaView::fillAgenda  )  [protected]
 

Fill agenda using the current set value for the start date.

Definition at line 637 of file koagendaview.cpp.

References QPtrList::at(), KOrg::BaseView::calendar(), QPtrList::count(), createDayLabels(), QDate::daysTo(), deleteSelectedDateTime(), QWidget::event(), QMemArray< int >::resize(), and setHolidayMasks().

Referenced by changeEventDisplay(), fillAgenda(), showDates(), and updateView().

void KOAgendaView::createDayLabels  )  [protected]
 

Create labels for the selected dates.

Definition at line 423 of file koagendaview.cpp.

References QBoxLayout::addSpacing(), QBoxLayout::addWidget(), QDate::currentDate(), QPtrList::first(), QWidget::font(), QString::isEmpty(), QPtrList::next(), QLabel::setAlignment(), QFont::setBold(), QLabel::setFont(), QLabel::setText(), KOrg::CalendarDecoration::shortText(), and KOrg::CalendarDecoration::smallWidget().

Referenced by fillAgenda(), and updateConfig().

void KOAgendaView::setHolidayMasks  )  [protected]
 

Set the masks on the agenda widgets indicating, which days are holidays.

Definition at line 863 of file koagendaview.cpp.

References QDate::dayOfWeek(), and QMemArray< bool >::resize().

Referenced by fillAgenda(), and updateConfig().

void KOAgendaView::updateEventDates KOAgendaItem *  item  )  [protected, slot]
 

Update event belonging to agenda item.

Definition at line 561 of file koagendaview.cpp.

References QDate::addDays(), QDateTime::date(), QDateTime::setDate(), and QDateTime::setTime().

void KOAgendaView::newTimeSpanSelected int  gxStart,
int  gyStart,
int  gxEnd,
int  gyEnd
[protected, slot]
 

Updates data for selected timespan.

Definition at line 917 of file koagendaview.cpp.

Referenced by newTimeSpanSelectedAllDay().

void KOAgendaView::newTimeSpanSelectedAllDay int  gxStart,
int  gyStart,
int  gxEnd,
int  gyEnd
[protected, slot]
 

Updates data for selected timespan for all day event.

Definition at line 910 of file koagendaview.cpp.

References newTimeSpanSelected().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.4.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Sat Oct 18 02:47:32 2003 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2001