korganizer Library API Documentation

CalendarView Class Reference

This is the main calendar widget. main calendar view widget. More...

#include <calendarview.h>

Inheritance diagram for CalendarView:

KOrg::CalendarViewBase QWidget List of all members.

Public Slots

void updateConfig ()
 options dialog made a changed to the configuration.

bool openCalendar (QString filename, bool merge=false)
 Load calendar from file filename.

bool saveCalendar (QString filename)
 Save calendar data to file.

void closeCalendar ()
 Close calendar.

void archiveCalendar ()
 Archive old events of calendar.

void showIncidence ()
void editIncidence ()
void deleteIncidence ()
void newEvent (QDateTime, QDateTime)
 create an editeventwin with supplied date/time, and if bool is true, make the event take all day.

void newEvent (QDateTime, QDateTime, bool allDay)
void newEvent (QDateTime fh)
void newEvent (QDate dt)
void newEvent ()
 create new event without having a date hint.

void newFloatingEvent ()
void editEvent (Event *)
 Create an editor for the supplied event.

void deleteEvent (Event *)
 Delete the supplied event.

bool deleteEvent (const QString &uid)
 Delete the event with the given unique ID.

void showEvent (Event *)
 Create a read-only viewer dialog for the supplied event.

void editTodo (Todo *)
 Create an editor dialog for a todo.

void showTodo (Todo *)
 Create a read-only viewer dialog for the supplied todo.

void newTodo ()
 create new todo

void newSubTodo ()
 create new todo with a parent todo

void newSubTodo (Todo *)
 create new todo with a parent todo

void deleteTodo (Todo *)
 Delete todo.

void todoModified (Todo *, int)
 This todo has been modified.

void checkClipboard ()
 Check if clipboard contains vCalendar event.

void readSettings ()
 using the KConfig associated with the kapp variable, read in the settings from the config file.

void writeSettings ()
 write current state to config file.

void readFilterSettings (KConfig *config)
 read settings for calendar filters

void writeFilterSettings (KConfig *config)
 write settings for calendar filters

void changeEventDisplay (Event *, int)
 passes on the message that an event has changed to the currently activated view so that it can make appropriate display changes.

void eventAdded (Event *)
void eventChanged (Event *)
void eventToBeDeleted (Event *)
void eventDeleted ()
void updateView (const QDate &start, const QDate &end)
void updateView ()
void updateTodoViews ()
 Full update of visible todo views.

void updateUnmanagedViews ()
void edit_cut ()
 cut the current appointment to the clipboard

void edit_copy ()
 copy the current appointment(s) to the clipboard

void edit_paste ()
 paste the current vobject(s) in the clipboard buffer into calendar

void edit_options ()
 edit viewing and configuration options.

void print ()
 Functions for printing, previewing a print, and setting up printing parameters.

void printSetup ()
void printPreview ()
void exportICalendar ()
 Export as iCalendar file.

void exportVCalendar ()
 Export as vCalendar file.

void appointment_show ()
 pop up a dialog to show an existing appointment.

void appointment_edit ()
 pop up an Appointment Dialog to edit an existing appointment.

void appointment_delete ()
 pop up dialog confirming deletion of currently selected event in the View.

void action_mail ()
 mails the currently selected event to a particular user as a vCalendar attachment.

void todo_unsub ()
void takeOverEvent ()
 Take ownership of selected event.

void takeOverCalendar ()
 Take ownership of all events in calendar.

bool isModified ()
 query whether or not the calendar is "dirty".

void setModified (bool modified=true)
 set the state of calendar.

bool isReadOnly ()
 query if the calendar is read-only.

void setReadOnly (bool readOnly=true)
 set state of calendar to read-only

void eventUpdated (Incidence *)
void schedule_publish (Incidence *incidence=0)
void schedule_request (Incidence *incidence=0)
void schedule_refresh (Incidence *incidence=0)
void schedule_cancel (Incidence *incidence=0)
void schedule_add (Incidence *incidence=0)
void schedule_reply (Incidence *incidence=0)
void schedule_counter (Incidence *incidence=0)
void schedule_declinecounter (Incidence *incidence=0)
void schedule_publish_freebusy (int daysToPublish=30)
void openAddressbook ()
void editFilters ()
void showFilter (bool visible)
void updateFilter ()
void filterEdited ()
void showIntro ()
void goToday ()
 Move the current view date to today.

void goNext ()
 Move to the next date(s) in the current view.

void goPrevious ()
 Move to the previous date(s) in the current view.

void toggleExpand ()
void dialogClosing (Incidence *)
void lookForIncomingMessages ()
 Look for new messages in the inbox.

void lookForOutgoingMessages ()
 Look for new messages in the outbox.

void processMainViewSelection (Incidence *)
void processTodoListSelection (Incidence *)
void processIncidenceSelection (Incidence *)
void purgeCompleted ()

Signals

void configChanged ()
 when change is made to options dialog, the topwidget will catch this and emit this signal which notifies all widgets which have registered for notification to update their settings.

void closingDown ()
 emitted when the topwidget is closing down, so that any attached child windows can also close.

void closed (QWidget *)
 emitted right before we die

void modifiedChanged (bool)
 Emitted when state of modified flag changes.

void readOnlyChanged (bool)
 Emitted when state of read-only flag changes.

void changeNavStringPrev (const QString &)
 Emitted when the unit of navigation changes.

void changeNavStringNext (const QString &)
void organizerEventsSelected (bool)
 Emitted when state of events selection has changed and user is organizer.

void groupEventsSelected (bool)
 Emitted when state of events selection has changed and user is attendee.

void incidenceSelected (Incidence *)
 Emitted when an incidence gets selected.

void todoSelected (bool)
 Emitted, when a todoitem is selected or deselected.

void pasteEnabled (bool)
 Emitted, when clipboard content changes.

void numIncomingChanged (int)
 Emitted, when the number of incoming messages has changed.

void numOutgoingChanged (int)
 Emitted, when the number of outgoing messages has changed.

void statusMessage (const QString &)
 Send status message, which can e.g.

void calendarViewExpanded (bool)

Public Member Functions

 CalendarView (QWidget *parent=0, const char *name=0)
 Constructs a new calendar view widget.

Calendar * calendar ()
KOViewManagerviewManager ()
KODialogManagerdialogManager ()
QDate startDate ()
QDate endDate ()
QWidgetStackviewStack ()
QWidgetleftFrame ()
DateNavigatordateNavigator ()
void addView (KOrg::BaseView *)
void showView (KOrg::BaseView *)
 changes the view to be the currently selected view

Incidence * currentSelection ()
int msgCalModified ()
void adaptNavigationUnits ()
 Adapt navigation units correpsonding to step size of navigation of the current view.


Protected Slots

void showDates (const KCal::DateList &)
 Select a view or adapt the current view to display the specified dates.


Protected Member Functions

void schedule (Scheduler::Method, Incidence *incidence=0)
int msgItemDelete ()
void signalAlarmDaemon ()
 tell the alarm daemon that we have saved, and he needs to reread

Todo * selectedTodo ()

Detailed Description

This is the main calendar widget. main calendar view widget.

It provides the different vies on t he calendar data as well as the date navigator. It also handles synchronisation of the different views and controls the different dialogs like preferences, event editor, search dialog etc.

Author:
Cornelius Schumacher

Definition at line 65 of file calendarview.h.


Constructor & Destructor Documentation

CalendarView::CalendarView QWidget parent = 0,
const char *  name = 0
 

Constructs a new calendar view widget.

Parameters:
parent parent window
name Qt internal widget object name

Definition at line 97 of file calendarview.cpp.

References QBoxLayout::addWidget(), checkClipboard(), QApplication::clipboard(), configChanged(), QDate::currentDate(), deleteTodo(), editTodo(), goNext(), goPrevious(), incidenceSelected(), isModified(), lookForIncomingMessages(), newSubTodo(), newTodo(), readSettings(), QPtrList< CalFilter >::setAutoDelete(), QWidget::setFixedHeight(), setModified(), QSplitter::setResizeMode(), showDates(), showTodo(), todoModified(), and updateConfig().


Member Function Documentation

void CalendarView::showView KOrg::BaseView  )  [virtual]
 

changes the view to be the currently selected view

Implements KOrg::CalendarViewBase.

Definition at line 1587 of file calendarview.cpp.

References KOViewManager::showView().

void CalendarView::configChanged  )  [signal]
 

when change is made to options dialog, the topwidget will catch this and emit this signal which notifies all widgets which have registered for notification to update their settings.

Referenced by CalendarView(), and updateConfig().

void CalendarView::closingDown  )  [signal]
 

emitted when the topwidget is closing down, so that any attached child windows can also close.

Referenced by closeCalendar().

void CalendarView::closed QWidget  )  [signal]
 

emitted right before we die

void CalendarView::modifiedChanged bool   )  [signal]
 

Emitted when state of modified flag changes.

Referenced by setModified().

void CalendarView::readOnlyChanged bool   )  [signal]
 

Emitted when state of read-only flag changes.

Referenced by setReadOnly().

void CalendarView::changeNavStringPrev const QString  )  [signal]
 

Emitted when the unit of navigation changes.

Referenced by adaptNavigationUnits().

void CalendarView::organizerEventsSelected bool   )  [signal]
 

Emitted when state of events selection has changed and user is organizer.

void CalendarView::groupEventsSelected bool   )  [signal]
 

Emitted when state of events selection has changed and user is attendee.

void CalendarView::incidenceSelected Incidence *   )  [signal]
 

Emitted when an incidence gets selected.

If the selection is cleared the signal is emitted with 0 as argument.

Referenced by CalendarView().

void CalendarView::todoSelected bool   )  [signal]
 

Emitted, when a todoitem is selected or deselected.

void CalendarView::pasteEnabled bool   )  [signal]
 

Emitted, when clipboard content changes.

Parameter indicates if paste is possible or not.

Referenced by checkClipboard().

void CalendarView::numIncomingChanged int   )  [signal]
 

Emitted, when the number of incoming messages has changed.

void CalendarView::numOutgoingChanged int   )  [signal]
 

Emitted, when the number of outgoing messages has changed.

void CalendarView::statusMessage const QString  )  [signal]
 

Send status message, which can e.g.

be displayed in the status bar.

void CalendarView::updateConfig  )  [slot]
 

options dialog made a changed to the configuration.

we catch this and notify all widgets which need to update their configuration.

Definition at line 516 of file calendarview.cpp.

References configChanged(), and KOViewManager::raiseCurrentView().

Referenced by CalendarView().

bool CalendarView::openCalendar QString  filename,
bool  merge = false
[slot]
 

Load calendar from file filename.

If merge is true, load calendar into existing one, if it is false, clear calendar, before loading. Return true, if calendar could be successfully loaded.

Definition at line 297 of file calendarview.cpp.

References QFile::exists(), QString::isEmpty(), KOTodoView::setDocumentId(), KODialogManager::setDocumentId(), KOViewManager::setDocumentId(), and setModified().

Referenced by KOrganizer::file_import(), and KOrganizer::openURL().

bool CalendarView::saveCalendar QString  filename  )  [slot]
 

Save calendar data to file.

Return true if calendar could be successfully saved.

Definition at line 336 of file calendarview.cpp.

References KOViewManager::currentView(), and KOrg::BaseView::flushView().

Referenced by KOrganizer::saveURL().

void CalendarView::closeCalendar  )  [slot]
 

Close calendar.

Clear calendar data and reset views to display an empty calendar.

Definition at line 355 of file calendarview.cpp.

References closingDown(), and setModified().

Referenced by KOrganizer::file_close().

void CalendarView::archiveCalendar  )  [slot]
 

Archive old events of calendar.

Definition at line 367 of file calendarview.cpp.

References KODialogManager::showArchiveDialog().

Referenced by KOrganizer::file_archive().

void CalendarView::newEvent QDateTime  ,
QDateTime 
[slot]
 

create an editeventwin with supplied date/time, and if bool is true, make the event take all day.

Definition at line 699 of file calendarview.cpp.

References KODialogManager::getEventEditor(), and KOEventEditor::newEvent().

void CalendarView::newEvent  )  [slot]
 

create new event without having a date hint.

Takes current date as default hint.

Definition at line 665 of file calendarview.cpp.

References KOViewManager::agendaView(), QDateTime::isValid(), DateNavigator::selectedDates(), KOAgendaView::selectedIsAllDay(), KOAgendaView::selectionEnd(), and KOAgendaView::selectionStart().

void CalendarView::editEvent Event *   )  [slot]
 

Create an editor for the supplied event.

Definition at line 744 of file calendarview.cpp.

References KOEventEditor::editEvent(), QMap< Incidence *, KOIncidenceEditor * >::end(), QMap< Incidence *, KOIncidenceEditor * >::find(), KODialogManager::getEventEditor(), QMap< Incidence *, KOIncidenceEditor * >::insert(), and showEvent().

Referenced by appointment_edit().

void CalendarView::deleteEvent Event *   )  [slot]
 

Delete the supplied event.

Definition at line 922 of file calendarview.cpp.

References changeEventDisplay(), KOViewManager::currentSelectionDate(), QDate::isValid(), and QDate::toString().

Referenced by appointment_delete(), KOrganizer::deleteEvent(), and deleteEvent().

bool CalendarView::deleteEvent const QString uid  )  [slot]
 

Delete the event with the given unique ID.

Returns false, if event wasn't found.

Definition at line 998 of file calendarview.cpp.

References deleteEvent().

void CalendarView::showEvent Event *   )  [slot]
 

Create a read-only viewer dialog for the supplied event.

Definition at line 795 of file calendarview.cpp.

Referenced by appointment_show(), and editEvent().

void CalendarView::editTodo Todo *   )  [slot]
 

Create an editor dialog for a todo.

Definition at line 770 of file calendarview.cpp.

References KOTodoEditor::editTodo(), QMap< Incidence *, KOIncidenceEditor * >::end(), QMap< Incidence *, KOIncidenceEditor * >::find(), KODialogManager::getTodoEditor(), QMap< Incidence *, KOIncidenceEditor * >::insert(), and showTodo().

Referenced by CalendarView().

void CalendarView::showTodo Todo *   )  [slot]
 

Create a read-only viewer dialog for the supplied todo.

Definition at line 802 of file calendarview.cpp.

Referenced by CalendarView(), and editTodo().

void CalendarView::newTodo  )  [slot]
 

create new todo

Definition at line 714 of file calendarview.cpp.

References QDateTime::currentDateTime(), KODialogManager::getTodoEditor(), and KOTodoEditor::newTodo().

Referenced by CalendarView().

void CalendarView::newSubTodo  )  [slot]
 

create new todo with a parent todo

Definition at line 721 of file calendarview.cpp.

Referenced by CalendarView().

void CalendarView::newSubTodo Todo *   )  [slot]
 

create new todo with a parent todo

Definition at line 727 of file calendarview.cpp.

References QDateTime::currentDateTime(), KODialogManager::getTodoEditor(), and KOTodoEditor::newTodo().

void CalendarView::deleteTodo Todo *   )  [slot]
 

Delete todo.

Definition at line 893 of file calendarview.cpp.

Referenced by CalendarView().

void CalendarView::todoModified Todo *  ,
int 
[slot]
 

This todo has been modified.

Definition at line 809 of file calendarview.cpp.

References QMap< Incidence *, KOIncidenceEditor * >::end(), QMap< Incidence *, KOIncidenceEditor * >::find(), KOTodoEditor::modified(), and KOViewManager::updateView().

Referenced by CalendarView().

void CalendarView::checkClipboard  )  [slot]
 

Check if clipboard contains vCalendar event.

The signal pasteEnabled() is emitted as result.

Definition at line 1460 of file calendarview.cpp.

References QApplication::clipboard(), and pasteEnabled().

Referenced by CalendarView(), and KOrganizer::KOrganizer().

void CalendarView::readSettings  )  [slot]
 

using the KConfig associated with the kapp variable, read in the settings from the config file.

Definition at line 373 of file calendarview.cpp.

References QValueList::count(), readFilterSettings(), KOViewManager::readSettings(), KOTodoView::restoreLayout(), DateNavigator::selectDates(), DateNavigator::selectWeek(), DateNavigator::selectWorkWeek(), and QSplitter::setSizes().

Referenced by CalendarView(), KOrganizer::KOrganizer(), and KOrganizer::readSettings().

void CalendarView::writeSettings  )  [slot]
 

write current state to config file.

Definition at line 413 of file calendarview.cpp.

References KOTodoView::saveLayout(), DateNavigator::selectedDates(), QSplitter::sizes(), writeFilterSettings(), and KOViewManager::writeSettings().

Referenced by KOrganizer::writeSettings().

void CalendarView::readFilterSettings KConfig *  config  )  [slot]
 

read settings for calendar filters

Definition at line 442 of file calendarview.cpp.

References QPtrList< CalFilter >::append(), QPtrList< CalFilter >::clear(), and QPtrList< CalFilter >::count().

Referenced by readSettings().

void CalendarView::writeFilterSettings KConfig *  config  )  [slot]
 

write settings for calendar filters

Definition at line 477 of file calendarview.cpp.

References QPtrList< CalFilter >::first(), and QPtrList< CalFilter >::next().

Referenced by writeSettings().

void CalendarView::changeEventDisplay Event *  ,
int 
[slot]
 

passes on the message that an event has changed to the currently activated view so that it can make appropriate display changes.

Definition at line 551 of file calendarview.cpp.

References KOrg::BaseView::changeEventDisplay(), KOViewManager::currentView(), KODialogManager::updateSearchDialog(), KOrg::BaseView::updateView(), and KOTodoView::updateView().

Referenced by deleteEvent(), edit_cut(), and edit_paste().

void CalendarView::updateTodoViews  )  [slot]
 

Full update of visible todo views.

Definition at line 571 of file calendarview.cpp.

References KOViewManager::currentView(), KOrg::BaseView::updateView(), and KOTodoView::updateView().

void CalendarView::edit_cut  )  [slot]
 

cut the current appointment to the clipboard

Definition at line 608 of file calendarview.cpp.

References changeEventDisplay(), KOViewManager::currentView(), KOrg::BaseView::isEventView(), and KOrg::BaseView::selectedIncidences().

void CalendarView::edit_copy  )  [slot]
 

copy the current appointment(s) to the clipboard

Definition at line 629 of file calendarview.cpp.

References KOViewManager::currentView(), KOrg::BaseView::isEventView(), and KOrg::BaseView::selectedIncidences().

void CalendarView::edit_paste  )  [slot]
 

paste the current vobject(s) in the clipboard buffer into calendar

Definition at line 649 of file calendarview.cpp.

References changeEventDisplay(), and DateNavigator::selectedDates().

void CalendarView::edit_options  )  [slot]
 

edit viewing and configuration options.

Definition at line 659 of file calendarview.cpp.

References KODialogManager::showOptionsDialog().

void CalendarView::print  )  [slot]
 

Functions for printing, previewing a print, and setting up printing parameters.

Definition at line 1315 of file calendarview.cpp.

References CalPrinter::print(), and DateNavigator::selectedDates().

void CalendarView::exportICalendar  )  [slot]
 

Export as iCalendar file.

Definition at line 1340 of file calendarview.cpp.

References QString::right().

void CalendarView::exportVCalendar  )  [slot]
 

Export as vCalendar file.

Definition at line 1351 of file calendarview.cpp.

References QString::right().

void CalendarView::appointment_show  )  [slot]
 

pop up a dialog to show an existing appointment.

Definition at line 821 of file calendarview.cpp.

References KOViewManager::currentView(), KOrg::BaseView::isEventView(), KOrg::BaseView::selectedIncidences(), and showEvent().

void CalendarView::appointment_edit  )  [slot]
 

pop up an Appointment Dialog to edit an existing appointment.

Get information on the appointment from the list of unique IDs that is currently in the View, called currIds.

Definition at line 841 of file calendarview.cpp.

References KOViewManager::currentView(), editEvent(), KOrg::BaseView::isEventView(), and KOrg::BaseView::selectedIncidences().

void CalendarView::appointment_delete  )  [slot]
 

pop up dialog confirming deletion of currently selected event in the View.

Definition at line 861 of file calendarview.cpp.

References KOViewManager::currentView(), deleteEvent(), KOrg::BaseView::isEventView(), and KOrg::BaseView::selectedIncidences().

void CalendarView::action_mail  )  [slot]
 

mails the currently selected event to a particular user as a vCalendar attachment.

Definition at line 1011 of file calendarview.cpp.

References KOViewManager::currentView(), QWidget::event(), KOrg::BaseView::isEventView(), and KOrg::BaseView::selectedIncidences().

void CalendarView::takeOverEvent  )  [slot]
 

Take ownership of selected event.

Definition at line 1521 of file calendarview.cpp.

void CalendarView::takeOverCalendar  )  [slot]
 

Take ownership of all events in calendar.

Definition at line 1534 of file calendarview.cpp.

References QPtrList::at(), and QPtrList::count().

bool CalendarView::isModified  )  [slot]
 

query whether or not the calendar is "dirty".

Definition at line 1277 of file calendarview.cpp.

Referenced by CalendarView(), KOrganizer::file_open(), KOrganizer::saveModifiedURL(), and KOrganizer::setTitle().

void CalendarView::setModified bool  modified = true  )  [slot]
 

set the state of calendar.

Modified means "dirty", i.e. needing a save.

Definition at line 1256 of file calendarview.cpp.

References modifiedChanged().

Referenced by CalendarView(), closeCalendar(), openCalendar(), and KOrganizer::saveURL().

bool CalendarView::isReadOnly  )  [slot]
 

query if the calendar is read-only.

Definition at line 1264 of file calendarview.cpp.

Referenced by KOrganizer::setTitle().

void CalendarView::setReadOnly bool  readOnly = true  )  [slot]
 

set state of calendar to read-only

Definition at line 1269 of file calendarview.cpp.

References readOnlyChanged().

void CalendarView::goToday  )  [slot]
 

Move the current view date to today.

Definition at line 501 of file calendarview.cpp.

References DateNavigator::selectToday().

void CalendarView::goNext  )  [slot]
 

Move to the next date(s) in the current view.

Definition at line 506 of file calendarview.cpp.

References DateNavigator::selectNext().

Referenced by CalendarView().

void CalendarView::goPrevious  )  [slot]
 

Move to the previous date(s) in the current view.

Definition at line 511 of file calendarview.cpp.

References DateNavigator::selectPrevious().

Referenced by CalendarView().

void CalendarView::lookForIncomingMessages  )  [slot]
 

Look for new messages in the inbox.

Definition at line 1670 of file calendarview.cpp.

References KODialogManager::incomingDialog().

Referenced by CalendarView(), and KOrganizer::KOrganizer().

void CalendarView::lookForOutgoingMessages  )  [slot]
 

Look for new messages in the outbox.

Definition at line 1664 of file calendarview.cpp.

References KODialogManager::outgoingDialog().

Referenced by KOrganizer::KOrganizer().

void CalendarView::showDates const KCal::DateList &   )  [protected, slot]
 

Select a view or adapt the current view to display the specified dates.

Definition at line 1473 of file calendarview.cpp.

References KOViewManager::currentView(), and KOViewManager::showAgendaView().

Referenced by CalendarView().

void CalendarView::adaptNavigationUnits  ) 
 

Adapt navigation units correpsonding to step size of navigation of the current view.

Definition at line 1378 of file calendarview.cpp.

References changeNavStringPrev(), KOrg::BaseView::currentDateCount(), KOViewManager::currentView(), and KOrg::BaseView::isEventView().

Referenced by KOViewManager::showView().

void CalendarView::signalAlarmDaemon  )  [protected]
 

tell the alarm daemon that we have saved, and he needs to reread

Definition at line 1283 of file calendarview.cpp.

References QFile::close(), QFile::open(), QFile::readLine(), and QFile::setName().


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