diff options
Diffstat (limited to 'doc/gconf/tmpl/gconf.sgml')
| -rw-r--r-- | doc/gconf/tmpl/gconf.sgml | 133 |
1 files changed, 29 insertions, 104 deletions
diff --git a/doc/gconf/tmpl/gconf.sgml b/doc/gconf/tmpl/gconf.sgml index d936dbec..7b802ddc 100644 --- a/doc/gconf/tmpl/gconf.sgml +++ b/doc/gconf/tmpl/gconf.sgml @@ -95,24 +95,15 @@ gconf_engine_notify_add(). <!-- ##### FUNCTION gconf_engine_notify_add ##### --> <para> -Registers a notification request with the <application>gconfd</application> -server. The server will notify the client when any key at or below -@namespace_section is set or unset. Try to watch the smallest possible part of -the namespace; otherwise you will slow down the server and your application with -unnecessary notifications. Note that you should prefer gconf_client_notify_add() -if you're using the #GObject wrapper library, because -gconf_client_notify_add() does not require a client-server conversation for -every callback. gconf_engine_notify_add() requests a different server notification for -every callback. The function returns an ID you can use to remove the -notification request; 0 is an invalid ID, and is returned if an error occurs. -</para> - -@conf: a #GConfEngine to monitor for changes. -@namespace_section: the directory or key to watch; you will be notified of changes at or below this point. -@func: the callback to invoke when a notification is received from the server. -@user_data: the data to pass to the callback. -@err: the return location for an allocated #GError, or <symbol>NULL</symbol> to ignore errors. -@Returns: an ID for the notification request, or 0 on error. + +</para> + +@conf: +@namespace_section: +@func: +@user_data: +@err: +@Returns: <!-- ##### FUNCTION gconf_engine_notify_remove ##### --> @@ -256,30 +247,24 @@ schema associations into the database during "make install." <!-- ##### FUNCTION gconf_engine_all_entries ##### --> <para> -Lists the key-value pairs in @dir. Does not list subdirectories; for -that use gconf_engine_all_dirs(). The returned list contains #GConfEntry -objects. A #GConfEntry contains an <emphasis>absolute</emphasis> key -and a value. The list is not recursive, it contains only the immediate -children of @dir. To free the returned list, gconf_entry_free() -each list element, then g_slist_free() the list itself. + </para> -@conf: a #GConfEngine. -@dir: Directory to list. -@err: the return location for an allocated #GError, or <symbol>NULL</symbol> to ignore errors. -@Returns: List of #GConfEntry. +@conf: +@dir: +@err: +@Returns: <!-- ##### FUNCTION gconf_engine_all_dirs ##### --> <para> -Lists the subdirectories in @dir. The returned list contains allocated -strings. Each string is the absolute path of a subdirectory. You should g_free() each string in the list, then g_slist_free() the list itself. + </para> -@conf: a #GConfEngine. -@dir: Directory to get subdirectories from. -@err: the return location for an allocated #GError, or <symbol>NULL</symbol> to ignore errors. -@Returns: List of allocated subdirectory names. +@conf: +@dir: +@err: +@Returns: <!-- ##### FUNCTION gconf_engine_suggest_sync ##### --> @@ -464,85 +449,25 @@ stored at @key, an error is returned. On error, or if @key is unset, <!-- ##### FUNCTION gconf_engine_get_schema ##### --> <para> -Requests the schema (%GCONF_VALUE_SCHEMA) stored at @key. -Automatically performs type-checking, so if a non-schema is stored at -@key, an error is returned. If no value is set or an error occurs, -<symbol>NULL</symbol> is returned. + </para> -@conf: a #GConfEngine. -@key: key you want the value of. -@err: the return location for an allocated #GError, or <symbol>NULL</symbol> to ignore errors. -@Returns: the value of @key as an allocated #GConfSchema, or <symbol>NULL</symbol> if no value was obtained. +@conf: +@key: +@err: +@Returns: <!-- ##### FUNCTION gconf_engine_get_list ##### --> <para> -Requests the list (%GCONF_VALUE_LIST) stored at @key. Automatically -performs type-checking, so if a non-list is stored at @key, or the -list does not contain elements of type @list_type, an error is -returned. If no value is set or an error occurs, <symbol>NULL</symbol> -is returned. Note that <symbol>NULL</symbol> is also the empty list, -so if you need to distinguish the empty list from an unset value, you -must use gconf_engine_get () to obtain a raw #GConfValue. -</para> -<para> -<emphasis>Remember that GConf lists can only store primitive types: -%GCONF_VALUE_FLOAT, %GCONF_VALUE_INT, %GCONF_VALUE_BOOL, -%GCONF_VALUE_STRING, %GCONF_VALUE_SCHEMA.</emphasis> Also remember -that lists must be uniform, you may not mix types in the same list. </para> -<para> -The type of the list elements depends on @list_type. A #GConfValue -with type %GCONF_VALUE_LIST normally stores a list of more #GConfValue -objects. gconf_engine_get_list() automatically converts to primitive C -types. Thus, the list->data fields in the returned list -contain: - -<informaltable pgwide="1" frame="none"> -<tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/> -<tbody> - -<row> -<entry>%GCONF_VALUE_INT</entry> -<entry>The integer itself, converted with GINT_TO_POINTER()</entry> -</row> - -<row> -<entry>%GCONF_VALUE_BOOL</entry> -<entry>The bool itself, converted with GINT_TO_POINTER()</entry> -</row> - -<row> -<entry>%GCONF_VALUE_FLOAT</entry> -<entry>A pointer to #gdouble, which should be freed with g_free()</entry> -</row> - -<row> -<entry>%GCONF_VALUE_STRING</entry> -<entry>A pointer to #gchar, which should be freed with g_free()</entry> -</row> - -<row> -<entry>%GCONF_VALUE_SCHEMA</entry> -<entry>A pointer to #GConfSchema, which should be freed with gconf_schema_free()</entry> -</row> - -</tbody></tgroup></informaltable> - -In the %GCONF_VALUE_FLOAT and %GCONF_VALUE_STRING cases, you must -g_free() each list element. In the %GCONF_VALUE_SCHEMA case you must -gconf_schema_free() each element. In all cases you must free the -list itself with g_slist_free(). -</para> - -@conf: a #GConfEngine. -@key: key you want the value of. -@list_type: type of each list element. -@err: the return location for an allocated #GError, or <symbol>NULL</symbol> to ignore errors. -@Returns: an allocated list, with elements as described above. +@conf: +@key: +@list_type: +@err: +@Returns: <!-- ##### FUNCTION gconf_engine_get_pair ##### --> |