|
Packit |
1e8aac |
<refentry id="widgetclasses" revision="8 Feb 2006">
|
|
Packit |
1e8aac |
<refmeta>
|
|
Packit |
1e8aac |
<refentrytitle>Widget Adaptor Definitions</refentrytitle>
|
|
Packit |
1e8aac |
<refmiscinfo>Glade UI</refmiscinfo>
|
|
Packit |
1e8aac |
</refmeta>
|
|
Packit |
1e8aac |
<refnamediv>
|
|
Packit |
1e8aac |
<refname>Widget Classes</refname>
|
|
Packit |
1e8aac |
<refpurpose>
|
|
Packit |
1e8aac |
Adding support for custom widgets
|
|
Packit |
1e8aac |
</refpurpose>
|
|
Packit |
1e8aac |
</refnamediv>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<refsect1>
|
|
Packit |
1e8aac |
<title>Forward</title>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
Widget support in Glade is provided by the #GladeWidgetAdaptor object, each
|
|
Packit |
1e8aac |
`glade-widget-class' definition in the catalog will result in the creation
|
|
Packit |
1e8aac |
of an adaptor, which inherits the funcionality of the adaptor created for its
|
|
Packit |
1e8aac |
parent, or the closest adaptor available in the ancestry. Adaptor methods can
|
|
Packit |
1e8aac |
be overridden by functions in the plugin by specifying them in the catalog.
|
|
Packit |
1e8aac |
There is also a wealth of options you can use in the `glade-widget-class' without
|
|
Packit |
1e8aac |
writing code.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A typical basic example of a widget class definition is as follows:
|
|
Packit |
1e8aac |
<programlisting>
|
|
Packit |
1e8aac |
]]></programlisting>
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
Here is the complete example of the form of the `glade-widget-class' definition:
|
|
Packit |
1e8aac |
<programlisting>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<post-create-function>foo_frobnicator_plugin_post_create</post-create-function>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
... widget class support functions go here
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<properties>
|
|
Packit |
1e8aac |
<property id="frobnicated" default="False"/>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
... property definitions go here
|
|
Packit |
1e8aac |
</properties>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<signals>
|
|
Packit |
1e8aac |
<signal id="frobnicate" since="1.0"/>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
... signal definitions go here
|
|
Packit |
1e8aac |
</signals>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<packing-properties>
|
|
Packit |
1e8aac |
... child packing property definitions go here
|
|
Packit |
1e8aac |
</packing-properties>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<actions>
|
|
Packit |
1e8aac |
<action id="launch_editor" name="Edit Frob" stock="gtk-edit"/>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
... context menu action definitions go here
|
|
Packit |
1e8aac |
</actions>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<packing-actions>
|
|
Packit |
1e8aac |
... context menu action definitions for child objects go here
|
|
Packit |
1e8aac |
</packing-actions>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<packing-defaults>
|
|
Packit |
1e8aac |
<parent-class name="GtkVBox">
|
|
Packit |
1e8aac |
<child-property id="expand" default="false"/>
|
|
Packit |
1e8aac |
</parent-class>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
... packing default definitions go here
|
|
Packit |
1e8aac |
</packing-defaults>
|
|
Packit |
1e8aac |
</glade-widget-class>]]></programlisting>
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
</refsect1>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<refsect1>
|
|
Packit |
1e8aac |
<title>Widget Class Properties</title>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
The following are all properies of the `glade-widget-class' tag
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
<variablelist>
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>name</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
The class name of the widget; unless the 'get-type-function' property is present,
|
|
Packit |
1e8aac |
this will essentially be used to instantiate the actual class by deriving
|
|
Packit |
1e8aac |
'gtk_label_get_type' from 'GtkLabel' and searching for 'gtk_label_get_type' in the
|
|
Packit |
1e8aac |
support library.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>since</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A 'major.minor' formed version describing the version of the owning catalog in which this
|
|
Packit |
1e8aac |
object class was introduced; example: <literal>since="1.0"</literal>.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>deprecated</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A boolean property depicting that this widget is currently deprecated.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>builder-unsupported</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A boolean property depicting that this widget is not supported by #GtkBuilder.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>get-type-function</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
Used to explicitly specify the name of the function used to get the type of the widget.
|
|
Packit |
1e8aac |
It is optional, but if it is not present, the 'name' property will be used to guess the
|
|
Packit |
1e8aac |
name of the function, a process that could lead to unexpected results.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>generic-name</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
Used to generate a default name for instances of the
|
|
Packit |
1e8aac |
widget in the UI editor. It is also used in conjunction with the 'icon-prefix'
|
|
Packit |
1e8aac |
to form an icon name for the widget.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>icon-name</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
Used to explicitly set an icon name for this widget.
|
|
Packit |
1e8aac |
These icon names are looked up in the current icon theme to retrieve an icon for
|
|
Packit |
1e8aac |
the widget.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>title</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
Used to display the name of the class in the palette and widget
|
|
Packit |
1e8aac |
tree and will be translated before use in the interface.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>parent</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
Use this to specify the name of the parent your widget derives from, you
|
|
Packit |
1e8aac |
can use this option instead of loading a real widget type (this allows you
|
|
Packit |
1e8aac |
to fake derive and still add properties and run your catalog independantly
|
|
Packit |
1e8aac |
of any plugins or libraries).
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>toplevel</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
Used to know whether this widget class is toplevel or not
|
|
Packit |
1e8aac |
in Glade context. This property will be inherited from the adaptors parent.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>fixed</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
Used to mark a #GladeWidgetClass for free form placement capacities
|
|
Packit |
1e8aac |
to be handled with a #GladeFixed. This property will be inherited from the adaptors parent.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>use-placeholders</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
Used to inform the core about adaptors that implement
|
|
Packit |
1e8aac |
#GtkContainer editing, and whether or not they use #GladePlaceholder. This property will
|
|
Packit |
1e8aac |
be inherited from the adaptors parent.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>default-width</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
The default width to load a #GtkWindow derived widget in the #GladeDesignView.
|
|
Packit |
1e8aac |
This property will be inherited from the adaptors parent.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>default-height</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
The default height to load a #GtkWindow derived widget in the #GladeDesignView.
|
|
Packit |
1e8aac |
This property will be inherited from the adaptors parent.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
</variablelist>
|
|
Packit |
1e8aac |
</refsect1>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<refsect1>
|
|
Packit |
1e8aac |
<title>Adapter Methods</title>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
The following are all child tags of the `glade-widget-class' tag
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
<variablelist>
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>constructor-function</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
Used to override the actual #GObject constructor of the said #GladeWidgetAdaptor
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>post-create-function</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A #GladePostCreateFunc support function that gets called whenever a widget of the said class is instantiated.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>deep-post-create-function</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
Same as `post-create-function' except in that you must always chain up
|
|
Packit |
1e8aac |
to the super class definition as a rule.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>get-property-function</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A #GladeGetPropertyFunc to get values of properties on an instance in the
|
|
Packit |
1e8aac |
runtime.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>set-property-function</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A #GladeSetPropertyFunc to set values of properties on an instance in the
|
|
Packit |
1e8aac |
runtime.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>verify-function</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A #GladeVerifyPropertyFunc to set values of properties on an instance in the
|
|
Packit |
1e8aac |
runtime.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>add-child-function</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A #GladeAddChildFunc to add children to instances in the runtime.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>remove-child-function</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A #GladeRemoveChildFunc to remove children from instances in the runtime.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>replace-child-function</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A #GladeReplaceChildFunc to replace children inside instances in the runtime.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>get-children-function</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A #GladeGetChildrenFunc to get a list of children inside instances in the runtime.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>child-get-property-function</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A #GladeChildGetPropertyFunc to get packing properties from instances in the runtime.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>child-set-property-function</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A #GladeChildSetPropertyFunc to set packing properties on instances in the runtime.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>child-verify-function</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A #GladeChildVerifyPropertyFunc to verify packing properties on instances in the runtime.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>get-internal-child-function</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A #GladeGetInternalFunc to retrieve an internal child of a composite object in the runtime.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>action-activate-function</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A #GladeActionActivateFunc to run a routine for a plugin defined #GladeWidgetAction.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>child-action-activate-function</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A #GladeChildActionActivateFunc to run a routine for a plugin defined packing #GladeWidgetAction.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>read-widget-function</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A #GladeReadWidgetFunc to load a widget from the xml.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>write-widget-function</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A #GladeWriteWidgetFunc to write a widget from the xml.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>read-child-function</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A #GladeReadWidgetFunc to read a child to the xml.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>write-child-function</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A #GladeWriteWidgetFunc to write a child to the xml.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>create-editor-property-function</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A #GladeCreateEPropFunc to create widgets to be used in Glade's property editor.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>string-from-value-function</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A #GladeStringFromValueFunc to create a string from a #GValue, these strings must
|
|
Packit |
1e8aac |
be unique and comparable for undo/redo to work properly.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
</variablelist>
|
|
Packit |
1e8aac |
</refsect1>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<refsect1>
|
|
Packit |
1e8aac |
<title>Action Definitions</title>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
Actions are added under the `actions' and `packing-actions' tags, actions can also
|
|
Packit |
1e8aac |
be nested so as to allow grouping in context menus, example:
|
|
Packit |
1e8aac |
<programlisting>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<action id="manage_frobs" name="Manage Frobs">
|
|
Packit |
1e8aac |
<action id="add_frob" name="Add" stock="gtk-add"/>
|
|
Packit |
1e8aac |
<action id="remove_frob" name="Remove" stock="gtk-remove"/>
|
|
Packit |
1e8aac |
</action>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
...]]></programlisting>
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
Here are the meanings of the `action' tag's properties:
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
<variablelist>
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>id</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
The string identifier for this action, the action_path argument to your #GladeActionActivateFunc
|
|
Packit |
1e8aac |
will be a combination if this id and any parents, for the above example:
|
|
Packit |
1e8aac |
<literal>"manage_frobs/add_frob"</literal>.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>name</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A string to be displayed in the UI for this action.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>stock</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
An optional Gtk stock icon to represent this action.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<varlistentry>
|
|
Packit |
1e8aac |
<term>important</term>
|
|
Packit |
1e8aac |
<listitem>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
A boolean option to add emphasis to this action; currently actions marked as `important'
|
|
Packit |
1e8aac |
are added to the toolbar.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</listitem>
|
|
Packit |
1e8aac |
</varlistentry>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
</variablelist>
|
|
Packit |
1e8aac |
</refsect1>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<refsect1>
|
|
Packit |
1e8aac |
<title>Packing Defaults</title>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
Default values can be specified for packing properties on your widget when added
|
|
Packit |
1e8aac |
to a said type of parent, as the example shows above; use the `parent-class' to
|
|
Packit |
1e8aac |
specify what parent (or derivative of that parent) you are targetting and fill
|
|
Packit |
1e8aac |
in any `child-property' tags you need for that parent using `id' property to
|
|
Packit |
1e8aac |
specify the property name and the `default' property for the value.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</refsect1>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<refsect1>
|
|
Packit |
1e8aac |
<title>Signals</title>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
The signal elements are currently only needed for versioning support, use
|
|
Packit |
1e8aac |
the `signal' child tag as described above and set signal `id' to be supported
|
|
Packit |
1e8aac |
since version `since'. Signals are initialized to be supported since the
|
|
Packit |
1e8aac |
introducing #GladeWidgetAdaptor was supported.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</refsect1>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<refsect1>
|
|
Packit |
1e8aac |
<title>Icons</title>
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
The Glade palette and other components use icons to represent the various widget classes.
|
|
Packit |
1e8aac |
It is a good idea to provide icons for your widget classes, as this
|
|
Packit |
1e8aac |
enhances the user interface.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
Glade uses the GTK+ GtkIconTheme facility to provide icons for widget classes. Any icon
|
|
Packit |
1e8aac |
available in the current icon theme can be used as an icon for a widget class.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
By default, an icon name of the format "widget-CATALOG_NAME-GENERIC_NAME"
|
|
Packit |
1e8aac |
is assigned to every widget class. CATALOG_NAME is the value of catalog name attribute,
|
|
Packit |
1e8aac |
and GENERIC_NAME is the value of an widget class's generic name attribute.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
To explicity set an icon name for a widget class, the "icon-name" attribute of the
|
|
Packit |
1e8aac |
"glade-widget-class" element can be specified. This will override the default icon
|
|
Packit |
1e8aac |
name assigned to the widget class.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<para>
|
|
Packit |
1e8aac |
Icon files can be installed under any system icon theme folder.
|
|
Packit |
1e8aac |
</para>
|
|
Packit |
1e8aac |
</refsect1>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
</refentry>
|