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

kalarm

KAAlarm Class Reference

#include <alarmevent.h>

Inheritance diagram for KAAlarm:

Inheritance graph
[legend]

List of all members.


Detailed Description

Definition at line 140 of file alarmevent.h.


Public Types

enum  Action {
  MESSAGE = T_MESSAGE, FILE = T_FILE, COMMAND = T_COMMAND, EMAIL = T_EMAIL,
  AUDIO = T_AUDIO
}
enum  SubType {
  INVALID__ALARM = INVALID_ALARM, MAIN__ALARM = MAIN_ALARM, REMINDER__ALARM = REMINDER_ALARM, TIMED_DEFERRAL_FLAG = 0x08,
  DEFERRED_DATE__ALARM = DEFERRED_ALARM, DEFERRED_TIME__ALARM = DEFERRED_ALARM | TIMED_DEFERRAL_FLAG, DEFERRED_REMINDER_DATE__ALARM = REMINDER_ALARM | DEFERRED_ALARM, DEFERRED_REMINDER_TIME__ALARM = REMINDER_ALARM | DEFERRED_ALARM | TIMED_DEFERRAL_FLAG,
  AT_LOGIN__ALARM = AT_LOGIN_ALARM, DISPLAYING__ALARM = DISPLAYING_ALARM, AUDIO__ALARM = AUDIO_ALARM, PRE_ACTION__ALARM = PRE_ACTION_ALARM,
  POST_ACTION__ALARM = POST_ACTION_ALARM
}
enum  Type {
  INVALID_ALARM = 0, MAIN_ALARM = 1, REMINDER_ALARM = 0x02, DEFERRED_ALARM = 0x04,
  DEFERRED_REMINDER_ALARM = REMINDER_ALARM | DEFERRED_ALARM, AT_LOGIN_ALARM = 0x10, DISPLAYING_ALARM = 0x20, AUDIO_ALARM = 0x30,
  PRE_ACTION_ALARM = 0x40, POST_ACTION_ALARM = 0x50
}

Public Member Functions

Action action () const
QString audioFile () const
QDate date () const
DateTime dateTime (bool withRepeats=false) const
bool deferred () const
void dumpDebug () const
const QString & eventID () const
int fadeSeconds () const
float fadeVolume () const
int flags () const
 KAAlarm (const KAAlarm &)
 KAAlarm ()
bool reminder () const
bool repeatSound () const
void setTime (const KDateTime &dt)
void setTime (const DateTime &dt)
float soundVolume () const
SubType subType () const
QTime time () const
Type type () const
bool valid () const
 ~KAAlarm ()

Static Public Member Functions

static const char * debugType (Type)

Member Enumeration Documentation

enum KAAlarm::Action

Enumerator:
MESSAGE 
FILE 
COMMAND 
EMAIL 
AUDIO 

Definition at line 144 of file alarmevent.h.

enum KAAlarm::SubType

Enumerator:
INVALID__ALARM 
MAIN__ALARM 
REMINDER__ALARM 
TIMED_DEFERRAL_FLAG 
DEFERRED_DATE__ALARM 
DEFERRED_TIME__ALARM 
DEFERRED_REMINDER_DATE__ALARM 
DEFERRED_REMINDER_TIME__ALARM 
AT_LOGIN__ALARM 
DISPLAYING__ALARM 
AUDIO__ALARM 
PRE_ACTION__ALARM 
POST_ACTION__ALARM 

Definition at line 172 of file alarmevent.h.

enum KAAlarm::Type

Enumerator:
INVALID_ALARM 
MAIN_ALARM 
REMINDER_ALARM 
DEFERRED_ALARM 
DEFERRED_REMINDER_ALARM 
AT_LOGIN_ALARM 
DISPLAYING_ALARM 
AUDIO_ALARM 
PRE_ACTION_ALARM 
POST_ACTION_ALARM 

Reimplemented from KAAlarmEventBase.

Definition at line 155 of file alarmevent.h.


Constructor & Destructor Documentation

KAAlarm::KAAlarm (  )  [inline]

Definition at line 193 of file alarmevent.h.

KAAlarm::KAAlarm ( const KAAlarm &  alarm  ) 

Definition at line 4059 of file alarmevent.cpp.

KAAlarm::~KAAlarm (  )  [inline]

Definition at line 195 of file alarmevent.h.


Member Function Documentation

Action KAAlarm::action (  )  const [inline]

Definition at line 196 of file alarmevent.h.

QString KAAlarm::audioFile (  )  const [inline]

Definition at line 206 of file alarmevent.h.

QDate KAAlarm::date (  )  const [inline]

Definition at line 204 of file alarmevent.h.

DateTime KAAlarm::dateTime ( bool  withRepeats = false  )  const [inline]

Definition at line 201 of file alarmevent.h.

const char * KAAlarm::debugType ( Type  type  )  [static]

Definition at line 4100 of file alarmevent.cpp.

bool KAAlarm::deferred (  )  const [inline]

Definition at line 212 of file alarmevent.h.

void KAAlarm::dumpDebug (  )  const

Reimplemented from KAAlarmEventBase.

Definition at line 4074 of file alarmevent.cpp.

const QString& KAAlarm::eventID (  )  const [inline]

Definition at line 200 of file alarmevent.h.

int KAAlarm::fadeSeconds (  )  const [inline]

Definition at line 209 of file alarmevent.h.

float KAAlarm::fadeVolume (  )  const [inline]

Definition at line 208 of file alarmevent.h.

int KAAlarm::flags (  )  const

Reimplemented from KAAlarmEventBase.

Definition at line 4066 of file alarmevent.cpp.

bool KAAlarm::reminder (  )  const [inline]

Definition at line 211 of file alarmevent.h.

bool KAAlarm::repeatSound (  )  const [inline]

Definition at line 210 of file alarmevent.h.

void KAAlarm::setTime ( const KDateTime &  dt  )  [inline]

Definition at line 214 of file alarmevent.h.

void KAAlarm::setTime ( const DateTime &  dt  )  [inline]

Definition at line 213 of file alarmevent.h.

float KAAlarm::soundVolume (  )  const [inline]

Definition at line 207 of file alarmevent.h.

SubType KAAlarm::subType (  )  const [inline]

Definition at line 199 of file alarmevent.h.

QTime KAAlarm::time (  )  const [inline]

Definition at line 205 of file alarmevent.h.

Type KAAlarm::type (  )  const [inline]

Definition at line 198 of file alarmevent.h.

bool KAAlarm::valid (  )  const [inline]

Definition at line 197 of file alarmevent.h.


The documentation for this class was generated from the following files:
  • alarmevent.h
  • alarmevent.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
  •   doc
  • libkdepim
  • libkholidays
  • libkleo
  • libkpgp
  • maildir
Generated for kdepim by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal