KDE PIM / Developers / API Docs / korganizer

CalendarView Class Reference

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

#include <calendarview.h>

Inherits KOrg::CalendarViewBase, and Observer.

List of all members.

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions


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 synchronization of the different views and controls the different dialogs like preferences, event editor, search dialog etc.

Author:
Cornelius Schumacher


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

Member Function Documentation

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

changes the view to be the currently selected view

Implements KOrg::CalendarViewBase.

void CalendarView::addExtension CalendarViewExtension::Factory *   ) 
 

Add calendar view extension widget.

CalendarView takes ownership of the objects created by the factory.

Incidence * CalendarView::currentSelection  )  [virtual]
 

currentSelection() returns a pointer to the incidence selected in the current view

Implements KOrg::CalendarViewBase.

Incidence * CalendarView::selectedIncidence  ) 
 

Return a pointer to the incidence selected in the current view.

If there is no selection, return the selected todo from the todo list on the left

QString CalendarView::currentFilterName  )  const
 

Returns the name of the current filter.

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.

void CalendarView::categoriesChanged  )  [signal]
 

Emitted when the categories were updated, and thus the categories editor dialog needs to reload the list of categories.

void CalendarView::closingDown  )  [signal]
 

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

void CalendarView::closed QWidget *   )  [signal]
 

emitted right before we die

void CalendarView::modifiedChanged bool   )  [signal]
 

Emitted when state of modified flag changes.

void CalendarView::readOnlyChanged bool   )  [signal]
 

Emitted when state of read-only flag changes.

void CalendarView::changeNavStringPrev const QString &   )  [signal]
 

Emitted when the unit of navigation changes.

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.

void CalendarView::todoSelected bool   )  [signal]
 

Emitted, when a todoitem is selected or deselected.

the connected slots enables/disables the corresponding menu items

void CalendarView::dayPassed const QDate &   )  [signal]
 

Emitted, when a day changed (i.e.

korganizer was running at midnight). The argument is the new date

void CalendarView::cancelAttendees Incidence *   )  [signal]
 

Attendees were removed from this incidence.

Only the removed attendees are present in the incidence, so we just need to send a cancel messages to all attendees groupware messages are enabled at all.

void CalendarView::pasteEnabled bool   )  [signal]
 

Emitted, when clipboard content changes.

Parameter indicates if paste is possible or not.

void CalendarView::statusMessage const QString &   )  [signal]
 

Send status message, which can e.g.

be displayed in the status bar.

void CalendarView::autoArchivingSettingsModified  )  [signal]
 

Emitted when auto-archiving options were modified.

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.

void CalendarView::updateCategories  )  [virtual, slot]
 

Calendar configuration was changed, so refresh categories list.

Implements KOrg::CalendarViewBase.

bool CalendarView::openCalendar const 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.

bool CalendarView::saveCalendar const QString &  filename  )  [slot]
 

Save calendar data to file.

Return true if calendar could be successfully saved.

void CalendarView::closeCalendar  )  [slot]
 

Close calendar.

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

void CalendarView::archiveCalendar  )  [slot]
 

Archive old events of calendar.

void CalendarView::newEvent const QDateTime &  ,
const QDateTime &  ,
bool  allDay = false
[slot]
 

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

void CalendarView::newEvent  )  [slot]
 

create new event without having a date hint.

Takes current date as default hint.

void CalendarView::newEvent const QString &   )  [slot]
 

Create new Event from given string.

void CalendarView::showIncidence Incidence *   )  [slot]
 

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

It calls the correct showXXX method

bool CalendarView::editIncidence Incidence *   )  [slot]
 

Create an editor for the supplied incidence.

It calls the correct editXXX method

void CalendarView::deleteIncidence Incidence *   )  [slot]
 

Delete the supplied incidence.

It calls the correct deleteXXX method

void CalendarView::deleteSubTodosIncidence Todo *  todo  )  [slot]
 

Delete the supplied todo and all sub-todos.

void CalendarView::deleteTodoIncidence Todo *  todo  )  [slot]
 

Delete the todo incidence, this is special to can delete sub-to-dos.

bool CalendarView::deleteEvent Event *   )  [inline, slot]
 

Check if deleting the supplied event is allowed.

bool CalendarView::deleteTodo Todo *   )  [inline, slot]
 

Check if deleting the todo is allowed.

bool CalendarView::deleteJournal Journal *   )  [inline, slot]
 

Check if deleting the supplied journal is allowed.

bool CalendarView::deleteIncidence const QString &  uid  )  [slot]
 

Delete the event with the given unique ID.

Returns false, if event wasn't found.

void CalendarView::newTodo  )  [slot]
 

create new todo

void CalendarView::newTodo const QDate &  date  )  [slot]
 

create new todo, due on date

void CalendarView::newSubTodo  )  [slot]
 

create new todo with a parent todo

void CalendarView::newSubTodo Todo *   )  [slot]
 

create new todo with a parent todo

void CalendarView::checkClipboard  )  [slot]
 

Check if clipboard contains vCalendar event.

The signal pasteEnabled() is emitted as result.

void CalendarView::readSettings  )  [slot]
 

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

You have to call setCalendar before calling readSettings.

void CalendarView::writeSettings  )  [slot]
 

write current state to config file.

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

read settings for calendar filters

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

write settings for calendar filters

void CalendarView::changeIncidenceDisplay Incidence *  ,
int 
[slot]
 

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

void CalendarView::edit_cut  )  [slot]
 

cut the current appointment to the clipboard

void CalendarView::edit_copy  )  [slot]
 

copy the current appointment(s) to the clipboard

void CalendarView::edit_paste  )  [slot]
 

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

void CalendarView::edit_options  )  [slot]
 

edit viewing and configuration options.

void CalendarView::print  )  [slot]
 

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

void CalendarView::exportWeb  )  [slot]
 

Export as HTML file.

void CalendarView::exportICalendar  )  [slot]
 

Export as iCalendar file.

void CalendarView::exportVCalendar  )  [slot]
 

Export as vCalendar file.

void CalendarView::appointment_show  )  [slot]
 

pop up a dialog to show an existing appointment.

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.

void CalendarView::appointment_delete  )  [slot]
 

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

bool CalendarView::makeSubTodosIndependents  )  [slot]
 

Make all sub-to-dos of todo independents, update the view.

bool CalendarView::makeSubTodosIndependents Todo *  todo  )  [slot]
 

Make all sub-to-dos of todo independents, not update the view.

void CalendarView::takeOverEvent  )  [slot]
 

Take ownership of selected event.

void CalendarView::takeOverCalendar  )  [slot]
 

Take ownership of all events in calendar.

bool CalendarView::isModified  )  [slot]
 

query whether or not the calendar is "dirty".

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

set the state of calendar.

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

bool CalendarView::isReadOnly  )  [slot]
 

query if the calendar is read-only.

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

set state of calendar to read-only

void CalendarView::updateFilter  )  [slot]
 

Filter configuration changed.

void CalendarView::goDate const QDate &  date  )  [slot]
 

Move the current view date to the specified date.

void CalendarView::goToday  )  [slot]
 

Move the current view date to today.

void CalendarView::goNext  )  [slot]
 

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

void CalendarView::goPrevious  )  [slot]
 

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

void CalendarView::filterActivated int  filterNo  )  [slot]
 

A different filter was selected.

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

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

void CalendarView::adaptNavigationUnits  ) 
 

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


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