aboutsummaryrefslogtreecommitdiffstats
path: root/doc/devel/calendar
diff options
context:
space:
mode:
Diffstat (limited to 'doc/devel/calendar')
-rw-r--r--doc/devel/calendar/cal-client/evolution-cal-client-decl.txt39
-rw-r--r--doc/devel/calendar/cal-client/evolution-cal-client.hierarchy3
-rw-r--r--doc/devel/calendar/cal-client/evolution-cal-client.signals6
-rw-r--r--doc/devel/calendar/cal-client/tmpl/cal-client.sgml18
-rw-r--r--doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml16
-rw-r--r--doc/devel/calendar/cal-util/evolution-cal-util-decl.txt34
-rw-r--r--doc/devel/calendar/cal-util/evolution-cal-util.hierarchy3
-rw-r--r--doc/devel/calendar/cal-util/tmpl/cal-component.sgml64
-rw-r--r--doc/devel/calendar/cal-util/tmpl/cal-util.sgml6
-rw-r--r--doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml3
10 files changed, 71 insertions, 121 deletions
diff --git a/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt b/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt
index 498285a370..54de988830 100644
--- a/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt
+++ b/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt
@@ -1,3 +1,16 @@
+<ENUM>
+<NAME>CalClientChangeType</NAME>
+typedef enum {
+ CAL_CLIENT_CHANGE_ADDED = 1 << 0,
+ CAL_CLIENT_CHANGE_MODIFIED = 1 << 1,
+ CAL_CLIENT_CHANGE_DELETED = 1 << 2
+} CalClientChangeType;
+</ENUM>
+<FUNCTION>
+<NAME>cal_client_change_list_free</NAME>
+<RETURNS>void </RETURNS>
+GList *list
+</FUNCTION>
<MACRO>
<NAME>CAL_CLIENT_TYPE</NAME>
#define CAL_CLIENT_TYPE (cal_client_get_type ())
@@ -53,6 +66,19 @@ struct CalClient {
CalClientPrivate *priv;
};
</STRUCT>
+<STRUCT>
+<NAME>CalClientClass</NAME>
+struct CalClientClass {
+ GtkObjectClass parent_class;
+
+ /* Notification signals */
+
+ void (* cal_loaded) (CalClient *client, CalClientLoadStatus status);
+
+ void (* obj_updated) (CalClient *client, const char *uid);
+ void (* obj_removed) (CalClient *client, const char *uid);
+};
+</STRUCT>
<FUNCTION>
<NAME>cal_client_get_type</NAME>
<RETURNS>GtkType </RETURNS>
@@ -138,16 +164,3 @@ CalClient *client, CalComponent *comp
<RETURNS>gboolean </RETURNS>
CalClient *client, const char *uid
</FUNCTION>
-<ENUM>
-<NAME>CalClientChangeType</NAME>
-typedef enum {
- CAL_CLIENT_CHANGE_ADDED = 1 << 0,
- CAL_CLIENT_CHANGE_MODIFIED = 1 << 1,
- CAL_CLIENT_CHANGE_DELETED = 1 << 2
-} CalClientChangeType;
-</ENUM>
-<FUNCTION>
-<NAME>cal_client_change_list_free</NAME>
-<RETURNS>void </RETURNS>
-GList *list
-</FUNCTION>
diff --git a/doc/devel/calendar/cal-client/evolution-cal-client.hierarchy b/doc/devel/calendar/cal-client/evolution-cal-client.hierarchy
index 88efa3e673..21651b5e89 100644
--- a/doc/devel/calendar/cal-client/evolution-cal-client.hierarchy
+++ b/doc/devel/calendar/cal-client/evolution-cal-client.hierarchy
@@ -1,2 +1,5 @@
GtkObject
+ GtkWidget
+ GtkRange
+ GtkContainer
CalClient
diff --git a/doc/devel/calendar/cal-client/evolution-cal-client.signals b/doc/devel/calendar/cal-client/evolution-cal-client.signals
index d5af728e6f..97e360b6a2 100644
--- a/doc/devel/calendar/cal-client/evolution-cal-client.signals
+++ b/doc/devel/calendar/cal-client/evolution-cal-client.signals
@@ -2,20 +2,20 @@
<NAME>CalClient::cal-loaded</NAME>
<RETURNS>void</RETURNS>
CalClient *calclient
-gint arg1
+GtkEnum arg1
</SIGNAL>
<SIGNAL>
<NAME>CalClient::obj-updated</NAME>
<RETURNS>void</RETURNS>
CalClient *calclient
-gchar *arg1
+GtkString arg1
</SIGNAL>
<SIGNAL>
<NAME>CalClient::obj-removed</NAME>
<RETURNS>void</RETURNS>
CalClient *calclient
-gchar *arg1
+GtkString arg1
</SIGNAL>
diff --git a/doc/devel/calendar/cal-client/tmpl/cal-client.sgml b/doc/devel/calendar/cal-client/tmpl/cal-client.sgml
index 6de1ab8045..d3ef7c8113 100644
--- a/doc/devel/calendar/cal-client/tmpl/cal-client.sgml
+++ b/doc/devel/calendar/cal-client/tmpl/cal-client.sgml
@@ -61,15 +61,6 @@ GTK+ object for communication with personal calendar server.
destroyed.
</para>
-@CAL_CLIENT_LOAD_SUCCESS: Indicates a successful load or create
- operation; the corresponding calendar is ready for use.
-@CAL_CLIENT_LOAD_ERROR: Indicates an error while loading or creating
- the calendar.
-@CAL_CLIENT_LOAD_IN_USE: Indicates that a create request failed
- because the specified calendar was already being used by another
- client.
-@CAL_CLIENT_LOAD_METHOD_NOT_SUPPORTED: Indicates an error due to
- trying to load a calendar for which a backend type is not present.
<!-- ##### ENUM CalClientGetStatus ##### -->
<para>
@@ -77,21 +68,12 @@ GTK+ object for communication with personal calendar server.
function.
</para>
-@CAL_CLIENT_GET_SUCCESS: Indicates a successful get operation.
-@CAL_CLIENT_GET_NOT_FOUND: Indicates that the requested object was
- not found.
-@CAL_CLIENT_GET_SYNTAX_ERROR: Indicates a syntax error when parsing
- the requested object. This could indicate a bug in the calendar
- client libraries or in the Wombat server.
<!-- ##### ENUM CalClientChangeType ##### -->
<para>
</para>
-@CAL_CLIENT_CHANGE_ADDED:
-@CAL_CLIENT_CHANGE_MODIFIED:
-@CAL_CLIENT_CHANGE_DELETED:
<!-- ##### FUNCTION cal_client_new ##### -->
<para>
diff --git a/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml b/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml
index a0c23894d9..77eb4a2b15 100644
--- a/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml
+++ b/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml
@@ -1,22 +1,22 @@
-<!-- ##### FUNCTION cal_client_update_pilot_id ##### -->
+<!-- ##### FUNCTION cal_client_get_events_in_range ##### -->
<para>
</para>
@client:
-@uid:
-@pilot_id:
-@pilot_status:
+@start:
+@end:
+@Returns:
-<!-- ##### FUNCTION cal_client_get_events_in_range ##### -->
+<!-- ##### FUNCTION cal_client_update_pilot_id ##### -->
<para>
</para>
@client:
-@start:
-@end:
-@Returns:
+@uid:
+@pilot_id:
+@pilot_status:
<!-- ##### FUNCTION cal_client_get_uid_by_pilot_id ##### -->
<para>
diff --git a/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt b/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt
index 573ce73a65..5ffc920dd4 100644
--- a/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt
+++ b/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt
@@ -64,7 +64,7 @@ typedef enum {
CAL_COMPONENT_CLASS_UNKNOWN
} CalComponentClassification;
</ENUM>
-<TYPEDEF>
+<STRUCT>
<NAME>CalComponentDateTime</NAME>
typedef struct {
/* Actual date/time value */
@@ -73,7 +73,7 @@ typedef struct {
/* Timezone ID */
const char *tzid;
} CalComponentDateTime;
-</TYPEDEF>
+</STRUCT>
<ENUM>
<NAME>CalComponentPeriodType</NAME>
typedef enum {
@@ -81,7 +81,7 @@ typedef enum {
CAL_COMPONENT_PERIOD_DURATION
} CalComponentPeriodType;
</ENUM>
-<TYPEDEF>
+<STRUCT>
<NAME>CalComponentPeriod</NAME>
typedef struct {
CalComponentPeriodType type;
@@ -93,8 +93,8 @@ typedef struct {
struct icaldurationtype duration;
} u;
} CalComponentPeriod;
-</TYPEDEF>
-<TYPEDEF>
+</STRUCT>
+<STRUCT>
<NAME>CalComponentText</NAME>
typedef struct {
/* Description string */
@@ -103,7 +103,7 @@ typedef struct {
/* Alternate representation URI */
const char *altrep;
} CalComponentText;
-</TYPEDEF>
+</STRUCT>
<ENUM>
<NAME>CalComponentTransparency</NAME>
typedef enum {
@@ -131,6 +131,12 @@ struct CalComponent {
CalComponentPrivate *priv;
};
</STRUCT>
+<STRUCT>
+<NAME>CalComponentClass</NAME>
+struct CalComponentClass {
+ GtkObjectClass parent_class;
+};
+</STRUCT>
<FUNCTION>
<NAME>cal_component_get_type</NAME>
<RETURNS>GtkType </RETURNS>
@@ -529,7 +535,7 @@ GSList *text_list
<STRUCT>
<NAME>CalComponentAlarm</NAME>
</STRUCT>
-<TYPEDEF>
+<STRUCT>
<NAME>CalAlarmInstance</NAME>
typedef struct {
/* UID of the alarm that triggered */
@@ -541,8 +547,8 @@ typedef struct {
/* Actual event occurrence to which this trigger corresponds */
time_t occur;
} CalAlarmInstance;
-</TYPEDEF>
-<TYPEDEF>
+</STRUCT>
+<STRUCT>
<NAME>CalComponentAlarms</NAME>
typedef struct {
/* The actual component */
@@ -551,7 +557,7 @@ typedef struct {
/* List of CalAlarmInstance structures */
GSList *alarms;
} CalComponentAlarms;
-</TYPEDEF>
+</STRUCT>
<ENUM>
<NAME>CalAlarmAction</NAME>
typedef enum {
@@ -572,7 +578,7 @@ typedef enum {
CAL_ALARM_TRIGGER_ABSOLUTE
} CalAlarmTriggerType;
</ENUM>
-<TYPEDEF>
+<STRUCT>
<NAME>CalAlarmTrigger</NAME>
typedef struct {
CalAlarmTriggerType type;
@@ -582,7 +588,7 @@ typedef struct {
struct icaltimetype abs_time;
} u;
} CalAlarmTrigger;
-</TYPEDEF>
+</STRUCT>
<FUNCTION>
<NAME>cal_component_has_alarms</NAME>
<RETURNS>gboolean </RETURNS>
@@ -646,14 +652,14 @@ CalComponent *comp,
<RETURNS>void </RETURNS>
CalComponent *comp,time_t start,time_t end,CalRecurInstanceFn cb,gpointer cb_data
</FUNCTION>
-<TYPEDEF>
+<STRUCT>
<NAME>CalObjInstance</NAME>
typedef struct {
char *uid; /* UID of the object */
time_t start; /* Start time of instance */
time_t end; /* End time of instance */
} CalObjInstance;
-</TYPEDEF>
+</STRUCT>
<FUNCTION>
<NAME>cal_obj_instance_list_free</NAME>
<RETURNS>void </RETURNS>
diff --git a/doc/devel/calendar/cal-util/evolution-cal-util.hierarchy b/doc/devel/calendar/cal-util/evolution-cal-util.hierarchy
index cc235653f2..469eb0f478 100644
--- a/doc/devel/calendar/cal-util/evolution-cal-util.hierarchy
+++ b/doc/devel/calendar/cal-util/evolution-cal-util.hierarchy
@@ -1,2 +1,5 @@
GtkObject
+ GtkWidget
+ GtkRange
+ GtkContainer
CalComponent
diff --git a/doc/devel/calendar/cal-util/tmpl/cal-component.sgml b/doc/devel/calendar/cal-util/tmpl/cal-component.sgml
index c429e22a9c..14943a155e 100644
--- a/doc/devel/calendar/cal-util/tmpl/cal-component.sgml
+++ b/doc/devel/calendar/cal-util/tmpl/cal-component.sgml
@@ -83,13 +83,6 @@ RFC 2445 iCalendar component object.
vtype of an uninitialized #CalComponent.
</para>
-@CAL_COMPONENT_NO_TYPE: Returned from cal_component_get_vtype() to
- indicate an uninitialized #CalComponent object.
-@CAL_COMPONENT_EVENT: Indicates a VEVENT component.
-@CAL_COMPONENT_TODO: Indicates a VTODO component.
-@CAL_COMPONENT_JOURNAL: Indicates a VJOURNAL component.
-@CAL_COMPONENT_FREEBUSY: Indicates a VFREEBUSY component.
-@CAL_COMPONENT_TIMEZONE: Indicates a VTIMEZOME component.
<!-- ##### ENUM CalComponentField ##### -->
<para>
@@ -97,25 +90,6 @@ RFC 2445 iCalendar component object.
are used by the calendar GUI code in &Evolution;.
</para>
-@CAL_COMPONENT_FIELD_CATEGORIES: Component's list of categories.
-@CAL_COMPONENT_FIELD_CLASSIFICATION: Component's classification.
-@CAL_COMPONENT_FIELD_COMPLETED: Component's completion date.
-@CAL_COMPONENT_FIELD_DTEND: Component's ending date.
-@CAL_COMPONENT_FIELD_DTSTART: Component's starting date.
-@CAL_COMPONENT_FIELD_DUE: Component's due date.
-@CAL_COMPONENT_FIELD_GEO: Component's geographical position.
-@CAL_COMPONENT_FIELD_PERCENT: Component's percent completed value.
-@CAL_COMPONENT_FIELD_PRIORITY: Component's priority.
-@CAL_COMPONENT_FIELD_SUMMARY: Component's summary.
-@CAL_COMPONENT_FIELD_TRANSPARENCY: Component's transparency value.
-@CAL_COMPONENT_FIELD_URL: Component's URL.
-@CAL_COMPONENT_FIELD_HAS_ALARMS: Whether the component has any alarms.
-@CAL_COMPONENT_FIELD_ICON: Which icon to use for the component.
-@CAL_COMPONENT_FIELD_COMPLETE: Whether the component has been completed.
-@CAL_COMPONENT_FIELD_RECURRING: Whether the component has any recurrences.
-@CAL_COMPONENT_FIELD_OVERDUE: Whether the component is overdue.
-@CAL_COMPONENT_FIELD_COLOR: Which color to use for the component.
-@CAL_COMPONENT_FIELD_NUM_FIELDS: Total number of enumerated fields.
<!-- ##### ENUM CalComponentClassification ##### -->
<para>
@@ -123,16 +97,8 @@ RFC 2445 iCalendar component object.
component.
</para>
-@CAL_COMPONENT_CLASS_NONE: Indicates that no access classification has
- been set for the corresponding component.
-@CAL_COMPONENT_CLASS_PUBLIC: Public access.
-@CAL_COMPONENT_CLASS_PRIVATE: Private access.
-@CAL_COMPONENT_CLASS_CONFIDENTIAL: Confidential access.
-@CAL_COMPONENT_CLASS_UNKNOWN: Unknown access classification value,
- used when &libical; returns something #CalComponent does not know
- about.
-<!-- ##### TYPEDEF CalComponentDateTime ##### -->
+<!-- ##### STRUCT CalComponentDateTime ##### -->
<para>
This structure defines a date and time value.
</para>
@@ -143,18 +109,14 @@ RFC 2445 iCalendar component object.
Defines how a period of time is specified.
</para>
-@CAL_COMPONENT_PERIOD_DATETIME: Indicates that the period is specified
- by starting and ending date/time values.
-@CAL_COMPONENT_PERIOD_DURATION: Indicates that the period is specified
- as a starding date/time and a duration value.
-<!-- ##### TYPEDEF CalComponentPeriod ##### -->
+<!-- ##### STRUCT CalComponentPeriod ##### -->
<para>
This structure defines a period of time.
</para>
-<!-- ##### TYPEDEF CalComponentText ##### -->
+<!-- ##### STRUCT CalComponentText ##### -->
<para>
This structure defines the value of a text property that may have
an alternate representation parameter.
@@ -166,10 +128,6 @@ RFC 2445 iCalendar component object.
</para>
-@CAL_COMPONENT_TRANSP_NONE:
-@CAL_COMPONENT_TRANSP_TRANSPARENT:
-@CAL_COMPONENT_TRANSP_OPAQUE:
-@CAL_COMPONENT_TRANSP_UNKNOWN:
<!-- ##### FUNCTION cal_component_gen_uid ##### -->
<para>
@@ -848,13 +806,13 @@ RFC 2445 iCalendar component object.
</para>
-<!-- ##### TYPEDEF CalAlarmInstance ##### -->
+<!-- ##### STRUCT CalAlarmInstance ##### -->
<para>
</para>
-<!-- ##### TYPEDEF CalComponentAlarms ##### -->
+<!-- ##### STRUCT CalComponentAlarms ##### -->
<para>
</para>
@@ -865,24 +823,14 @@ RFC 2445 iCalendar component object.
</para>
-@CAL_ALARM_NONE:
-@CAL_ALARM_AUDIO:
-@CAL_ALARM_DISPLAY:
-@CAL_ALARM_EMAIL:
-@CAL_ALARM_PROCEDURE:
-@CAL_ALARM_UNKNOWN:
<!-- ##### ENUM CalAlarmTriggerType ##### -->
<para>
</para>
-@CAL_ALARM_TRIGGER_NONE:
-@CAL_ALARM_TRIGGER_RELATIVE_START:
-@CAL_ALARM_TRIGGER_RELATIVE_END:
-@CAL_ALARM_TRIGGER_ABSOLUTE:
-<!-- ##### TYPEDEF CalAlarmTrigger ##### -->
+<!-- ##### STRUCT CalAlarmTrigger ##### -->
<para>
</para>
diff --git a/doc/devel/calendar/cal-util/tmpl/cal-util.sgml b/doc/devel/calendar/cal-util/tmpl/cal-util.sgml
index ccd35fac2e..0009f54fed 100644
--- a/doc/devel/calendar/cal-util/tmpl/cal-util.sgml
+++ b/doc/devel/calendar/cal-util/tmpl/cal-util.sgml
@@ -14,7 +14,7 @@ Miscellaneous utilities
</para>
-<!-- ##### TYPEDEF CalObjInstance ##### -->
+<!-- ##### STRUCT CalObjInstance ##### -->
<para>
</para>
@@ -33,10 +33,6 @@ Miscellaneous utilities
</para>
-@CALOBJ_TYPE_EVENT:
-@CALOBJ_TYPE_TODO:
-@CALOBJ_TYPE_JOURNAL:
-@CALOBJ_TYPE_ANY:
<!-- ##### FUNCTION cal_obj_uid_list_free ##### -->
<para>
diff --git a/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml b/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml
index b2a547aec9..ff68fae99d 100644
--- a/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml
+++ b/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml
@@ -53,8 +53,7 @@
</para>
-@trigger:
-<!--
+@trigger: <!--
Local variables:
mode: sgml
sgml-parent-document: ("../../../evolution-devel-guide.sgml" "book" "refsect2" "")