Next: , Previous: GError, Up: Top

7 GConfSchema

A describes a

7.1 Overview

A "schema" describes a key-value pair in a GConf database. It may include information such as default value and value type, as well as documentation describing the pair, the name of the application that created the pair, etc.

A <g-conf-schema> duplicates some of the information about the value it describes, such as type information. In these cases, the type information provided describes what the type of the value should be, not what the type actually is.

7.2 Usage

— Class: <g-conf-schema>

Derives from <gboxed>.

This class defines no direct slots.

— Function: gconf-schema-new ⇒  (ret <g-conf-schema>)

Creates a new <g-conf-schema>.

ret
newly allocated <g-conf-schema>
— Function: gconf-schema-get-locale (self <g-conf-schema>) ⇒  (ret mchars)

Returns the locale for a <g-conf-schema>. The returned string is not a copy, so don't try to free it. It is "owned" by the <g-conf-schema> and will be destroyed when the <g-conf-schema> is destroyed.

schema
a <g-conf-schema>
ret
the locale
— Function: gconf-schema-get-short-desc (self <g-conf-schema>) ⇒  (ret mchars)

Returns the short description for a <g-conf-schema>. The returned string is not a copy, don't try to free it. It is "owned" by the <g-conf-schema> and will be destroyed when the <g-conf-schema> is destroyed.

schema
a <g-conf-schema>.
ret
the short description.
— Function: gconf-schema-get-long-desc (self <g-conf-schema>) ⇒  (ret mchars)

Returns the long description for a <g-conf-schema>. The returned string is not a copy, don't try to free it. It is "owned" by the <g-conf-schema> and will be destroyed when the <g-conf-schema> is destroyed.

schema
a <g-conf-schema>
ret
the long description.
— Function: gconf-schema-get-owner (self <g-conf-schema>) ⇒  (ret mchars)

Returns the owner of a <g-conf-schema>. The returned string is not a copy, don't try to free it. It is "owned" by the <g-conf-schema> and will be destroyed when the <g-conf-schema> is destroyed.

schema
a <g-conf-schema>.
ret
the owner.
— Function: gconf-schema-get-default-value (self <g-conf-schema>) ⇒  (ret <g-conf-value>)

Returns the default value of the entry that is described by a <g-conf-schema>.

schema
a <g-conf-schema>.
ret
the default value of the entry.
— Function: gconf-schema-get-car-type (self <g-conf-schema>) ⇒  (ret <g-conf-value-type>)

Returns the default type of the first member of the pair in the entry (which should be of type ‘GCONF_VALUE_PAIR’) described by schema.

schema
a <g-conf-schema>.
ret
the type of the first member of the pair element of the entry.
— Function: gconf-schema-get-cdr-type (self <g-conf-schema>) ⇒  (ret <g-conf-value-type>)

Returns the default type of the second member of the pair in the entry (which should be of type ‘GCONF_VALUE_PAIR’) described by schema.

schema
a <g-conf-schema>.
ret
the type of the second member of the pair element of the entry.
— Function: gconf-schema-get-list-type (self <g-conf-schema>) ⇒  (ret <g-conf-value-type>)

Returns the default type of the list elements of the entry (which should be of default type ‘GCONF_VALUE_LIST’) described by schema.

schema

ret
— Function: gconf-schema-set-type (self <g-conf-schema>) (type <g-conf-value-type>)

Sets the <g-conf-value-type> of the <g-conf-schema> to type.

sc
a <g-conf-schema>.
type
the type.
— Function: gconf-schema-set-locale (self <g-conf-schema>) (locale mchars)

Sets the locale for a <g-conf-schema> to locale. locale is copied.

sc
a <g-conf-schema>.
locale
the locale.
— Function: gconf-schema-set-short-desc (self <g-conf-schema>) (desc mchars)

Sets the short description of a <g-conf-schema> to desc. desc is copied.

sc
a <g-conf-schema>.
desc
the short description.
— Function: gconf-schema-set-long-desc (self <g-conf-schema>) (desc mchars)

Sets the long description of a <g-conf-schema> to desc. desc is copied.

sc
a <g-conf-schema>.
desc
the long description.
— Function: gconf-schema-set-owner (self <g-conf-schema>) (owner mchars)

Sets the "owner" of the <g-conf-schema>, where the owner is the name of the application that created the entry.

sc
a <g-conf-schema>.
owner
the name of the creating application.
— Function: gconf-schema-set-default-value (self <g-conf-schema>) (val <g-conf-value>)

Sets the default value for the entry described by the <g-conf-schema>. The <g-conf-value> is copied. Alternatively, use gconf-schema-set-default-value-nocopy.

sc
a <g-conf-schema>.
val
the default value.
— Function: gconf-schema-set-car-type (self <g-conf-schema>) (type <g-conf-value-type>)

Sets the <g-conf-value-type> of the first member (car) of the entry (which should be of type ‘GCONF_VALUE_PAIR’) described by <g-conf-schema> to type.

sc
a <g-conf-schema>.
type
the type.
— Function: gconf-schema-set-cdr-type (self <g-conf-schema>) (type <g-conf-value-type>)

Sets the <g-conf-value-type> of the second member (cdr) of the entry (which should be of type ‘GCONF_VALUE_PAIR’) described by <g-conf-schema> to type.

sc
a <g-conf-schema>.
type
the type.
— Function: gconf-schema-set-list-type (self <g-conf-schema>) (type <g-conf-value-type>)

Sets the <g-conf-value-type> of the list elements of the entry (which should be of type ‘GCONF_VALUE_LIST’) described by <g-conf-schema> to type.

sc
a <g-conf-schema>.
type
the type.