korganizer Library API Documentation

KOrganizer Class Reference

This is the main class for KOrganizer. constructs a new main window for korganizer. More...

#include <korganizer.h>

Inheritance diagram for KOrganizer:

KOrg::MainWindow List of all members.

Public Slots

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

void setActive (bool active=true)
 Sets the active state of the calendar belonging to this window.

void makeActive ()
 Make calendar active.

void showStatusMessage (const QString &)
 show status message


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 calendarActivated (KOrganizer *)
 emitted when this calendar has been made active


Public Member Functions

 KOrganizer (const char *name=0)
 Constructs a new main window.

KOrg::CalendarViewBaseview () const
bool openURL (const KURL &url, bool merge=false)
 Open calendar file from URL.

bool mergeURL (const KURL &url)
 Merge calendar file from URL to current calendar.

bool saveURL ()
 Save calendar file to URL of current calendar.

bool saveAsURL (const KURL &kurl)
 Save calendar file to URL.

bool saveModifiedURL ()
 Save calendar if it is modified by the user.

KURL getCurrentURL () const
 Get current URL.

bool openURL (QString url)
 Open calendar file from URL.

bool mergeURL (QString url)
 Open calendar file from URL.

bool saveAsURL (QString url)
 Save calendar file to URL.

void closeURL ()
 Close calendar file opened from URL.

QString getCurrentURLasString () const
 Get current URL as QString.

virtual bool deleteEvent (QString uid)
 Delete event with the given unique id from current calendar.

bool isActive ()
QString localFileName ()

Static Public Member Functions

KOrganizerfindInstance (const KURL &url)
 Is there a instance with this URL?

void setStartedKAddressBook (bool tmpBool)

Protected Slots

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 file_new ()
 open new window

void file_open ()
 open a file, load it into the calendar.

void file_openRecent (const KURL &url)
 open a file from the list of recent files.

void file_import ()
 import a calendar from another program like ical.

void file_merge ()
 open a calendar and add the contents to the current calendar.

void file_revert ()
 revert to saved

void file_archive ()
 delete or archive old entries in your calendar for speed/space.

void file_save ()
 save a file with the current fileName.

void file_saveas ()
 save a file under a (possibly) different filename.

void file_close ()
 close a file, prompt for save if changes made.

void file_quit ()
 exit the program, prompt for save if files are "dirty".

void configureDateTime ()
 Open kcontrol module for configuring date and time formats.

void configureToolbars ()
 Open toolbar configuration dialog.

void editKeys ()
 Configure key bindings.

void showTip ()
 Show tip of the day.

void showTipOnStart ()
 Show tip of the day.

void processIncidenceSelection (Incidence *)
void downloadNewStuff ()
void uploadNewStuff ()
void toggleToolBars (bool)
 toggle the appearance of the tool bars.

void toggleToolBar ()
void toggleStatusBar ()
void toggleFilterView ()
void statusBarPressed (int)
void checkAutoSave ()
 called by the autoSaveTimer to automatically save the calendar

void setTitle ()
 Sets title of window according to filename and modification state.

void setNumIncoming (int)
void setNumOutgoing (int)
void configureDateTimeFinished (KProcess *)
void slotNewToolbarConfig ()

Protected Member Functions

void initActions ()
bool queryClose ()
 supplied so that close events close calendar properly.

bool queryExit ()
void saveProperties (KConfig *)
void readProperties (KConfig *)
KURL getSaveURL ()
 Get URL for saving.

void enableIncidenceActions (bool enable)

Detailed Description

This is the main class for KOrganizer. constructs a new main window for korganizer.

It extends the KDE KMainWindow. it provides the main view that the user sees upon startup, as well as menus, buttons, etc. etc.

Author:
Preston Brown

Definition at line 74 of file korganizer.h.


Constructor & Destructor Documentation

KOrganizer::KOrganizer const char *  name = 0  ) 
 

Constructs a new main window.

Parameters:
name Qt internal widget name

Definition at line 75 of file korganizer.cpp.

References KOWindowList::addWindow(), checkAutoSave(), CalendarView::checkClipboard(), configChanged(), CalendarView::lookForIncomingMessages(), CalendarView::lookForOutgoingMessages(), CalendarView::readSettings(), readSettings(), setTitle(), showStatusMessage(), showTipOnStart(), QTimer::singleShot(), QTimer::start(), and updateConfig().

Referenced by file_new().


Member Function Documentation

bool KOrganizer::openURL const KURL &  url,
bool  merge = false
[virtual]
 

Open calendar file from URL.

Merge into current calendar, if merge is true.

Implements KOrg::MainWindow.

Definition at line 721 of file korganizer.cpp.

References QString::arg(), CalendarView::openCalendar(), setActive(), setTitle(), and showStatusMessage().

Referenced by file_merge(), file_open(), file_openRecent(), file_revert(), mergeURL(), and openURL().

bool KOrganizer::mergeURL const KURL &  url  ) 
 

Merge calendar file from URL to current calendar.

bool KOrganizer::saveURL  )  [virtual]
 

Save calendar file to URL of current calendar.

Implements KOrg::MainWindow.

Definition at line 774 of file korganizer.cpp.

References CalendarView::calendar(), ExportWebDialog::exportWebPage(), QString::length(), QString::replace(), QString::right(), CalendarView::saveCalendar(), CalendarView::setModified(), setTitle(), showStatusMessage(), QTimer::start(), and QTimer::stop().

Referenced by checkAutoSave(), file_save(), saveAsURL(), and saveModifiedURL().

bool KOrganizer::saveAsURL const KURL &  kurl  )  [virtual]
 

Save calendar file to URL.

Implements KOrg::MainWindow.

Definition at line 848 of file korganizer.cpp.

References saveURL(), setActive(), and setTitle().

Referenced by file_saveas(), saveAsURL(), and saveModifiedURL().

bool KOrganizer::saveModifiedURL  ) 
 

Save calendar if it is modified by the user.

Ask user what to do.

Definition at line 899 of file korganizer.cpp.

References getSaveURL(), CalendarView::isModified(), saveAsURL(), and saveURL().

Referenced by file_close(), and queryClose().

KURL KOrganizer::getCurrentURL  )  const [inline, virtual]
 

Get current URL.

Implements KOrg::MainWindow.

Definition at line 102 of file korganizer.h.

Referenced by KOWindowList::findInstance().

KOrganizer * KOrganizer::findInstance const KURL &  url  )  [static]
 

Is there a instance with this URL?

Definition at line 1110 of file korganizer.cpp.

References KOWindowList::findInstance().

Referenced by file_open(), and file_openRecent().

bool KOrganizer::openURL QString  url  ) 
 

Open calendar file from URL.

Definition at line 1228 of file korganizer.cpp.

References openURL().

bool KOrganizer::mergeURL QString  url  ) 
 

Open calendar file from URL.

Definition at line 1233 of file korganizer.cpp.

References openURL().

bool KOrganizer::saveAsURL QString  url  ) 
 

Save calendar file to URL.

Definition at line 1238 of file korganizer.cpp.

References saveAsURL().

void KOrganizer::closeURL  ) 
 

Close calendar file opened from URL.

Definition at line 767 of file korganizer.cpp.

References file_close().

QString KOrganizer::getCurrentURLasString  )  const
 

Get current URL as QString.

Definition at line 1243 of file korganizer.cpp.

bool KOrganizer::deleteEvent QString  uid  )  [virtual]
 

Delete event with the given unique id from current calendar.

Definition at line 1248 of file korganizer.cpp.

References CalendarView::deleteEvent().

void KOrganizer::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 KOrganizer().

void KOrganizer::closingDown  )  [signal]
 

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

void KOrganizer::calendarActivated KOrganizer  )  [signal]
 

emitted when this calendar has been made active

Referenced by makeActive().

void KOrganizer::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 1047 of file korganizer.cpp.

References checkAutoSave(), QTimer::isActive(), QTimer::start(), and QTimer::stop().

Referenced by KOrganizer().

void KOrganizer::setActive bool  active = true  )  [slot]
 

Sets the active state of the calendar belonging to this window.

If a calendar is active the alarm daemon checks and signals events for alarm notification. The active calendar is loaded by default, when starting KOrganizer.

Definition at line 1118 of file korganizer.cpp.

References setTitle().

Referenced by KOWindowList::deactivateCalendars(), file_close(), makeActive(), openURL(), and saveAsURL().

void KOrganizer::makeActive  )  [slot]
 

Make calendar active.

Definition at line 1126 of file korganizer.cpp.

References calendarActivated(), and setActive().

Referenced by queryClose().

void KOrganizer::showStatusMessage const QString  )  [slot]
 

show status message

Definition at line 1223 of file korganizer.cpp.

Referenced by KOrganizer(), openURL(), and saveURL().

void KOrganizer::readSettings  )  [protected, slot]
 

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

Definition at line 187 of file korganizer.cpp.

References CalendarView::readSettings().

Referenced by KOrganizer().

void KOrganizer::writeSettings  )  [protected, slot]
 

write current state to config file.

Definition at line 209 of file korganizer.cpp.

References CalendarView::writeSettings().

Referenced by queryClose().

void KOrganizer::file_new  )  [protected, slot]
 

open new window

Definition at line 566 of file korganizer.cpp.

References KOrganizer().

void KOrganizer::file_open  )  [protected, slot]
 

open a file, load it into the calendar.

Definition at line 572 of file korganizer.cpp.

References findInstance(), QString::isEmpty(), CalendarView::isModified(), and openURL().

void KOrganizer::file_openRecent const KURL &  url  )  [protected, slot]
 

open a file from the list of recent files.

Definition at line 600 of file korganizer.cpp.

References findInstance(), and openURL().

void KOrganizer::file_import  )  [protected, slot]
 

import a calendar from another program like ical.

Definition at line 612 of file korganizer.cpp.

References QFile::exists(), QString::fromLatin1(), QDir::homeDirPath(), and CalendarView::openCalendar().

void KOrganizer::file_merge  )  [protected, slot]
 

open a calendar and add the contents to the current calendar.

Definition at line 669 of file korganizer.cpp.

References openURL().

void KOrganizer::file_revert  )  [protected, slot]
 

revert to saved

Definition at line 681 of file korganizer.cpp.

References openURL().

void KOrganizer::file_archive  )  [protected, slot]
 

delete or archive old entries in your calendar for speed/space.

Definition at line 676 of file korganizer.cpp.

References CalendarView::archiveCalendar().

void KOrganizer::file_save  )  [protected, slot]
 

save a file with the current fileName.

Definition at line 695 of file korganizer.cpp.

References file_saveas(), and saveURL().

void KOrganizer::file_saveas  )  [protected, slot]
 

save a file under a (possibly) different filename.

Definition at line 686 of file korganizer.cpp.

References getSaveURL(), and saveAsURL().

Referenced by file_save().

void KOrganizer::file_close  )  [protected, slot]
 

close a file, prompt for save if changes made.

Definition at line 701 of file korganizer.cpp.

References CalendarView::closeCalendar(), saveModifiedURL(), setActive(), and setTitle().

Referenced by closeURL().

void KOrganizer::file_quit  )  [protected, slot]
 

exit the program, prompt for save if files are "dirty".

Definition at line 715 of file korganizer.cpp.

void KOrganizer::configureDateTime  )  [protected, slot]
 

Open kcontrol module for configuring date and time formats.

Definition at line 1064 of file korganizer.cpp.

void KOrganizer::configureToolbars  )  [protected, slot]
 

Open toolbar configuration dialog.

Definition at line 1078 of file korganizer.cpp.

void KOrganizer::editKeys  )  [protected, slot]
 

Configure key bindings.

Definition at line 1095 of file korganizer.cpp.

void KOrganizer::showTip  )  [protected, slot]
 

Show tip of the day.

Definition at line 1100 of file korganizer.cpp.

void KOrganizer::showTipOnStart  )  [protected, slot]
 

Show tip of the day.

Definition at line 1105 of file korganizer.cpp.

Referenced by KOrganizer().

void KOrganizer::toggleToolBars bool   )  [protected, slot]
 

toggle the appearance of the tool bars.

Definition at line 1168 of file korganizer.cpp.

void KOrganizer::checkAutoSave  )  [protected, slot]
 

called by the autoSaveTimer to automatically save the calendar

Definition at line 1032 of file korganizer.cpp.

References saveURL().

Referenced by KOrganizer(), and updateConfig().

void KOrganizer::setTitle  )  [protected, slot]
 

Sets title of window according to filename and modification state.

Definition at line 1012 of file korganizer.cpp.

References CalendarView::isModified(), and CalendarView::isReadOnly().

Referenced by file_close(), KOrganizer(), openURL(), saveAsURL(), saveURL(), and setActive().

bool KOrganizer::queryClose  )  [protected]
 

supplied so that close events close calendar properly.

Definition at line 966 of file korganizer.cpp.

References KOWindowList::lastInstance(), makeActive(), saveModifiedURL(), and writeSettings().

KURL KOrganizer::getSaveURL  )  [protected]
 

Get URL for saving.

Opens FileDialog.

Definition at line 936 of file korganizer.cpp.

References QString::right().

Referenced by file_saveas(), and saveModifiedURL().


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.5.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Sun Feb 15 11:41:11 2004 by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2001