doc/gconf/tmpl/gconf-schema.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GConfSchema
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5
   6 A #GConfSchema describes a #GConfEntry
   7
   8 <!-- ##### SECTION Long_Description ##### -->
   9 <para>
  10 A "schema" describes a key-value pair in a GConf database.
  11 It may include information such as default value and value
  12 type, as well as documentation describing the pair, the
  13 name of the application that created the pair, etc.
  14 </para>
  15 <para>
  16 A #GConfSchema duplicates some of the information about the value it
  17 describes, such as type information. In these cases, the type information
  18 provided describes what the type of the value <emphasis>should
  19 be</emphasis>, not what the type actually is.
  20 </para>
  21
  22 <!-- ##### SECTION See_Also ##### -->
  23 <para>
  24
  25 </para>
  26
  27 <!-- ##### SECTION Stability_Level ##### -->
  28
  29
  30 <!-- ##### STRUCT GConfSchema ##### -->
  31 <para>
  32 An opaque data type representing a description of a key-value pair.
  33 </para>
  34
  35
  36 <!-- ##### FUNCTION gconf_schema_new ##### -->
  37 <para>
  38 Creates a new #GConfSchema.
  39 </para>
  40
  41 @Returns: newly allocated #GConfSchema
  42
  43
  44 <!-- ##### FUNCTION gconf_schema_free ##### -->
  45 <para>
  46 Deallocates a #GConfSchema. Also frees any allocated memory
  47 inside the #GConfSchema.
  48 </para>
  49
  50 @sc: a #GConfSchema to destroy.
  51
  52
  53 <!-- ##### FUNCTION gconf_schema_copy ##### -->
  54 <para>
  55 Copies a #GConfSchema. The copy is a deep copy, that is, any allocated memory
  56 inside the #GConfSchema will also be copied.
  57 </para>
  58
  59 @sc: a #GConfSchema to copy.
  60 @Returns: a newly allocated #GConfSchema
  61
  62
  63 <!-- ##### FUNCTION gconf_schema_get_type ##### -->
  64 <para>
  65 Returns the type of the entry described by a #GConfSchema
  66 </para>
  67
  68 @schema: a #GConfSchema
  69 @Returns: the entry type.
  70 <!-- #Unused Parameters # -->
  71
  72
  73 <!-- ##### FUNCTION gconf_schema_get_locale ##### -->
  74 <para>
  75 Returns the locale for a #GConfSchema. The returned string
  76 is <emphasis>not</emphasis> a copy, so don't try to free it. It is
  77 "owned" by the #GConfSchema and will be destroyed when the #GConfSchema
  78 is destroyed.
  79 </para>
  80
  81 @schema: a #GConfSchema
  82 @Returns: the locale
  83 <!-- # Unused parameters # -->
  84
  85
  86 <!-- ##### FUNCTION gconf_schema_get_short_desc ##### -->
  87 <para>
  88 Returns the short description for a #GConfSchema. The returned string
  89 is <emphasis>not</emphasis> a copy, don't try to free it. It is
  90 "owned" by the #GConfSchema and will be destroyed when the #GConfSchema
  91 is destroyed.
  92 </para>
  93
  94 @schema: a #GConfSchema.
  95 @Returns: the short description.
  96
  97
  98 <!-- ##### FUNCTION gconf_schema_get_long_desc ##### -->
  99 <para>
 100 Returns the long description for a #GConfSchema. The returned string
 101 is <emphasis>not</emphasis> a copy, don't try to free it. It is
 102 "owned" by the #GConfSchema and will be destroyed when the #GConfSchema
 103 is destroyed.
 104 </para>
 105
 106 @schema: a #GConfSchema
 107 @Returns: the long description.
 108
 109
 110 <!-- ##### FUNCTION gconf_schema_get_owner ##### -->
 111 <para>
 112 Returns the owner of a #GConfSchema. The returned string
 113 is <emphasis>not</emphasis> a copy, don't try to free it. It is
 114 "owned" by the #GConfSchema and will be destroyed when the #GConfSchema
 115 is destroyed.
 116 </para>
 117
 118 @schema: a #GConfSchema.
 119 @Returns: the owner.
 120
 121
 122 <!-- ##### FUNCTION gconf_schema_get_default_value ##### -->
 123 <para>
 124 Returns the default value of the entry that is described by a #GConfSchema.
 125 </para>
 126
 127 @schema: a #GConfSchema.
 128 @Returns: the default value of the entry.
 129
 130
 131 <!-- ##### FUNCTION gconf_schema_get_car_type ##### -->
 132 <para>
 133 Returns the default type of the first member of the pair in the entry
 134 (which should be of type %GCONF_VALUE_PAIR) described by @schema.
 135 </para>
 136
 137 @schema: a #GConfSchema.
 138 @Returns: the type of the first member of the pair element of the entry.
 139
 140
 141 <!-- ##### FUNCTION gconf_schema_get_cdr_type ##### -->
 142 <para>
 143 Returns the default type of the second member of the pair in the entry
 144 (which should be of type %GCONF_VALUE_PAIR) described by @schema.
 145 </para>
 146
 147 @schema: a #GConfSchema.
 148 @Returns: the type of the second member of the pair element of the entry.
 149
 150
 151 <!-- ##### FUNCTION gconf_schema_get_list_type ##### -->
 152 <para>
 153 Returns the default type of the list elements of the entry (which should be
 154 of default type %GCONF_VALUE_LIST) described by @schema.
 155 </para>
 156
 157 +@schema: a #GConfSchema.
 158 +@Returns: the type of the list elements of the entry.
 159
 160 @schema:
 161 @Returns:
 162
 163
 164 <!-- ##### FUNCTION gconf_schema_set_type ##### -->
 165 <para>
 166 Sets the #GConfValueType of the #GConfSchema to @type.
 167 </para>
 168
 169 @sc: a #GConfSchema.
 170 @type: the type.
 171
 172
 173 <!-- ##### FUNCTION gconf_schema_set_locale ##### -->
 174 <para>
 175 Sets the locale for a #GConfSchema to @locale. @locale is copied.
 176 </para>
 177
 178 @sc: a #GConfSchema.
 179 @locale: the locale.
 180
 181
 182 <!-- ##### FUNCTION gconf_schema_set_short_desc ##### -->
 183 <para>
 184 Sets the short description of a #GConfSchema to @desc. @desc is copied.
 185 </para>
 186
 187 @sc: a #GConfSchema.
 188 @desc: the short description.
 189
 190
 191 <!-- ##### FUNCTION gconf_schema_set_long_desc ##### -->
 192 <para>
 193 Sets the long description of a #GConfSchema to @desc. @desc is copied.
 194 </para>
 195
 196 @sc: a #GConfSchema.
 197 @desc: the long description.
 198
 199
 200 <!-- ##### FUNCTION gconf_schema_set_owner ##### -->
 201 <para>
 202 Sets the "owner" of the #GConfSchema, where the owner is the
 203 name of the application that created the entry.
 204 </para>
 205
 206 @sc: a #GConfSchema.
 207 @owner: the name of the creating application.
 208
 209
 210 <!-- ##### FUNCTION gconf_schema_set_default_value ##### -->
 211 <para>
 212 Sets the default value for the entry described by the #GConfSchema.
 213 The #GConfValue is copied. Alternatively, use
 214 gconf_schema_set_default_value_nocopy().
 215 </para>
 216
 217 @sc: a #GConfSchema.
 218 @val: the default value.
 219
 220
 221 <!-- ##### FUNCTION gconf_schema_set_default_value_nocopy ##### -->
 222 <para>
 223 Sets the default value for the entry described by the #GConfSchema.
 224 The #GConfValue is not copied; the #GConfSchema takes ownership of it.
 225 Alternatively, use gconf_schema_set_default_value().
 226 </para>
 227
 228 @sc: a #GConfSchema.
 229 @val: the default value.
 230
 231
 232 <!-- ##### FUNCTION gconf_schema_set_car_type ##### -->
 233 <para>
 234 Sets the #GConfValueType of the first member (car) of the entry (which
 235 should be of type %GCONF_VALUE_PAIR) described by #GConfSchema to @type.
 236 </para>
 237
 238 @sc: a #GConfSchema.
 239 @type: the type.
 240
 241
 242 <!-- ##### FUNCTION gconf_schema_set_cdr_type ##### -->
 243 <para>
 244 Sets the #GConfValueType of the second member (cdr) of the entry (which
 245 should be of type %GCONF_VALUE_PAIR) described by #GConfSchema to @type.
 246 </para>
 247
 248 @sc: a #GConfSchema.
 249 @type: the type.
 250
 251
 252 <!-- ##### FUNCTION gconf_schema_set_list_type ##### -->
 253 <para>
 254 Sets the #GConfValueType of the list elements of the entry (which
 255 should be of type %GCONF_VALUE_LIST) described by #GConfSchema to @type.
 256 </para>
 257
 258 @sc: a #GConfSchema.
 259 @type: the type.
 260
 261