• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdepim
  • Sitemap
  • Contact Us
 

kalarm

KAlarm Namespace Reference


Enumerations

enum  { USE_EVENT_ID = 0x01, NO_RESOURCE_PROMPT = 0x02, ALLOW_KORG_UPDATE = 0x04 }
enum  FileType {
  Unknown, TextPlain, TextFormatted, TextApplication,
  Image
}
enum  UpdateError {
  ERR_ADD, ERR_MODIFY, ERR_DELETE, ERR_REACTIVATE,
  ERR_TEMPLATE
}
enum  UpdateStatus {
  UPDATE_OK, UPDATE_KORG_ERR, UPDATE_ERROR, UPDATE_FAILED,
  SAVE_FAILED
}

Functions

bool addArchivedEvent (KAEvent &event, AlarmResource *resource)
UpdateStatus addEvent (KAEvent &event, AlarmResource *resource, QWidget *msgParent, int options, bool showKOrgErr)
UpdateStatus addEvents (QList< KAEvent > &events, QWidget *msgParent, bool allowKOrgUpdate, bool showKOrgErr)
UpdateStatus addTemplate (KAEvent &event, AlarmResource *resource, QWidget *msgParent)
KDateTime applyTimeZone (const QString &tzstring, const QDate &date, const QTime &time, bool haveTime, const KDateTime &defaultDt)
QString browseFile (const QString &caption, QString &defaultDir, const QString &initialFile, const QString &filter, KFile::Modes mode, QWidget *parent)
bool convTimeString (const QByteArray &tzString, KDateTime &dateTime, const KDateTime &defaultDt, bool allowTZ)
KToggleAction * createAlarmEnableAction (QObject *parent)
TemplateMenuAction * createNewFromTemplateAction (const QString &label, KActionCollection *, const QString &name)
int currentCalendarVersion ()
QString currentCalendarVersionString ()
void deleteDisplayEvent (const QString &eventID)
UpdateStatus deleteEvent (KAEvent &event, bool archive, QWidget *msgParent, bool showKOrgErr)
UpdateStatus deleteEvents (KAEvent::List &events, bool archive, QWidget *msgParent, bool showKOrgErr)
UpdateStatus deleteTemplate (const QString &eventID, QWidget *msgParent=0)
UpdateStatus deleteTemplates (const QStringList &eventIDs, QWidget *msgParent)
QRect desktopWorkArea ()
void displayKOrgUpdateError (QWidget *parent, UpdateError code, int nAlarms)
MainWindow * displayMainWindowSelected (const QString &eventID=QString())
void displayUpdateError (QWidget *parent, UpdateStatus status, UpdateError code, int nAlarms, int nKOrgAlarms, bool showKOrgError)
void doEditNewAlarm (EditAlarmDlg *)
bool dontShowErrors (const QString &eventId, const QString &tag)
QStringList dontShowErrors (const QString &eventId)
bool editAlarm (const QString &eventID, QWidget *parent)
void editAlarm (KAEvent *event, QWidget *parent)
bool editNewAlarm (const QString &templateName, QWidget *parent)
void editNewAlarm (const KAEvent *preset, QWidget *parent)
void editNewAlarm (KAEvent::Action action, QWidget *parent, const AlarmText *text)
void editNewAlarm (EditAlarmDlg::Type type, QWidget *parent)
void editNewTemplate (const KAEvent *preset, QWidget *parent)
void editNewTemplate (EditAlarmDlg::Type type, QWidget *parent)
void editTemplate (KAEvent *event, QWidget *parent)
UpdateStatus enableEvents (KAEvent::List &events, bool enable, QWidget *msgParent)
FileType fileType (const KMimeType::Ptr &mimetype)
int getVersionNumber (const QString &version, QString *subVersion)
bool isWorkingTime (const KDateTime &dt)
int localeDayInWeek_to_weekDay (int index)
int localeFirstDayOfWeek ()
UpdateStatus modifyEvent (KAEvent &oldEvent, KAEvent &newEvent, QWidget *msgParent, bool showKOrgErr)
void outputAlarmWarnings (QWidget *parent, const KAEvent *event)
void purgeArchive (int purgeDays)
UpdateStatus reactivateEvent (KAEvent &event, AlarmResource *resource, QWidget *msgParent, bool showKOrgErr)
UpdateStatus reactivateEvents (KAEvent::List &events, QStringList &ineligibleIDs, AlarmResource *resource, QWidget *msgParent, bool showKOrgErr)
bool readConfigWindowSize (const char *window, QSize &result, int *splitterWidth)
void refreshAlarms ()
void refreshAlarmsIfQueued ()
QString runKMail (bool minimise)
bool runProgram (const QString &program, QString &dbusService, const QString &dbusWindowPath, QString &errorMessage)
void setDontShowErrors (const QString &eventId, const QString &tag)
void setDontShowErrors (const QString &eventId, const QStringList &tags)
QString stripAccel (const QString &text)
KAEvent::List templateList ()
UpdateStatus updateEvent (KAEvent &event, QWidget *msgParent, bool archiveOnDelete)
UpdateStatus updateTemplate (KAEvent &event, QWidget *msgParent)
int Version (int major, int minor, int rev)
int Version ()
void viewAlarm (const KAEvent *event, QWidget *parent)
int weekDay_to_localeDayInWeek (int weekDay)
QString weekDayName (int day, const KLocale *locale)
void writeConfigWindowSize (const char *window, const QSize &size, int splitterWidth)

Enumeration Type Documentation

anonymous enum

Enumerator:
USE_EVENT_ID 
NO_RESOURCE_PROMPT 
ALLOW_KORG_UPDATE 

Definition at line 111 of file functions.h.

enum KAlarm::FileType

Return codes from fileType().

Enumerator:
Unknown 
TextPlain 
TextFormatted 
TextApplication 
Image 

Definition at line 50 of file functions.h.

enum KAlarm::UpdateError

Error codes supplied as parameter to displayUpdateError().

Enumerator:
ERR_ADD 
ERR_MODIFY 
ERR_DELETE 
ERR_REACTIVATE 
ERR_TEMPLATE 

Definition at line 62 of file functions.h.

enum KAlarm::UpdateStatus

Return codes from calendar update functions.

The codes are ordered as far as possible by severity.

Enumerator:
UPDATE_OK 
UPDATE_KORG_ERR 
UPDATE_ERROR 
UPDATE_FAILED 
SAVE_FAILED 

Definition at line 54 of file functions.h.

Function Documentation

bool KAlarm::addArchivedEvent ( KAEvent &  event,
AlarmResource *  resource 
)

Definition at line 275 of file functions.cpp.

UpdateStatus KAlarm::addEvent ( KAEvent &  event,
AlarmResource *  resource,
QWidget *  msgParent,
int  options,
bool  showKOrgErr 
)

Definition at line 161 of file functions.cpp.

UpdateStatus KAlarm::addEvents ( QList< KAEvent > &  events,
QWidget *  msgParent,
bool  allowKOrgUpdate,
bool  showKOrgErr 
)

Definition at line 207 of file functions.cpp.

UpdateStatus KAlarm::addTemplate ( KAEvent &  event,
AlarmResource *  resource,
QWidget *  msgParent 
)

Definition at line 313 of file functions.cpp.

KDateTime KAlarm::applyTimeZone ( const QString &  tzstring,
const QDate &  date,
const QTime &  time,
bool  haveTime,
const KDateTime &  defaultDt 
)

Definition at line 1583 of file functions.cpp.

QString KAlarm::browseFile ( const QString &  caption,
QString &  defaultDir,
const QString &  initialFile,
const QString &  filter,
KFile::Modes  mode,
QWidget *  parent 
)

Definition at line 1390 of file functions.cpp.

bool KAlarm::convTimeString ( const QByteArray &  tzString,
KDateTime &  dateTime,
const KDateTime &  defaultDt,
bool  allowTZ 
)

Definition at line 1461 of file functions.cpp.

KToggleAction * KAlarm::createAlarmEnableAction ( QObject *  parent  ) 

Definition at line 136 of file functions.cpp.

TemplateMenuAction * KAlarm::createNewFromTemplateAction ( const QString &  label,
KActionCollection *  actions,
const QString &  name 
)

Create a "New From Template" QAction.

Definition at line 149 of file functions.cpp.

int KAlarm::currentCalendarVersion (  )  [inline]

Return which version of KAlarm was the first to use the current calendar/event format.

Definition at line 79 of file functions.h.

QString KAlarm::currentCalendarVersionString (  )  [inline]

Definition at line 80 of file functions.h.

void KAlarm::deleteDisplayEvent ( const QString &  eventID  ) 

Definition at line 577 of file functions.cpp.

UpdateStatus KAlarm::deleteEvent ( KAEvent &  event,
bool  archive,
QWidget *  msgParent,
bool  showKOrgErr 
)

Definition at line 470 of file functions.cpp.

UpdateStatus KAlarm::deleteEvents ( KAEvent::List &  events,
bool  archive,
QWidget *  msgParent,
bool  showKOrgErr 
)

Definition at line 477 of file functions.cpp.

UpdateStatus KAlarm::deleteTemplate ( const QString &  eventID,
QWidget *  msgParent = 0 
) [inline]

Definition at line 127 of file functions.h.

UpdateStatus KAlarm::deleteTemplates ( const QStringList &  eventIDs,
QWidget *  msgParent 
)

Definition at line 538 of file functions.cpp.

QRect KAlarm::desktopWorkArea (  ) 

Definition at line 1302 of file functions.cpp.

void KAlarm::displayKOrgUpdateError ( QWidget *  parent,
UpdateError  code,
int  nAlarms 
)

Definition at line 794 of file functions.cpp.

MainWindow * KAlarm::displayMainWindowSelected ( const QString &  eventID  ) 

Display a main window with the specified event selected.

Definition at line 103 of file functions.cpp.

void KAlarm::displayUpdateError ( QWidget *  parent,
UpdateStatus  status,
UpdateError  code,
int  nAlarms,
int  nKOrgAlarms,
bool  showKOrgError 
)

Definition at line 760 of file functions.cpp.

void KAlarm::doEditNewAlarm ( EditAlarmDlg *  editDlg  ) 

Definition at line 869 of file functions.cpp.

bool KAlarm::dontShowErrors ( const QString &  eventId,
const QString &  tag 
)

Definition at line 1220 of file functions.cpp.

QStringList KAlarm::dontShowErrors ( const QString &  eventId  ) 

Definition at line 1207 of file functions.cpp.

bool KAlarm::editAlarm ( const QString &  eventID,
QWidget *  parent 
)

Definition at line 992 of file functions.cpp.

void KAlarm::editAlarm ( KAEvent *  event,
QWidget *  parent 
)

Definition at line 954 of file functions.cpp.

bool KAlarm::editNewAlarm ( const QString &  templateName,
QWidget *  parent 
)

Definition at line 897 of file functions.cpp.

void KAlarm::editNewAlarm ( const KAEvent *  preset,
QWidget *  parent 
)

Definition at line 859 of file functions.cpp.

void KAlarm::editNewAlarm ( KAEvent::Action  action,
QWidget *  parent,
const AlarmText *  text 
)

Definition at line 830 of file functions.cpp.

void KAlarm::editNewAlarm ( EditAlarmDlg::Type  type,
QWidget *  parent 
)

Definition at line 820 of file functions.cpp.

void KAlarm::editNewTemplate ( const KAEvent *  preset,
QWidget *  parent 
)

Definition at line 934 of file functions.cpp.

void KAlarm::editNewTemplate ( EditAlarmDlg::Type  type,
QWidget *  parent 
)

Definition at line 915 of file functions.cpp.

void KAlarm::editTemplate ( KAEvent *  event,
QWidget *  parent 
)

Definition at line 1022 of file functions.cpp.

UpdateStatus KAlarm::enableEvents ( KAEvent::List &  events,
bool  enable,
QWidget *  msgParent 
)

Definition at line 690 of file functions.cpp.

FileType KAlarm::fileType ( const KMimeType::Ptr &  mimetype  ) 

Check from its mime type whether a file appears to be a text or image file.

If a text file, its type is distinguished.

Definition at line 1367 of file functions.cpp.

int KAlarm::getVersionNumber ( const QString &  version,
QString *  subVersion 
)

Definition at line 1328 of file functions.cpp.

bool KAlarm::isWorkingTime ( const KDateTime &  dt  ) 

Definition at line 1412 of file functions.cpp.

int KAlarm::localeDayInWeek_to_weekDay ( int  index  )  [inline]

Definition at line 156 of file functions.h.

int KAlarm::localeFirstDayOfWeek (  ) 

Definition at line 1425 of file functions.cpp.

UpdateStatus KAlarm::modifyEvent ( KAEvent &  oldEvent,
KAEvent &  newEvent,
QWidget *  msgParent,
bool  showKOrgErr 
)

Definition at line 351 of file functions.cpp.

void KAlarm::outputAlarmWarnings ( QWidget *  parent,
const KAEvent *  event 
)

Definition at line 1082 of file functions.cpp.

void KAlarm::purgeArchive ( int  purgeDays  ) 

Definition at line 734 of file functions.cpp.

UpdateStatus KAlarm::reactivateEvent ( KAEvent &  event,
AlarmResource *  resource,
QWidget *  msgParent,
bool  showKOrgErr 
)

Definition at line 590 of file functions.cpp.

UpdateStatus KAlarm::reactivateEvents ( KAEvent::List &  events,
QStringList &  ineligibleIDs,
AlarmResource *  resource,
QWidget *  msgParent,
bool  showKOrgErr 
)

Definition at line 598 of file functions.cpp.

bool KAlarm::readConfigWindowSize ( const char *  window,
QSize &  result,
int *  splitterWidth 
)

Definition at line 1270 of file functions.cpp.

void KAlarm::refreshAlarms (  ) 

Definition at line 1102 of file functions.cpp.

void KAlarm::refreshAlarmsIfQueued (  ) 

Definition at line 1118 of file functions.cpp.

QString KAlarm::runKMail ( bool  minimise  ) 

Definition at line 1147 of file functions.cpp.

bool KAlarm::runProgram ( const QString &  program,
QString &  dbusService,
const QString &  dbusWindowPath,
QString &  errorMessage 
)

Definition at line 1163 of file functions.cpp.

void KAlarm::setDontShowErrors ( const QString &  eventId,
const QString &  tag 
)

Definition at line 1249 of file functions.cpp.

void KAlarm::setDontShowErrors ( const QString &  eventId,
const QStringList &  tags 
)

Definition at line 1232 of file functions.cpp.

QString KAlarm::stripAccel ( const QString &  text  ) 

Definition at line 1640 of file functions.cpp.

KAEvent::List KAlarm::templateList (  ) 

Returns a list of all alarm templates.

If shell commands are disabled, command alarm templates are omitted.

Definition at line 1063 of file functions.cpp.

UpdateStatus KAlarm::updateEvent ( KAEvent &  event,
QWidget *  msgParent,
bool  archiveOnDelete 
)

Definition at line 417 of file functions.cpp.

UpdateStatus KAlarm::updateTemplate ( KAEvent &  event,
QWidget *  msgParent 
)

Definition at line 446 of file functions.cpp.

int KAlarm::Version ( int  major,
int  minor,
int  rev 
) [inline]

Definition at line 76 of file functions.h.

int KAlarm::Version (  ) 

Return current KAlarm version number.

Definition at line 1314 of file functions.cpp.

void KAlarm::viewAlarm ( const KAEvent *  event,
QWidget *  parent 
)

Definition at line 1052 of file functions.cpp.

int KAlarm::weekDay_to_localeDayInWeek ( int  weekDay  )  [inline]

Definition at line 150 of file functions.h.

QString KAlarm::weekDayName ( int  day,
const KLocale *  locale 
)

Definition at line 1436 of file functions.cpp.

void KAlarm::writeConfigWindowSize ( const char *  window,
const QSize &  size,
int  splitterWidth 
)

Definition at line 1288 of file functions.cpp.

kalarm

Skip menu "kalarm"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

kdepim

Skip menu "kdepim"
  • akonadi
  •   clients
  •   kabc
  •   kcal
  •   kcm
  • akregator
  • console
  •   kabcclient
  •   konsolekalendar
  • kaddressbook
  • kalarm
  •   lib
  • kdgantt
  • kdgantt1
  • kjots
  • kleopatra
  • kmail
  • kmobiletools
  • knode
  • knotes
  • kontact
  • kontactinterfaces
  • korganizer
  •   korgac
  • kpilot
  • ktimetracker
  • libkdepim
  • libkholidays
  • libkleo
  • libkpgp
  • maildir
Generated for kdepim by