/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!

\page icalsupport.html

\target icalsupport
\title Supported iCalendar Features

\section1 Calendar Components
The ical specification allows a number of components to be supported within each calendar. The
following are supported with the QOrganizer Versit implementation.

\table
  \header
    \li Versit Component
    \li QOrganizer Component
  \row
    \li VEVENT
    \li QOrganizerEvent, QOrganizerEventOccurrence
  \row
    \li VTODO
    \li QOrganizerTodo, QOrganizerTodoOccurrence
  \row
    \li VJOURNAL
    \li QOrganizerJournal
  \row
    \li VALARM
    \li QOrganizerItemAudibleReminder, QOrganizerItemEmailReminder, QOrganizerItemVisualReminder
\endtable


\section1 Properties

The following table lists the iCalendar properties that the \l{Qt Versit C++ API} supports
for the Organizer calendar components.

\table
  \header
    \li Versit Property
    \li QOrganizerDetail
  \row
    \li DTSTART
    \li QOrganizerEventTime
  \row
    \li DTEND
    \li QOrganizerEventTime
  \row
    \li RECURRENCE-ID
    \li QOrganizerItemParent
  \row
    \li UID
    \li QOrganizerItemId
  \row
    \li PRIORITY
    \li QOrganizerItemPriority
\row
    \li DUE
    \li QOrganizerTodoTime
  \row
    \li CREATED
    \li QOrganizerTodoTime, QOrganizerItemTimestamp
  \row
    \li LAST-MODIFIED
    \li QOrganizerTodoTime, QOrganizerItemTimestamp
  \row
    \li RRULE
    \li QOrganizerItemRecurrence
  \row
    \li EXRULE
    \li QOrganizerRecurrenceRule
  \row
    \li EXDATE
    \li QOrganizerRecurrenceRule
  \row
    \li INTERVAL
    \li QOrganizerRecurrenceRule
  \row
    \li FREQ
    \li QOrganizerRecurrenceRule
  \row
    \li RDATE
    \li QOrganizerRecurrenceRule
  \row
    \li DATE
    \li QOrganizerEventTime
  \row
    \li COMMENT
    \li QOrganizerItemComment
  \row
    \li DUE
    \li QOrganizerTodoTime
  \row
    \li CATEGORIES
    \li QOrganizerItemTag
  \row
    \li X-QTPROJECT-EXTENDED-DETAIL
    \li QOrganizerItemExtendedDetail
\endtable


\section1 Parameters

The Versit module supports the following vCard parameter:
\list
  \li ENCODING (for base64 or quoted-printable values)
  \li CHARSET (text character set for a specific property)
  \li TYPE (see below)
\endlist

The following table lists the values that are supported for the TYPE parameter:

\table
  \header
    \li Value of TYPE parameter
    \li Value of QOrganizerDetail Context/SubType
  \row
    \li DAILY
    \li QOrganizerRecurrenceRule::Daily
  \row
    \li WEEKLY
    \li QOrganizerRecurrenceRule::Weekly
  \row
    \li MONTHLY
    \li QOrganizerRecurrenceRule::Monthly
  \row
    \li YEARLY
    \li QOrganizerRecurrenceRule::Yearly

  \row
    \li COUNT
    \li QOrganizerRecurrenceRule::CountLimit
  \row
    \li UNTIL
    \li QOrganizerRecurrenceRule::DateLimit
  \row
    \li INTERVAL
    \li QOrganizerRecurrenceRule::Frequency
  \row
    \li BYDAY
    \li Qt::DayOfWeek
  \row
    \li BYMONTHDAY
    \li see \l{QOrganizerRecurrenceRule::setDaysOfMonth()}
  \row
    \li BYYEARDAY
    \li see \l{QOrganizerRecurrenceRule::setDaysOfYear()}
  \row
    \li BYWEEKNO
    \li see \l{QOrganizerRecurrenceRule::setWeeksOfYear()}
  \row
    \li BYMONTH
    \li QOrganizerRecurrenceRule::Month
  \row
    \li BYSETPOS
    \li see \l{QOrganizerRecurrenceRule::setPositions()}
  \row
    \li WKST
    \li Qt::DayOfWeek
  \row
    \li STATUS
    \li QOrganizerTodoProgress::FieldStatus
  \row
    \li IN-PROCESS
    \li QOrganizerTodoProgress::StatusInProgress
  \row
    \li COMPLETED
    \li QOrganizerTodoProgress::StatusComplete
  \row
    \li NEEDS-ACTION
    \li QOrganizerTodoProgress::StatusNotStarted
  \row
    \li PERCENT-COMPLETE
    \li QOrganizerTodoProgress::FieldPercentageComplete
\endtable

*/
