cvs: /phpdoc/functions mcal.sgml

musone Fri Sep 10 17:36:56 1999 EDT Modified files: /phpdoc/functions mcal.sgml Log: added updated information and new functions Index: phpdoc/functions/mcal.sgml diff -u phpdoc/functions/mcal.sgml:1.2 phpdoc/functions/mcal.sgml:1.3 --- phpdoc/functions/mcal.sgml:1.2 Thu Sep 2 23:04:12 1999 +++ phpdoc/functions/mcal.sgml Fri Sep 10 17:36:56 1999 @@ -8,13 +8,13 @@ libmcal is a C library for accessing calendars. It's written to be very modular, with plugable drivers. MCAL is the calendar -equivalent of IMAP for mailboxes. +equivalent of the IMAP module for mailboxes. with mcal support, a calendar stream can be opened much like the -mailbox stream with the IMAP support. calendars can be local file stores, +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 +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 @@ -28,6 +28,35 @@ 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> </partintro> <refentry id="function.mcal-open"> @@ -50,7 +79,7 @@ <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. + <parameter>options</parameter> to that mailbox also. The streams internal event structure is also initialized upon connection. <para> </refsect1> </refentry> @@ -109,7 +138,19 @@ object start - Object containing a datetime entry. <listitem><simpara> object end - Object containing a datetime entry. - </itemizedlist> + <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> + All datetime entries consist of an object that contains: <itemizedlist> @@ -126,6 +167,9 @@ <listitem><simpara> int sec - seconds </itemizedlist> + <listitem><simpara> + int alarm - minutes before event to send an alarm + </itemizedlist> </refsect1> </refentry> @@ -141,31 +185,22 @@ <funcsynopsis> <funcdef>array <function>mcal_list_events</function></funcdef> <paramdef>stream <parameter>mcal_stream</parameter></paramdef> - <paramdef>datetime <parameter>begin_date</parameter></paramdef> - <paramdef>datetime <parameter>end_date</parameter></paramdef> + <paramdef>[int <parameter>begin_year</parameter></paramdef> + <paramdef>int <parameter>begin_month</parameter></paramdef> + <paramdef>int <parameter>begin_day</parameter></paramdef> + <paramdef>int <parameter>end_year</parameter></paramdef> + <paramdef>int <parameter>end_month</parameter></paramdef> + <paramdef>int <parameter>end_day]</parameter></paramdef> </funcsynopsis> <para> - Returns an array of event ID's that are between the two given datetimes. + 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 a beginning datetime - and an end datetime for a calendar stream. An array of event id's that are between - the given datetimes are returned. + <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. - All datetime entries consist of an object that contains: - <itemizedlist> - <listitem><simpara> - int year - year - <listitem><simpara> - int month - month - <listitem><simpara> - int mday - day of month - <listitem><simpara> - int hour - hour - <listitem><simpara> - int min - minutes - <listitem><simpara> - int sec - seconds - </itemizedlist> </refsect1> </refentry> @@ -180,44 +215,10 @@ <funcsynopsis> <funcdef>int <function>mcal_store_event</function></funcdef> <paramdef>int <parameter>mcal_stream</parameter></paramdef> - <paramdef>object <parameter>event</parameter></paramdef> </funcsynopsis> <para> - <function>mcal_store_event</function> Stores an event into - an MCAL calendar. - an event object consists of: - <itemizedlist> - <listitem><simpara> - int public - 1 if public, 0 if private; - <listitem><simpara> - string caegory - 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 sned out an alarm. - <listitem><simpara> - datetime start - datetime object of the start of the event. - <listitem><simpara> - datetime end - datetime object of the end of the event. - </itemizedlist> - All datetime entries consist of an object that contains: - <itemizedlist> - <listitem><simpara> - int year - year - <listitem><simpara> - int month - month - <listitem><simpara> - int mday - day of month - <listitem><simpara> - int hour - hour - <listitem><simpara> - int min - minutes - <listitem><simpara> - int sec - seconds - </itemizedlist> - + <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> @@ -264,23 +265,537 @@ <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> <funcsynopsis> - <funcdef>array <function>mcal_list_alarms</function></funcdef> + <funcdef>array <function>mcal_list_events</function></funcdef> <paramdef>stream <parameter>mcal_stream</parameter></paramdef> - <paramdef>datetime <parameter>alarm_date</parameter></paramdef> + <paramdef>[int <parameter>begin_year</parameter></paramdef> + <paramdef>int <parameter>begin_month</parameter></paramdef> + <paramdef>int <parameter>begin_day</parameter></paramdef> + <paramdef>int <parameter>end_year</parameter></paramdef> + <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. + + </refsect1> + </refentry> + + <refentry id="function.mcal-event-init"> + <refnamediv> + <refname>mcal_event_init</refname> + <refpurpose>initializes a streams global event structure</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>int <function>mcal_event_init</function></funcdef> + <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. + <para> + Returns true. + </refsect1> + </refentry> + + <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> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>int <function>mcal_event_set_category</function></funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <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. + <para> + Returns true. + </refsect1> + </refentry> + + <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> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>int <function>mcal_event_set_title</function></funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <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. + <para> + Returns true. + </refsect1> + </refentry> + + <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> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <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. + <para> + Returns true. + </refsect1> + </refentry> + + <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> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>int <function>mcal_event_set_start</function></funcdef> + <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> + </funcsynopsis> + <para> + <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> + </refentry> + + <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> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>int <function>mcal_event_set_end</function></funcdef> + <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> + </funcsynopsis> + <para> + <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> + </refentry> + + <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> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>int <function>mcal_event_set_alarm</function></funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <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. + <para> + Returns true. + </refsect1> + </refentry> + + <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> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>int <function>mcal_event_set_class</function></funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <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. + <para> + Returns true. + </refsect1> + </refentry> + + + <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> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>int <function>mcal_is_leap_year</function></funcdef> + <paramdef>int <parameter>year</parameter></paramdef> + </funcsynopsis> + <para> + <function>mcal_is_leap_year</function> +returns 1 if the given year is a leap year, 1 if not. + </refsect1> + </refentry> + + <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> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>int <function>mcal_days_in_month</function></funcdef> + <paramdef>int <parameter>month</parameter></paramdef> + <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. + </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> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>int <function>mcal_date_valid</function></funcdef> + <paramdef>int <parameter>year</parameter></paramdef> + <paramdef>int <parameter>month</parameter></paramdef> + <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. + </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> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>int <function>mcal_time_valid</function></funcdef> + <paramdef>int <parameter>hour</parameter></paramdef> + <paramdef>int <parameter>minutes</parameter></paramdef> + <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. + </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> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>int <function>mcal_</function></funcdef> + <paramdef>int <parameter>year</parameter></paramdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int <parameter>day</parameter></paramdef> + </funcsynopsis> + <para> + <function>mcal_day_of_week</function> + returns the day of the week of the given date + <para> + Returns true. + </refsect1> + </refentry> + <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> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>int <function>mcal_</function></funcdef> + <paramdef>int <parameter>year</parameter></paramdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int <parameter>day</parameter></paramdef> </funcsynopsis> + <para> + <function>mcal_day_of_year</function> + returns the day of the year of the given date <para> - Returns an array of event ID's that has an alarm going off at the given datetime. + Returns true. + </refsect1> + </refentry> + + <refentry id="function.mcal-date-compare"> + <refnamediv> + <refname>mcal_date_compare</refname> + <refpurpose>Compares two dates</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>int <function>mcal_date_compare</function></funcdef> + <paramdef>int <parameter>a_year</parameter></paramdef> + <paramdef>int <parameter>a_month</parameter></paramdef> + <paramdef>int <parameter>a_day</parameter></paramdef> + <paramdef>int <parameter>b_year</parameter></paramdef> + <paramdef>int <parameter>b_month</parameter></paramdef> + <paramdef>int <parameter>b_day</parameter></paramdef> + </funcsynopsis> <para> - <function>mcal_list_alarms</function> function takes in a datetime - for a calendar stream. An array of event id's that has an alarm should be going off - at the datetime are returned. + <function>mcal_date_compare</function> + Compares the two given dates, returns <0, 0, >0 if a<b, a==b, a>b respectively + </refsect1> + </refentry> + <refentry id="function.mcal-next-recurrence"> + <refnamediv> + <refname>mcal_next_recurrence</refname> + <refpurpose>Returns the next recurrence of the event</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>int <function>mcal_next_recurrence</function></funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>int <parameter>weekstart</parameter></paramdef> + <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. + <para> + Returns true. + </refsect1> + </refentry> + + <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> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <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> + <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>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. + </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> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <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> + <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>interval</parameter></paramdef> + <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. + </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> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <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> + <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>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. + </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> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <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> + <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>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. + </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> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <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> + <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>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 . + </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> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <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: + + <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> + + All datetime entries consist of an object that contains: <itemizedlist> <listitem><simpara> @@ -294,12 +809,15 @@ <listitem><simpara> int min - minutes <listitem><simpara> - int sec - seconds + int sec - seconds </itemizedlist> + <listitem><simpara> + int alarm - minutes before event to send an alarm + </itemizedlist> </refsect1> </refentry> + - </reference> <!-- Keep this comment at the end of the file Local variables: