• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

KCal Library

KCal Namespace Reference

Contains all the KCal library global classes, objects, and functions. More...


Namespaces

namespace  ICalDrag
namespace  IncidenceFormatter
namespace  VCalDrag

Classes

class  Alarm
 Represents an alarm notification. More...
class  Attachment
 Represents information related to an attachment for a Calendar Incidence. More...
class  Attendee
 Represents information related to an attendee of an Calendar Incidence, typically a meeting or task (to-do). More...
class  Calendar
 Represents the main calendar class. More...
class  CalendarLocal
 This class provides a calendar stored as a local file. More...
class  CalendarNull
 Represents a null calendar class; that is, a calendar which contains no information and provides no capabilities. More...
class  CalendarResources
 This class provides a Calendar which is composed of other Calendars known as "Resources". More...
class  CalFilter
 Provides a filter for calendars. More...
class  CalFormat
 An abstract base class that provides an interface to various calendar formats. More...
class  CalStorage
 An abstract base class that provides a calendar storage interface. More...
class  Compat
 This class provides compatibility to older or broken calendar files. More...
class  CompatFactory
 Factory for creating the right Compat object. More...
class  CompatOutlook9
 Compatibility class for Outlook 9 calendar files. More...
class  CompatPre31
 Compatibility class for KOrganizer pre-3.1 calendar files. More...
class  CompatPre32
 Compatibility class for KOrganizer pre-3.2 calendar files. More...
class  CompatPre35
 Compatibility class for KOrganizer pre-3.5 calendar files. More...
class  CustomProperties
 A class to manage custom calendar properties. More...
class  DndFactory
 vCalendar/iCalendar Drag-and-Drop object factory. More...
class  Duration
 Represents a span of time measured in seconds or days. More...
class  ErrorFormat
 Calendar format related error class. More...
class  Event
 This class provides an Event in the sense of RFC2445. More...
class  Exception
 Exceptions base class, currently used as a fancy kind of error code and not as an C++ exception. More...
class  FileStorage
 This class provides a calendar storage as a local file. More...
class  FreeBusy
 Provides information about the free/busy time of a calendar. More...
class  FreeBusyCache
 An abstract base class to allow different implementations of storing free busy information, e.g. More...
class  FreeBusyPeriod
 The period can be defined by either a start time and an end time or by a start time and a duration. More...
class  HtmlExport
 This class provides the functions to export a calendar as a HTML page. More...
class  ICalFormat
 iCalendar format implementation. More...
class  ICalTimeZone
 The ICalTimeZone class represents an iCalendar VTIMEZONE component. More...
class  ICalTimeZoneBackend
 Backend class for KICalTimeZone class. More...
class  ICalTimeZoneData
 Parsed iCalendar VTIMEZONE data. More...
class  ICalTimeZones
 The ICalTimeZones class represents a time zone database which consists of a collection of individual iCalendar time zone definitions. More...
class  ICalTimeZoneSource
 A class which reads and parses iCalendar VTIMEZONE components, and accesses libical time zone data. More...
class  Incidence
 Provides the abstract base class common to non-FreeBusy (Events, To-dos, Journals) calendar components known as incidences. More...
class  IncidenceBase
 An abstract class that provides a common base for all calendar incidence classes. More...
class  Journal
 Provides a Journal in the sense of RFC2445. More...
class  KResult
 This class represents the result of an operation. More...
class  KResultError
 Convenience class for creating a KResult of type Error. More...
class  KResultInProgress
 Convenience class for creating a KResult of type InProgress. More...
class  KResultOk
 Convenience class for creating a KResult of type Ok. More...
class  ListBase
 This class provides a template for lists of pointers. More...
class  Period
 The period can be defined by either a start time and an end time or by a start time and a duration. More...
class  Person
 This class represents a person, with a name and an email address. More...
class  QtopiaFormat
 This class implements the calendar format used by Qtopia. More...
class  Recurrence
 This class represents a recurrence rule for a calendar incidence. More...
class  RecurrenceRule
 This class represents a recurrence rule for a calendar incidence. More...
class  ResourceCached
 This class provides a calendar resource using a local CalendarLocal object to cache the calendar data. More...
class  ResourceCachedReloadConfig
 Configuration widget for reload policy. More...
class  ResourceCachedSaveConfig
 Configuration widget for save policy. More...
class  ResourceCalendar
 This class provides the interfaces for a calendar resource. More...
class  ResourceLocal
 Provides a calendar resource stored as a local file. More...
class  ResourceLocalConfig
 Configuration widget for local file resource. More...
class  ResourceLocalDir
 This class provides a calendar stored as a file per incidence in a directory. More...
class  ResourceLocalDirConfig
 Configuration widget for local dir resource. More...
class  ScheduleMessage
 A Scheduling message class. More...
class  Scheduler
 This class provides an encapsulation of iTIP transactions (RFC 2446). More...
class  SortableList
 A QList which can be sorted. More...
class  Todo
 Provides a To-do in the sense of RFC2445. More...

Typedefs

typedef KRES::Manager
< ResourceCalendar > 
CalendarResourceManager
typedef SortableList< QDate > DateList
typedef SortableList< KDateTime > DateTimeList
typedef SortableList< QTime > TimeList

Enumerations

enum  EventSortField { EventSortUnsorted, EventSortStartDate, EventSortEndDate, EventSortSummary }
enum  iTIPMethod {
  iTIPPublish, iTIPRequest, iTIPReply, iTIPAdd,
  iTIPCancel, iTIPRefresh, iTIPCounter, iTIPDeclineCounter,
  iTIPNoMethod
}
enum  JournalSortField { JournalSortUnsorted, JournalSortDate, JournalSortSummary }
enum  SortDirection { SortDirectionAscending, SortDirectionDescending }
enum  TodoSortField {
  TodoSortUnsorted, TodoSortStartDate, TodoSortDueDate, TodoSortPriority,
  TodoSortPercentComplete, TodoSortSummary
}

Detailed Description

Contains all the KCal library global classes, objects, and functions.


Typedef Documentation

typedef KRES::Manager<ResourceCalendar> KCal::CalendarResourceManager

Type representing the manager of a ResourceCalendar.

Definition at line 547 of file resourcecalendar.h.

typedef SortableList< QDate > KCal::DateList

List of dates.

Definition at line 72 of file incidencebase.h.

typedef SortableList< KDateTime > KCal::DateTimeList

List of times.

Definition at line 74 of file incidencebase.h.


Enumeration Type Documentation

enum KCal::EventSortField

Calendar Event sort keys.

Enumerator:
EventSortUnsorted  Do not sort Events.
EventSortStartDate  Sort Events chronologically, by start date.
EventSortEndDate  Sort Events chronologically, by end date.
EventSortSummary  Sort Events alphabetically, by summary.

Definition at line 69 of file calendar.h.

enum KCal::iTIPMethod

iTIP methods.

Enumerator:
iTIPPublish  Event, to-do, journal or freebusy posting.
iTIPRequest  Event, to-do or freebusy scheduling request.
iTIPReply  Event, to-do or freebusy reply to request.
iTIPAdd  Event, to-do or journal additional property request.
iTIPCancel  Event, to-do or journal cancellation notice.
iTIPRefresh  Event or to-do description update request.
iTIPCounter  Event or to-do submit counter proposal.
iTIPDeclineCounter  Event or to-do decline a counter proposal.
iTIPNoMethod  No method.

Definition at line 34 of file scheduler.h.

enum KCal::JournalSortField

Calendar Journal sort keys.

Enumerator:
JournalSortUnsorted  Do not sort Journals.
JournalSortDate  Sort Journals chronologically by date.
JournalSortSummary  Sort Journals alphabetically, by summary.

Definition at line 91 of file calendar.h.

enum KCal::SortDirection

Calendar Incidence sort directions.

Enumerator:
SortDirectionAscending  Sort in ascending order (first to last).
SortDirectionDescending  Sort in descending order (last to first).

Definition at line 61 of file calendar.h.

enum KCal::TodoSortField

Calendar Todo sort keys.

Enumerator:
TodoSortUnsorted  Do not sort Todos.
TodoSortStartDate  Sort Todos chronologically, by start date.
TodoSortDueDate  Sort Todos chronologically, by due date.
TodoSortPriority  Sort Todos by priority.
TodoSortPercentComplete  Sort Todos by percentage completed.
TodoSortSummary  Sort Todos alphabetically, by summary.

Definition at line 79 of file calendar.h.

KCal Library

Skip menu "KCal Library"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  • kabc
  • kblog
  • kcal
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.7.1
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