cvs: /phpdoc/functions mcal.sgml

eschmid Sat Sep 11 13:25:51 1999 EDT Modified files: /phpdoc/functions mcal.sgml Log: Some cosmetics. Index: phpdoc/functions/mcal.sgml diff -u phpdoc/functions/mcal.sgml:1.3 phpdoc/functions/mcal.sgml:1.4 --- phpdoc/functions/mcal.sgml:1.3 Fri Sep 10 17:36:56 1999 +++ phpdoc/functions/mcal.sgml Sat Sep 11 13:25:51 1999 @@ -3,60 +3,66 @@ <titleabbrev>MCAL</titleabbrev> <partintro> -<simpara> - mcal stands for Modular Calendar Access Library. + <para> + MCAL stands for Modular Calendar Access Library. -libmcal is a C library for accessing calendars. It's written -to be very modular, with plugable drivers. MCAL is the calendar -equivalent of the IMAP module for mailboxes. + <para> + Libmcal is a C library for accessing calendars. It's written to be + very modular, with plugable drivers. MCAL is the calendar + equivalent of the IMAP module for mailboxes. + + <para> + With mcal support, a calendar stream can be opened much like the + mailbox stream with the IMAP support. Calendars can be local file + stores, remote ICAP servers, or other formats that are supported + by the mcal library. + + <para> + Calendar events can be pulled up, queried, and stored. There is + also support for calendar triggers (alarms) and reoccuring events. + + <para> + With libmcal, central calendar servers can be accessed and used, + removing the need for any specific database or local file + programming. -with mcal support, a calendar stream can be opened much like the -mailbox stream with the IMAP support. Calendars can be local file stores, -remote ICAP servers, or other formats that are supported by the mcal library. - -Calendar events can be pulled up, queried, and stored. There is also support -for calendar triggers (alarms) and reoccuring events. - -With libmcal, central calendar servers can be accessed and used, removing the need -for any specific database or local file programming. - -</simpara> - - <simpara> + <para> To get these functions to work, you have to compile PHP with - <option role="configure">--with-mcal</option>. That requires the mcal library to be - installed. Grab the latest version from <ulink - url="http://mcal.chek.com/">http://mcal.chek.com/</ulink> - and compile and install it. -<simpara> -The following constants are defined when using the MCAL module: - -MCAL_SUNDAY -MCAL_MONDAY -MCAL_TUESDAY -MCAL_WEDNESDAY -MCAL_THURSDAY -MCAL_FRIDAY -MCAL_SATURDAY - -MCAL_JANUARY -MCAL_FEBRUARY -MCAL_MARCH -MCAL_APRIL -MCAL_MAY -MCAL_JUNE -MCAL_JULY -MCAL_AUGUGT -MCAL_SEPTEMBER -MCAL_OCTOBER -MCAL_NOVEMBER -MCAL_DECEMBER - -most of the functions use an internal event structure that is unique for each stream. -This alleviates the need to -pass around large objects between functions. There are convenience functions -for setting, initializing, and retrieving the event structure values. -</simpara> + <option role="configure">--with-mcal</option>. That requires the + mcal library to be installed. Grab the latest version from <ulink + url="http://mcal.chek.com/">http://mcal.chek.com/</ulink> and + compile and install it. + + <para> + The following constants are defined when using the MCAL module: + + MCAL_SUNDAY, + MCAL_MONDAY, + MCAL_TUESDAY, + MCAL_WEDNESDAY, + MCAL_THURSDAY, + MCAL_FRIDAY, + MCAL_SATURDAY, + + MCAL_JANUARY, + MCAL_FEBRUARY, + MCAL_MARCH, + MCAL_APRIL, + MCAL_MAY, + MCAL_JUNE, + MCAL_JULY, + MCAL_AUGUGT, + MCAL_SEPTEMBER, + MCAL_OCTOBER, + MCAL_NOVEMBER, and + MCAL_DECEMBER. + + Most of the functions use an internal event structure that is + unique for each stream. This alleviates the need to pass around + large objects between functions. There are convenience functions + for setting, initializing, and retrieving the event structure + values. + </partintro> <refentry id="function.mcal-open"> @@ -76,10 +82,11 @@ <para> Returns an MCAL stream on success, false on error. <para> - <function>mcal_open</function> opens up an MCAL connection to the specified - <parameter>calendar</parameter> store. If the optional - <parameter>options</parameter> is specified, passes the - <parameter>options</parameter> to that mailbox also. The streams internal event structure is also initialized upon connection. + <function>mcal_open</function> opens up an MCAL connection to the + specified <parameter>calendar</parameter> store. If the optional + <parameter>options</parameter> is specified, passes the + <parameter>options</parameter> to that mailbox also. The streams + internal event structure is also initialized upon connection. <para> </refsect1> </refentry> @@ -105,7 +112,9 @@ <refentry id="function.mcal-fetch-event"> <refnamediv> <refname>mcal_fetch_event</refname> - <refpurpose>Fetches an event from the calendar stream/</refpurpose> + <refpurpose> + Fetches an event from the calendar stream + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -120,57 +129,53 @@ calendar stream specified by <parameter>id</parameter>. <para> Returns an event object consisting of: - - <itemizedlist> - <listitem><simpara> - int id - ID of that event. - <listitem><simpara> - int public - TRUE if the event if public, FALSE if it is private. - <listitem><simpara> - string category - Category string of the event. - <listitem><simpara> - string title - Title string of the event. - <listitem><simpara> - string description - Description string of the event. - <listitem><simpara> - int alarm - number of minutes before the event to send an alarm/reminder. - <listitem><simpara> - object start - Object containing a datetime entry. - <listitem><simpara> - object end - Object containing a datetime entry. - <listitem><simpara> - int recur_type - recurrence type - </itemizedlist> - <listitem><simpara> - int recur_interval - recurrence interval - </itemizedlist> - <listitem><simpara> - datetime recur_endate - recurrence end date - </itemizedlist> - <listitem><simpara> - int recur_data - recurrence data + <itemizedlist> + <listitem><simpara> + int id - ID of that event. + <listitem><simpara> + int public - TRUE if the event if public, FALSE if it is + private. + <listitem><simpara> + string category - Category string of the event. + <listitem><simpara> + string title - Title string of the event. + <listitem><simpara> + string description - Description string of the event. + <listitem><simpara> + int alarm - number of minutes before the event to send an + alarm/reminder. + <listitem><simpara> + object start - Object containing a datetime entry. + <listitem><simpara> + object end - Object containing a datetime entry. + <listitem><simpara> + int recur_type - recurrence type + <listitem><simpara> + int recur_interval - recurrence interval + <listitem><simpara> + datetime recur_endate - recurrence end date + <listitem><simpara> + int recur_data - recurrence data </itemizedlist> + All datetime entries consist of an object that contains: - All datetime entries consist of an object that contains: - <itemizedlist> + <itemizedlist> <listitem><simpara> - int year - year + int year - year <listitem><simpara> - int month - month + int month - month <listitem><simpara> - int mday - day of month + int mday - day of month <listitem><simpara> - int hour - hour - <listitem><simpara> - int min - minutes - <listitem><simpara> - int sec - seconds - </itemizedlist> - <listitem><simpara> - int alarm - minutes before event to send an alarm + int hour - hour + <listitem><simpara> + int min - minutes + <listitem><simpara> + int sec - seconds + <listitem><simpara> + int alarm - minutes before event to send an alarm </itemizedlist> - </refsect1> </refentry> @@ -178,7 +183,9 @@ <refentry id="function.mcal-list-events"> <refnamediv> <refname>mcal_list_events</refname> - <refpurpose>Return a list of events between two given datetimes</refpurpose> + <refpurpose> + Return a list of events between two given datetimes + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -193,14 +200,14 @@ <paramdef>int <parameter>end_day]</parameter></paramdef> </funcsynopsis> <para> - Returns an array of event ID's that are between the start and end dates, or - if just a stream is given, uses the start and end dates in the global event structure. - - <para> - <function>mcal_list_events</function> function takes in an optional beginning date - and an end date for a calendar stream. An array of event id's that are between - the given dates or the internal event dates are returned. - + Returns an array of event ID's that are between the start and end + dates, or if just a stream is given, uses the start and end dates + in the global event structure. + <para> + <function>mcal_list_events</function> function takes in an + optional beginning date and an end date for a calendar stream. An + array of event id's that are between the given dates or the + internal event dates are returned. </refsect1> </refentry> @@ -217,8 +224,8 @@ <paramdef>int <parameter>mcal_stream</parameter></paramdef> </funcsynopsis> <para> - <function>mcal_store_event</function> Stores the global event into - an MCAL calendar for the given stream. + <function>mcal_store_event</function> Stores the global event + into an MCAL calendar for the given stream. <para> Returns true on success and false on error. <para> @@ -238,7 +245,8 @@ <paramdef>int <parameter>uid</parameter></paramdef> </funcsynopsis> <para> - <function>mcal_delete_event</function> deletes the calendar event specified by the uid. + <function>mcal_delete_event</function> deletes the calendar event + specified by the uid. <para> Returns true. </refsect1> @@ -256,7 +264,8 @@ <paramdef>int <parameter>uid</parameter></paramdef> </funcsynopsis> <para> - <function>mcal_snooze</function> turns off an alarm for a calendar event specified by the uid. + <function>mcal_snooze</function> turns off an alarm for a + calendar event specified by the uid. <para> Returns true. </refsect1> @@ -265,8 +274,9 @@ <refentry id="function.mcal-list-alarms"> <refnamediv> <refname>mcal_list_alarms</refname> - <refpurpose>Return a list of events that has an alarm triggered at the given datetime -</refpurpose> + <refpurpose> + Return a list of events that has an alarm triggered at the given datetime + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -280,22 +290,24 @@ <paramdef>int <parameter>end_month</parameter></paramdef> <paramdef>int <parameter>end_day]</parameter></paramdef> </funcsynopsis> - Returns an array of event ID's that has an alarm going offbetween the start and end -dates, or - if just a stream is given, uses the start and end dates in the global event structure. - - <para> - <function>mcal_list_events</function> function takes in an optional beginning date - and an end date for a calendar stream. An array of event id's that are between - the given dates or the internal event dates are returned. - + <para> + Returns an array of event ID's that has an alarm going offbetween + the start and end dates, or if just a stream is given, uses the + start and end dates in the global event structure. + <para> + <function>mcal_list_events</function> function takes in an + optional beginning date and an end date for a calendar stream. An + array of event id's that are between the given dates or the + internal event dates are returned. </refsect1> </refentry> <refentry id="function.mcal-event-init"> <refnamediv> <refname>mcal_event_init</refname> - <refpurpose>initializes a streams global event structure</refpurpose> + <refpurpose> + initializes a streams global event structure + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -304,9 +316,9 @@ <paramdef>int <parameter>stream</parameter></paramdef> </funcsynopsis> <para> - <function>mcal_event_init</function> - initializes a streams global event structure. this effectively sets all elements of -the structure to 0, or the default settings. + <function>mcal_event_init</function> initializes a streams global + event structure. this effectively sets all elements of the + structure to 0, or the default settings. <para> Returns true. </refsect1> @@ -315,7 +327,9 @@ <refentry id="function.mcal-event-set-category"> <refnamediv> <refname>mcal_event_set_category</refname> - <refpurpose>Sets the category of the streams global event structure</refpurpose> + <refpurpose> + Sets the category of the streams global event structure + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -325,8 +339,8 @@ <paramdef>string <parameter>category</parameter></paramdef> </funcsynopsis> <para> - <function>mcal_event_set_category</function> sets the streams global event structure's -category to the given string. + <function>mcal_event_set_category</function> sets the streams + global event structure's category to the given string. <para> Returns true. </refsect1> @@ -335,7 +349,9 @@ <refentry id="function.mcal-event-set-title"> <refnamediv> <refname>mcal_event_set_title</refname> - <refpurpose>Sets the title of the streams global event structure</refpurpose> + <refpurpose> + Sets the title of the streams global event structure + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -345,8 +361,8 @@ <paramdef>string <parameter>title</parameter></paramdef> </funcsynopsis> <para> - <function>mcal_event_set_title</function> sets the streams global event structure's -title to the given string. + <function>mcal_event_set_title</function> sets the streams global + event structure's title to the given string. <para> Returns true. </refsect1> @@ -355,18 +371,22 @@ <refentry id="function.mcal-event-set-description"> <refnamediv> <refname>mcal_event_set_description</refname> - <refpurpose>Sets the description of the streams global event structure</refpurpose> + <refpurpose> + Sets the description of the streams global event structure + </refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> - <funcdef>int <function>mcal_event_set_description</function></funcdef> + <funcdef>int + <function>mcal_event_set_description</function> + </funcdef> <paramdef>int <parameter>stream</parameter></paramdef> <paramdef>string <parameter>description</parameter></paramdef> </funcsynopsis> <para> - <function>mcal_event_set_description</function> sets the streams global event structure's -description to the given string. + <function>mcal_event_set_description</function> sets the streams + global event structure's description to the given string. <para> Returns true. </refsect1> @@ -375,7 +395,10 @@ <refentry id="function.mcal-event-set-start"> <refnamediv> <refname>mcal_event_set_start</refname> - <refpurpose>Sets the start date and time of the streams global event structure</refpurpose> + <refpurpose> + Sets the start date and time of the streams global event + structure + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -384,14 +407,29 @@ <paramdef>int <parameter>stream</parameter></paramdef> <paramdef>int <parameter>year</parameter></paramdef> <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>[int <parameter>day</parameter></paramdef> - <paramdef>int <parameter>hour</parameter></paramdef> - <paramdef>int <parameter>min</parameter></paramdef> - <paramdef>int <parameter>sec]</parameter></paramdef> + <paramdef>int + <parameter> + <optional>day</optional> + </parameter> + </paramdef> + <paramdef>int + <parameter> + <optional>hour</optional> + </parameter> + </paramdef> + <paramdef>int + <parameter> + <optional>min</optional></parameter> + </paramdef> + <paramdef>int + <parameter> + <optional>sec</optional> + </parameter> + </paramdef> </funcsynopsis> <para> - <function>mcal_event_set_start</function> sets the streams global event structure's -start date and time to the given values. + <function>mcal_event_set_start</function> sets the streams global + event structure's start date and time to the given values. <para> Returns true. </refsect1> @@ -400,7 +438,9 @@ <refentry id="function.mcal-event-set-end"> <refnamediv> <refname>mcal_event_set_end</refname> - <refpurpose>Sets the end date and time of the streams global event structure</refpurpose> + <refpurpose> + Sets the end date and time of the streams global event structure + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -415,8 +455,8 @@ <paramdef>int <parameter>sec]</parameter></paramdef> </funcsynopsis> <para> - <function>mcal_event_set_end</function> sets the streams global event structure's -end date and time to the given values. + <function>mcal_event_set_end</function> sets the streams global + event structure's end date and time to the given values. <para> Returns true. </refsect1> @@ -425,7 +465,9 @@ <refentry id="function.mcal-event-set-alarm"> <refnamediv> <refname>mcal_event_set_alarm</refname> - <refpurpose>Sets the alarm of the streams global event structure</refpurpose> + <refpurpose> + Sets the alarm of the streams global event structure + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -435,8 +477,8 @@ <paramdef>int <parameter>alarm</parameter></paramdef> </funcsynopsis> <para> - <function>mcal_event_set_alarm</function> sets the streams global event structure's -alarm to the given minutes before the event. + <function>mcal_event_set_alarm</function> sets the streams global + event structure's alarm to the given minutes before the event. <para> Returns true. </refsect1> @@ -445,7 +487,9 @@ <refentry id="function.mcal-event-set-class"> <refnamediv> <refname>mcal_event_set_class</refname> - <refpurpose>Sets the class of the streams global event structure</refpurpose> + <refpurpose> + Sets the class of the streams global event structure + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -455,8 +499,9 @@ <paramdef>int <parameter>class</parameter></paramdef> </funcsynopsis> <para> - <function>mcal_event_set_class</function> sets the streams global event structure's -class to the given value. The class is either 0 for public, or 1 for private. + <function>mcal_event_set_class</function> sets the streams global + event structure's class to the given value. The class is either 0 + for public, or 1 for private. <para> Returns true. </refsect1> @@ -466,7 +511,9 @@ <refentry id="function.mcal-is-leap-year"> <refnamediv> <refname>mcal_is_leap_year</refname> - <refpurpose>Returns if the given year is a leap year or not.</refpurpose> + <refpurpose> + Returns if the given year is a leap year or not + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -483,7 +530,9 @@ <refentry id="function.mcal-days-in-month"> <refnamediv> <refname>mcal_days_in_month</refname> - <refpurpose>Returns the number of days in the given month.</refpurpose> + <refpurpose> + Returns the number of days in the given month + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -493,15 +542,18 @@ <paramdef>int <parameter>leap year</parameter></paramdef> </funcsynopsis> <para> - <function>mcal_days_in_month</function> - Returns the number of days in the given month, taking into account if the given year is a leap year or not. + <function>mcal_days_in_month</function> Returns the number of + days in the given month, taking into account if the given year is + a leap year or not. </refsect1> </refentry> <refentry id="function.mcal-date-valid"> <refnamediv> <refname>mcal_date_valid</refname> - <refpurpose>Returns true if the given year,month,day is a valid date</refpurpose> + <refpurpose> + Returns true if the given year, month, day is a valid date + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -512,15 +564,17 @@ <paramdef>int <parameter>day</parameter></paramdef> </funcsynopsis> <para> - <function>mcal_date_valid</function> -Returns true if the given year, month and day is a valid date, false if not. + <function>mcal_date_valid</function> Returns true if the given + year, month and day is a valid date, false if not. </refsect1> </refentry> <refentry id="function.mcal-time-valid"> <refnamediv> <refname>mcal_time_valid</refname> - <refpurpose>Returns true if the given year,month,day is a valid time</refpurpose> + <refpurpose> + Returns true if the given year, month, day is a valid time + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -531,15 +585,17 @@ <paramdef>int <parameter>seconds</parameter></paramdef> </funcsynopsis> <para> - <function>mcal_time_valid</function> -Returns true if the given hour, minutes and seconds is a valid time, false if not. + <function>mcal_time_valid</function> Returns true if the given + hour, minutes and seconds is a valid time, false if not. </refsect1> </refentry> <refentry id="function.mcal-day-of-week"> <refnamediv> <refname>mcal_day_of_week</refname> - <refpurpose>returns the day of the week of the given date</refpurpose> + <refpurpose> + Returns the day of the week of the given date + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -550,8 +606,8 @@ <paramdef>int <parameter>day</parameter></paramdef> </funcsynopsis> <para> - <function>mcal_day_of_week</function> - returns the day of the week of the given date + <function>mcal_day_of_week</function> returns the day of the week + of the given date <para> Returns true. </refsect1> @@ -560,7 +616,9 @@ <refentry id="function.mcal-day-of-year"> <refnamediv> <refname>mcal_day_of_year</refname> - <refpurpose>returns the day of the year of the given date</refpurpose> + <refpurpose> + Returns the day of the year of the given date + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -571,8 +629,8 @@ <paramdef>int <parameter>day</parameter></paramdef> </funcsynopsis> <para> - <function>mcal_day_of_year</function> - returns the day of the year of the given date + <function>mcal_day_of_year</function> returns the day of the year + of the given date <para> Returns true. </refsect1> @@ -595,8 +653,8 @@ <paramdef>int <parameter>b_day</parameter></paramdef> </funcsynopsis> <para> - <function>mcal_date_compare</function> - Compares the two given dates, returns <0, 0, >0 if a<b, a==b, a>b respectively + <function>mcal_date_compare</function> Compares the two given + dates, returns &lt;0, 0, >0 if a&lt;b, a==b, a>b respectively </refsect1> </refentry> @@ -614,10 +672,11 @@ <paramdef>array <parameter>next</parameter></paramdef> </funcsynopsis> <para> - <function>mcal_next_recurrence</function> - returns an object filled with the next date the event occurs, on or -after the supplied date. Returns empty date field if event does not - occur or something is invalid. Uses weekstart to determine what day is considered the beginning of the week. + <function>mcal_next_recurrence</function> returns an object + filled with the next date the event occurs, on or after the + supplied date. Returns empty date field if event does not occur + or something is invalid. Uses weekstart to determine what day is + considered the beginning of the week. <para> Returns true. </refsect1> @@ -626,12 +685,16 @@ <refentry id="function.mcal-event-set-recur-daily"> <refnamediv> <refname>mcal_event_set_recur_daily</refname> - <refpurpose>Sets the recurrence of the streams global event structure</refpurpose> + <refpurpose> + Sets the recurrence of the streams global event structure + </refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> - <funcdef>int <function>mcal_event_set_recur_daily</function></funcdef> + <funcdef>int + <function>mcal_event_set_recur_daily</function> + </funcdef> <paramdef>int <parameter>stream</parameter></paramdef> <paramdef>int <parameter>year</parameter></paramdef> <paramdef>int <parameter>month</parameter></paramdef> @@ -642,21 +705,25 @@ <paramdef>int <parameter>interval</parameter></paramdef> </funcsynopsis> <para> - <function>mcal_event_set_recur_daily</function> - sets the streams global event structure's -recurrence to the given value to be reoccuring on a daily basis, ending at the given date. + <function>mcal_event_set_recur_daily</function> sets the streams + global event structure's recurrence to the given value to be + reoccuring on a daily basis, ending at the given date. </refsect1> </refentry> <refentry id="function.mcal-event-set-recur-weekly"> <refnamediv> <refname>mcal_event_set_recur_weekly</refname> - <refpurpose>Sets the recurrence of the streams global event structure</refpurpose> + <refpurpose> + Sets the recurrence of the streams global event structure + </refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> - <funcdef>int <function>mcal_event_set_recur_weekly</function></funcdef> + <funcdef>int + <function>mcal_event_set_recur_weekly</function> + </funcdef> <paramdef>int <parameter>stream</parameter></paramdef> <paramdef>int <parameter>year</parameter></paramdef> <paramdef>int <parameter>month</parameter></paramdef> @@ -668,21 +735,25 @@ <paramdef>int <parameter>weekdays</parameter></paramdef> </funcsynopsis> <para> - <function>mcal_event_set_recur_weekly</function> - sets the streams global event structure's -recurrence to the given value to be reoccuring on a weekly basis, ending at the given date. + <function>mcal_event_set_recur_weekly</function> sets the streams + global event structure's recurrence to the given value to be + reoccuring on a weekly basis, ending at the given date. </refsect1> </refentry> <refentry id="function.mcal-event-set-recur-monthly-mday"> <refnamediv> <refname>mcal_event_set_recur_monthly_mday</refname> - <refpurpose>Sets the recurrence of the streams global event structure</refpurpose> + <refpurpose> + Sets the recurrence of the streams global event structure + </refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> - <funcdef>int <function>mcal_event_set_recur_monthly_mday</function></funcdef> + <funcdef>int + <function>mcal_event_set_recur_monthly_mday</function> + </funcdef> <paramdef>int <parameter>stream</parameter></paramdef> <paramdef>int <parameter>year</parameter></paramdef> <paramdef>int <parameter>month</parameter></paramdef> @@ -693,21 +764,26 @@ <paramdef>int <parameter>interval</parameter></paramdef> </funcsynopsis> <para> - <function>mcal_event_set_recur_monthly_mday</function> - sets the streams global event structure's -recurrence to the given value to be reoccuring on a monthly by month day basis, ending at the given date. + <function>mcal_event_set_recur_monthly_mday</function> sets the + streams global event structure's recurrence to the given value to + be reoccuring on a monthly by month day basis, ending at the + given date. </refsect1> </refentry> <refentry id="function.mcal-event-set-recur-monthly-wday"> <refnamediv> <refname>mcal_event_set_recur_monthly_wday</refname> - <refpurpose>Sets the recurrence of the streams global event structure</refpurpose> + <refpurpose> + Sets the recurrence of the streams global event structure + </refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> - <funcdef>int <function>mcal_event_set_recur_monthly_wday</function></funcdef> + <funcdef>int + <function>mcal_event_set_recur_monthly_wday</function> + </funcdef> <paramdef>int <parameter>stream</parameter></paramdef> <paramdef>int <parameter>year</parameter></paramdef> <paramdef>int <parameter>month</parameter></paramdef> @@ -718,22 +794,26 @@ <paramdef>int <parameter>interval</parameter></paramdef> </funcsynopsis> <para> - <function>mcal_event_set_recur_monthly_wday</function> - sets the streams global event structure's -recurrence to the given value to be reoccuring on a monthly by week basis, ending at the given -date. + <function>mcal_event_set_recur_monthly_wday</function> sets the + streams global event structure's recurrence to the given value to + be reoccuring on a monthly by week basis, ending at the given + date. </refsect1> </refentry> <refentry id="function.mcal-event-set-recur-yearly"> <refnamediv> <refname>mcal_event_set_recur_yearly</refname> - <refpurpose>Sets the recurrence of the streams global event structure</refpurpose> + <refpurpose> + Sets the recurrence of the streams global event structure + </refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> - <funcdef>int <function>mcal_event_set_recur_yearly</function></funcdef> + <funcdef>int + <function>mcal_event_set_recur_yearly</function> + </funcdef> <paramdef>int <parameter>stream</parameter></paramdef> <paramdef>int <parameter>year</parameter></paramdef> <paramdef>int <parameter>month</parameter></paramdef> @@ -744,75 +824,78 @@ <paramdef>int <parameter>interval</parameter></paramdef> </funcsynopsis> <para> - <function>mcal_event_set_recur_yearly</function> - sets the streams global event structure's -recurrence to the given value to be reoccuring on a yearly basis,ending at the given date . + <function>mcal_event_set_recur_yearly</function> sets the streams + global event structure's recurrence to the given value to be + reoccuring on a yearly basis,ending at the given date . </refsect1> </refentry> <refentry id="function.mcal-fetch-current-stream-event"> <refnamediv> <refname>mcal_fetch_current_stream_event</refname> - <refpurpose>Returns an object containing the current streams event structure</refpurpose> + <refpurpose> + Returns an object containing the current streams event structure + </refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> - <funcdef>int <function>mcal_fetch_current_stream_event</function></funcdef> + <funcdef>int + <function>mcal_fetch_current_stream_event</function> + </funcdef> <paramdef>int <parameter>stream</parameter></paramdef> </funcsynopsis> <para> <function>mcal_event_fetch_current_stream_event</function> -returns the current stream's event structure as an object containing: + returns the current stream's event structure as an object + containing: - <itemizedlist> - <listitem><simpara> - int id - ID of that event. - <listitem><simpara> - int public - TRUE if the event if public, FALSE if it is private. - <listitem><simpara> - string category - Category string of the event. - <listitem><simpara> - string title - Title string of the event. - <listitem><simpara> - string description - Description string of the event. - <listitem><simpara> - int alarm - number of minutes before the event to send an alarm/reminder. - <listitem><simpara> - object start - Object containing a datetime entry. - <listitem><simpara> - object end - Object containing a datetime entry. - <listitem><simpara> - int recur_type - recurrence type - </itemizedlist> - <listitem><simpara> - int recur_interval - recurrence interval - </itemizedlist> - <listitem><simpara> - datetime recur_endate - recurrence end date - </itemizedlist> - <listitem><simpara> - int recur_data - recurrence data + <itemizedlist> + <listitem><simpara> + int id - ID of that event. + <listitem><simpara> + int public - TRUE if the event if public, FALSE if it is + private. + <listitem><simpara> + string category - Category string of the event. + <listitem><simpara> + string title - Title string of the event. + <listitem><simpara> + string description - Description string of the event. + <listitem><simpara> + int alarm - number of minutes before the event to send an + alarm/reminder. + <listitem><simpara> + object start - Object containing a datetime entry. + <listitem><simpara> + object end - Object containing a datetime entry. + <listitem><simpara> + int recur_type - recurrence type + <listitem><simpara> + int recur_interval - recurrence interval + <listitem><simpara> + datetime recur_endate - recurrence end date + <listitem><simpara> + int recur_data - recurrence data </itemizedlist> - All datetime entries consist of an object that contains: - <itemizedlist> + All datetime entries consist of an object that contains: + <itemizedlist> <listitem><simpara> - int year - year + int year - year <listitem><simpara> - int month - month + int month - month <listitem><simpara> - int mday - day of month + int mday - day of month <listitem><simpara> - int hour - hour - <listitem><simpara> - int min - minutes - <listitem><simpara> - int sec - seconds - </itemizedlist> - <listitem><simpara> - int alarm - minutes before event to send an alarm + int hour - hour + <listitem><simpara> + int min - minutes + <listitem><simpara> + int sec - seconds + <listitem><simpara> + int alarm - minutes before event to send an alarm </itemizedlist> </refsect1> </refentry>