grim/guifications3

broke GfPreference and GfPreference type out to tmpl/gf_preference.sgml
org.guifications.gf3
2009-10-11, Gary Kramlich
5c7d7b1e3e21
Parents 001d4ff7b7b2
Children 98b673e733a3dc1a11140a3a
broke GfPreference and GfPreference type out to tmpl/gf_preference.sgml
4 files changed, 253 insertions(+), 225 deletions(-)
  • +1 -0
    gflib/doc/gflib/gflib-docs.sgml
  • +33 -27
    gflib/doc/gflib/gflib-sections.txt
  • +219 -0
    gflib/doc/gflib/tmpl/gf_preference.sgml
  • +0 -198
    gflib/doc/gflib/tmpl/gf_preference_engine.sgml
    • --- a/gflib/doc/gflib/gflib-docs.sgml Sun Oct 11 04:02:29 2009 -0500
    +++ b/gflib/doc/gflib/gflib-docs.sgml Sun Oct 11 04:12:39 2009 -0500
    @@ -53,6 +53,7 @@
    <xi:include href="xml/gf_plugin.xml"/>
    <xi:include href="xml/gf_plugin_info.xml"/>
    <xi:include href="xml/gf_plugin_loader.xml"/>
    + <xi:include href="xml/gf_preference.xml"/>
    <xi:include href="xml/gf_preference_engine.xml"/>
    <xi:include href="xml/gf_preference_engine_null.xml"/>
    <xi:include href="xml/gf_preference_engine_xml.xml"/>
    --- a/gflib/doc/gflib/gflib-sections.txt Sun Oct 11 04:02:29 2009 -0500
    +++ b/gflib/doc/gflib/gflib-sections.txt Sun Oct 11 04:12:39 2009 -0500
    @@ -147,28 +147,10 @@
    </SECTION>
    <SECTION>
    -<FILE>gf_preference_engine</FILE>
    -<TITLE>GfPreferenceEngine</TITLE>
    +<FILE>gf_preference</FILE>
    +<TITLE>GfPreference</TITLE>
    GfPreferenceType
    GfPreference
    -GfPreferenceEngine
    -gf_preference_engine_reload
    -gf_preference_engine_save
    -gf_preference_engine_add_section
    -gf_preference_engine_add_string
    -gf_preference_engine_set_string
    -gf_preference_engine_get_string
    -gf_preference_engine_add_int
    -gf_preference_engine_set_int
    -gf_preference_engine_get_int
    -gf_preference_engine_add_bool
    -gf_preference_engine_set_bool
    -gf_preference_engine_get_bool
    -gf_preference_engine_exists
    -gf_preference_engine_rename
    -gf_preference_engine_remove
    -gf_preference_engine_query
    -gf_preference_engine_get_type
    gf_preference_type_from_string
    gf_preference_type_to_string
    gf_preference_copy
    @@ -189,18 +171,42 @@
    gf_preference_set_bool
    gf_preference_get_bool
    <SUBSECTION Standard>
    -gf_preference_engine_get_g_type
    +GF_TYPE_PREFERENCE
    +GF_TYPE_PREFERENCE_TYPE
    gf_preference_type_get_type
    gf_preference_get_g_type
    -GfPreferenceEngineClass
    +</SECTION>
    +
    +<SECTION>
    +<FILE>gf_preference_engine</FILE>
    +<TITLE>GfPreferenceEngine</TITLE>
    +GfPreferenceEngine
    +gf_preference_engine_reload
    +gf_preference_engine_save
    +gf_preference_engine_add_section
    +gf_preference_engine_add_string
    +gf_preference_engine_set_string
    +gf_preference_engine_get_string
    +gf_preference_engine_add_int
    +gf_preference_engine_set_int
    +gf_preference_engine_get_int
    +gf_preference_engine_add_bool
    +gf_preference_engine_set_bool
    +gf_preference_engine_get_bool
    +gf_preference_engine_exists
    +gf_preference_engine_rename
    +gf_preference_engine_remove
    +gf_preference_engine_query
    +gf_preference_engine_get_type
    +<SUBSECTION Standard>
    +GF_IS_PREFERENCE_ENGINE
    +GF_IS_PREFERENCE_ENGINE_CLASS
    GF_PREFERENCE_ENGINE
    -GF_IS_PREFERENCE_ENGINE
    -GF_TYPE_PREFERENCE_ENGINE
    GF_PREFERENCE_ENGINE_CLASS
    -GF_IS_PREFERENCE_ENGINE_CLASS
    GF_PREFERENCE_ENGINE_GET_CLASS
    -GF_TYPE_PREFERENCE_TYPE
    -GF_TYPE_PREFERENCE
    +GF_TYPE_PREFERENCE_ENGINE
    +GfPreferenceEngineClass
    +gf_preference_engine_get_g_type
    </SECTION>
    <SECTION>
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/gflib/doc/gflib/tmpl/gf_preference.sgml Sun Oct 11 04:12:39 2009 -0500
    @@ -0,0 +1,219 @@
    +<!-- ##### SECTION Title ##### -->
    +GfPreference
    +
    +<!-- ##### SECTION Short_Description ##### -->
    +GfPreference Object API
    +
    +<!-- ##### SECTION Long_Description ##### -->
    +<para>
    + The basic preference api.
    +</para>
    +
    +
    +<!-- ##### SECTION See_Also ##### -->
    +<para>
    +
    +</para>
    +
    +
    +<!-- ##### SECTION Stability_Level ##### -->
    +
    +
    +<!-- ##### ENUM GfPreferenceType ##### -->
    +<para>
    +
    +</para>
    +
    +@GF_PREFERENCE_TYPE_UNKNOWN:
    +@GF_PREFERENCE_TYPE_SECTION:
    +@GF_PREFERENCE_TYPE_STRING:
    +@GF_PREFERENCE_TYPE_INT:
    +@GF_PREFERENCE_TYPE_BOOL:
    +@GF_PREFERENCE_TYPES:
    +
    +<!-- ##### STRUCT GfPreference ##### -->
    +<para>
    +
    +</para>
    +
    +@name:
    +@path:
    +@type:
    +@value:
    +
    +<!-- ##### MACRO gf_preference_type_from_string ##### -->
    +<para>
    + Gets a #GfPreferenceType from a string.
    +</para>
    +<para>
    + Note: @str MUST be the untranslated string!
    +</para>
    +
    +@str: The string.
    +@Returns: The #GfPreferenceType.
    +
    +
    +<!-- ##### MACRO gf_preference_type_to_string ##### -->
    +<para>
    + Gets a string from a #GfPreferenceType.
    +</para>
    +
    +@type: The #GfPreferenceType.
    +@i18n: TRUE for the translated version.
    +@Returns: @type as a string.
    +
    +
    +<!-- ##### FUNCTION gf_preference_copy ##### -->
    +<para>
    +
    +</para>
    +
    +@pref:
    +@Returns:
    +
    +
    +<!-- ##### FUNCTION gf_preference_free ##### -->
    +<para>
    +
    +</para>
    +
    +@pref:
    +
    +
    +<!-- ##### FUNCTION gf_preference_freev ##### -->
    +<para>
    +
    +</para>
    +
    +@prefs:
    +
    +
    +<!-- ##### FUNCTION gf_preference_new ##### -->
    +<para>
    +
    +</para>
    +
    +@name:
    +@path:
    +@type:
    +@value:
    +@Returns:
    +
    +
    +<!-- ##### FUNCTION gf_preference_set_name ##### -->
    +<para>
    +
    +</para>
    +
    +@pref:
    +@name:
    +
    +
    +<!-- ##### FUNCTION gf_preference_get_name ##### -->
    +<para>
    +
    +</para>
    +
    +@pref:
    +@Returns:
    +
    +
    +<!-- ##### FUNCTION gf_preference_get_full_name ##### -->
    +<para>
    +
    +</para>
    +
    +@pref:
    +@Returns:
    +
    +
    +<!-- ##### FUNCTION gf_preference_set_path ##### -->
    +<para>
    +
    +</para>
    +
    +@pref:
    +@path:
    +
    +
    +<!-- ##### FUNCTION gf_preference_get_path ##### -->
    +<para>
    +
    +</para>
    +
    +@pref:
    +@Returns:
    +
    +
    +<!-- ##### FUNCTION gf_preference_set_type ##### -->
    +<para>
    +
    +</para>
    +
    +@pref:
    +@type:
    +
    +
    +<!-- ##### FUNCTION gf_preference_get_type ##### -->
    +<para>
    +
    +</para>
    +
    +@pref:
    +@Returns:
    +
    +
    +<!-- ##### FUNCTION gf_preference_set_string ##### -->
    +<para>
    +
    +</para>
    +
    +@pref:
    +@value:
    +
    +
    +<!-- ##### FUNCTION gf_preference_get_string ##### -->
    +<para>
    +
    +</para>
    +
    +@pref:
    +@Returns:
    +
    +
    +<!-- ##### FUNCTION gf_preference_set_int ##### -->
    +<para>
    +
    +</para>
    +
    +@pref:
    +@value:
    +
    +
    +<!-- ##### FUNCTION gf_preference_get_int ##### -->
    +<para>
    +
    +</para>
    +
    +@pref:
    +@Returns:
    +
    +
    +<!-- ##### FUNCTION gf_preference_set_bool ##### -->
    +<para>
    +
    +</para>
    +
    +@pref:
    +@value:
    +
    +
    +<!-- ##### FUNCTION gf_preference_get_bool ##### -->
    +<para>
    +
    +</para>
    +
    +@pref:
    +@Returns:
    +
    +
    --- a/gflib/doc/gflib/tmpl/gf_preference_engine.sgml Sun Oct 11 04:02:29 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_preference_engine.sgml Sun Oct 11 04:12:39 2009 -0500
    @@ -22,28 +22,6 @@
    <!-- ##### SECTION Stability_Level ##### -->
    -<!-- ##### ENUM GfPreferenceType ##### -->
    -<para>
    -
    -</para>
    -
    -@GF_PREFERENCE_TYPE_UNKNOWN:
    -@GF_PREFERENCE_TYPE_SECTION:
    -@GF_PREFERENCE_TYPE_STRING:
    -@GF_PREFERENCE_TYPE_INT:
    -@GF_PREFERENCE_TYPE_BOOL:
    -@GF_PREFERENCE_TYPES:
    -
    -<!-- ##### STRUCT GfPreference ##### -->
    -<para>
    -
    -</para>
    -
    -@name:
    -@path:
    -@type:
    -@value:
    -
    <!-- ##### STRUCT GfPreferenceEngine ##### -->
    @@ -241,179 +219,3 @@
    @Returns:
    -<!-- ##### MACRO gf_preference_type_from_string ##### -->
    -<para>
    - Gets a #GfPreferenceType from a string.
    -</para>
    -<para>
    - Note: @str MUST be the untranslated string!
    -</para>
    -
    -@str: The string.
    -@Returns: The #GfPreferenceType.
    -
    -
    -<!-- ##### MACRO gf_preference_type_to_string ##### -->
    -<para>
    - Gets a string from a #GfPreferenceType.
    -</para>
    -
    -@type: The #GfPreferenceType.
    -@i18n: TRUE for the translated version.
    -@Returns: @type as a string.
    -
    -
    -<!-- ##### FUNCTION gf_preference_copy ##### -->
    -<para>
    -
    -</para>
    -
    -@pref:
    -@Returns:
    -
    -
    -<!-- ##### FUNCTION gf_preference_free ##### -->
    -<para>
    -
    -</para>
    -
    -@pref:
    -
    -
    -<!-- ##### FUNCTION gf_preference_freev ##### -->
    -<para>
    -
    -</para>
    -
    -@prefs:
    -
    -
    -<!-- ##### FUNCTION gf_preference_new ##### -->
    -<para>
    -
    -</para>
    -
    -@name:
    -@path:
    -@type:
    -@value:
    -@Returns:
    -
    -
    -<!-- ##### FUNCTION gf_preference_set_name ##### -->
    -<para>
    -
    -</para>
    -
    -@pref:
    -@name:
    -
    -
    -<!-- ##### FUNCTION gf_preference_get_name ##### -->
    -<para>
    -
    -</para>
    -
    -@pref:
    -@Returns:
    -
    -
    -<!-- ##### FUNCTION gf_preference_get_full_name ##### -->
    -<para>
    -
    -</para>
    -
    -@pref:
    -@Returns:
    -
    -
    -<!-- ##### FUNCTION gf_preference_set_path ##### -->
    -<para>
    -
    -</para>
    -
    -@pref:
    -@path:
    -
    -
    -<!-- ##### FUNCTION gf_preference_get_path ##### -->
    -<para>
    -
    -</para>
    -
    -@pref:
    -@Returns:
    -
    -
    -<!-- ##### FUNCTION gf_preference_set_type ##### -->
    -<para>
    -
    -</para>
    -
    -@pref:
    -@type:
    -
    -
    -<!-- ##### FUNCTION gf_preference_get_type ##### -->
    -<para>
    -
    -</para>
    -
    -@pref:
    -@Returns:
    -
    -
    -<!-- ##### FUNCTION gf_preference_set_string ##### -->
    -<para>
    -
    -</para>
    -
    -@pref:
    -@value:
    -
    -
    -<!-- ##### FUNCTION gf_preference_get_string ##### -->
    -<para>
    -
    -</para>
    -
    -@pref:
    -@Returns:
    -
    -
    -<!-- ##### FUNCTION gf_preference_set_int ##### -->
    -<para>
    -
    -</para>
    -
    -@pref:
    -@value:
    -
    -
    -<!-- ##### FUNCTION gf_preference_get_int ##### -->
    -<para>
    -
    -</para>
    -
    -@pref:
    -@Returns:
    -
    -
    -<!-- ##### FUNCTION gf_preference_set_bool ##### -->
    -<para>
    -
    -</para>
    -
    -@pref:
    -@value:
    -
    -
    -<!-- ##### FUNCTION gf_preference_get_bool ##### -->
    -<para>
    -
    -</para>
    -
    -@pref:
    -@Returns:
    -
    -