diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/CMakeLists.txt | 30 | ||||
| -rw-r--r-- | doc/api/Doxyfile.pim | 2 | ||||
| -rw-r--r-- | doc/kalarm/index.docbook | 154 | ||||
| -rw-r--r-- | doc/karm/index.docbook | 12 |
4 files changed, 101 insertions, 97 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 493b1b46..17255caf 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -1,13 +1,17 @@ -################################################# -# -# (C) 2010-2011 Serghei Amelian -# serghei (DOT) amelian (AT) gmail.com -# -# Improvements and feedback are welcome -# -# This file is released under GPL >= 2 -# -################################################# - -tde_auto_add_subdirectories() - +tde_conditional_add_subdirectory( BUILD_AKREGATOR akregator ) +tde_conditional_add_subdirectory( BUILD_KADDRESSBOOK kaddressbook ) +tde_conditional_add_subdirectory( BUILD_KALARM kalarm ) +tde_conditional_add_subdirectory( BUILD_KANDY kandy ) +tde_conditional_add_subdirectory( BUILD_KARM karm ) +tde_conditional_add_subdirectory( BUILD_CERTMANAGER kleopatra ) +tde_conditional_add_subdirectory( BUILD_KMAIL kmail ) +tde_conditional_add_subdirectory( BUILD_KMOBILE kmobile ) +tde_conditional_add_subdirectory( BUILD_KNODE knode ) +tde_conditional_add_subdirectory( BUILD_KNOTES knotes ) +tde_conditional_add_subdirectory( BUILD_KONSOLEKALENDAR konsolekalendar ) +tde_conditional_add_subdirectory( BUILD_KONTACT kontact ) +tde_conditional_add_subdirectory( BUILD_KORGANIZER korganizer ) +tde_conditional_add_subdirectory( BUILD_KORN korn ) +tde_conditional_add_subdirectory( BUILD_KTNEF ktnef ) +tde_conditional_add_subdirectory( BUILD_CERTMANAGER kwatchgnupg ) +tde_conditional_add_subdirectory( BUILD_TDEIOSLAVE tdeioslave ) diff --git a/doc/api/Doxyfile.pim b/doc/api/Doxyfile.pim index 62cf6790..2f238502 100644 --- a/doc/api/Doxyfile.pim +++ b/doc/api/Doxyfile.pim @@ -930,7 +930,7 @@ INCLUDE_FILE_PATTERNS = PREDEFINED = TQT_VERSION=320 \ __cplusplus \ - Q_WS_X11 + TQ_WS_X11 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # this tag can be used to specify a list of macro names that should be expanded. diff --git a/doc/kalarm/index.docbook b/doc/kalarm/index.docbook index 3362f18c..a85022ff 100644 --- a/doc/kalarm/index.docbook +++ b/doc/kalarm/index.docbook @@ -2700,8 +2700,8 @@ at some future date.</para></note> </refnamediv> <refsynopsisdiv> <synopsis> -void cancelEvent(const QString& <replaceable>calendarFile</replaceable>, - const QString& <replaceable>eventID</replaceable>) +void cancelEvent(const TQString& <replaceable>calendarFile</replaceable>, + const TQString& <replaceable>eventID</replaceable>) </synopsis> <refsect2> @@ -2751,8 +2751,8 @@ ignored.</para></note> </refnamediv> <refsynopsisdiv> <synopsis> -void triggerEvent(const QString& <replaceable>calendarFile</replaceable>, - const QString& <replaceable>eventID</replaceable>) +void triggerEvent(const TQString& <replaceable>calendarFile</replaceable>, + const TQString& <replaceable>eventID</replaceable>) </synopsis> <refsect2> @@ -2809,8 +2809,8 @@ ignored.</para></note> </refnamediv> <refsynopsisdiv> <synopsis> -void handleEvent(const QString& <replaceable>calendarFile</replaceable>, - const QString& <replaceable>eventID</replaceable>) +void handleEvent(const TQString& <replaceable>calendarFile</replaceable>, + const TQString& <replaceable>eventID</replaceable>) </synopsis> <refsect2> @@ -2876,26 +2876,26 @@ ignored.</para></note> </refnamediv> <refsynopsisdiv> <synopsis> -bool scheduleMessage(const QString& <replaceable>message</replaceable>, - const QString& <replaceable>dateTime</replaceable>, +bool scheduleMessage(const TQString& <replaceable>message</replaceable>, + const TQString& <replaceable>dateTime</replaceable>, int <replaceable>lateCancel</replaceable>, int <replaceable>flags</replaceable>, - const QString& <replaceable>bgColor</replaceable>, - const QString& <replaceable>fgColor</replaceable>, - const QString& <replaceable>font</replaceable>, + const TQString& <replaceable>bgColor</replaceable>, + const TQString& <replaceable>fgColor</replaceable>, + const TQString& <replaceable>font</replaceable>, const KURL& <replaceable>audioURL</replaceable>, int <replaceable>reminder</replaceable>, - const QString& <replaceable>recurrence</replaceable>, + const TQString& <replaceable>recurrence</replaceable>, int <replaceable>subRepeatInterval</replaceable>, int <replaceable>subRepeatCount</replaceable>) </synopsis> <synopsis> -bool scheduleMessage(const QString& <replaceable>message</replaceable>, - const QString& <replaceable>dateTime</replaceable>, +bool scheduleMessage(const TQString& <replaceable>message</replaceable>, + const TQString& <replaceable>dateTime</replaceable>, int <replaceable>lateCancel</replaceable>, int <replaceable>flags</replaceable>, - const QString& <replaceable>bgColor</replaceable>, - const QString& <replaceable>fgColor</replaceable>, - const QString& <replaceable>font</replaceable>, + const TQString& <replaceable>bgColor</replaceable>, + const TQString& <replaceable>fgColor</replaceable>, + const TQString& <replaceable>font</replaceable>, const KURL& <replaceable>audioURL</replaceable>, int <replaceable>reminder</replaceable>, int <replaceable>recurType</replaceable>, @@ -2903,18 +2903,18 @@ bool scheduleMessage(const QString& <replaceable>message</replaceable>, int <replaceable>recurCount</replaceable>) </synopsis> <synopsis> -bool scheduleMessage(const QString& <replaceable>message</replaceable>, - const QString& <replaceable>dateTime</replaceable>, +bool scheduleMessage(const TQString& <replaceable>message</replaceable>, + const TQString& <replaceable>dateTime</replaceable>, int <replaceable>lateCancel</replaceable>, int <replaceable>flags</replaceable>, - const QString& <replaceable>bgColor</replaceable>, - const QString& <replaceable>fgColor</replaceable>, - const QString& <replaceable>font</replaceable>, + const TQString& <replaceable>bgColor</replaceable>, + const TQString& <replaceable>fgColor</replaceable>, + const TQString& <replaceable>font</replaceable>, const KURL& <replaceable>audioURL</replaceable>, int <replaceable>reminder</replaceable>, int <replaceable>recurType</replaceable>, int <replaceable>recurInterval</replaceable>, - const QString& <replaceable>endDateTime</replaceable>) + const TQString& <replaceable>endDateTime</replaceable>) </synopsis> <refsect2> @@ -2933,12 +2933,12 @@ bool scheduleMessage(const QString& <replaceable>message</replaceable>, <para>Specifies the scheduled date, or date and time, at which the message should be displayed. For a date-only alarm, the string should be in the format <quote>YYYY-MM-DD</quote> (as returned by -<methodname>QDate::toString(Qt::ISODate)</methodname>). For an alarm +<methodname>QDate::toString(TQt::ISODate)</methodname>). For an alarm with a date and time, the string should be in the format <quote>YYYY-MM-DDTHH:MM[:SS]</quote> (as returned by -<methodname>QDateTime::toString(Qt::ISODate)</methodname>) or +<methodname>QDateTime::toString(TQt::ISODate)</methodname>) or <quote>HH:MM[:SS]</quote> (as returned by -<methodname>QTime::toString(Qt::ISODate)</methodname>). If no date is +<methodname>QTime::toString(TQt::ISODate)</methodname>). If no date is specified, today's date is used. Note that any seconds value is ignored.</para> </listitem> @@ -2969,10 +2969,10 @@ applicable to message alarms.</para> <listitem> <para>Specifies the background color for displaying the message. The string may be in the format <quote>#RRGGBB</quote> (as returned by -<methodname>QColor::name()</methodname>) where RR, GG and BB are +<methodname>TQColor::name()</methodname>) where RR, GG and BB are two-digit hexadecimal values for red, green and blue. Alternatively the string may be in any of the other formats accepted by -<methodname>QColor::setNamedColor()</methodname>, such as a name from +<methodname>TQColor::setNamedColor()</methodname>, such as a name from the X color database (⪚ <quote>red</quote> or <quote>steelblue</quote>). Set the string to null to specify the current default background color.</para> @@ -3124,22 +3124,22 @@ text or image file.</refpurpose> <refsynopsisdiv> <synopsis> bool scheduleFile(const KURL& <replaceable>URL</replaceable>, - const QString& <replaceable>dateTime</replaceable>, + const TQString& <replaceable>dateTime</replaceable>, int <replaceable>lateCancel</replaceable>, int <replaceable>flags</replaceable>, - const QString& <replaceable>bgColor</replaceable>, + const TQString& <replaceable>bgColor</replaceable>, const KURL& <replaceable>audioURL</replaceable>, int <replaceable>reminder</replaceable>, - const QString& <replaceable>recurrence</replaceable>, + const TQString& <replaceable>recurrence</replaceable>, int <replaceable>subRepeatInterval</replaceable>, int <replaceable>subRepeatCount</replaceable>) </synopsis> <synopsis> bool scheduleFile(const KURL& <replaceable>URL</replaceable>, - const QString& <replaceable>dateTime</replaceable>, + const TQString& <replaceable>dateTime</replaceable>, int <replaceable>lateCancel</replaceable>, int <replaceable>flags</replaceable>, - const QString& <replaceable>bgColor</replaceable>, + const TQString& <replaceable>bgColor</replaceable>, const KURL& <replaceable>audioURL</replaceable>, int <replaceable>reminder</replaceable>, int <replaceable>recurType</replaceable>, @@ -3148,15 +3148,15 @@ bool scheduleFile(const KURL& <replaceable>URL</replaceable>, </synopsis> <synopsis> bool scheduleFile(const KURL& <replaceable>URL</replaceable>, - const QString& <replaceable>dateTime</replaceable>, + const TQString& <replaceable>dateTime</replaceable>, int <replaceable>lateCancel</replaceable>, int <replaceable>flags</replaceable>, - const QString& <replaceable>bgColor</replaceable>, + const TQString& <replaceable>bgColor</replaceable>, const KURL& <replaceable>audioURL</replaceable>, int <replaceable>reminder</replaceable>, int <replaceable>recurType</replaceable>, int <replaceable>recurInterval</replaceable>, - const QString& <replaceable>endDateTime</replaceable>) + const TQString& <replaceable>endDateTime</replaceable>) </synopsis> <refsect2> @@ -3176,12 +3176,12 @@ displayed in the message to be scheduled.</para> <para>Specifies the scheduled date, or date and time, at which the file should be displayed. For a date-only alarm, the string should be in the format <quote>YYYY-MM-DD</quote> (as returned by -<methodname>QDate::toString(Qt::ISODate)</methodname>). For an alarm +<methodname>QDate::toString(TQt::ISODate)</methodname>). For an alarm with a date and time, the string should be in the format <quote>YYYY-MM-DDTHH:MM[:SS]</quote> (as returned by -<methodname>QDateTime::toString(Qt::ISODate)</methodname>) or +<methodname>QDateTime::toString(TQt::ISODate)</methodname>) or <quote>HH:MM[:SS]</quote> (as returned by -<methodname>QTime::toString(Qt::ISODate)</methodname>). If no date is +<methodname>QTime::toString(TQt::ISODate)</methodname>). If no date is specified, today's date is used. Note that any seconds value is ignored.</para> </listitem> @@ -3212,10 +3212,10 @@ applicable to file alarms.</para> <listitem> <para>Specifies the background color for displaying the file. The string may be in the format <quote>#RRGGBB</quote> (as returned by -<methodname>QColor::name()</methodname>) where RR, GG and BB are +<methodname>TQColor::name()</methodname>) where RR, GG and BB are two-digit hexadecimal values for red, green and blue. Alternatively the string may be in any of the other formats accepted by -<methodname>QColor::setNamedColor()</methodname>, such as a name from +<methodname>TQColor::setNamedColor()</methodname>, such as a name from the X color database (⪚ <quote>red</quote> or <quote>steelblue</quote>). Set the string to null to specify the current default background color.</para> @@ -3338,17 +3338,17 @@ command.</refpurpose> </refnamediv> <refsynopsisdiv> <synopsis> -bool scheduleCommand(const QString& <replaceable>commandLine</replaceable>, - const QString& <replaceable>dateTime</replaceable>, +bool scheduleCommand(const TQString& <replaceable>commandLine</replaceable>, + const TQString& <replaceable>dateTime</replaceable>, int <replaceable>lateCancel</replaceable>, int <replaceable>flags</replaceable>, - const QString& <replaceable>recurrence</replaceable>, + const TQString& <replaceable>recurrence</replaceable>, int <replaceable>subRepeatInterval</replaceable>, int <replaceable>subRepeatCount</replaceable>) </synopsis> <synopsis> -bool scheduleCommand(const QString& <replaceable>commandLine</replaceable>, - const QString& <replaceable>dateTime</replaceable>, +bool scheduleCommand(const TQString& <replaceable>commandLine</replaceable>, + const TQString& <replaceable>dateTime</replaceable>, int <replaceable>lateCancel</replaceable>, int <replaceable>flags</replaceable>, int <replaceable>recurType</replaceable>, @@ -3356,13 +3356,13 @@ bool scheduleCommand(const QString& <replaceable>commandLine</replaceable>, int <replaceable>recurCount</replaceable>) </synopsis> <synopsis> -bool scheduleCommand(const QString& <replaceable>commandLine</replaceable>, - const QString& <replaceable>dateTime</replaceable>, +bool scheduleCommand(const TQString& <replaceable>commandLine</replaceable>, + const TQString& <replaceable>dateTime</replaceable>, int <replaceable>lateCancel</replaceable>, int <replaceable>flags</replaceable>, int <replaceable>recurType</replaceable>, int <replaceable>recurInterval</replaceable>, - const QString& <replaceable>endDateTime</replaceable>) + const TQString& <replaceable>endDateTime</replaceable>) </synopsis> <refsect2> @@ -3383,12 +3383,12 @@ parameter contains a shell command line or a command script.</para> <para>Specifies the scheduled date, or date and time, at which the command should be executed. For a date-only alarm, the string should be in the format <quote>YYYY-MM-DD</quote> (as returned by -<methodname>QDate::toString(Qt::ISODate)</methodname>). For an alarm +<methodname>QDate::toString(TQt::ISODate)</methodname>). For an alarm with a date and time, the string should be in the format <quote>YYYY-MM-DDTHH:MM[:SS]</quote> (as returned by -<methodname>QDateTime::toString(Qt::ISODate)</methodname>) or +<methodname>QDateTime::toString(TQt::ISODate)</methodname>) or <quote>HH:MM[:SS]</quote> (as returned by -<methodname>QTime::toString(Qt::ISODate)</methodname>). If no date is +<methodname>QTime::toString(TQt::ISODate)</methodname>). If no date is specified, today's date is used. Note that any seconds value is ignored.</para> </listitem> @@ -3512,25 +3512,25 @@ parameters, its usage is identical to </refnamediv> <refsynopsisdiv> <synopsis> -bool scheduleEmail(const QString& <replaceable>fromID</replaceable>, - const QString& <replaceable>addresses</replaceable>, - const QString& <replaceable>subject</replaceable>, - const QString& <replaceable>message</replaceable>, - const QString& <replaceable>attachments</replaceable>, - const QString& <replaceable>dateTime</replaceable>, +bool scheduleEmail(const TQString& <replaceable>fromID</replaceable>, + const TQString& <replaceable>addresses</replaceable>, + const TQString& <replaceable>subject</replaceable>, + const TQString& <replaceable>message</replaceable>, + const TQString& <replaceable>attachments</replaceable>, + const TQString& <replaceable>dateTime</replaceable>, int <replaceable>lateCancel</replaceable>, int <replaceable>flags</replaceable>, - const QString& <replaceable>recurrence</replaceable>, + const TQString& <replaceable>recurrence</replaceable>, int <replaceable>subRepeatInterval</replaceable>, int <replaceable>subRepeatCount</replaceable>) </synopsis> <synopsis> -bool scheduleEmail(const QString& <replaceable>fromID</replaceable>, - const QString& <replaceable>addresses</replaceable>, - const QString& <replaceable>subject</replaceable>, - const QString& <replaceable>message</replaceable>, - const QString& <replaceable>attachments</replaceable>, - const QString& <replaceable>dateTime</replaceable>, +bool scheduleEmail(const TQString& <replaceable>fromID</replaceable>, + const TQString& <replaceable>addresses</replaceable>, + const TQString& <replaceable>subject</replaceable>, + const TQString& <replaceable>message</replaceable>, + const TQString& <replaceable>attachments</replaceable>, + const TQString& <replaceable>dateTime</replaceable>, int <replaceable>lateCancel</replaceable>, int <replaceable>flags</replaceable>, int <replaceable>recurType</replaceable>, @@ -3538,17 +3538,17 @@ bool scheduleEmail(const QString& <replaceable>fromID</replaceable>, int <replaceable>recurCount</replaceable>) </synopsis> <synopsis> -bool scheduleEmail(const QString& <replaceable>fromID</replaceable>, - const QString& <replaceable>addresses</replaceable>, - const QString& <replaceable>subject</replaceable>, - const QString& <replaceable>message</replaceable>, - const QString& <replaceable>attachments</replaceable>, - const QString& <replaceable>dateTime</replaceable>, +bool scheduleEmail(const TQString& <replaceable>fromID</replaceable>, + const TQString& <replaceable>addresses</replaceable>, + const TQString& <replaceable>subject</replaceable>, + const TQString& <replaceable>message</replaceable>, + const TQString& <replaceable>attachments</replaceable>, + const TQString& <replaceable>dateTime</replaceable>, int <replaceable>lateCancel</replaceable>, nt <replaceable>flags</replaceable>, int <replaceable>recurType</replaceable>, int <replaceable>recurInterval</replaceable>, - const QString& <replaceable>endTime</replaceable>) + const TQString& <replaceable>endTime</replaceable>) </synopsis> <refsect2> @@ -3599,12 +3599,12 @@ email attachments.</para> <para>Specifies the scheduled date, or date and time, at which the email should be sent. For a date-only alarm, the string should be in the format <quote>YYYY-MM-DD</quote> (as returned by -<methodname>QDate::toString(Qt::ISODate)</methodname>). For an alarm +<methodname>QDate::toString(TQt::ISODate)</methodname>). For an alarm with a date and time, the string should be in the format <quote>YYYY-MM-DDTHH:MM[:SS]</quote> (as returned by -<methodname>QDateTime::toString(Qt::ISODate)</methodname>) or +<methodname>QDateTime::toString(TQt::ISODate)</methodname>) or <quote>HH:MM[:SS]</quote> (as returned by -<methodname>QTime::toString(Qt::ISODate)</methodname>). If no date is +<methodname>QTime::toString(TQt::ISODate)</methodname>). If no date is specified, today's date is used. Note that any seconds value is ignored.</para> </listitem> @@ -3728,7 +3728,7 @@ dialog</link> to edit an alarm.</refpurpose> </refnamediv> <refsynopsisdiv> <synopsis> -bool edit(const QString& <replaceable>eventID</replaceable>) +bool edit(const TQString& <replaceable>eventID</replaceable>) </synopsis> <refsect2> @@ -3772,7 +3772,7 @@ dialog</link> to edit a new alarm.</refpurpose> </refnamediv> <refsynopsisdiv> <synopsis> -bool editNew(const QString& <replaceable>templateName</replaceable>) +bool editNew(const TQString& <replaceable>templateName</replaceable>) </synopsis> <refsect2> diff --git a/doc/karm/index.docbook b/doc/karm/index.docbook index 08de3cc4..e8d6495e 100644 --- a/doc/karm/index.docbook +++ b/doc/karm/index.docbook @@ -1117,7 +1117,7 @@ times were reset.</para></glossdef> </glossentry> </refnamediv> <refsynopsisdiv> <synopsis> -QString version() +TQString version() </synopsis> </refsynopsisdiv> <refsect1> @@ -1138,7 +1138,7 @@ in the typical GNU format of major.minor.bugfix.</para> </refnamediv> <refsynopsisdiv> <synopsis> -QString quit() +TQString quit() </synopsis> </refsynopsisdiv> <refsect1> @@ -1159,7 +1159,7 @@ external program can gracefully shutdown &karm;. </refnamediv> <refsynopsisdiv> <synopsis> -QString hastodo(QString taskname) +TQString hastodo(TQString taskname) </synopsis> <refsect2> <title>Parameters</title> @@ -1175,7 +1175,7 @@ QString hastodo(QString taskname) </refsynopsisdiv> <refsect1> <title>Description</title> -<para><function>hastodo(QString taskname)</function> is a &DCOP; call that +<para><function>hastodo(TQString taskname)</function> is a &DCOP; call that looks for a of the given name. If found, it returns the iCalendar UID that identifies that todo. If not found, it returns an empty string. @@ -1196,7 +1196,7 @@ than one todo has a matching name, the first one found is returned.</para> </refnamediv> <refsynopsisdiv> <synopsis> -QString addtodo(QString todoname) +TQString addtodo(TQString todoname) </synopsis> <refsect2> <title>Parameters</title> @@ -1213,7 +1213,7 @@ QString addtodo(QString todoname) <refsect1> <title>Description</title> -<para><function>addtodo(QString todoname)</function> is a &DCOP; call that +<para><function>addtodo(TQString todoname)</function> is a &DCOP; call that adds a new top-level todo to the current storage. The UID of the new todo is returned. </para> |