Skip to main content :: ::

KDE PIM API Reference

:: Skip to Link Menu

/ API Reference / libkcal

libkcal KCal::IncidenceBase Class Reference #include <incidencebase.h> Inheritance diagram for KCal::IncidenceBase: List of all members. Detailed Description This class provides the base class common to all calendar components. Definition at line 45 of file incidencebase.h. Public Types enum   { SYNCNONE = 0, SYNCMOD = 1, SYNCDEL = 3 } Public Member Functions   IncidenceBase ()   IncidenceBase (const IncidenceBase &) virtual  ~IncidenceBase () IncidenceBase &  operator= (const IncidenceBase &i) bool  operator== (const IncidenceBase &) const virtual bool  accept (Visitor &) virtual QCString  type () const =0 void  setUid (const QString &) QString  uid () const void  setLastModified (const QDateTime &lm) QDateTime  lastModified () const void  setOrganizer (const Person &o) void  setOrganizer (const QString &o) Person  organizer () const virtual void  setReadOnly (bool) bool  isReadOnly () const virtual void  setDtStart (const QDateTime &dtStart) virtual QDateTime  dtStart () const virtual QString  dtStartTimeStr () const virtual QString  dtStartDateStr (bool shortfmt=true) const virtual QString  dtStartStr () const virtual void  setDuration (int seconds) int  duration () const void  setHasDuration (bool) bool  hasDuration () const bool  doesFloat () const void  setFloats (bool f) void  addComment (const QString &comment) bool  removeComment (const QString &comment) void  clearComments () QStringList  comments () const void  addAttendee (Attendee *attendee, bool doUpdate=true) void  clearAttendees () const Attendee::List &  attendees () const int  attendeeCount () const Attendee *  attendeeByMail (const QString &) const Attendee *  attendeeByMails (const QStringList &, const QString &email=QString::null) const Attendee *  attendeeByUid (const QString &uid) const void  setSyncStatus (int status) void  setSyncStatusSilent (int status) int  syncStatus () const void  setPilotId (unsigned long id) unsigned long  pilotId () const void  registerObserver (Observer *) void  unRegisterObserver (Observer *) void  updated () void  updatedSilent () Protected Member Functions virtual void  customPropertyUpdated () Protected Attributes bool  mReadOnly Classes class   Observer class   Visitor   This class provides the interface for a visitor of calendar components. More... Member Enumeration Documentation anonymous enum   Pilot synchronization states. Definition at line 222 of file incidencebase.h. Member Function Documentation virtual bool KCal::IncidenceBase::accept (  Visitor &   )  [inline, virtual]   Accept IncidenceVisitor. A class taking part in the visitor mechanism has to provide this implementation: bool accept(Visitor &v) { return v.visit(this); } Definition at line 107 of file incidencebase.h. void IncidenceBase::addAttendee (  Attendee *  attendee, bool  doUpdate = true )    Add Attendee to this incidence. IncidenceBase takes ownership of the Attendee object. Parameters: attendee  a pointer to the attendee to add doUpdate  If true the Observers are notified, if false they are not. Definition at line 262 of file incidencebase.cpp. void IncidenceBase::addComment (  const QString &  comment  )    Add a comment to this incidence. Does not add a linefeed character. Just appends the text as passed in. Parameters: comment  The comment to add. Definition at line 231 of file incidencebase.cpp. Attendee * IncidenceBase::attendeeByMail (  const QString &   )  const   Return the Attendee with this email address. Definition at line 301 of file incidencebase.cpp. Attendee * IncidenceBase::attendeeByMails (  const QStringList &  , const QString &  email = QString::null )  const   Return first Attendee with one of the given email addresses. Definition at line 311 of file incidencebase.cpp. Attendee * IncidenceBase::attendeeByUid (  const QString &  uid  )  const   Return attendee with given uid. Definition at line 327 of file incidencebase.cpp. int KCal::IncidenceBase::attendeeCount (   )  const [inline]   Return number of attendees. Definition at line 204 of file incidencebase.h. const Attendee::List& KCal::IncidenceBase::attendees (   )  const [inline]   Return list of attendees. Definition at line 200 of file incidencebase.h. void IncidenceBase::clearAttendees (   )    Remove all Attendees. Definition at line 295 of file incidencebase.cpp. void IncidenceBase::clearComments (   )    Delete all comments associated with this incidence. Definition at line 251 of file incidencebase.cpp. QStringList IncidenceBase::comments (   )  const   Return all comments associated with this incidence. Definition at line 256 of file incidencebase.cpp. void IncidenceBase::customPropertyUpdated (   )  [protected, virtual]   The default implementation does nothing: override in derived classes to perform change processing. Reimplemented from KCal::CustomProperties. Definition at line 411 of file incidencebase.cpp. bool IncidenceBase::doesFloat (   )  const   Return true or false depending on whether the incidence "floats," i.e. has a date but no time attached to it. Definition at line 218 of file incidencebase.cpp. QDateTime IncidenceBase::dtStart (   )  const [virtual]   returns an event's starting date/time as a QDateTime. Definition at line 197 of file incidencebase.cpp. QString IncidenceBase::dtStartDateStr (  bool  shortfmt = true  )  const [virtual]   returns an event's starting date as a string formatted according to the users locale settings Definition at line 207 of file incidencebase.cpp. QString IncidenceBase::dtStartStr (   )  const [virtual]   returns an event's starting date and time as a string formatted according to the users locale settings Definition at line 212 of file incidencebase.cpp. QString IncidenceBase::dtStartTimeStr (   )  const [virtual]   returns an event's starting time as a string formatted according to the users locale settings Definition at line 202 of file incidencebase.cpp. bool KCal::IncidenceBase::isReadOnly (   )  const [inline]   Return if the object is read-only. Definition at line 129 of file incidencebase.h. QDateTime IncidenceBase::lastModified (   )  const   Return the time the incidence was last modified. Definition at line 155 of file incidencebase.cpp. unsigned long IncidenceBase::pilotId (   )  const   Return Pilot Id. Definition at line 386 of file incidencebase.cpp. void IncidenceBase::registerObserver (  Observer *   )    Register observer. The observer is notified when the observed object changes. Definition at line 391 of file incidencebase.cpp. bool IncidenceBase::removeComment (  const QString &  comment  )    Remove a comment from the event. Removes first comment whose string is an exact match for the string passed in. Returns: true if match found, false otherwise. Definition at line 236 of file incidencebase.cpp. void IncidenceBase::setDtStart (  const QDateTime &  dtStart  )  [virtual]   for setting the event's starting date/time with a QDateTime. Reimplemented in KCal::Incidence, and KCal::Todo. Definition at line 190 of file incidencebase.cpp. void IncidenceBase::setFloats (  bool  f  )    Set whether the incidence floats, i.e. has a date but no time attached to it. Reimplemented in KCal::Incidence. Definition at line 223 of file incidencebase.cpp. void IncidenceBase::setLastModified (  const QDateTime &  lm  )    Sets the time the incidence was last modified. Definition at line 141 of file incidencebase.cpp. void IncidenceBase::setOrganizer (  const Person &  o  )    sets the organizer for the event Definition at line 160 of file incidencebase.cpp. void IncidenceBase::setPilotId (  unsigned long  id  )    Set Pilot Id. Definition at line 378 of file incidencebase.cpp. void IncidenceBase::setReadOnly (  bool   )  [virtual]   Set readonly status. Reimplemented in KCal::Incidence. Definition at line 185 of file incidencebase.cpp. void IncidenceBase::setSyncStatus (  int  status  )    Set synchronisation satus. Definition at line 360 of file incidencebase.cpp. void IncidenceBase::setUid (  const QString &   )    Set the unique id for the event. Definition at line 130 of file incidencebase.cpp. int IncidenceBase::syncStatus (   )  const   Return synchronisation status. Definition at line 373 of file incidencebase.cpp. QString IncidenceBase::uid (   )  const   Return the unique id for the event. Definition at line 136 of file incidencebase.cpp. void IncidenceBase::unRegisterObserver (  Observer *   )    Unregister observer. It isn't notified anymore about changes. Definition at line 396 of file incidencebase.cpp. void IncidenceBase::updated (   )    Call this to notify the observers after the IncidenceBas object has changed. Definition at line 401 of file incidencebase.cpp. The documentation for this class was generated from the following files: incidencebase.h incidencebase.cpp

libkcal Main Page Namespace List Class Hierarchy Alphabetical List Class List File List Directories Namespace Members Class Members API Dox akregator   src     librss certmanager   lib kaddressbook kalarm   lib kandy karm kdgantt kgantt kioslaves   imap4   mbox kitchensync kmail knotes konsolekalendar kontact korganizer kpilot   kpilot   lib libemailfunctions libkcal libkdepim libkholidays libkmime libkpgp libkpimidentities

KDE Home | KDE Accessibility Home | Description of Access Keys

Maintained by Adriaan de Groot and Allen Winter.
KDE and K Desktop Environment are trademarks of KDE e.V. | Legal