Commit c43aaea0 authored by Tristan Van Berkom's avatar Tristan Van Berkom

Run gtkdocize with --flavour=no-tmpl



	* autogen.sh: Run gtkdocize with --flavour=no-tmpl
	
	* configure.ac: Require gtk-doc 1.9 and bump to 3.5.0 dev version.
	
	* doc/gladeui-overrides.txt, doc/children.sgml, doc/tmpl/*: Removed unneeded.

	* doc/gladeui-docs.sgml, doc/widgetclasses.sgml,
	doc/catalogintro.sgml, doc/Makefile.am: Mega docs update, added new
	files and completely rediscribed the catalog in its new form.

	* gladeui/glade-design-view.c, gladeui/glade-widget.c, 
	gladeui/glade-widget-adaptor.c, gladeui/glade-command.c,
	gladeui/glade-widget-adaptor.h, gladeui/glade-base-editor.c,
	gladeui/glade-widget-action.c, gladeui/glade-xml-utils.c,
	gladeui/glade-utils.c, gladeui/glade-catalog.c, gladeui/glade-property.c,
	gladeui/glade-project.c: Added some description statements to newly 
	documented files, fixed some warnings in other sources.

M    ChangeLog
M    configure.ac
M    doc/gladeui-docs.sgml
M    doc/widgetclasses.sgml
M    doc/catalogintro.sgml
D    doc/gladeui-overrides.txt
M    doc/Makefile.am
D    doc/children.sgml
D    doc/tmpl
M    doc/gladeui-sections.txt
M    doc/gladeui.types
M    doc/properties.sgml
M    gladeui/glade-design-view.c
M    gladeui/glade-widget.c
M    gladeui/glade-widget-adaptor.c
M    gladeui/glade-command.c
M    gladeui/glade-widget-adaptor.h
M    gladeui/glade-base-editor.c
M    gladeui/glade-widget-action.c
M    gladeui/glade-xml-utils.c
M    gladeui/glade-utils.c
M    gladeui/glade-catalog.c
M    gladeui/glade-property.c
M    gladeui/glade-project.c
M    autogen.sh

svn path=/trunk/; revision=1775
parent c79fc7cb
2008-04-07 Tristan Van Berkom <tvb@gnome.org>
* autogen.sh: Run gtkdocize with --flavour=no-tmpl
* configure.ac: Require gtk-doc 1.9 and bump to 3.5.0 dev version.
* doc/gladeui-overrides.txt, doc/children.sgml, doc/tmpl/*: Removed unneeded.
* doc/gladeui-docs.sgml, doc/widgetclasses.sgml,
doc/catalogintro.sgml, doc/Makefile.am: Mega docs update, added new
files and completely rediscribed the catalog in its new form.
* gladeui/glade-design-view.c, gladeui/glade-widget.c,
gladeui/glade-widget-adaptor.c, gladeui/glade-command.c,
gladeui/glade-widget-adaptor.h, gladeui/glade-base-editor.c,
gladeui/glade-widget-action.c, gladeui/glade-xml-utils.c,
gladeui/glade-utils.c, gladeui/glade-catalog.c, gladeui/glade-property.c,
gladeui/glade-project.c: Added some description statements to newly
documented files, fixed some warnings in other sources.
2008-04-06 Tristan Van Berkom <tvb@gnome.org>
* plugins/gtk+/glade-gtk.c: Implemented dual format for atk
......
......@@ -6,7 +6,6 @@ test -z "$srcdir" && srcdir=.
PKG_NAME="glade"
(test -f $srcdir/configure.ac \
&& test -f $srcdir/autogen.sh) || {
echo -n "**Error**: Directory "\`$srcdir\'" does not look like the"
......@@ -50,4 +49,4 @@ automake_version=1.9
# ;;
#esac
REQUIRED_GNOME_DOC_UTILS_VERSION=0.9.0 REQUIRED_AUTOMAKE_VERSION="$automake_version" GNOME_DATADIR="$gnome_datadir" USE_GNOME2_MACROS=1 . $gnome_autogen
GTKDOCIZE="gtkdocize --flavour no-tmpl" REQUIRED_GNOME_DOC_UTILS_VERSION=0.9.0 REQUIRED_AUTOMAKE_VERSION="$automake_version" GNOME_DATADIR="$gnome_datadir" USE_GNOME2_MACROS=1 . $gnome_autogen
......@@ -3,8 +3,8 @@ dnl Process this file with autoconf to produce a configure script.
AC_PREREQ(2.52)
m4_define(glade_major_version, 3)
m4_define(glade_minor_version, 4)
m4_define(glade_micro_version, 3)
m4_define(glade_minor_version, 5)
m4_define(glade_micro_version, 0)
m4_define(glade_version, glade_major_version.glade_minor_version.glade_micro_version)
AC_INIT([glade3], [glade_version],
......@@ -111,7 +111,7 @@ AC_TRY_LINK([#include <stdarg.h>], [va_list ap1, ap2; va_copy(ap1, ap2);],
dnl ================================================================
dnl Check for gtk-doc
dnl ================================================================
GTK_DOC_CHECK(1.4)
GTK_DOC_CHECK(1.9)
dnl ================================================================
dnl Check for gtk+
......
## Process this file with automake to produce Makefile.in
# We require automake 1.6 at least.
AUTOMAKE_OPTIONS = 1.9
AUTOMAKE_OPTIONS = 1.6
# This is a blank Makefile.am for using gtk-doc.
# Copy this to your project's API docs directory and modify the variables to
......@@ -58,9 +58,8 @@ IGNORE_HFILES=\
glade-id-allocator.h \
glade-catalog.h \
glade.h \
glade-xml-utils.h \
glade-design-layout.h \
glade-popup.h \
glade-devhelp.h \
glade-gtk.h \
glade-palette-expander.h \
glade-palette-item.h \
......@@ -77,8 +76,7 @@ content_files=\
version.xml \
catalogintro.sgml \
widgetclasses.sgml \
properties.sgml \
children.sgml
properties.sgml
# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
# These files must be listed here *and* in content_files
......@@ -86,8 +84,7 @@ content_files=\
expand_content_files=\
catalogintro.sgml \
widgetclasses.sgml \
properties.sgml \
children.sgml
properties.sgml
# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
# Only needed if you are using gtkdoc-scangobj to dynamically query widget
......@@ -100,7 +97,7 @@ GTKDOC_CFLAGS= \
-I$(top_srcdir) \
-I$(top_builddir) \
`pkg-config --cflags gtk+-2.0`
GTKDOC_LIBS=${top_builddir}/gladeui/libgladeui-1.la
# This includes the standard gtk-doc make rules, copied by gtkdocize.
......@@ -110,10 +107,12 @@ include $(top_srcdir)/gtk-doc.make
# e.g. EXTRA_DIST += version.xml.in
EXTRA_DIST += version.xml.in
GTK_HOME = http://developer.gnome.org/doc/API/2.0/gtk
GDK_HOME = http://developer.gnome.org/doc/API/2.0/gdk
GOBJECT_HOME = http://developer.gnome.org/doc/API/2.0/gobject
GLIB_HOME = http://developer.gnome.org/doc/API/2.0/glib
# XXX Seems this is no longer working with gtkdoc 1.9 :(
GTK_HOME = http://library.gnome.org/devel/gtk/stable
GDK_HOME = http://library.gnome.org/devel/gdk/stable
GOBJECT_HOME = http://library.gnome.org/devel/gobject/stable
GLIB_HOME = http://library.gnome.org/devel/glib/stable
webdocs: all
rm -rf html-web
......
......@@ -12,51 +12,52 @@ How to write and install a catalog
<refsect1>
<title>Introduction</title>
<para>
The widgets that are available in the Glade UI builder are handled in a
dynamic way and additional widgets can be added, for example from other
libraries, by installing a widget plugin.
</para>
<para>
A widget plugin consists of a catalog file and a shared library and
icons for the widgets to use in the widget palette and widget tree.
</para>
<para>
The catalog file is written in an XML format that will be described
below. There is also a DTD for the format which can be found in the widgets
directory of the glade-3 package.
</para>
<para>
Many properties of widgets can be handled automatically by the GObject
introspection features. Not all of them can though, and advanced widgets
often also need additional support from code. This is specified in the
catalog file, where you can override default values, hide properties,
specify functions to call in the installed plugin, etc.
You can provide support for your custom widgets in a few ways, you can
make a package and install it to the system directories, load additional
catalogs in user directories, project directories for example, and
you can optionally provide code support and/or icons, if you dont provide
icons for the inspector and palette Glade will simply print a warning
and use a default icon. The catalog file is written in an XML format and
a DTD for the format can be found in the plugins/ directory of the Glade
tarball.
</para>
<para>
The catalog file is also used to group the widgets in groups that
correspond to the groups in the Glade widget palette.
In most cases gtk+ derived widgets can be added with little effort and it
is enough to simply specify the widget's type; glade will introspect
its properties and signals - but due to the organic nature of a widget
toolkit there are always exceptions. In this document we'll try to provide
some basic examples and describe a wealth of options that can be used to
enhance UI editing and workaround exceptions.
</para>
<para>
In theory, the catalog file should be enough, but many widgets also need
supporting code to be usable in Glade, which is where the plugin library
comes in. An example of both a catalog file and plugin library can be
found in the Glade sources, since the GTK+ widget set that is supported
by default in Glade also is implemented this way. The catalog file is
located in widgets/gtk+.xml, and the source code in src/glade-gtk.c. The
catalog file starts by specifying the name of the catalog and the plugin
library to use:
The catalog file starts by specifying the name of the catalog and the plugin
library to use, the following examples assume you have a namespace "Foo" and
are integrating an object "Frobnicator":
<programlisting>
<![CDATA[<glade-catalog name="gtk+" library="gladegtk">
<![CDATA[<glade-catalog name="foo" library="foo" depends="gtk+">
<init-function>my_catalog_init</init-function>
<glade-widget-classes>
<glade-widget-class name="FooFrobnicator" generic-name="frobnicator" title="Frobnicator"/>
... widget classes go here
</glade-widget-classes>
<glade-widget-group name="foo" title="Foo">
<glade-widget-class-ref name="FooFrobnicator"/>
... widget class references go here
</glade-widget-group>
... widget groups go here
</glade-catalog>]]></programlisting>
......@@ -97,8 +98,13 @@ to the value of the 'name' attribute.
<term>library</term>
<listitem>
<para>
The 'library' property is a shorthand name for the plugin library which shall
be dlopen'd from <literal>$prefix/lib/glade-3/modules/</literal>
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.
</para>
</listitem>
</varlistentry>
......@@ -120,11 +126,10 @@ 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 catalog file (such as glade-widget-group `title's and such; translatable
values will be marked in this document as we go along and should be any strings
that are displayed in the glade UI). If the 'domain' property is not specified,
the library property will be used in it's stead.
The 'domain' property is 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.
</para>
</listitem>
</varlistentry>
......@@ -139,16 +144,6 @@ The 'book' property is used to specify a namespace to search devhelp docs librar
</listitem>
</varlistentry>
<varlistentry>
<term>fixed</term>
<listitem>
<para>
The 'fixed' property is used to mark a #GladeWidgetClass for free form placement capacities
to be handled with a #GladeFixed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>init-function</term>
<listitem>
......@@ -181,5 +176,20 @@ The icons for palette etc go into the pixmap directory:
The plugin library should be installed into the modules directory:
<programlisting>pkg-config --variable=moduledir gladeui-1.0</programlisting>
</para>
<para>
You can also load your catalog from a user directory by specifying
additional load path(s) in the environment, for instance:
<programlisting>GLADE_CATALOG_PATH=~/mycatalogs:~/work/foo/glade</programlisting>
</para>
<para>
Same goes for optional plugin libraries, for instance:
<programlisting>GLADE_MODULE_PATH=~/work/foo/src</programlisting>
</para>
<para>
Currently loading icons without installing them is unsupported.
</para>
</refsect1>
</refentry>
<refentry id="children" revision="8 Feb 2006">
<refmeta>
<refentrytitle>Container Objects</refentrytitle>
<refmiscinfo>Glade UI</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Containers</refname>
<refpurpose>
How to add support for hierarchic widget relationships
</refpurpose>
</refnamediv>
<refsect1>
<title>Defining Containers in the Catalog</title>
<para>
GtkContainer objects which parent GtkWidget objects have built-in detection in the
glade core; but other container relationships may be constructed; if for example you
wished to treat a GtkMenuBar --> GtkMenuItem relationship specially in the plugin;
Any GObject can parent any GObject. The default GtkContainer --> GtkWidget relationship
can also be modified for a GtkContainer derived object.
</para>
<para>
Child support definitions are identified by the GType of supported child class and
are embedded into a glade-widget-class block like so:
<programlisting>
<![CDATA[<glade-widget-class name="Foo">
<children>
<child>
<type>Bar</type>
... 'Foo --> Bar' container relationship parameters go here
<properties>
... packing property definition for this container relationship
</properties>
</child>
... more child definitions here ...
</children>
</glade-widget-class>]]></programlisting>
Note that you can access and modify and even add virtual packing properties in
exactly the same way as previously described with normal object properties.
</para>
</refsect1>
<refsect2>
<title>Container Relationship Parameter Tag Definitions</title>
<para>
<variablelist>
<varlistentry>
<term>add-child-function</term>
<listitem>
<para>
A #GladeAddChildFunc used to add child objects from parent objects.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>remove-child-function</term>
<listitem>
<para>
A #GladeRemoveChildFunc used to remove child objects from parent objects.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>replace-child-function</term>
<listitem>
<para>
A #GladeReplaceChildFunc Used to swap placholders with project widgets.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>get-children-function</term>
<listitem>
<para>
A #GladeGetChildrenFunc to return a list of children for this container. If you
have any anarchist internal children; they should be listed here along with
normal children.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>child-set-property-function</term>
<listitem>
<para>
A #GladeChildSetPropertyFunc to set a packing property on this child.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>child-get-property-function</term>
<listitem>
<para>
A #GladeChildGetPropertyFunc to get a packing property on this child.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>special-child-type</term>
<listitem>
<para>
A special type identifier that will indicate whether this is an alternate
child type; such as a notebook tab label or a frame label. The value of
special-child-type is the name of the added packing property for this child type;
you must then use the type to add children to the "correct port" at load time.
</para>
<para>
Currently this isnt very neatly done; you must do:
<programlisting>g_object_set_data (child, "special-child-type", type);</programlisting>
when creating special child types and handle it on replace-child; look at glade-gtk.c for
examples.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect2>
</refentry>
......@@ -4,7 +4,6 @@
<!ENTITY CatalogIntro SYSTEM "xml/catalogintro.sgml">
<!ENTITY WidgetClasses SYSTEM "xml/widgetclasses.sgml">
<!ENTITY Properties SYSTEM "xml/properties.sgml">
<!ENTITY Children SYSTEM "xml/children.sgml">
<!ENTITY GladeCommand SYSTEM "xml/glade-command.xml">
<!ENTITY GladeApp SYSTEM "xml/glade-app.xml">
<!ENTITY GladeClipboardView SYSTEM "xml/glade-clipboard-view.xml">
......@@ -24,17 +23,22 @@
<!ENTITY GladeWidget SYSTEM "xml/glade-widget.xml">
<!ENTITY GladeFixed SYSTEM "xml/glade-fixed.xml">
<!ENTITY GladeBaseEditor SYSTEM "xml/glade-base-editor.xml">
<!ENTITY GladeDesignView SYSTEM "xml/glade-design-view.xml">
<!ENTITY GladeXmlUtils SYSTEM "xml/glade-xml-utils.xml">
<!ENTITY GladeWidgetAction SYSTEM "xml/glade-widget-action.xml">
<!ENTITY version SYSTEM "version.xml">
]>
<book id="index">
<bookinfo>
<title>Glade UI Builder Reference Manual</title>
<title>Glade User Interface Designer Reference Manual</title>
<abstract>
<para>This document attempts to describe how to use the Glade UI Builder core
library to integrate Glade into your application and how to integrate your
custom (GTK+ based) widget toolkit into the Glade UI Builder.</para>
<para>
This document attempts to describe how to use the Glade UI Designer core
library to integrate Glade into your application and how to integrate your
custom GTK+ derived widgets into the Glade UI Builder.
</para>
<para>You can always get the latest version of this document here (XXX linkme)
<para>You can always get the latest version of this document <ulink url="http://glade.gnome.org/docs/index.html">here</ulink>
and you should have received a copy with the glade-3 tarball.</para>
</abstract>
<releaseinfo>for &version;</releaseinfo>
......@@ -52,7 +56,6 @@
&CatalogIntro;
&WidgetClasses;
&Properties;
&Children;
</part>
<part id="core">
......@@ -64,10 +67,12 @@
&GladeProperty;
&GladeWidgetAdaptor;
&GladePropertyClass;
&GladeWidgetAction;
&GladeCommand;
&GladeClipboard;
&GladeBaseEditor;
&GladePlaceholder;
&GladeXmlUtils;
</part>
<part id="dockables">
......@@ -78,6 +83,7 @@
&GladeClipboardView;
&GladeInspector;
&GladeSignalEditor;
&GladeDesignView;
</part>
<part id="misc">
......
......@@ -243,24 +243,6 @@ glade_clipboard_get_type
GladeClipboardClass
</SECTION>
<SECTION>
<FILE>glade-design-layout</FILE>
<TITLE>GladeDesignLayout</TITLE>
GladeDesignLayout
glade_design_layout_new
glade_design_layout_widget_event
<SUBSECTION Standard>
GLADE_DESIGN_LAYOUT
GLADE_IS_DESIGN_LAYOUT
GLADE_TYPE_DESIGN_LAYOUT
glade_design_layout_get_type
GLADE_DESIGN_LAYOUT_CLASS
GLADE_IS_DESIGN_LAYOUT_CLASS
GLADE_DESIGN_LAYOUT_GET_CLASS
GladeDesignLayoutClass
GladeDesignLayoutPrivate
</SECTION>
<SECTION>
<FILE>glade-signal</FILE>
GladeSignal
......@@ -775,3 +757,192 @@ glade_util_get_file_mtime
glade_util_draw_selection_nodes
</SECTION>
<SECTION>
<FILE>glade-xml-utils</FILE>
glade_xml_search_child
glade_xml_search_child_required
glade_xml_get_content
glade_xml_set_content
glade_xml_get_value_int
glade_xml_get_value_int_required
glade_xml_get_value_string
glade_xml_get_value_string_required
glade_xml_get_boolean
glade_xml_set_value
glade_xml_get_property_string_required
glade_xml_get_property_string
glade_xml_get_property_boolean
glade_xml_get_property_double
glade_xml_get_property_int
glade_xml_node_set_property_string
glade_xml_node_set_property_boolean
glade_xml_node_new
glade_xml_node_new_comment
glade_xml_node_delete
glade_xml_node_get_children
glade_xml_node_next
glade_xml_node_verify
glade_xml_node_verify_silent
glade_xml_node_get_name
glade_xml_node_append_child
glade_xml_node_remove
glade_xml_node_is_comment
glade_xml_node_next_with_comments
glade_xml_node_get_children_with_comments
glade_xml_doc_get_root
glade_xml_doc_new
glade_xml_doc_set_root
glade_xml_doc_free
glade_xml_doc_save
glade_xml_context_new
glade_xml_context_destroy
glade_xml_context_free
glade_xml_context_new_from_path
glade_xml_context_get_doc
glade_xml_load_sym_from_node
<SUBSECTION Standard>
GLADE_XML_CONTEXT
GLADE_XML_IS_CONTEXT
CAST_BAD
GladeXmlContext
GladeXmlNode
GladeXmlDoc
GLADE_XML_TAG_PROJECT
GLADE_XML_TAG_WIDGET
GLADE_XML_TAG_LIBGLADE_PROJECT
GLADE_XML_TAG_BUILDER_PROJECT
GLADE_XML_TAG_LIBGLADE_WIDGET
GLADE_XML_TAG_BUILDER_WIDGET
GLADE_XML_TAG_REQUIRES
GLADE_XML_TAG_LIB
GLADE_XML_TAG_PROPERTY
GLADE_XML_TAG_CLASS
GLADE_XML_TAG_ID
GLADE_XML_TAG_SIGNAL
GLADE_XML_TAG_HANDLER
GLADE_XML_TAG_AFTER
GLADE_XML_TAG_OBJECT
GLADE_XML_TAG_NAME
GLADE_XML_TAG_CHILD
GLADE_XML_TAG_PACKING
GLADE_XML_TAG_PLACEHOLDER
GLADE_XML_TAG_INTERNAL_CHILD
GLADE_XML_TAG_I18N_TRUE
GLADE_XML_TAG_SIGNAL_TRUE
GLADE_XML_TAG_TYPE
GLADE_TAG_GLADE_CATALOG
GLADE_TAG_GLADE_WIDGET_CLASSES
GLADE_TAG_GLADE_WIDGET_CLASS
GLADE_TAG_GLADE_WIDGET_GROUP
GLADE_TAG_GLADE_WIDGET_CLASS_REF
GLADE_TAG_ADAPTOR
GLADE_TAG_LIBRARY
GLADE_TAG_DEPENDS
GLADE_TAG_DOMAIN
GLADE_TAG_BOOK
GLADE_TAG_SIGNAL_NAME
GLADE_TAG_DEFAULT
GLADE_TAG_DISABLED
GLADE_TAG_DEFAULT_PALETTE_STATE
GLADE_TAG_REPLACE_CHILD_FUNCTION
GLADE_TAG_DEEP_POST_CREATE_FUNCTION
GLADE_TAG_POST_CREATE_FUNCTION
GLADE_TAG_GET_INTERNAL_CHILD_FUNCTION
GLADE_TAG_ADD_CHILD_FUNCTION
GLADE_TAG_REMOVE_CHILD_FUNCTION
GLADE_TAG_GET_CHILDREN_FUNCTION
GLADE_TAG_CHILD_SET_PROP_FUNCTION
GLADE_TAG_CHILD_GET_PROP_FUNCTION
GLADE_TAG_CHILD_VERIFY_FUNCTION
GLADE_TAG_CONSTRUCTOR_FUNCTION
GLADE_TAG_ACTION_ACTIVATE_FUNCTION
GLADE_TAG_CHILD_ACTION_ACTIVATE_FUNCTION
GLADE_TAG_READ_WIDGET_FUNCTION
GLADE_TAG_WRITE_WIDGET_FUNCTION
GLADE_TAG_READ_CHILD_FUNCTION
GLADE_TAG_WRITE_CHILD_FUNCTION
GLADE_TAG_CREATE_EPROP_FUNCTION
GLADE_TAG_STRING_FROM_VALUE_FUNCTION
GLADE_TAG_PROPERTIES
GLADE_TAG_PACKING_PROPERTIES
GLADE_TAG_PROPERTY
GLADE_TAG_ACTIONS
GLADE_TAG_PACKING_ACTIONS
GLADE_TAG_ACTION
GLADE_TAG_TYPE
GLADE_TAG_SPEC
GLADE_TAG_TOOLTIP
GLADE_TAG_PARAMETERS
GLADE_TAG_PARAMETER
GLADE_TAG_SET_FUNCTION
GLADE_TAG_GET_FUNCTION
GLADE_TAG_VERIFY_FUNCTION
GLADE_TAG_QUERY
GLADE_TAG_COMMON
GLADE_TAG_OPTIONAL
GLADE_TAG_OPTIONAL_DEFAULT
GLADE_TAG_VISIBLE
GLADE_TAG_EXPANDED
GLADE_TAG_GENERIC_NAME
GLADE_TAG_NAME
GLADE_TAG_PARENT
GLADE_TAG_TITLE
GLADE_TAG_ID
GLADE_TAG_KEY
GLADE_TAG_VALUE
GLADE_TAG_TRANSLATABLE
GLADE_TAG_HAS_CONTEXT
GLADE_TAG_COMMENT
GLADE_TAG_PACKING_DEFAULTS
GLADE_TAG_PARENT_CLASS
GLADE_TAG_CHILD_PROPERTY
GLADE_TAG_DISPLAYABLE_VALUES
GLADE_TAG_NICK
GLADE_TAG_SPECIAL_CHILD_TYPE
GLADE_TAG_SAVE
GLADE_TAG_SAVE_ALWAYS
GLADE_TAG_EDITABLE
GLADE_TAG_IGNORE
GLADE_TAG_VISIBLE_LINES
GLADE_TAG_RESOURCE
GLADE_TAG_THEMED_ICON
GLADE_TAG_INIT_FUNCTION
GLADE_TAG_ATK_PROPERTY
GLADE_TAG_FIXED
GLADE_TAG_TRANSFER_ON_PASTE
GLADE_TAG_WEIGHT
GLADE_TAG_STOCK
GLADE_TAG_GET_TYPE_FUNCTION
GLADE_TAG_TOPLEVEL
GLADE_TAG_USE_PLACEHOLDERS
GLADE_TAG_DEFAULT_WIDTH
GLADE_TAG_DEFAULT_HEIGHT
GLADE_TAG_EVENT_HANDLER_CONNECTED
GLADE_TAG_FALSE
GLADE_TAG_TRUE
GLADE_TAG_YES
GLADE_TAG_NO
GLADE_TAG_ICON_PREFIX
GLADE_TAG_ICON_NAME
GLADE_TAG_IMPORTANT
GLADE_ENUM_DATA_TAG
</SECTION>
<SECTION>
<FILE>glade-widget-action</FILE>
<TITLE>GladeWidgetAction</TITLE>
GWActionClass
GladeWidgetAction
glade_widget_action_class_free
glade_widget_action_class_clone
glade_widget_action_remove
glade_widget_action_set_sensitive
<SUBSECTION Standard>
GLADE_WIDGET_ACTION
GLADE_IS_WIDGET_ACTION
GLADE_TYPE_WIDGET_ACTION
glade_widget_action_get_type
GLADE_WIDGET_ACTION_CLASS
GLADE_IS_WIDGET_ACTION_CLASS
GLADE_WIDGET_ACTION_GET_CLASS
</SECTION>
......@@ -14,3 +14,7 @@ glade_inspector_get_type
glade_property_get_type
glade_widget_get_type
glade_widget_adaptor_get_type
glade_design_view_get_type
glade_design_layout_get_type
glade_base_editor_get_type
glade_widget_action_get_type
<
......@@ -11,30 +11,50 @@ How to augment or define a #GladePropertyClass
</refnamediv>
<refsect1>
<title>Property Class Parameters</title>
<title>Property Class Configuration</title>
<para>
There are alot of things that can be done with properties in glade; properties
can be added and removed from widget classes, lets list all the different
things you can do with properties.
Properties are introspected at load time and loaded into #GladePropertyClass structures.
The behaviour of properties can be modified by the catalog and fake properties can be added
for editing purposes. Here is an example of the xml form:
<programlisting><![CDATA[...
<property id="frobnicate-mode" default="FOO_FROBNICATE_RED">
... spec, tooltip etc
<displayable-values>
<value id="FOO_FROBNICATE_RED" name="Red"/>
<value id="FOO_FROBNICATE_BLUE" name="Blue"/>
... values here
</displayable-values>
</property>
...]]></programlisting>
</para>
<para>
Properties of the 'property' tag:
<variablelist>
<varlistentry>
<term>name</term>
<term>id</term>
<listitem>
<para>
The name to be used in the interface, this string is translated.
(if name is not specified; it defaults to the nickname of the #GParamSpec)
This is manditory and specifies the property that we are modifying (or adding)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>id</term>
<term>name</term>
<listitem>
<para>
This is manditory and specifies the property that we are modifying (or adding)
The name to be used in the interface.
(if name is not specified; it defaults to the nickname of the #GParamSpec)
</para>
</listitem>
</varlistentry>
......@@ -140,140 +160,103 @@ is the value saved).
<term>resource</term>
<listitem>
<para>
This is for string properties that represent filenames that are packaged with
Depicts string properties that represent filenames that are packaged with
the glade file (like pixbufs); you can set this to "True" and the string
property will be treated like a resource.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
Child tags of the 'property' tag:
<variablelist>