diff options
| -rw-r--r-- | ChangeLog | 3 | ||||
| -rw-r--r-- | doc/catalogintro.sgml | 61 | ||||
| -rw-r--r-- | doc/properties.sgml | 11 | ||||
| -rw-r--r-- | doc/widgetclasses.sgml | 46 |
4 files changed, 101 insertions, 20 deletions
@@ -25,6 +25,9 @@ * gladeui/glade-utils.c: glade_util_ui_message() takes a widget to embed arg now. + * doc/catalogintro.sgml, doc/widgetclasses.sgml, doc/properties.sgml: + Documented newly added catalog tags. + 2008-04-08 Tristan Van Berkom <tvb@gnome.org> * NEWS: Rolling 3.5.0 diff --git a/doc/catalogintro.sgml b/doc/catalogintro.sgml index f30e2854..57b71e19 100644 --- a/doc/catalogintro.sgml +++ b/doc/catalogintro.sgml @@ -79,19 +79,40 @@ you can also use 'icon-prefix', 'depends' and 'domain'. <term>name</term> <listitem> <para> -The 'name' property is simply a string identifier for the catalog in -question, it will be used to identify your catalog so that the glade file can explicitly -require it and to manage inter catalog dependencies. +A string identifier for the catalog in question, it will be used to identify your +catalog so that the glade file can explicitly require it and to manage inter +catalog dependencies. </para> </listitem> </varlistentry> <varlistentry> + <term>version</term> + <listitem> + <para> +A 'major.minor' formed version describing the current version of underlying widget kit; +example: <literal>version="1.0"</literal>. This is needed for version checking to work. +Please note that all versioning related support is completely optional. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>targetable</term> + <listitem> + <para> +A comma separated list of 'major.minor' formed versions describing sensable previous +targetable versions of the underlying toolkit not including the current version; +example: <literal>targetable="0.6,0.8"</literal>. + </para> + </listitem> + </varlistentry> + + <varlistentry> <term>icon-prefix</term> <listitem> <para> -The 'icon-prefix' attribute is used to form icon names for widgets. This property defaults -to the value of the 'name' attribute. +Used to form icon names for widgets. This property defaults to the value of the 'name' attribute. </para> </listitem> </varlistentry> @@ -100,13 +121,13 @@ to the value of the 'name' attribute. <term>library</term> <listitem> <para> -The 'library' property is used to load the types and introspect properties, unless -you are faking your widget classes (which will be described later on), glade will -need to load this library, it can either be the name of the library containing the -widgets or the plugin library which is assumed to implicitly link to your widget -library. The library will be loaded either by a user specified path, the system -plugin directory: <literal>$prefix/lib/glade-3/modules/</literal>, or from -the default system library paths in the afore mentioned order of precedence. +Used to load the types and introspect properties, unless you are faking your widget +classes (which will be described later on), glade will need to load this library, +it can either be the name of the library containing the widgets or the plugin library +which is assumed to implicitly link to your widget library. The library will be loaded +either by a user specified path, the system plugin directory: +<literal>$prefix/lib/glade-3/modules/</literal>, or from the default system library +paths in the afore mentioned order of precedence. </para> </listitem> </varlistentry> @@ -115,11 +136,11 @@ the default system library paths in the afore mentioned order of precedence. <term>depends</term> <listitem> <para> -The 'depends' property is used for inheritance of support code to work -properly (i.e. if your object derives from an object in gtk+, you'll want the default -support code in the gladegtk plugin to be enabled for your widget too). This property's -value is the `name' property of another installed glade plugin; usually you'll want to -declare: 'depends="gtk+"' for your plugin. +Used for inheritance of support code to work properly (i.e. if your object derives +from an object in gtk+, you'll want the default support code in the gladegtk plugin +to be enabled for your widget too). This property's value is the `name' property of +another installed glade plugin; usually you'll want to declare: 'depends="gtk+"' +for your plugin. </para> </listitem> </varlistentry> @@ -128,7 +149,7 @@ declare: 'depends="gtk+"' for your plugin. <term>domain</term> <listitem> <para> -The 'domain' property is the domain in which to search for translatable strings from the +The domain in which to search for translatable strings from the catalog file; please note that all strings from the catalog that will apear in the UI are translated using this domain. If the 'domain' is not specified, the library property will be used in it's stead. @@ -140,7 +161,7 @@ be used in it's stead. <term>book</term> <listitem> <para> -The 'book' property is used to specify a namespace to search devhelp docs library with +Used to specify a namespace to search devhelp docs library with (specificly, it is the $(DOC_MODULE) that you specified in your gtk-doc Makefile.am). </para> </listitem> @@ -150,7 +171,7 @@ The 'book' property is used to specify a namespace to search devhelp docs librar <term>init-function</term> <listitem> <para> -The 'init-function' tag is used to retrieve an optional global entry point to your plugin; +Used to retrieve an optional global entry point to your plugin; if you need to initialize any backends or whatnot this is a good place. Your catalog's init-function will be called before any widget classes are instantiated. </para> diff --git a/doc/properties.sgml b/doc/properties.sgml index 7db9e737..4d2be078 100644 --- a/doc/properties.sgml +++ b/doc/properties.sgml @@ -60,6 +60,17 @@ The name to be used in the interface. </varlistentry> <varlistentry> + <term>since</term> + <listitem> + <para> +A 'major.minor' formed version describing the version of the owning catalog in which this +property was introduced; example: <literal>since="1.0"</literal>. Properties are initialized +to be supported since the introducing #GladeWidgetAdaptor was supported. + </para> + </listitem> + </varlistentry> + + <varlistentry> <term>disabled</term> <listitem> <para> diff --git a/doc/widgetclasses.sgml b/doc/widgetclasses.sgml index bdc3d0ab..dfa3ea67 100644 --- a/doc/widgetclasses.sgml +++ b/doc/widgetclasses.sgml @@ -44,6 +44,14 @@ Here is the complete example of the form of the `glade-widget-class' definition: </properties> + <signals> + + <signal id="frobnicate" since="1.0"/> + + ... signal definitions go here + + </signals> + <packing-properties> ... child packing property definitions go here @@ -97,6 +105,34 @@ support library. </listitem> </varlistentry> + <varlistentry> + <term>since</term> + <listitem> + <para> +A 'major.minor' formed version describing the version of the owning catalog in which this +object class was introduced; example: <literal>since="1.0"</literal>. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>deprecated</term> + <listitem> + <para> +A boolean property depicting that this widget is currently deprecated. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>builder-unsupported</term> + <listitem> + <para> +A boolean property depicting that this widget is not supported by #GtkBuilder. + </para> + </listitem> + </varlistentry> + <varlistentry> <term>get-type-function</term> <listitem> @@ -490,6 +526,16 @@ specify the property name and the `default' property for the value. </refsect1> <refsect1> + <title>Signals</title> + <para> +The signal elements are currently only needed for versioning support, use +the `signal' child tag as described above and set signal `id' to be supported +since version `since'. Signals are initialized to be supported since the +introducing #GladeWidgetAdaptor was supported. + </para> + </refsect1> + + <refsect1> <title>Icons</title> <para> The Glade palette and other components use icons to represent the various widget classes. |