[Galago-commits] r2800 - in trunk/libgalago: . docs/reference
docs/reference/tmpl libgalago
galago-commits at freedesktop.org
galago-commits at freedesktop.org
Sat May 20 19:56:47 PDT 2006
Author: chipx86
Date: 2006-05-20 19:56:33 -0700 (Sat, 20 May 2006)
New Revision: 2800
Modified:
trunk/libgalago/ChangeLog
trunk/libgalago/docs/reference/libgalago-docs.sgml
trunk/libgalago/docs/reference/libgalago-sections.txt
trunk/libgalago/docs/reference/tmpl/galago-account.sgml
trunk/libgalago/docs/reference/tmpl/galago-assert.sgml
trunk/libgalago/docs/reference/tmpl/galago-context.sgml
trunk/libgalago/docs/reference/tmpl/galago-core.sgml
trunk/libgalago/docs/reference/tmpl/galago-dbus.sgml
trunk/libgalago/docs/reference/tmpl/galago-image.sgml
trunk/libgalago/docs/reference/tmpl/galago-key-value.sgml
trunk/libgalago/docs/reference/tmpl/galago-person.sgml
trunk/libgalago/docs/reference/tmpl/galago-presence.sgml
trunk/libgalago/docs/reference/tmpl/galago-private.sgml
trunk/libgalago/docs/reference/tmpl/galago-service.sgml
trunk/libgalago/docs/reference/tmpl/galago-status.sgml
trunk/libgalago/docs/reference/tmpl/galago-value.sgml
trunk/libgalago/docs/reference/tmpl/libgalago-unused.sgml
trunk/libgalago/libgalago/galago-account.c
trunk/libgalago/libgalago/galago-account.h
trunk/libgalago/libgalago/galago-assert.h
trunk/libgalago/libgalago/galago-context-base.h
trunk/libgalago/libgalago/galago-context-priv.h
trunk/libgalago/libgalago/galago-context.c
trunk/libgalago/libgalago/galago-context.h
trunk/libgalago/libgalago/galago-core.c
trunk/libgalago/libgalago/galago-core.h
trunk/libgalago/libgalago/galago-dbus.c
trunk/libgalago/libgalago/galago-dbus.h
trunk/libgalago/libgalago/galago-image.c
trunk/libgalago/libgalago/galago-image.h
trunk/libgalago/libgalago/galago-key-value.c
trunk/libgalago/libgalago/galago-key-value.h
trunk/libgalago/libgalago/galago-object.c
trunk/libgalago/libgalago/galago-object.h
trunk/libgalago/libgalago/galago-person.c
trunk/libgalago/libgalago/galago-person.h
trunk/libgalago/libgalago/galago-presence.c
trunk/libgalago/libgalago/galago-presence.h
trunk/libgalago/libgalago/galago-private.h
trunk/libgalago/libgalago/galago-service.c
trunk/libgalago/libgalago/galago-service.h
trunk/libgalago/libgalago/galago-status.c
trunk/libgalago/libgalago/galago-status.h
trunk/libgalago/libgalago/galago-value.c
trunk/libgalago/libgalago/galago-value.h
trunk/libgalago/libgalago/galago.h
Log:
Big ol' documentation update. Wowee.
Modified: trunk/libgalago/ChangeLog
===================================================================
--- trunk/libgalago/ChangeLog 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/ChangeLog 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,3 +1,52 @@
+Sat May 20 19:56:19 PDT 2006 Christian Hammond <chipx86 at chipx86.com>
+
+ * docs/reference/libgalago-docs.sgml:
+ * docs/reference/libgalago-sections.txt:
+ * docs/reference/tmpl/galago-account.sgml:
+ * docs/reference/tmpl/galago-assert.sgml:
+ * docs/reference/tmpl/galago-context.sgml:
+ * docs/reference/tmpl/galago-core.sgml:
+ * docs/reference/tmpl/galago-dbus.sgml:
+ * docs/reference/tmpl/galago-image.sgml:
+ * docs/reference/tmpl/galago-key-value.sgml:
+ * docs/reference/tmpl/galago-person.sgml:
+ * docs/reference/tmpl/galago-presence.sgml:
+ * docs/reference/tmpl/galago-private.sgml:
+ * docs/reference/tmpl/galago-service.sgml:
+ * docs/reference/tmpl/galago-status.sgml:
+ * docs/reference/tmpl/galago-value.sgml:
+ * docs/reference/tmpl/libgalago-unused.sgml:
+ * libgalago/galago-account.c:
+ * libgalago/galago-account.h:
+ * libgalago/galago-assert.h:
+ * libgalago/galago-context-base.h:
+ * libgalago/galago-context.c:
+ * libgalago/galago-context.h:
+ * libgalago/galago-context-priv.h:
+ * libgalago/galago-core.c:
+ * libgalago/galago-core.h:
+ * libgalago/galago-dbus.c:
+ * libgalago/galago-dbus.h:
+ * libgalago/galago.h:
+ * libgalago/galago-image.c:
+ * libgalago/galago-image.h:
+ * libgalago/galago-key-value.c:
+ * libgalago/galago-key-value.h:
+ * libgalago/galago-object.c:
+ * libgalago/galago-object.h:
+ * libgalago/galago-person.c:
+ * libgalago/galago-person.h:
+ * libgalago/galago-presence.c:
+ * libgalago/galago-presence.h:
+ * libgalago/galago-private.h:
+ * libgalago/galago-service.c:
+ * libgalago/galago-service.h:
+ * libgalago/galago-status.c:
+ * libgalago/galago-status.h:
+ * libgalago/galago-value.c:
+ * libgalago/galago-value.h:
+ - Big ol' documentation update. Wowee.
+
Wed May 17 18:27:05 PDT 2006 Christian Hammond <chipx86 at chipx86.com>
* docs/reference/tmpl/galago-account.sgml:
Modified: trunk/libgalago/docs/reference/libgalago-docs.sgml
===================================================================
--- trunk/libgalago/docs/reference/libgalago-docs.sgml 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/docs/reference/libgalago-docs.sgml 2006-05-21 02:56:33 UTC (rev 2800)
@@ -6,17 +6,24 @@
<title>libgalago Reference Manual</title>
</bookinfo>
- <chapter>
- <title>libgalago</title>
+ <chapter id='objects'>
+ <title>Object Reference</title>
<xi:include href="xml/galago-account.xml"/>
<xi:include href="xml/galago-context.xml"/>
<xi:include href="xml/galago-core.xml"/>
<xi:include href="xml/galago-image.xml"/>
- <xi:include href="xml/galago-key-value.xml"/>
<xi:include href="xml/galago-object.xml"/>
<xi:include href="xml/galago-person.xml"/>
<xi:include href="xml/galago-presence.xml"/>
<xi:include href="xml/galago-service.xml"/>
<xi:include href="xml/galago-status.xml"/>
</chapter>
+
+ <chapter id='utils'>
+ <title>Utility API</title>
+ <xi:include href="xml/galago-key-value.xml"/>
+ <xi:include href="xml/galago-value.xml"/>
+ <xi:include href="xml/galago-assert.xml"/>
+ <xi:include href="xml/galago-dbus.xml"/>
+ </chapter>
</book>
Modified: trunk/libgalago/docs/reference/libgalago-sections.txt
===================================================================
--- trunk/libgalago/docs/reference/libgalago-sections.txt 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/docs/reference/libgalago-sections.txt 2006-05-21 02:56:33 UTC (rev 2800)
@@ -289,6 +289,7 @@
</SECTION>
<SECTION>
+<TITLE>GalagoKeyValue</TITLE>
<FILE>galago-key-value</FILE>
galago_key_value_new
galago_key_value_destroy
@@ -299,37 +300,13 @@
</SECTION>
<SECTION>
+<TITLE>Assertion Macros</TITLE>
<FILE>galago-assert</FILE>
galago_goto_if_fail
</SECTION>
<SECTION>
-<FILE>galago-context-priv</FILE>
-GalagoContextOps
-galago_context_set_ops
-galago_context_add_service
-galago_context_remove_service
-galago_context_add_person
-galago_context_remove_person
-galago_context_add_object
-galago_context_remove_object
-galago_context_clear_objects
-</SECTION>
-
-<SECTION>
-<FILE>galago-private</FILE>
-_
-N_
-textdomain
-gettext
-dgettext
-dcgettext
-bindtextdomain
-bind_textdomain_codeset
-GALAGO_ME_ID
-</SECTION>
-
-<SECTION>
+<TITLE>GalagoValue</TITLE>
<FILE>galago-value</FILE>
GalagoValue
GalagoType
@@ -372,6 +349,7 @@
</SECTION>
<SECTION>
+<TITLE>GalagoContext</TITLE>
<FILE>galago-context</FILE>
galago_context_get_type
galago_context_new
@@ -389,6 +367,7 @@
</SECTION>
<SECTION>
+<TITLE>D-BUS Utility Functions</TITLE>
<FILE>galago-dbus</FILE>
DBUS_API_SUBJECT_TO_CHANGE
GALAGO_DBUS_SERVICE
@@ -408,4 +387,3 @@
galago_dbus_send_message_with_reply
galago_dbus_object_push_full
</SECTION>
-
Modified: trunk/libgalago/docs/reference/tmpl/galago-account.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-account.sgml 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/docs/reference/tmpl/galago-account.sgml 2006-05-21 02:56:33 UTC (rev 2800)
@@ -32,7 +32,7 @@
<!-- ##### STRUCT GalagoAccount ##### -->
<para>
-This is an opaque structure representing an account. This should be used
+This is an opaque structure representing an account. This should not be used
directly. Use the accessor functions below.
</para>
Modified: trunk/libgalago/docs/reference/tmpl/galago-assert.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-assert.sgml 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/docs/reference/tmpl/galago-assert.sgml 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,12 +1,12 @@
<!-- ##### SECTION Title ##### -->
-galago-assert
+Assertion Macros
<!-- ##### SECTION Short_Description ##### -->
+Assertion macros.
-
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+This contains useful assertion macros.
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -19,10 +19,11 @@
<!-- ##### MACRO galago_goto_if_fail ##### -->
<para>
-
+Jumps to a label if the condition fails. This is similar to
+g_return_if_fail(), but uses a goto instead of returns.
</para>
- at cond:
- at label:
+ at cond: The condition.
+ at label: The label to jump to if @cond fails.
Modified: trunk/libgalago/docs/reference/tmpl/galago-context.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-context.sgml 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/docs/reference/tmpl/galago-context.sgml 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,12 +1,14 @@
<!-- ##### SECTION Title ##### -->
-galago-context
+GalagoContext
<!-- ##### SECTION Short_Description ##### -->
+Context data
-
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+#GalagoContext stores per-context data, such as a list of people and services.
+It basically holds the top-level objects that otherwise don't have a parent.
+Developers should almost never need this. It's used in galago-daemon.
</para>
<!-- ##### SECTION See_Also ##### -->
Modified: trunk/libgalago/docs/reference/tmpl/galago-core.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-core.sgml 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/docs/reference/tmpl/galago-core.sgml 2006-05-21 02:56:33 UTC (rev 2800)
@@ -2,12 +2,19 @@
GalagoCore
<!-- ##### SECTION Short_Description ##### -->
+The core API.
-
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+The core API of Galago. These functions are used for initializing Galago,
+creating and retrieving top-level #GalagoPerson and #GalagoService objects,
+and listening to signals.
</para>
+<para>
+There is only one #GalagoCore object, and it exists as long as Galago is
+initialized (by calling galago_init()). You can retrieve a pointer to it
+using galago_get_core().
+</para>
<!-- ##### SECTION See_Also ##### -->
<para>
@@ -19,36 +26,43 @@
<!-- ##### MACRO GALAGO_DBUS_CORE_INTERFACE ##### -->
<para>
-
+The D-BUS interface that #GalagoCore maps to.
</para>
<!-- ##### MACRO GALAGO_DBUS_CORE_OBJECT ##### -->
<para>
-
+The D-BUS object path to the remote Core object.
</para>
<!-- ##### STRUCT GalagoCorePrivate ##### -->
<para>
-
+Private data belonging to a #GalagoCore.
</para>
<!-- ##### ENUM GalagoInitFlags ##### -->
<para>
-
+Initialization flags passed to galago_init().
</para>
@GALAGO_INIT_CLIENT:
+ Initialize as a client. The connection will be used for querying data
+ only.
@GALAGO_INIT_FEED:
+ Initialize as a feed. The connection will feed service, account, person,
+ and presence data to galago-daemon. This takes precedence over
+ %GALAGO_INIT_CLIENT.
@GALAGO_INIT_NO_ACTIVATION:
+ Don't activate the Galago service automatically.
<!-- ##### STRUCT GalagoCore ##### -->
<para>
-
+The core object. Fields should not be used directly.
+Use the accessor functions below.
</para>
Modified: trunk/libgalago/docs/reference/tmpl/galago-dbus.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-dbus.sgml 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/docs/reference/tmpl/galago-dbus.sgml 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,12 +1,14 @@
<!-- ##### SECTION Title ##### -->
-galago-dbus
+D-BUS Utility Functions
<!-- ##### SECTION Short_Description ##### -->
+D-BUS utility functions.
-
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+A set of Galago-specific utility functions for working with D-BUS. These
+functions should be considered semi-public, but are expected to change in
+time.
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -26,21 +28,21 @@
<!-- ##### MACRO GALAGO_DBUS_SERVICE ##### -->
<para>
-
+The Galago D-BUS service.
</para>
<!-- ##### MACRO GALAGO_DBUS_ERROR_INVALID_ATTRIBUTE ##### -->
<para>
-
+An "Invalid Attribute" D-BUS message error.
</para>
<!-- ##### MACRO GALAGO_DBUS_ERROR_OBJECT_NOT_FOUND ##### -->
<para>
-
+An "Object Not Found" D-BUS message error.
</para>
Modified: trunk/libgalago/docs/reference/tmpl/galago-image.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-image.sgml 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/docs/reference/tmpl/galago-image.sgml 2006-05-21 02:56:33 UTC (rev 2800)
@@ -2,11 +2,13 @@
GalagoImage
<!-- ##### SECTION Short_Description ##### -->
+Image data.
-
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+#GalagoImage represents image data, sort of like #GdkPixbuf. However,
+this only supports pointing to a file on disk, or the contents of the file
+itself. This is used for photos and avatars.
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -19,19 +21,20 @@
<!-- ##### STRUCT GalagoImagePrivate ##### -->
<para>
-
+Private data belonging to a #GalagoImage.
</para>
<!-- ##### STRUCT GalagoImage ##### -->
<para>
-
+This is an opaque structure representing an image. This should not be used
+directly. Use the accessor functions below.
</para>
<!-- ##### MACRO GALAGO_DBUS_IMAGE_INTERFACE ##### -->
<para>
-
+The D-BUS interface that #GalagoImage maps to.
</para>
Modified: trunk/libgalago/docs/reference/tmpl/galago-key-value.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-key-value.sgml 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/docs/reference/tmpl/galago-key-value.sgml 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,12 +1,14 @@
<!-- ##### SECTION Title ##### -->
-galago-key-value
+GalagoKeyValue
<!-- ##### SECTION Short_Description ##### -->
+Key/value pair.
-
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+#GalagoKeyValue is a key/value pair, returned in some lists. It uses a string
+for a key and a #GValue for the value type. As such, it can hold any value
+that has a #GType.
</para>
<!-- ##### SECTION See_Also ##### -->
Modified: trunk/libgalago/docs/reference/tmpl/galago-person.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-person.sgml 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/docs/reference/tmpl/galago-person.sgml 2006-05-21 02:56:33 UTC (rev 2800)
@@ -35,7 +35,7 @@
<!-- ##### STRUCT GalagoPerson ##### -->
<para>
-This is an opaque structure representing a person. This should be used
+This is an opaque structure representing a person. This should not be used
directly. Use the accessor functions below.
</para>
Modified: trunk/libgalago/docs/reference/tmpl/galago-presence.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-presence.sgml 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/docs/reference/tmpl/galago-presence.sgml 2006-05-21 02:56:33 UTC (rev 2800)
@@ -26,7 +26,7 @@
<!-- ##### STRUCT GalagoPresence ##### -->
<para>
-This is an opaque structure representing a presence. This should be used
+This is an opaque structure representing a presence. This should not be used
directly. Use the accessor functions below.
</para>
@@ -79,7 +79,7 @@
<!-- ##### MACRO GALAGO_DBUS_PRESENCE_INTERFACE ##### -->
<para>
-
+The D-BUS interface that #GalagoPresence maps to.
</para>
Modified: trunk/libgalago/docs/reference/tmpl/galago-private.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-private.sgml 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/docs/reference/tmpl/galago-private.sgml 2006-05-21 02:56:33 UTC (rev 2800)
@@ -17,79 +17,3 @@
<!-- ##### SECTION Stability_Level ##### -->
-<!-- ##### MACRO _ ##### -->
-<para>
-
-</para>
-
- at String:
-
-
-<!-- ##### MACRO N_ ##### -->
-<para>
-
-</para>
-
- at String:
-
-
-<!-- ##### MACRO textdomain ##### -->
-<para>
-
-</para>
-
- at String:
-
-
-<!-- ##### MACRO gettext ##### -->
-<para>
-
-</para>
-
- at String:
-
-
-<!-- ##### MACRO dgettext ##### -->
-<para>
-
-</para>
-
- at Domain:
- at String:
-
-
-<!-- ##### MACRO dcgettext ##### -->
-<para>
-
-</para>
-
- at Domain:
- at String:
- at Type:
-
-
-<!-- ##### MACRO bindtextdomain ##### -->
-<para>
-
-</para>
-
- at Domain:
- at Directory:
-
-
-<!-- ##### MACRO bind_textdomain_codeset ##### -->
-<para>
-
-</para>
-
- at Domain:
- at Codeset:
-
-
-<!-- ##### MACRO GALAGO_ME_ID ##### -->
-<para>
-
-</para>
-
-
-
Modified: trunk/libgalago/docs/reference/tmpl/galago-service.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-service.sgml 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/docs/reference/tmpl/galago-service.sgml 2006-05-21 02:56:33 UTC (rev 2800)
@@ -50,7 +50,7 @@
<!-- ##### STRUCT GalagoService ##### -->
<para>
-This is an opaque structure representing a service. This should be used
+This is an opaque structure representing a service. This should not be used
directly. Use the accessor functions below.
</para>
Modified: trunk/libgalago/docs/reference/tmpl/galago-status.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-status.sgml 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/docs/reference/tmpl/galago-status.sgml 2006-05-21 02:56:33 UTC (rev 2800)
@@ -2,16 +2,23 @@
GalagoStatus
<!-- ##### SECTION Short_Description ##### -->
+Status type in a presence.
-
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+#GalagoStatus represents a single status in a #GalagoPresence. A status
+is something like "available" or "away." They may hold attributes, such
+as an away message.
</para>
+<para>
+Some statuses are exclusive. "available" and "away" would be exclusive
+statuses. Some are not exclusive, such as "invisible." These status types
+are dependent on the server that they are on.
+</para>
<!-- ##### SECTION See_Also ##### -->
<para>
-
+#GalagoPresence
</para>
<!-- ##### SECTION Stability_Level ##### -->
@@ -19,88 +26,96 @@
<!-- ##### STRUCT GalagoStatusPrivate ##### -->
<para>
-
+Private data belonging to a #GalagoStatus.
</para>
<!-- ##### ENUM GalagoStatusType ##### -->
<para>
-
+A type of status primitive. These are the most common ways to describe a
+status, and are used for availability determination and calculations.
</para>
@GALAGO_STATUS_UNSET:
+ Unset. This is never set and only used as an error return type.
@GALAGO_STATUS_OFFLINE:
+ Offline.
@GALAGO_STATUS_AVAILABLE:
+ Available.
@GALAGO_STATUS_AWAY:
+ Away from the computer.
@GALAGO_STATUS_EXTENDED_AWAY:
+ Away for a long period of time.
@GALAGO_STATUS_HIDDEN:
+ Hidden from view from others.
<!-- ##### MACRO GALAGO_STATUS_ID_AVAILABLE ##### -->
<para>
-
+Available.
</para>
<!-- ##### MACRO GALAGO_STATUS_ID_AWAY ##### -->
<para>
-
+Away from the computer.
</para>
<!-- ##### MACRO GALAGO_STATUS_ID_BRB ##### -->
<para>
-
+Be right back.
</para>
<!-- ##### MACRO GALAGO_STATUS_ID_BUSY ##### -->
<para>
-
+Busy.
</para>
<!-- ##### MACRO GALAGO_STATUS_ID_DND ##### -->
<para>
-
+Do not disturb.
</para>
<!-- ##### MACRO GALAGO_STATUS_ID_EXTENDED_AWAY ##### -->
<para>
-
+Away for a longer period of time.
</para>
<!-- ##### MACRO GALAGO_STATUS_ID_HIDDEN ##### -->
<para>
-
+Hidden from others.
</para>
<!-- ##### MACRO GALAGO_STATUS_ID_OFFLINE ##### -->
<para>
-
+Offline.
</para>
<!-- ##### MACRO GALAGO_STATUS_ATTR_MESSAGE ##### -->
<para>
-
+Message status attribute. This is used for away and available message text.
</para>
<!-- ##### STRUCT GalagoStatus ##### -->
<para>
-
+This is an opaque structure representing a status. This should not be used
+directly. Use the accessor functions below.
</para>
Modified: trunk/libgalago/docs/reference/tmpl/galago-value.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-value.sgml 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/docs/reference/tmpl/galago-value.sgml 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,12 +1,15 @@
<!-- ##### SECTION Title ##### -->
-galago-value
+GalagoValue
<!-- ##### SECTION Short_Description ##### -->
+Generic data type container.
-
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+This is a generic data type container, similar in ways to #GValue. It was
+originally written before libgalago was glib-based. It will go away in time,
+to be replaced with #GValue. Currently, this is used only in the D-BUS
+utility functions.
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -29,20 +32,35 @@
</para>
@GALAGO_VALUE_TYPE_UNKNOWN:
+ Unknown type.
@GALAGO_VALUE_TYPE_CHAR:
+ Character.
@GALAGO_VALUE_TYPE_UCHAR:
+ Unsigned character.
@GALAGO_VALUE_TYPE_BOOLEAN:
+ Boolean
@GALAGO_VALUE_TYPE_SHORT:
+ Short integer.
@GALAGO_VALUE_TYPE_USHORT:
+ Unsigned short integer.
@GALAGO_VALUE_TYPE_INT:
+ Integer.
@GALAGO_VALUE_TYPE_UINT:
+ Unsigned integer.
@GALAGO_VALUE_TYPE_LONG:
+ Long integer.
@GALAGO_VALUE_TYPE_ULONG:
+ Unsigned long integer.
@GALAGO_VALUE_TYPE_STRING:
+ String.
@GALAGO_VALUE_TYPE_OBJECT:
+ Object pointer.
@GALAGO_VALUE_TYPE_POINTER:
+ Generic pointer.
@GALAGO_VALUE_TYPE_LIST:
+ A list of values.
@GALAGO_VALUE_TYPE_ARRAY:
+ An array of values.
<!-- ##### FUNCTION galago_value_new ##### -->
<para>
@@ -125,255 +143,255 @@
<!-- ##### FUNCTION galago_value_set_char ##### -->
<para>
-
+Sets the value's character data.
</para>
- at value:
- at data:
+ at value: The #GalagoValue.
+ at data: The character data.
<!-- ##### FUNCTION galago_value_set_uchar ##### -->
<para>
-
+Sets the value's unsigned char data.
</para>
- at value:
- at data:
+ at value: The #GalagoValue.
+ at data: The unsigned char data.
<!-- ##### FUNCTION galago_value_set_boolean ##### -->
<para>
-
+Sets the value's boolean data.
</para>
- at value:
- at data:
+ at value: The #GalagoValue.
+ at data: The boolean data.
<!-- ##### FUNCTION galago_value_set_short ##### -->
<para>
-
+Sets the value's short integer data.
</para>
- at value:
- at Param2:
+ at value: The #GalagoValue.
+ at Param2: The short integer data.
<!-- ##### FUNCTION galago_value_set_ushort ##### -->
<para>
-
+Sets the value's unsigned short integer data.
</para>
- at value:
- at Param2:
+ at value: The #GalagoValue.
+ at Param2: The unsigned short integer data.
<!-- ##### FUNCTION galago_value_set_int ##### -->
<para>
-
+Sets the value's integer data.
</para>
- at value:
- at data:
+ at value: The #GalagoValue.
+ at data: The integer data.
<!-- ##### FUNCTION galago_value_set_uint ##### -->
<para>
-
+Sets the value's unsigned integer data.
</para>
- at value:
- at data:
+ at value: The #GalagoValue.
+ at data: The unsigned integer data.
<!-- ##### FUNCTION galago_value_set_long ##### -->
<para>
-
+Sets the value's long integer data.
</para>
- at value:
- at Param2:
+ at value: The #GalagoValue.
+ at Param2: The long integer data.
<!-- ##### FUNCTION galago_value_set_ulong ##### -->
<para>
-
+Sets the value's unsigned long integer data.
</para>
- at value:
- at Param2:
+ at value: The #GalagoValue.
+ at Param2: The unsigned long integer data.
<!-- ##### FUNCTION galago_value_set_string ##### -->
<para>
-
+Sets the value's string data.
</para>
- at value:
- at data:
+ at value: The #GalagoValue.
+ at data: The string data.
<!-- ##### FUNCTION galago_value_set_object ##### -->
<para>
-
+Sets the value's object data.
</para>
- at value:
- at data:
+ at value: The #GalagoValue.
+ at data: The object data.
<!-- ##### FUNCTION galago_value_set_pointer ##### -->
<para>
-
+Sets the value's pointer data.
</para>
- at value:
- at data:
+ at value: The #GalagoValue.
+ at data: The pointer data.
<!-- ##### FUNCTION galago_value_set_list ##### -->
<para>
-
+Sets the value's list of values.
</para>
- at value:
- at data:
+ at value: The #GalagoValue.
+ at data: The list of values.
<!-- ##### FUNCTION galago_value_set_array ##### -->
<para>
-
+Sets the value's array of values.
</para>
- at value:
- at data:
- at size:
+ at value: The #GalagoValue.
+ at data: The array of values.
+ at size: The size of the array.
<!-- ##### FUNCTION galago_value_get_char ##### -->
<para>
-
+Returns the value's char data.
</para>
- at value:
- at Returns:
+ at value: The #GalagoValue.
+ at Returns: The char data.
<!-- ##### FUNCTION galago_value_get_uchar ##### -->
<para>
-
+Returns the value's unsigned character data.
</para>
- at value:
- at Returns:
+ at value: The #GalagoValue.
+ at Returns: The unsigned char data.
<!-- ##### FUNCTION galago_value_get_boolean ##### -->
<para>
-
+Returns the value's boolean data.
</para>
- at value:
- at Returns:
+ at value: The #GalagoValue.
+ at Returns: The boolean data.
<!-- ##### FUNCTION galago_value_get_short ##### -->
<para>
-
+Returns the value's short integer data.
</para>
- at value:
- at Returns:
+ at value: The #GalagoValue.
+ at Returns: The short integer data.
<!-- ##### FUNCTION galago_value_get_ushort ##### -->
<para>
-
+Returns the value's unsigned short integer data.
</para>
- at value:
- at Returns:
+ at value: The #GalagoValue.
+ at Returns: The unsigned short integer data.
<!-- ##### FUNCTION galago_value_get_int ##### -->
<para>
-
+Returns the value's integer data.
</para>
- at value:
- at Returns:
+ at value: The #GalagoValue.
+ at Returns: The integer data.
<!-- ##### FUNCTION galago_value_get_uint ##### -->
<para>
-
+Returns the value's unsigned integer data.
</para>
- at value:
- at Returns:
+ at value: The #GalagoValue.
+ at Returns: The unsigned integer data.
<!-- ##### FUNCTION galago_value_get_long ##### -->
<para>
-
+Returns the value's long integer data.
</para>
- at value:
- at Returns:
+ at value: The #GalagoValue.
+ at Returns: The long integer data.
<!-- ##### FUNCTION galago_value_get_ulong ##### -->
<para>
-
+Returns the value's unsigned long integer data.
</para>
- at value:
- at Returns:
+ at value: The #GalagoValue.
+ at Returns: The unsigned long integer data.
<!-- ##### FUNCTION galago_value_get_string ##### -->
<para>
-
+Returns the value's string data.
</para>
- at value:
- at Returns:
+ at value: The #GalagoValue.
+ at Returns: The string data.
<!-- ##### FUNCTION galago_value_get_object ##### -->
<para>
-
+Returns the value's object data.
</para>
- at value:
- at Returns:
+ at value: The #GalagoValue.
+ at Returns: The object data.
<!-- ##### FUNCTION galago_value_get_pointer ##### -->
<para>
-
+Returns the value's pointer data.
</para>
- at value:
- at Returns:
+ at value: The #GalagoValue.
+ at Returns: The pointer data.
<!-- ##### FUNCTION galago_value_get_list ##### -->
<para>
-
+Returns the value's list of values.
</para>
- at value:
- at Returns:
+ at value: The #GalagoValue.
+ at Returns: The list of values.
<!-- ##### FUNCTION galago_value_get_array ##### -->
<para>
-
+Returns the value's array of values.
</para>
- at value:
- at ret_array:
- at ret_size:
+ at value: The #GalagoValue.
+ at ret_array: The returned array.
+ at ret_size: The returned size of the array.
Modified: trunk/libgalago/docs/reference/tmpl/libgalago-unused.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/libgalago-unused.sgml 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/docs/reference/tmpl/libgalago-unused.sgml 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,73 +1,72 @@
-<!-- ##### STRUCT GalagoContextOps ##### -->
+<!-- ##### SECTION ./tmpl/GalagoKeyValue.sgml:Long_Description ##### -->
<para>
</para>
- at service_added:
- at service_removed:
- at person_added:
- at person_removed:
-<!-- ##### STRUCT SexySpellEntry ##### -->
+<!-- ##### SECTION ./tmpl/GalagoKeyValue.sgml:See_Also ##### -->
<para>
-The #GalagoAccount struct contains private data only, and should be manipulated using the functions below.
+
</para>
-<!-- ##### FUNCTION galago_context_add_object ##### -->
-<para>
+<!-- ##### SECTION ./tmpl/GalagoKeyValue.sgml:Short_Description ##### -->
-</para>
- at obj:
-<!-- ##### FUNCTION galago_context_add_person ##### -->
-<para>
+<!-- ##### SECTION ./tmpl/GalagoKeyValue.sgml:Stability_Level ##### -->
-</para>
- at person:
-<!-- ##### FUNCTION galago_context_add_service ##### -->
+<!-- ##### SECTION ./tmpl/GalagoKeyValue.sgml:Title ##### -->
+GalagoKeyValue
+
+
+<!-- ##### SECTION ./tmpl/galago-context-priv.sgml:Long_Description ##### -->
<para>
</para>
- at service:
-<!-- ##### FUNCTION galago_context_clear_objects ##### -->
+<!-- ##### SECTION ./tmpl/galago-context-priv.sgml:See_Also ##### -->
<para>
</para>
- at origin:
-<!-- ##### FUNCTION galago_context_remove_object ##### -->
-<para>
+<!-- ##### SECTION ./tmpl/galago-context-priv.sgml:Short_Description ##### -->
-</para>
- at obj:
-<!-- ##### FUNCTION galago_context_remove_person ##### -->
-<para>
+<!-- ##### SECTION ./tmpl/galago-context-priv.sgml:Stability_Level ##### -->
-</para>
- at person:
-<!-- ##### FUNCTION galago_context_remove_service ##### -->
+<!-- ##### SECTION ./tmpl/galago-context-priv.sgml:Title ##### -->
+galago-context-priv
+
+
+<!-- ##### SECTION ./tmpl/galago-private.sgml:Long_Description ##### -->
<para>
</para>
- at service:
-<!-- ##### FUNCTION galago_context_set_ops ##### -->
+<!-- ##### SECTION ./tmpl/galago-private.sgml:See_Also ##### -->
<para>
</para>
- at context:
- at ops:
+<!-- ##### SECTION ./tmpl/galago-private.sgml:Short_Description ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/galago-private.sgml:Stability_Level ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/galago-private.sgml:Title ##### -->
+galago-private
+
+
Modified: trunk/libgalago/libgalago/galago-account.c
===================================================================
--- trunk/libgalago/libgalago/galago-account.c 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-account.c 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,7 +1,7 @@
-/**
- * @file libgalago/galago-account.c Galago Account API
+/*
+ * Galago Account API
*
- * @Copyright (C) 2004-2006 Christian Hammond
+ * Copyright (C) 2004-2006 Christian Hammond
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
@@ -110,6 +110,13 @@
gobject_class->set_property = galago_account_set_property;
gobject_class->get_property = galago_account_get_property;
+ /**
+ * GalagoAccount::connection-state-changed:
+ * @account: The object which received the signal.
+ *
+ * Emitted when the state of the connection changes, when the
+ * account goes online or offline.
+ */
signals[CONNECTION_STATE_CHANGED] =
g_signal_new("connection_state_changed",
G_TYPE_FROM_CLASS(klass),
@@ -120,6 +127,12 @@
g_cclosure_marshal_VOID__VOID,
G_TYPE_NONE, 0);
+ /**
+ * GalagoAccount::display-name-changed:
+ * @account: The object which received the signal.
+ *
+ * Emitted whenever the display name of the account changes.
+ */
signals[DISPLAY_NAME_CHANGED] =
g_signal_new("display_name_changed",
G_TYPE_FROM_CLASS(klass),
@@ -129,6 +142,14 @@
g_cclosure_marshal_VOID__VOID,
G_TYPE_NONE, 0);
+ /**
+ * GalagoAccount::presence-created:
+ * @account: The object which received the signal.
+ * @presence: The new presence object.
+ *
+ * Emitted whenever a new #GalagoPresence object is created for this
+ * account.
+ */
signals[PRESENCE_CREATED] =
g_signal_new("presence_created",
G_TYPE_FROM_CLASS(klass),
@@ -139,6 +160,13 @@
G_TYPE_NONE, 1,
G_TYPE_POINTER);
+ /**
+ * GalagoAccount::presence-deleted:
+ * @account: The object which received the signal.
+ *
+ * Emitted whenever a #GalagoPresence object associated with this
+ * account is destroyed.
+ */
signals[PRESENCE_DELETED] =
g_signal_new("presence_deleted",
G_TYPE_FROM_CLASS(klass),
@@ -148,6 +176,13 @@
g_cclosure_marshal_VOID__VOID,
G_TYPE_NONE, 0);
+ /**
+ * GalagoAccount::avatar-set:
+ * @account: The object which received the signal.
+ * @avatar: The avatar set.
+ *
+ * Emitted whenever an avatar is set for this account.
+ */
signals[AVATAR_SET] =
g_signal_new("avatar_set",
G_TYPE_FROM_CLASS(klass),
@@ -158,6 +193,13 @@
G_TYPE_NONE, 1,
G_TYPE_POINTER);
+ /**
+ * GalagoAccount::contact-added:
+ * @account: The object which received the signal.
+ * @contact: The contact added to this account.
+ *
+ * Emitted whenever a contact has been added to this account.
+ */
signals[CONTACT_ADDED] =
g_signal_new("contact_added",
G_TYPE_FROM_CLASS(klass),
@@ -168,6 +210,13 @@
G_TYPE_NONE, 1,
G_TYPE_POINTER);
+ /**
+ * GalagoAccount::contact-removed:
+ * @account: The object which received the signal.
+ * @contact: The contact removed from this account.
+ *
+ * Emitted whenever a contact has been removed from this account.
+ */
signals[CONTACT_REMOVED] =
g_signal_new("contact_removed",
G_TYPE_FROM_CLASS(klass),
Modified: trunk/libgalago/libgalago/galago-account.h
===================================================================
--- trunk/libgalago/libgalago/galago-account.h 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-account.h 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,12 +1,8 @@
-/**
- * @file libgalago/galago-account.h Galago Account API
- * @ingroup Presence
+/*
+ * Galago Account API
*
- * @Copyright (C) 2004-2006 Christian Hammond
+ * Copyright (C) 2004-2006 Christian Hammond
*
- * #GalagoAccount models a single account a #GalagoPerson has with a
- * provider (a #GalagoService).
- *
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
Modified: trunk/libgalago/libgalago/galago-assert.h
===================================================================
--- trunk/libgalago/libgalago/galago-assert.h 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-assert.h 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,8 +1,7 @@
-/**
- * @file libgalago/galago-assert.h Assertion API
- * @ingroup Utility
+/*
+ * Assertion API
*
- * @Copyright (C) 2004-2006 Christian Hammond.
+ * Copyright (C) 2004-2006 Christian Hammond.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
Modified: trunk/libgalago/libgalago/galago-context-base.h
===================================================================
--- trunk/libgalago/libgalago/galago-context-base.h 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-context-base.h 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,8 +1,7 @@
-/**
- * @file libgalago/galago-context-base.h Galago Context Base Support
- * @ingroup Presence
+/*
+ * Galago Context Base Support
*
- * @Copyright (C) 2004-2006 Christian Hammond
+ * Copyright (C) 2004-2006 Christian Hammond
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
Modified: trunk/libgalago/libgalago/galago-context-priv.h
===================================================================
--- trunk/libgalago/libgalago/galago-context-priv.h 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-context-priv.h 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,8 +1,7 @@
-/**
- * @file libgalago/galago-context-priv.h Galago Context Private API
- * @ingroup Presence
+/*
+ * Galago Context Private API
*
- * @Copyright (C) 2004-2006 Christian Hammond
+ * Copyright (C) 2004-2006 Christian Hammond
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
@@ -32,88 +31,30 @@
*/
struct _GalagoContextOps
{
- /** Called when a service is added. */
+ /* Called when a service is added. */
void (*service_added)(GalagoService *service);
- /** Called when a service is removed. */
+ /* Called when a service is removed. */
void (*service_removed)(GalagoService *service);
- /** Called when a person is added. */
+ /* Called when a person is added. */
void (*person_added)(GalagoPerson *person);
- /** Called when a person is removed. */
+ /* Called when a person is removed. */
void (*person_removed)(GalagoPerson *person);
};
G_BEGIN_DECLS
-/**************************************************************************/
-/** @name Galago Context API */
-/**************************************************************************/
-/*@{*/
-
-/**
- * Sets the context ops to use for a context.
- *
- * @context: The context.
- * @ops: The ops structure.
- */
void galago_context_set_ops(GalagoContext *context, GalagoContextOps *ops);
-/**
- * Adds a service to the context's services cache.
- *
- * @service: The service to add.
- */
void galago_context_add_service(GalagoService *service);
-
-/**
- * Removes a service from the context's services cache.
- *
- * @service: The service to remove.
- */
void galago_context_remove_service(GalagoService *service);
-/**
- * Adds a person to the context's person cache.
- *
- * @person: The person to add.
- */
void galago_context_add_person(GalagoPerson *person);
-
-/**
- * Removes a person from the context's person cache.
- *
- * @person: The person to remove.
- */
void galago_context_remove_person(GalagoPerson *person);
-/**
- * Adds an object to the internal object tree.
- *
- * @internal This is used internally.
- *
- * @obj: The object to add.
- */
void galago_context_add_object(GalagoObject *obj);
-
-/**
- * Removes an object from the internal object tree.
- *
- * @internal This is used internally.
- *
- * @obj: The object to remove.
- */
void galago_context_remove_object(GalagoObject *obj);
-
-/**
- * Clears all objects of a specified origin from a context.
- *
- * @internal This is used internally.
- *
- * @origin: The origin of objects to clear.
- */
void galago_context_clear_objects(GalagoOrigin origin);
-/*@}*/
-
G_END_DECLS
#endif /* _GALAGO_CONTEXT_PRIV_H_ */
Modified: trunk/libgalago/libgalago/galago-context.c
===================================================================
--- trunk/libgalago/libgalago/galago-context.c 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-context.c 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,7 +1,7 @@
-/**
- * @file libgalago/galago-context.c Galago Context API
+/*
+ * Galago Context API
*
- * @Copyright (C) 2004-2006 Christian Hammond
+ * Copyright (C) 2004-2006 Christian Hammond
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
@@ -196,6 +196,13 @@
GALAGO_OBJECT_CLASS(parent_class)->destroy(object);
}
+/**
+ * galago_context_new:
+ *
+ * Creates a new context.
+ *
+ * Returns: The new context.
+ */
GalagoContext *
galago_context_new(void)
{
@@ -204,6 +211,12 @@
NULL));
}
+/**
+ * galago_context_push:
+ * @context: The context to push.
+ *
+ * Pushes a context onto the stack.
+ */
void
galago_context_push(GalagoContext *context)
{
@@ -215,6 +228,11 @@
G_UNLOCK(_contexts_lock);
}
+/**
+ * galago_context_pop:
+ *
+ * Pops a context off the stack.
+ */
void
galago_context_pop(void)
{
@@ -230,6 +248,13 @@
G_UNLOCK(_contexts_lock);
}
+/**
+ * galago_context_get:
+ *
+ * Returns the current context.
+ *
+ * Returns: The current context.
+ */
GalagoContext *
galago_context_get(void)
{
@@ -239,6 +264,12 @@
return GALAGO_CONTEXT(contexts->data);
}
+/**
+ * galago_context_set_obj_path_prefix:
+ * @prefix: The object path prefix.
+ *
+ * Sets the base object path prefix for this context.
+ */
void
galago_context_set_obj_path_prefix(const char *prefix)
{
@@ -253,6 +284,13 @@
context->priv->obj_path_prefix = (prefix == NULL ? NULL : g_strdup(prefix));
}
+/**
+ * galago_context_get_obj_path_prefix:
+ *
+ * Returns the base object path prefix for this context.
+ *
+ * Returns: The object path prefix.
+ */
const char *
galago_context_get_obj_path_prefix(void)
{
@@ -264,6 +302,13 @@
return context->priv->obj_path_prefix;
}
+/**
+ * galago_context_set_ops:
+ * @context: The context.
+ * @ops: The ops structure.
+ *
+ * Sets the context ops to use for a context.
+ */
void
galago_context_set_ops(GalagoContext *context, GalagoContextOps *ops)
{
@@ -272,6 +317,12 @@
context->priv->ops = ops;
}
+/**
+ * galago_context_add_service:
+ * @service: The service to add.
+ *
+ * Adds a service to the context's services cache.
+ */
void
galago_context_add_service(GalagoService *service)
{
@@ -337,6 +388,12 @@
}
}
+/**
+ * galago_context_remove_service:
+ * @service: The service to remove.
+ *
+ * Removes a service from the context's services cache.
+ */
void
galago_context_remove_service(GalagoService *service)
{
@@ -380,6 +437,15 @@
}
}
+/**
+ * galago_context_get_service:
+ * @id: The service ID.
+ * @origin: The object's origin.
+ *
+ * Returns the service with the specified ID.
+ *
+ * Returns: The service, if found, or %NULL.
+ */
GalagoService *
galago_context_get_service(const char *id, GalagoOrigin origin)
{
@@ -404,6 +470,14 @@
return service;
}
+/**
+ * galago_context_get_services:
+ * @origin: The object's origin.
+ *
+ * Returns a list of all services.
+ *
+ * Returns: The list of services, if found, or %NULL.
+ */
GList *
galago_context_get_services(GalagoOrigin origin)
{
@@ -476,6 +550,12 @@
(id == NULL ? NULL : g_strdup(id)), g_free);
}
+/**
+ * galago_context_add_person:
+ * @person: The person to add.
+ *
+ * Adds a person to the context's person cache.
+ */
void
galago_context_add_person(GalagoPerson *person)
{
@@ -549,6 +629,12 @@
}
}
+/**
+ * galago_context_remove_person:
+ * @person: The person to remove.
+ *
+ * Removes a person from the context's person cache.
+ */
void
galago_context_remove_person(GalagoPerson *person)
{
@@ -597,6 +683,15 @@
}
}
+/**
+ * galago_context_get_person:
+ * @id: The person ID.
+ * @origin: The object's origin.
+ *
+ * Returns the person with the specified ID.
+ *
+ * Returns: The person, if found, or %NULL.
+ */
GalagoPerson *
galago_context_get_person(const char *id, GalagoOrigin origin)
{
@@ -623,6 +718,15 @@
return person;
}
+/**
+ * galago_context_get_person_with_session_id:
+ * @session_id: The person's session ID.
+ * @origin: The object's origin.
+ *
+ * Returns the person with the specified session ID.
+ *
+ * Returns: The person, if found, or %NULL.
+ */
GalagoPerson *
galago_context_get_person_with_session_id(const char *session_id,
GalagoOrigin origin)
@@ -649,6 +753,14 @@
return person;
}
+/**
+ * galago_context_get_people:
+ * @origin: The object's origin.
+ *
+ * Returns a list of all people.
+ *
+ * Returns: The list of people, if found, or %NULL.
+ */
GList *
galago_context_get_people(GalagoOrigin origin)
{
@@ -674,6 +786,14 @@
}
}
+/**
+ * galago_context_add_object
+ * @obj: The object to add.
+ *
+ * Adds an object to the internal object tree.
+ *
+ * This should only be used internally.
+ */
void
galago_context_add_object(GalagoObject *obj)
{
@@ -691,6 +811,14 @@
g_strdup(galago_object_get_dbus_path(obj)), obj);
}
+/**
+ * galago_context_remove_object:
+ * @obj: The object to remove.
+ *
+ * Removes an object from the internal object tree.
+ *
+ * This should only be used internally.
+ */
void
galago_context_remove_object(GalagoObject *obj)
{
@@ -708,6 +836,14 @@
galago_object_get_dbus_path(obj));
}
+/**
+ * galago_context_clear_objects:
+ * @origin: The origin of objects to clear.
+ *
+ * Clears all objects of a specified origin from a context.
+ *
+ * This should only be used internally.
+ */
void
galago_context_clear_objects(GalagoOrigin origin)
{
@@ -746,6 +882,14 @@
}
}
+/**
+ * galago_context_get_object:
+ * @path: The D-BUS object path.
+ *
+ * Finds an object with the specified path.
+ *
+ * Returns: The object if found, or NULL.
+ */
GalagoObject *
galago_context_get_object(const char *path)
{
Modified: trunk/libgalago/libgalago/galago-context.h
===================================================================
--- trunk/libgalago/libgalago/galago-context.h 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-context.h 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,8 +1,7 @@
-/**
- * @file libgalago/galago-context.h Galago Context API
- * @ingroup Presence
+/*
+ * Galago Context API
*
- * @Copyright (C) 2004-2006 Christian Hammond
+ * Copyright (C) 2004-2006 Christian Hammond
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
@@ -39,117 +38,30 @@
G_BEGIN_DECLS
/**************************************************************************/
-/** @name Galago Context API */
+/** Galago Context API */
/**************************************************************************/
-/*@{*/
-/**
- * Returns GalagoContext's GType.
- *
- * Returns: The GType.
- */
GType galago_context_get_type(void);
-/**
- * Creates a new context.
- *
- * Returns: The new context.
- */
GalagoContext *galago_context_new(void);
-/**
- * Pushes a context onto the stack.
- *
- * @context: The context to push.
- */
void galago_context_push(GalagoContext *context);
-
-/**
- * Pops a context off the stack.
- */
void galago_context_pop(void);
-
-/**
- * Returns the current context.
- *
- * Returns: The current context.
- */
GalagoContext *galago_context_get(void);
-/**
- * Sets the base object path prefix for this context.
- *
- * @prefix: The object path prefix.
- */
void galago_context_set_obj_path_prefix(const char *prefix);
-
-/**
- * Returns the base object path prefix for this context.
- *
- * Returns: The object path prefix.
- */
const char *galago_context_get_obj_path_prefix(void);
-/**
- * Returns the service with the specified ID.
- *
- * @id: The service ID.
- * @origin: The object's origin.
- *
- * Returns: The service, if found, or NULL.
- */
GalagoService *galago_context_get_service(const char *id, GalagoOrigin origin);
-
-/**
- * Returns a list of all services.
- *
- * @origin: The object's origin.
- *
- * Returns: The list of services, if found, or NULL.
- */
GList *galago_context_get_services(GalagoOrigin origin);
-/**
- * Returns the person with the specified ID.
- *
- * @id: The person ID.
- * @origin: The object's origin.
- *
- * Returns: The person, if found, or NULL.
- */
GalagoPerson *galago_context_get_person(const char *id, GalagoOrigin origin);
-
-/**
- * Returns the person with the specified session ID.
- *
- * @session_id: The person's session ID.
- * @origin: The object's origin.
- *
- * Returns: The person, if found, or NULL.
- */
GalagoPerson *galago_context_get_person_with_session_id(const char *session_id,
GalagoOrigin origin);
-
-/**
- * Returns a list of all people.
- *
- * @origin: The object's origin.
- *
- * Returns: The list of people, if found, or NULL.
- */
GList *galago_context_get_people(GalagoOrigin origin);
-/**
- * Finds an object with the specified path.
- *
- * @path: The D-BUS object path.
- *
- * Returns: The object if found, or NULL.
- */
GalagoObject *galago_context_get_object(const char *path);
-/*@}*/
-
G_END_DECLS
#endif /* _GALAGO_CONTEXT_H_ */
Modified: trunk/libgalago/libgalago/galago-core.c
===================================================================
--- trunk/libgalago/libgalago/galago-core.c 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-core.c 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,7 +1,7 @@
-/**
- * @file libgalago/galago-core.c Galago Context API
+/*
+ * Galago Context API
*
- * @Copyright (C) 2004-2006 Christian Hammond
+ * Copyright (C) 2004-2006 Christian Hammond
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
@@ -151,6 +151,13 @@
klass->calc_priority_account = NULL;
+ /**
+ * GalagoCore::registered:
+ * @core: The object which received the signal.
+ *
+ * Emitted when the application successfully registers with the
+ * daemon.
+ */
signals[REGISTERED] =
g_signal_new("registered",
G_TYPE_FROM_CLASS(klass),
@@ -160,6 +167,12 @@
g_cclosure_marshal_VOID__VOID,
G_TYPE_NONE, 0);
+ /**
+ * GalagoCore::unregistered:
+ * @core: The object which received the signal.
+ *
+ * Emitted when the application unregisters with the daemon.
+ */
signals[UNREGISTERED] =
g_signal_new("unregistered",
G_TYPE_FROM_CLASS(klass),
@@ -169,6 +182,13 @@
g_cclosure_marshal_VOID__VOID,
G_TYPE_NONE, 0);
+ /**
+ * GalagoCore::service-added:
+ * @core: The object which received the signal.
+ * @service: The service added.
+ *
+ * Emitted when a service is added.
+ */
signals[SERVICE_ADDED] =
g_signal_new("service_added",
G_TYPE_FROM_CLASS(klass),
@@ -179,6 +199,13 @@
G_TYPE_NONE, 1,
GALAGO_TYPE_SERVICE);
+ /**
+ * GalagoCore::service-removed:
+ * @core: The object which received the signal.
+ * @service: The service removed.
+ *
+ * Emitted when a service is removed.
+ */
signals[SERVICE_REMOVED] =
g_signal_new("service_removed",
G_TYPE_FROM_CLASS(klass),
@@ -189,6 +216,13 @@
G_TYPE_NONE, 1,
GALAGO_TYPE_SERVICE);
+ /**
+ * GalagoCore::person-added:
+ * @core: The object which received the signal.
+ * @person: The person added.
+ *
+ * Emitted when a person is added.
+ */
signals[PERSON_ADDED] =
g_signal_new("person_added",
G_TYPE_FROM_CLASS(klass),
@@ -199,6 +233,13 @@
G_TYPE_NONE, 1,
GALAGO_TYPE_SERVICE);
+ /**
+ * GalagoCore::person-removed:
+ * @core: The object which received the signal.
+ * @person: The person removed.
+ *
+ * Emitted when a person is removed.
+ */
signals[PERSON_REMOVED] =
g_signal_new("person_removed",
G_TYPE_FROM_CLASS(klass),
@@ -209,6 +250,17 @@
G_TYPE_NONE, 1,
GALAGO_TYPE_SERVICE);
+ /**
+ * GalagoCore::calc-priority-account:
+ * @core: The object which received the signal.
+ * @person: The person the priority account is being calculated for.
+ *
+ * Emitted when the priority account for a person needs to be calculated.
+ * The callback function should return the account that is considered
+ * the priority, which is by default the most available one.
+ *
+ * Returns: The priority account.
+ */
signals[CALC_PRIORITY_ACCOUNT] =
g_signal_new("calc_priority_account",
G_TYPE_FROM_CLASS(klass),
Modified: trunk/libgalago/libgalago/galago-core.h
===================================================================
--- trunk/libgalago/libgalago/galago-core.h 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-core.h 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,8 +1,7 @@
-/**
- * @file libgalago/galago-core.h Galago Core API
- * @ingroup Presence
+/*
+ * Galago Core API
*
- * @Copyright (C) 2004-2006 Christian Hammond
+ * Copyright (C) 2004-2006 Christian Hammond
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
@@ -53,16 +52,8 @@
typedef enum
{
- /** Connection will be used for querying data only. */
GALAGO_INIT_CLIENT = 0,
-
- /**
- * Connection will feed presence data. This takes precedence over
- * GALAGO_INIT_CLIENT.
- */
GALAGO_INIT_FEED = 1 << 0,
-
- /** The daemon will not be activated automatically. */
GALAGO_INIT_NO_ACTIVATION = 1 << 1
} GalagoInitFlags;
Modified: trunk/libgalago/libgalago/galago-dbus.c
===================================================================
--- trunk/libgalago/libgalago/galago-dbus.c 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-dbus.c 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,7 +1,7 @@
-/**
- * @file libgalago/galago-dbus.c D-BUS Support API
+/*
+ * D-BUS Support API
*
- * @Copyright (C) 2004-2006 Christian Hammond.
+ * Copyright (C) 2004-2006 Christian Hammond.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
Modified: trunk/libgalago/libgalago/galago-dbus.h
===================================================================
--- trunk/libgalago/libgalago/galago-dbus.h 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-dbus.h 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,8 +1,7 @@
-/**
- * @file libgalago/galago-dbus.h D-BUS Support API
- * @ingroup Utility
+/*
+ * D-BUS Support API
*
- * @Copyright (C) 2004-2006 Christian Hammond.
+ * Copyright (C) 2004-2006 Christian Hammond.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
Modified: trunk/libgalago/libgalago/galago-image.c
===================================================================
--- trunk/libgalago/libgalago/galago-image.c 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-image.c 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,7 +1,7 @@
-/**
- * @file libgalago/galago-image.c Galago Image API
+/*
+ * Galago Image API
*
- * @Copyright (C) 2004-2006 Christian Hammond
+ * Copyright (C) 2004-2006 Christian Hammond
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
Modified: trunk/libgalago/libgalago/galago-image.h
===================================================================
--- trunk/libgalago/libgalago/galago-image.h 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-image.h 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,8 +1,7 @@
-/**
- * @file libgalago/galago-image.h Galago Image API
- * @ingroup Utility
+/*
+ * Galago Image API
*
- * @Copyright (C) 2004-2006 Christian Hammond
+ * Copyright (C) 2004-2006 Christian Hammond
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
Modified: trunk/libgalago/libgalago/galago-key-value.c
===================================================================
--- trunk/libgalago/libgalago/galago-key-value.c 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-key-value.c 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,7 +1,7 @@
-/**
- * @file libgalago/galago-key-value.c Galago Key/Value Data Structure
+/*
+ * Galago Key/Value Data Structure
*
- * @Copyright (C) 2006 Christian Hammond
+ * Copyright (C) 2006 Christian Hammond
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
@@ -20,6 +20,16 @@
*/
#include <libgalago/galago-key-value.h>
+/**
+ * galago_key_value_new:
+ * @key: The key.
+ * @value: The value.
+ *
+ * Allocates a key/value pair. The #GalagoKeyValue will take ownership
+ * of @value.
+ *
+ * Returns: The new key/value pair.
+ */
GalagoKeyValue *
galago_key_value_new(const char *key, GValue *value)
{
@@ -34,6 +44,13 @@
return key_value;
}
+/**
+ * galago_key_value_destroy:
+ * @key_value: The #GalagoKeyValue to destroy.
+ *
+ * Deallocates a #GalagoKeyValue. This will free the contained key and
+ * value and the structure itself.
+ */
void
galago_key_value_destroy(GalagoKeyValue *key_value)
{
@@ -45,6 +62,13 @@
g_free(key_value);
}
+/**
+ * galago_key_value_set_key:
+ * @key_value: The #GalagoKeyValue.
+ * @key: The new key.
+ *
+ * Sets a new key on a #GalagoKeyValue.
+ */
void
galago_key_value_set_key(GalagoKeyValue *key_value, const char *key)
{
@@ -60,6 +84,14 @@
key_value->key = g_strdup(key);
}
+/**
+ * galago_key_value_get_key:
+ * @key_value: The #GalagoKeyValue.
+ *
+ * Gets the key belonging to a #GalagoKeyValue.
+ *
+ * Returns: A #GalagoKeyValue's key.
+ */
const char *
galago_key_value_get_key(const GalagoKeyValue *key_value)
{
@@ -68,6 +100,14 @@
return key_value->key;
}
+/**
+ * galago_key_value_set_value:
+ * @key_value: The #GalagoKeyValue.
+ * @value: The new value.
+ *
+ * Sets the new value on a #GalagoKeyValue. This will destroy the old
+ * value set. The #GalagoKeyValue will take ownership of the new value.
+ */
void
galago_key_value_set_value(GalagoKeyValue *key_value, GValue *value)
{
@@ -85,6 +125,14 @@
key_value->value = value;
}
+/**
+ * galago_key_value_get_value:
+ * @key_value: The #GalagoKeyValue.
+ *
+ * Gets the value belonging to a #GalagoKeyValue.
+ *
+ * Returns: A #GalagoKeyValue's value.
+ */
const GValue *
galago_key_value_get_value(const GalagoKeyValue *key_value)
{
Modified: trunk/libgalago/libgalago/galago-key-value.h
===================================================================
--- trunk/libgalago/libgalago/galago-key-value.h 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-key-value.h 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,5 +1,5 @@
-/**
- * @file libgalago/galago-key-value.h Galago Key/Value Data Structure
+/*
+ * Key/Value Data Structure
*
* @Copyright (C) 2006 Christian Hammond
*
Modified: trunk/libgalago/libgalago/galago-object.c
===================================================================
--- trunk/libgalago/libgalago/galago-object.c 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-object.c 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,7 +1,7 @@
-/**
- * @file libgalago/galago-object.c Galago Object API
+/*
+ * Galago Object API
*
- * @Copyright (C) 2004-2006 Christian Hammond
+ * Copyright (C) 2004-2006 Christian Hammond
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
@@ -106,6 +106,15 @@
gobject_class->set_property = galago_object_set_property;
gobject_class->get_property = galago_object_get_property;
+ /**
+ * GalagoObject::destroy:
+ * @object: The object which received the signal.
+ *
+ * Emitted when the object is undergoing a dispose. Signals that anything
+ * holding a reference to this object should release the reference.
+ * This may or may not end with the object being finalized, depending
+ * on whether there are any references left after this is emitted.
+ */
signals[DESTROY] =
g_signal_new("destroy",
G_TYPE_FROM_CLASS(klass),
Modified: trunk/libgalago/libgalago/galago-object.h
===================================================================
--- trunk/libgalago/libgalago/galago-object.h 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-object.h 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,8 +1,7 @@
-/**
- * @file libgalago/galago-object.h Galago Base Object
- * @ingroup Utility
+/*
+ * Galago Base Object
*
- * @Copyright (C) 2004-2006 Christian Hammond
+ * Copyright (C) 2004-2006 Christian Hammond
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
Modified: trunk/libgalago/libgalago/galago-person.c
===================================================================
--- trunk/libgalago/libgalago/galago-person.c 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-person.c 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,7 +1,7 @@
-/**
- * @file libgalago/galago-person.c Galago Person API
+/*
+ * Galago Person API
*
- * @Copyright (C) 2004-2006 Christian Hammond
+ * Copyright (C) 2004-2006 Christian Hammond
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
@@ -111,6 +111,13 @@
gobject_class->set_property = galago_person_set_gproperty;
gobject_class->get_property = galago_person_get_gproperty;
+ /**
+ * GalagoPerson::account-added:
+ * @person: The object which received the signal.
+ * @account: The account added to this person.
+ *
+ * Emitted whenever an account has been added to this person.
+ */
signals[ACCOUNT_ADDED] =
g_signal_new("account_added",
G_TYPE_FROM_CLASS(klass),
@@ -121,6 +128,13 @@
G_TYPE_NONE, 1,
G_TYPE_POINTER);
+ /**
+ * GalagoPerson::account-removed:
+ * @person: The object which received the signal.
+ * @account: The account added to this person.
+ *
+ * Emitted whenever an account has been removed from this person.
+ */
signals[ACCOUNT_REMOVED] =
g_signal_new("account_removed",
G_TYPE_FROM_CLASS(klass),
@@ -131,6 +145,13 @@
G_TYPE_NONE, 1,
G_TYPE_POINTER);
+ /**
+ * GalagoPerson::photo-set:
+ * @person: The object which received the signal.
+ * @photo: The photo set on this person.
+ *
+ * Emitted whenever a photo has been set on this person.
+ */
signals[PHOTO_SET] =
g_signal_new("photo_set",
G_TYPE_FROM_CLASS(klass),
Modified: trunk/libgalago/libgalago/galago-person.h
===================================================================
--- trunk/libgalago/libgalago/galago-person.h 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-person.h 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,14 +1,8 @@
-/**
- * @file libgalago/galago-person.h Galago Person API
- * @ingroup Presence
+/*
+ * Galago Person API
*
- * #GalagoPerson represents a single person and their personal information
- * (such as name and address). As people can have multiple IM accounts, each
- * #GalagoPerson can have many #GalagoAccount%s associated with it
- * (created using galago_service_create_account()).
+ * Copyright (C) 2004-2006 Christian Hammond
*
- * @Copyright (C) 2004-2006 Christian Hammond
- *
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
Modified: trunk/libgalago/libgalago/galago-presence.c
===================================================================
--- trunk/libgalago/libgalago/galago-presence.c 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-presence.c 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,7 +1,7 @@
-/**
- * @file libgalago/galago-presence.c Galago Presence API
+/*
+ * Galago Presence API
*
- * @Copyright (C) 2004-2006 Christian Hammond
+ * Copyright (C) 2004-2006 Christian Hammond
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
@@ -106,6 +106,16 @@
gobject_class->set_property = galago_presence_set_property;
gobject_class->get_property = galago_presence_get_property;
+ /**
+ * GalagoPresence::idle-changed:
+ * @presence: The object which received the signal.
+ * @idle: The idle state.
+ * @idle_start_time: The time the user went idle, if @idle is %TRUE, or 0.
+ *
+ * Emitted whenever the idle state changes. If @idle is %TRUE,
+ * @idle_start_time will be a UNIX timestamp indicating when the user
+ * went idle. Otherwise, it will be 0.
+ */
signals[IDLE_CHANGED] =
g_signal_new("idle_changed",
G_TYPE_FROM_CLASS(klass),
@@ -117,6 +127,13 @@
G_TYPE_BOOLEAN,
G_TYPE_ULONG);
+ /**
+ * GalagoPresence::status-added:
+ * @presence: The object which received the signal.
+ * @status: The status that was added.
+ *
+ * Emitted whenever a status is added.
+ */
signals[STATUS_ADDED] =
g_signal_new("status_added",
G_TYPE_FROM_CLASS(klass),
@@ -127,6 +144,13 @@
G_TYPE_NONE, 1,
G_TYPE_POINTER);
+ /**
+ * GalagoPresence::status-removed:
+ * @presence: The object which received the signal.
+ * @status: The status that was removed.
+ *
+ * Emitted whenever a status is removed.
+ */
signals[STATUS_REMOVED] =
g_signal_new("status_removed",
G_TYPE_FROM_CLASS(klass),
@@ -137,6 +161,14 @@
G_TYPE_NONE, 1,
G_TYPE_POINTER);
+ /**
+ * GalagoPresence::status-updated:
+ * @presence: The object which received the signal.
+ * @status: The status that was updated.
+ * @name: The name of the attribute updated.
+ *
+ * Emitted when an attribute on a status was set or updated.
+ */
signals[STATUS_UPDATED] =
g_signal_new("status_updated",
G_TYPE_FROM_CLASS(klass),
@@ -148,6 +180,13 @@
G_TYPE_POINTER,
G_TYPE_STRING);
+ /**
+ * GalagoPresence::changed:
+ * @presence: The object which received the signal.
+ *
+ * Emitted when a property (idle state or a status added or removed)
+ * on the presence is updated.
+ */
signals[CHANGED] =
g_signal_new("changed",
G_TYPE_FROM_CLASS(klass),
@@ -835,7 +874,6 @@
* @presence: The presence.
* @type: The status type.
*
- *
* Returns whether or not a presence has a status with the specified
* primitive type.
*
Modified: trunk/libgalago/libgalago/galago-presence.h
===================================================================
--- trunk/libgalago/libgalago/galago-presence.h 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-presence.h 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,13 +1,8 @@
-/**
- * @file libgalago/galago-presence.h Galago Presence API
- * @ingroup Presence
+/*
+ * Galago Presence API
*
- * A presence is associated with a #GalagoAccount and contains a list of the
- * account's statuses (#GalagoStatus), the current status, the idle time, and
- * other information.
+ * Copyright (C) 2004-2006 Christian Hammond
*
- * @Copyright (C) 2004-2006 Christian Hammond
- *
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
Modified: trunk/libgalago/libgalago/galago-private.h
===================================================================
--- trunk/libgalago/libgalago/galago-private.h 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-private.h 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,8 +1,7 @@
-/**
- * @file libgalago/galago-private.h Private declarations
- * @ingroup Utility
+/*
+ * Private declarations
*
- * @Copyright (C) 2004-2006 Christian Hammond
+ * Copyright (C) 2004-2006 Christian Hammond
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
Modified: trunk/libgalago/libgalago/galago-service.c
===================================================================
--- trunk/libgalago/libgalago/galago-service.c 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-service.c 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,7 +1,7 @@
-/**
- * @file libgalago/galago-service.c Galago Service API
+/*
+ * Galago Service API
*
- * @Copyright (C) 2004-2006 Christian Hammond
+ * Copyright (C) 2004-2006 Christian Hammond
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
@@ -101,6 +101,13 @@
gobject_class->set_property = galago_service_set_property;
gobject_class->get_property = galago_service_get_property;
+ /**
+ * GalagoService::account-added:
+ * @service: The object which received the signal.
+ * @account: The account that was added.
+ *
+ * Emitted when an account is added to the service.
+ */
signals[ACCOUNT_ADDED] =
g_signal_new("account-added",
G_TYPE_FROM_CLASS(klass),
@@ -111,6 +118,13 @@
G_TYPE_NONE, 1,
G_TYPE_POINTER);
+ /**
+ * GalagoService::account-removed:
+ * @service: The object which received the signal.
+ * @account: The account that was removed.
+ *
+ * Emitted when an account is removed to the service.
+ */
signals[ACCOUNT_REMOVED] =
g_signal_new("account-removed",
G_TYPE_FROM_CLASS(klass),
Modified: trunk/libgalago/libgalago/galago-service.h
===================================================================
--- trunk/libgalago/libgalago/galago-service.h 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-service.h 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,13 +1,8 @@
-/**
- * @file libgalago/galago-service.h Galago Service API
- * @ingroup Presence
+/*
+ * Galago Service API
*
- * A #GalagoService represents an online service to which users can
- * connect that keeps track of the user's presence. Examples are instant
- * messaging services (such as Jabber) or video chat (such as SIP).
+ * Copyright (C) 2004-2006 Christian Hammond
*
- * @Copyright (C) 2004-2006 Christian Hammond
- *
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
Modified: trunk/libgalago/libgalago/galago-status.c
===================================================================
--- trunk/libgalago/libgalago/galago-status.c 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-status.c 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,7 +1,7 @@
-/**
- * @file libgalago/galago-status.c Galago Status API
+/*
+ * Galago Status API
*
- * @Copyright (C) 2004-2006 Christian Hammond
+ * Copyright (C) 2004-2006 Christian Hammond
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
Modified: trunk/libgalago/libgalago/galago-status.h
===================================================================
--- trunk/libgalago/libgalago/galago-status.h 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-status.h 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,8 +1,7 @@
-/**
- * @file libgalago/galago-status.h Galago Status API
- * @ingroup Presence
+/*
+ * Galago Status API
*
- * @Copyright (C) 2004-2006 Christian Hammond
+ * Copyright (C) 2004-2006 Christian Hammond
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
Modified: trunk/libgalago/libgalago/galago-value.c
===================================================================
--- trunk/libgalago/libgalago/galago-value.c 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-value.c 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,7 +1,7 @@
-/**
- * @file libgalago/galago-value.c Value wrapper API
+/*
+ * Value wrapper API
*
- * @Copyright (C) 2004-2006 Christian Hammond
+ * Copyright (C) 2004-2006 Christian Hammond
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
@@ -106,6 +106,16 @@
return value->data.name##_data; \
}
+/**
+ * galago_value_new
+ * @type: The type.
+ * @data: The optional data to set.
+ * @detail: Extra detail, type-specific. Currently unused.
+ *
+ * Creates a new #GalagoValue.
+ *
+ * Returns: The new value.
+ */
GalagoValue *
galago_value_new(GalagoType type, const void *data, void *detail)
{
@@ -150,6 +160,16 @@
return value;
}
+/**
+ * galago_value_new_object
+ * @type: The GType.
+ * @obj: The object.
+ *
+ * Creates a new, special #GalagoValue that takes an object type and an
+ * optional object.
+ *
+ * Returns: The new value.
+ */
GalagoValue *
galago_value_new_object(GType type, const GObject *obj)
{
@@ -165,6 +185,19 @@
return value;
}
+/**
+ * galago_value_new_list
+ * @type: The type of list values.
+ * @list: The optional default list of values.
+ * @detail: Extra detail, type-specific.
+ *
+ * Creates a new, special #GalagoValue that takes only a list of values
+ * of the specified type.
+ *
+ * If @type is %GALAGO_VALUE_TYPE_OBJECT, @detail must be the class type.
+ *
+ * Returns: The new value.
+ */
GalagoValue *
galago_value_new_list(GalagoType type, GList *list, void *detail)
{
@@ -178,6 +211,20 @@
return value;
}
+/**
+ * galago_value_new_array
+ * @type: The type of list values.
+ * @array: The optional default array of values.
+ * @size: The size of the array.
+ * @detail: Extra detail, type-specific.
+ *
+ * Creates a new, special #GalagoValue that takes only an array of values
+ * of the specified type.
+ *
+ * If @type is %GALAGO_VALUE_TYPE_OBJECT, @detail must be the class type.
+ *
+ * Returns: The new value.
+ */
GalagoValue *
galago_value_new_array(GalagoType type, const void *array, gsize size,
void *detail)
@@ -194,6 +241,12 @@
return value;
}
+/**
+ * galago_value_destroy:
+ * @value: The #GalagoValue.
+ *
+ * Destroys a #GalagoValue.
+ */
void
galago_value_destroy(GalagoValue *value)
{
@@ -217,6 +270,14 @@
g_free(value);
}
+/**
+ * galago_value_get_type:
+ * @value: The #GalagoValue.
+ *
+ * Returns a #GalagoValue's type.
+ *
+ * Returns: The #GalagoValue's type.
+ */
GalagoType
galago_value_get_type(const GalagoValue *value)
{
@@ -225,6 +286,14 @@
return value->type;
}
+/**
+ * galago_value_get_subtype:
+ * @value: The #GalagoValue.
+ *
+ * Returns a value's subtype. This is only usable for lists and arrays.
+ *
+ * Returns: The value's list type.
+ */
GalagoType
galago_value_get_subtype(const GalagoValue *value)
{
@@ -237,6 +306,15 @@
return value->subtype;
}
+/**
+ * galago_value_get_gtype:
+ * @value: The #GalagoValue.
+ *
+ * Returns the contained object's #GType, if the #GalagoValue's type is
+ * %GALAGO_VALUE_TYPE_OBJECT.
+ *
+ * Returns: The object's #GType, or %NULL.
+ */
GType
galago_value_get_gtype(const GalagoValue *value)
{
Modified: trunk/libgalago/libgalago/galago-value.h
===================================================================
--- trunk/libgalago/libgalago/galago-value.h 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago-value.h 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,8 +1,7 @@
-/**
- * @file libgalago/galago-value.h Value wrapper API
- * @ingroup Utility
+/*
+ * Value wrapper API
*
- * @Copyright (C) 2004-2006 Christian Hammond
+ * Copyright (C) 2004-2006 Christian Hammond
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
@@ -26,365 +25,74 @@
typedef struct _GalagoValue GalagoValue;
-/**
- * Specific value types.
- */
typedef enum
{
- GALAGO_VALUE_TYPE_UNKNOWN = 0, /**< Unknown type. */
- GALAGO_VALUE_TYPE_CHAR, /**< Character. */
- GALAGO_VALUE_TYPE_UCHAR, /**< Unsigned character. */
- GALAGO_VALUE_TYPE_BOOLEAN, /**< Boolean. */
- GALAGO_VALUE_TYPE_SHORT, /**< Short integer. */
- GALAGO_VALUE_TYPE_USHORT, /**< Unsigned short integer. */
- GALAGO_VALUE_TYPE_INT, /**< Integer. */
- GALAGO_VALUE_TYPE_UINT, /**< Unsigned integer. */
- GALAGO_VALUE_TYPE_LONG, /**< Long integer. */
- GALAGO_VALUE_TYPE_ULONG, /**< Unsigned long integer. */
- GALAGO_VALUE_TYPE_STRING, /**< String. */
- GALAGO_VALUE_TYPE_OBJECT, /**< Object pointer. */
- GALAGO_VALUE_TYPE_POINTER, /**< Generic pointer. */
- GALAGO_VALUE_TYPE_LIST, /**< A list of values. */
- GALAGO_VALUE_TYPE_ARRAY /**< An array of values. */
+ GALAGO_VALUE_TYPE_UNKNOWN = 0, /* Unknown type. */
+ GALAGO_VALUE_TYPE_CHAR, /* Character. */
+ GALAGO_VALUE_TYPE_UCHAR, /* Unsigned character. */
+ GALAGO_VALUE_TYPE_BOOLEAN, /* Boolean. */
+ GALAGO_VALUE_TYPE_SHORT, /* Short integer. */
+ GALAGO_VALUE_TYPE_USHORT, /* Unsigned short integer. */
+ GALAGO_VALUE_TYPE_INT, /* Integer. */
+ GALAGO_VALUE_TYPE_UINT, /* Unsigned integer. */
+ GALAGO_VALUE_TYPE_LONG, /* Long integer. */
+ GALAGO_VALUE_TYPE_ULONG, /* Unsigned long integer. */
+ GALAGO_VALUE_TYPE_STRING, /* String. */
+ GALAGO_VALUE_TYPE_OBJECT, /* Object pointer. */
+ GALAGO_VALUE_TYPE_POINTER, /* Generic pointer. */
+ GALAGO_VALUE_TYPE_LIST, /* A list of values. */
+ GALAGO_VALUE_TYPE_ARRAY /* An array of values. */
} GalagoType;
G_BEGIN_DECLS
/**************************************************************************/
-/** @name Value API */
+/** Value API */
/**************************************************************************/
-/*@{*/
-/**
- * Creates a new GalagoValue.
- *
- * @type: The type.
- * @data: The optional data to set.
- * @detail: Extra detail, type-specific. Currently unused.
- *
- * Returns: The new value.
- */
GalagoValue *galago_value_new(GalagoType type, const void *data, void *detail);
-
-/**
- * Creates a new, special GalagoValue that takes an object type and an
- * optional object.
- *
- * @type: The GType.
- * @obj: The object.
- *
- * Returns: The new value.
- */
GalagoValue *galago_value_new_object(GType type, const GObject *obj);
-
-/**
- * Creates a new, special GalagoValue that takes only a list of values
- * of the specified type.
- *
- * If @a type is GALAGO_VALUE_TYPE_OBJECT, @a detail must be the class type.
- *
- * @type: The type of list values.
- * @list: The optional default list of values.
- * @detail: Extra detail, type-specific.
- *
- * Returns: The new value.
- */
-GalagoValue *galago_value_new_list(GalagoType type, GList *list,
- void *detail);
-
-/**
- * Creates a new, special GalagoValue that takes only an array of values
- * of the specified type.
- *
- * If @a type is GALAGO_VALUE_TYPE_OBJECT, @a detail must be the class type.
- *
- * @type: The type of list values.
- * @array: The optional default array of values.
- * @size: The size of the array.
- * @detail: Extra detail, type-specific.
- *
- * Returns: The new value.
- */
+GalagoValue *galago_value_new_list(GalagoType type, GList *list, void *detail);
GalagoValue *galago_value_new_array(GalagoType type, const void *array,
gsize size, void *detail);
-
-/**
- * Destroys a GalagoValue.
- *
- * @value: The value to destroy.
- */
void galago_value_destroy(GalagoValue *value);
-/**
- * Returns a value's type.
- *
- * Returns: The value's type.
- */
GalagoType galago_value_get_type(const GalagoValue *value);
-
-/**
- * Returns a value's subtype.
- *
- * This is only usable for lists and arrays.
- *
- * Returns: The value's list type.
- */
GalagoType galago_value_get_subtype(const GalagoValue *value);
-
-/**
- * Returns the object's GType, if the value's type is GALAGO_VALUE_TYPE_OBJECT.
- *
- * @value: The value.
- *
- * Returns: The object's GType, or NULL.
- */
GType galago_value_get_gtype(const GalagoValue *value);
-/**
- * Sets the value's character data.
- *
- * @value: The value.
- * @data: The character data.
- */
void galago_value_set_char(GalagoValue *value, char data);
-
-/**
- * Sets the value's unsigned character data.
- *
- * @value: The value.
- * @data: The unsigned character data.
- */
void galago_value_set_uchar(GalagoValue *value, unsigned char data);
-
-/**
- * Sets the value's boolean data.
- *
- * @value: The value.
- * @data: The boolean data.
- */
void galago_value_set_boolean(GalagoValue *value, gboolean data);
-
-/**
- * Sets the value's short integer data.
- *
- * @value: The value.
- * @data: The short integer data.
- */
void galago_value_set_short(GalagoValue *value, short data);
-
-/**
- * Sets the value's unsigned short integer data.
- *
- * @value: The value.
- * @data: The unsigned short integer data.
- */
void galago_value_set_ushort(GalagoValue *value, unsigned short data);
-
-/**
- * Sets the value's integer data.
- *
- * @value: The value.
- * @data: The integer data.
- */
void galago_value_set_int(GalagoValue *value, int data);
-
-/**
- * Sets the value's unsigned integer data.
- *
- * @value: The value.
- * @data: The unsigned integer data.
- */
void galago_value_set_uint(GalagoValue *value, unsigned int data);
-
-/**
- * Sets the value's long integer data.
- *
- * @value: The value.
- * @data: The long integer data.
- */
void galago_value_set_long(GalagoValue *value, long data);
-
-/**
- * Sets the value's unsigned long integer data.
- *
- * @value: The value.
- * @data: The unsigned long integer data.
- */
void galago_value_set_ulong(GalagoValue *value, unsigned long data);
-
-/**
- * Sets the value's string data.
- *
- * @value: The value.
- * @data: The string data.
- */
void galago_value_set_string(GalagoValue *value, const char *data);
-
-/**
- * Sets the value's object data.
- *
- * @value: The value.
- * @data: The object data.
- */
void galago_value_set_object(GalagoValue *value, void *data);
-
-/**
- * Sets the value's pointer data.
- *
- * @value: The value.
- * @data: The pointer data.
- */
void galago_value_set_pointer(GalagoValue *value, void *data);
-
-/**
- * Sets the value's list of values.
- *
- * @value: The value.
- * @data: The list of values.
- */
void galago_value_set_list(GalagoValue *value, GList *data);
+void galago_value_set_array(GalagoValue *value, const void *data, gsize size);
-/**
- * Sets the value's array of values.
- *
- * @value: The value.
- * @data: The array of values.
- * @size: The size of the array.
- */
-void galago_value_set_array(GalagoValue *value, const void *data,
- gsize size);
-
-/**
- * Returns the value's character data.
- *
- * @value: The value.
- *
- * Returns: The character data.
- */
char galago_value_get_char(const GalagoValue *value);
-
-/**
- * Returns the value's unsigned character data.
- *
- * @value: The value.
- *
- * Returns: The unsigned character data.
- */
unsigned char galago_value_get_uchar(const GalagoValue *value);
-
-/**
- * Returns the value's boolean data.
- *
- * @value: The value.
- *
- * Returns: The boolean data.
- */
gboolean galago_value_get_boolean(const GalagoValue *value);
-
-/**
- * Returns the value's short integer data.
- *
- * @value: The value.
- *
- * Returns: The short integer data.
- */
short galago_value_get_short(const GalagoValue *value);
-
-/**
- * Returns the value's unsigned short integer data.
- *
- * @value: The value.
- *
- * Returns: The unsigned short integer data.
- */
unsigned short galago_value_get_ushort(const GalagoValue *value);
-
-/**
- * Returns the value's integer data.
- *
- * @value: The value.
- *
- * Returns: The integer data.
- */
int galago_value_get_int(const GalagoValue *value);
-
-/**
- * Returns the value's unsigned integer data.
- *
- * @value: The value.
- *
- * Returns: The unsigned integer data.
- */
unsigned int galago_value_get_uint(const GalagoValue *value);
-
-/**
- * Returns the value's long integer data.
- *
- * @value: The value.
- *
- * Returns: The long integer data.
- */
long galago_value_get_long(const GalagoValue *value);
-
-/**
- * Returns the value's unsigned long integer data.
- *
- * @value: The value.
- *
- * Returns: The unsigned long integer data.
- */
unsigned long galago_value_get_ulong(const GalagoValue *value);
-
-/**
- * Returns the value's string data.
- *
- * @value: The value.
- *
- * Returns: The string data.
- */
const char *galago_value_get_string(const GalagoValue *value);
-
-/**
- * Returns the value's object data.
- *
- * @value: The value.
- *
- * Returns: The object data.
- */
void *galago_value_get_object(const GalagoValue *value);
-
-/**
- * Returns the value's pointer data.
- *
- * @value: The value.
- *
- * Returns: The pointer data.
- */
void *galago_value_get_pointer(const GalagoValue *value);
-
-/**
- * Returns the value's list of values.
- *
- * @value: The value.
- *
- * Returns: The list of values.
- */
GList *galago_value_get_list(const GalagoValue *value);
-
-/**
- * Returns the value's array of values.
- *
- * @value: The value.
- * @ret_array: The returned array.
- * @ret_size: The returned size of the array.
- */
void galago_value_get_array(const GalagoValue *value,
- const void **ret_array,
- gsize *ret_size);
+ const void **ret_array, gsize *ret_size);
-/*@}*/
-
G_END_DECLS
#endif /* _GALAGO_VALUE_H_ */
Modified: trunk/libgalago/libgalago/galago.h
===================================================================
--- trunk/libgalago/libgalago/galago.h 2006-05-18 01:28:19 UTC (rev 2799)
+++ trunk/libgalago/libgalago/galago.h 2006-05-21 02:56:33 UTC (rev 2800)
@@ -1,7 +1,7 @@
-/**
- * @file libgalago/galago.h Main Galago include file.
+/*
+ * Main Galago include file.
*
- * @Copyright (C) 2004-2006 Christian Hammond.
+ * Copyright (C) 2004-2006 Christian Hammond.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
More information about the galago-commits
mailing list