diff options
| author | Tristan Van Berkom <tvb@src.gnome.org> | 2008-04-07 12:23:11 +0000 |
|---|---|---|
| committer | Tristan Van Berkom <tvb@src.gnome.org> | 2008-04-07 12:23:11 +0000 |
| commit | c43aaea090997a285ece539bf9b9f4bfbe057382 (patch) | |
| tree | 826099d08f6f90b1c3bf51c22b0d7ddc6d193b4a /doc | |
| parent | c79fc7cbe1f06d4a6164075b8d39ddff18df247a (diff) | |
| download | glade-c43aaea090997a285ece539bf9b9f4bfbe057382.tar.gz | |
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
Diffstat (limited to 'doc')
35 files changed, 734 insertions, 6139 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 68e4736b..f04d84fe 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,7 +1,7 @@ ## 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 diff --git a/doc/catalogintro.sgml b/doc/catalogintro.sgml index 0b2aa025..a31153b0 100644 --- a/doc/catalogintro.sgml +++ b/doc/catalogintro.sgml @@ -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> @@ -140,16 +145,6 @@ The 'book' property is used to specify a namespace to search devhelp docs librar </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> <para> @@ -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> diff --git a/doc/children.sgml b/doc/children.sgml deleted file mode 100644 index 718a30bf..00000000 --- a/doc/children.sgml +++ /dev/null @@ -1,125 +0,0 @@ -<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> diff --git a/doc/gladeui-docs.sgml b/doc/gladeui-docs.sgml index 7ef577fd..466bed24 100644 --- a/doc/gladeui-docs.sgml +++ b/doc/gladeui-docs.sgml @@ -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"> diff --git a/doc/gladeui-overrides.txt b/doc/gladeui-overrides.txt deleted file mode 100644 index e69de29b..00000000 --- a/doc/gladeui-overrides.txt +++ /dev/null diff --git a/doc/gladeui-sections.txt b/doc/gladeui-sections.txt index b796a38f..93ee0c29 100644 --- a/doc/gladeui-sections.txt +++ b/doc/gladeui-sections.txt @@ -244,24 +244,6 @@ 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 glade_signal_new @@ -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> diff --git a/doc/gladeui.types b/doc/gladeui.types index a62e4355..7a694e5e 100644 --- a/doc/gladeui.types +++ b/doc/gladeui.types @@ -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 diff --git a/doc/properties.sgml b/doc/properties.sgml index 3a27aadd..7db9e737 100644 --- a/doc/properties.sgml +++ b/doc/properties.sgml @@ -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> <varlistentry> - <term>spec</term> + <term>themed-icon</term> <listitem> <para> -Specifies a function to be used to return a #GParamSpec for this property; -this is used to add virtual properties to an object (like the "size" property -on #GtkBox). +Depicts a string property that is used for an icon from the theme. These will +the appropriate editor. </para> </listitem> </varlistentry> <varlistentry> - <term>tooltip</term> + <term>weight</term> <listitem> <para> -The tooltip to be displayed in the property editor for this property, this -is also translated. The tooltip defaults to the blurb of the associated -#GParamSpec. +A numerical value to specify this properties position in the property editor. </para> </listitem> </varlistentry> <varlistentry> - <term>visible-lines</term> + <term>transfer-on-paste</term> <listitem> <para> -An integer value to specify how many lines will be shown for text properties -in the editor (this doesnt really work because of the complexity of calculating -size of rendered text; instead, just set this to 2 if you want the text property -to be edited in a textview with a scrolled window as opposed to a simple text entry). +Used for packing properties; depicts packing properties that should follow +the widget when pasted to a new container that supports the same properties. </para> </listitem> </varlistentry> <varlistentry> - <term>set-function</term> + <term>save-always</term> <listitem> <para> -A #GladeSetPropertyFunc used to set the property instead of g_object_set() +Specifies that the property should be saved regardless of its value (properties at thier +default values are normally not saved). </para> </listitem> </varlistentry> + </variablelist> + </para> + + <para> +Child tags of the 'property' tag: + <variablelist> <varlistentry> - <term>get-function</term> + <term>spec</term> <listitem> <para> -A #GladeSetPropertyFunc function used to set the property instead of g_object_get() +Specifies a function to be used to return a #GParamSpec for this property; +this is used to add virtual properties to an object (like the "size" property +on #GtkBox). </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>tooltip</term> + <listitem> <para> -Technical note: that the get-function is hardly ever used, the only -time glade-3 will actually ask the object what a property's value should be; -is when adding a widget to a container and introspecting the values that -the container assigned the child as packing properties. +The tooltip to be displayed in the property editor for this property. +The tooltip defaults to the blurb of the associated #GParamSpec. </para> </listitem> </varlistentry> <varlistentry> - <term>verify-function</term> + <term>visible-lines</term> <listitem> <para> -A #GladeVerifyPropertyFunc function to verify whether the requested value is valid. -If specified; the editor will not allow the user to commit a value that this -function returns False for. +An integer value to specify how many lines will be shown for text properties +in the editor (this doesnt really work because of the complexity of calculating +size of rendered text; instead, just set this to 2 if you want the text property +to be edited in a textview with a scrolled window as opposed to a simple text entry). </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>displayable-values</term> + <listitem> <para> -Technical note: verify functions are nescisary in glade-3 because of -the abstraction between the value maintained in the glade-3 core and -the value that is actually on the said GObject's property. In other words, -if verify-function returns false; glade's value won't change and set-function -won't be called, if set-function decides not commit the said value, thats -its own rotten business (hehe) and if the property is set to ignore="True", -verify functions will still function properly even if set-functions are not -called for that property. +Allows you to specify user friendly strings for enum and flag values as shown in the +example above, use the `id' property in the value tag to depict the real value name +and the `name' property for the human readable one. </para> </listitem> </varlistentry> + </variablelist> </para> </refsect1> - <refsect2> - <title>Displayable Values, Packing defaults and such</title> - <para> -Enum and Flag type properties tend to have long complicated names unsuited for the glade -environment, glade will allow you to substitute these names using the displayable-values -child tag; the form looks like this: - <programlisting> -<![CDATA[<property id="pack-type"> - <displayable-values> - <value id="GTK_PACK_START" name="Start"></value> - <value id="GTK_PACK_END" name="End"></value> - </displayable-values> -</property>]]></programlisting> -Note that the "name" (which will be the resulting name for each `id') is a translated -string. - </para> - - <para> -A widget class may have default packing properties for each type of container that -it can be added to; a short example should suffice as a description of how this works: - <programlisting> -<![CDATA[<packing-defaults> - <parent-class name="GtkVBox"> - <child-property id="expand" default="false"/> - </parent-class> -</packing-defaults>]]></programlisting> -Note that you can list any number of 'packing-defaults' in a row. - </para> - - <para> -Properties can have additional parameters; these are completely unused by glade -but may be usefull for a plugin writer who may want to use the GladeParameter -api to find parameters on property classes; the form looks like this: - <programlisting> -<![CDATA[<property id="foo"> - <parameters> - <parameter key="Min" value="1"/> - <parameter key="Max" value="10000"/> - </parameters> -</property>]]></programlisting> - </para> - </refsect2> </refentry> diff --git a/doc/tmpl/glade-app.sgml b/doc/tmpl/glade-app.sgml deleted file mode 100644 index 00ed2fb0..00000000 --- a/doc/tmpl/glade-app.sgml +++ /dev/null @@ -1,423 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GladeApp - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GladeApp ##### --> -<para> - -</para> - - -<!-- ##### SIGNAL GladeApp::update-ui ##### --> -<para> - -</para> - -@gladeapp: the object which received the signal. - -<!-- ##### ARG GladeApp:active-project ##### --> -<para> - -</para> - -<!-- ##### ARG GladeApp:pointer-mode ##### --> -<para> - -</para> - -<!-- ##### FUNCTION glade_app_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_pointer_mode_get_type ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_app_get ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_app_update_ui ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION glade_app_set_window ##### --> -<para> - -</para> - -@window: - - -<!-- ##### FUNCTION glade_app_get_window ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_app_get_editor ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_app_get_palette ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_app_get_clipboard ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_app_get_clipboard_view ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_app_get_project ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_app_set_project ##### --> -<para> - -</para> - -@project: - - -<!-- ##### FUNCTION glade_app_get_pointer_mode ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_app_set_pointer_mode ##### --> -<para> - -</para> - -@mode: - - -<!-- ##### FUNCTION glade_app_add_project ##### --> -<para> - -</para> - -@project: - - -<!-- ##### FUNCTION glade_app_remove_project ##### --> -<para> - -</para> - -@project: - - -<!-- ##### FUNCTION glade_app_get_projects ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_app_get_config ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_app_is_project_loaded ##### --> -<para> - -</para> - -@project_path: -@Returns: - - -<!-- ##### FUNCTION glade_app_get_project_by_path ##### --> -<para> - -</para> - -@project_path: -@Returns: - - -<!-- ##### FUNCTION glade_app_show_properties ##### --> -<para> - -</para> - -@raise: - - -<!-- ##### FUNCTION glade_app_hide_properties ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION glade_app_command_copy ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION glade_app_command_cut ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION glade_app_command_paste ##### --> -<para> - -</para> - -@placeholder: - - -<!-- ##### FUNCTION glade_app_command_delete ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION glade_app_command_delete_clipboard ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION glade_app_command_undo ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION glade_app_command_redo ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION glade_app_config_save ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_app_set_transient_parent ##### --> -<para> - -</para> - -@parent: - - -<!-- ##### FUNCTION glade_app_get_transient_parent ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_app_set_accel_group ##### --> -<para> - -</para> - -@accel_group: - - -<!-- ##### FUNCTION glade_app_update_instance_count ##### --> -<para> - -</para> - -@project: - - -<!-- ##### FUNCTION glade_app_undo_button_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_app_redo_button_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_app_get_selection ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_app_is_selected ##### --> -<para> - -</para> - -@object: -@Returns: - - -<!-- ##### FUNCTION glade_app_selection_set ##### --> -<para> - -</para> - -@object: -@emit_signal: - - -<!-- ##### FUNCTION glade_app_selection_add ##### --> -<para> - -</para> - -@object: -@emit_signal: - - -<!-- ##### FUNCTION glade_app_selection_remove ##### --> -<para> - -</para> - -@object: -@emit_signal: - - -<!-- ##### FUNCTION glade_app_selection_clear ##### --> -<para> - -</para> - -@emit_signal: - - -<!-- ##### FUNCTION glade_app_selection_changed ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION glade_app_get_catalogs_dir ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_app_get_modules_dir ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_app_get_plugins_dir ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_app_get_pixmaps_dir ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_app_get_locale_dir ##### --> -<para> - -</para> - -@Returns: - - diff --git a/doc/tmpl/glade-base-editor.sgml b/doc/tmpl/glade-base-editor.sgml deleted file mode 100644 index ed40ba58..00000000 --- a/doc/tmpl/glade-base-editor.sgml +++ /dev/null @@ -1,96 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GladeBaseEditor - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GladeBaseEditor ##### --> -<para> - -</para> - -@parent: -@priv: - -<!-- ##### FUNCTION glade_base_editor_new ##### --> -<para> - -</para> - -@container: -@tree_like: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION glade_base_editor_add_default_properties ##### --> -<para> - -</para> - -@editor: -@gchild: - - -<!-- ##### FUNCTION glade_base_editor_add_properties ##### --> -<para> - -</para> - -@editor: -@gchild: -@packing: -@Varargs: - - -<!-- ##### FUNCTION glade_base_editor_add_label ##### --> -<para> - -</para> - -@editor: -@str: - - -<!-- ##### FUNCTION glade_base_editor_add_popup_items ##### --> -<para> - -</para> - -@editor: -@Varargs: - - -<!-- ##### FUNCTION glade_base_editor_set_show_signal_editor ##### --> -<para> - -</para> - -@editor: -@val: - - -<!-- ##### FUNCTION glade_base_editor_pack_new_window ##### --> -<para> - -</para> - -@editor: -@title: -@help_markup: -@Returns: - - diff --git a/doc/tmpl/glade-clipboard-view.sgml b/doc/tmpl/glade-clipboard-view.sgml deleted file mode 100644 index 9148d38c..00000000 --- a/doc/tmpl/glade-clipboard-view.sgml +++ /dev/null @@ -1,60 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GladeClipboardView - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GladeClipboardView ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION glade_clipboard_view_new ##### --> -<para> - -</para> - -@clipboard: -@Returns: - - -<!-- ##### FUNCTION glade_clipboard_view_add ##### --> -<para> - -</para> - -@view: -@widget: - - -<!-- ##### FUNCTION glade_clipboard_view_remove ##### --> -<para> - -</para> - -@view: -@widget: - - -<!-- ##### FUNCTION glade_clipboard_view_refresh_sel ##### --> -<para> - -</para> - -@view: - - diff --git a/doc/tmpl/glade-clipboard.sgml b/doc/tmpl/glade-clipboard.sgml deleted file mode 100644 index b73759a7..00000000 --- a/doc/tmpl/glade-clipboard.sgml +++ /dev/null @@ -1,91 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GladeClipboard - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GladeClipboard ##### --> -<para> - -</para> - - -<!-- ##### ARG GladeClipboard:has-selection ##### --> -<para> - -</para> - -<!-- ##### FUNCTION glade_clipboard_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_clipboard_add ##### --> -<para> - -</para> - -@clipboard: -@widgets: - - -<!-- ##### FUNCTION glade_clipboard_remove ##### --> -<para> - -</para> - -@clipboard: -@widgets: - - -<!-- ##### FUNCTION glade_clipboard_selection_add ##### --> -<para> - -</para> - -@clipboard: -@widget: - - -<!-- ##### FUNCTION glade_clipboard_selection_remove ##### --> -<para> - -</para> - -@clipboard: -@widget: - - -<!-- ##### FUNCTION glade_clipboard_selection_clear ##### --> -<para> - -</para> - -@clipboard: - - -<!-- ##### FUNCTION glade_clipboard_get_has_selection ##### --> -<para> - -</para> - -@clipboard: -@Returns: - - diff --git a/doc/tmpl/glade-command.sgml b/doc/tmpl/glade-command.sgml deleted file mode 100644 index 1548ee64..00000000 --- a/doc/tmpl/glade-command.sgml +++ /dev/null @@ -1,229 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GladeCommand - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GCSetPropData ##### --> -<para> - -</para> - -@property: -@new_value: -@old_value: - -<!-- ##### STRUCT GladeCommand ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION glade_command_push_group ##### --> -<para> - -</para> - -@fmt: -@Varargs: - - -<!-- ##### FUNCTION glade_command_pop_group ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION glade_command_execute ##### --> -<para> - -</para> - -@command: -@Returns: - - -<!-- ##### FUNCTION glade_command_undo ##### --> -<para> - -</para> - -@command: -@Returns: - - -<!-- ##### FUNCTION glade_command_unifies ##### --> -<para> - -</para> - -@command: -@other: -@Returns: - - -<!-- ##### FUNCTION glade_command_collapse ##### --> -<para> - -</para> - -@command: -@other: - - -<!-- ##### FUNCTION glade_command_set_property ##### --> -<para> - -</para> - -@property: -@Varargs: - - -<!-- ##### FUNCTION glade_command_set_property_value ##### --> -<para> - -</para> - -@property: -@value: - - -<!-- ##### FUNCTION glade_command_set_properties ##### --> -<para> - -</para> - -@property: -@old_value: -@new_value: -@Varargs: - - -<!-- ##### FUNCTION glade_command_set_properties_list ##### --> -<para> - -</para> - -@project: -@props: - - -<!-- ##### FUNCTION glade_command_set_name ##### --> -<para> - -</para> - -@glade_widget: -@name: - - -<!-- ##### FUNCTION glade_command_delete ##### --> -<para> - -</para> - -@widgets: - - -<!-- ##### FUNCTION glade_command_create ##### --> -<para> - -</para> - -@adaptor: -@parent: -@placeholder: -@project: -@Returns: - - -<!-- ##### FUNCTION glade_command_cut ##### --> -<para> - -</para> - -@widgets: - - -<!-- ##### FUNCTION glade_command_copy ##### --> -<para> - -</para> - -@widgets: - - -<!-- ##### FUNCTION glade_command_paste ##### --> -<para> - -</para> - -@widgets: -@parent: -@placeholder: - - -<!-- ##### FUNCTION glade_command_dnd ##### --> -<para> - -</para> - -@widgets: -@parent: -@placeholder: - - -<!-- ##### FUNCTION glade_command_add_signal ##### --> -<para> - -</para> - -@glade_widget: -@signal: - - -<!-- ##### FUNCTION glade_command_remove_signal ##### --> -<para> - -</para> - -@glade_widget: -@signal: - - -<!-- ##### FUNCTION glade_command_change_signal ##### --> -<para> - -</para> - -@glade_widget: -@old_signal: -@new_signal: - - -<!-- ##### FUNCTION glade_command_set_i18n ##### --> -<para> - -</para> - -@property: -@translatable: -@has_context: -@comment: - - diff --git a/doc/tmpl/glade-design-layout.sgml b/doc/tmpl/glade-design-layout.sgml deleted file mode 100644 index 2c448580..00000000 --- a/doc/tmpl/glade-design-layout.sgml +++ /dev/null @@ -1,46 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GladeDesignLayout - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GladeDesignLayout ##### --> -<para> - -</para> - -@parent_instance: -@priv: - -<!-- ##### FUNCTION glade_design_layout_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_design_layout_widget_event ##### --> -<para> - -</para> - -@layout: -@event_gwidget: -@event: -@Returns: - - diff --git a/doc/tmpl/glade-design-view.sgml b/doc/tmpl/glade-design-view.sgml deleted file mode 100644 index 32fb29e8..00000000 --- a/doc/tmpl/glade-design-view.sgml +++ /dev/null @@ -1,63 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GladeDesignView - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GladeDesignView ##### --> -<para> - -</para> - -@parent_instance: -@priv: - -<!-- ##### FUNCTION glade_design_view_new ##### --> -<para> - -</para> - -@project: -@Returns: - - -<!-- ##### FUNCTION glade_design_view_get_project ##### --> -<para> - -</para> - -@view: -@Returns: - - -<!-- ##### FUNCTION glade_design_view_get_from_project ##### --> -<para> - -</para> - -@project: -@Returns: - - -<!-- ##### FUNCTION glade_design_view_get_layout ##### --> -<para> - -</para> - -@view: -@Returns: - - diff --git a/doc/tmpl/glade-editor-property.sgml b/doc/tmpl/glade-editor-property.sgml deleted file mode 100644 index a750fbcd..00000000 --- a/doc/tmpl/glade-editor-property.sgml +++ /dev/null @@ -1,103 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GladeEditorProperty - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GladeEditorProperty ##### --> -<para> - -</para> - - -<!-- ##### SIGNAL GladeEditorProperty::gtk-doc-search ##### --> -<para> - -</para> - -@gladeeditorproperty: the object which received the signal. -@arg1: -@arg2: -@arg3: - -<!-- ##### ARG GladeEditorProperty:property-class ##### --> -<para> - -</para> - -<!-- ##### ARG GladeEditorProperty:show-info ##### --> -<para> - -</para> - -<!-- ##### ARG GladeEditorProperty:use-command ##### --> -<para> - -</para> - -<!-- ##### MACRO GLADE_MAKE_EPROP_TYPE ##### --> -<para> - -</para> - -@func: -@type: -@parent: - - -<!-- ##### FUNCTION glade_editor_property_load ##### --> -<para> - -</para> - -@eprop: -@property: - - -<!-- ##### FUNCTION glade_editor_property_load_by_widget ##### --> -<para> - -</para> - -@eprop: -@widget: - - -<!-- ##### FUNCTION glade_editor_property_commit ##### --> -<para> - -</para> - -@eprop: -@value: - - -<!-- ##### FUNCTION glade_editor_property_show_info ##### --> -<para> - -</para> - -@eprop: - - -<!-- ##### FUNCTION glade_editor_property_hide_info ##### --> -<para> - -</para> - -@eprop: - - diff --git a/doc/tmpl/glade-editor.sgml b/doc/tmpl/glade-editor.sgml deleted file mode 100644 index 4ccef30a..00000000 --- a/doc/tmpl/glade-editor.sgml +++ /dev/null @@ -1,160 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GladeEditor - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### MACRO GLADE_EDITOR_TABLE ##### --> -<para> - -</para> - -@t: - - -<!-- ##### MACRO GLADE_IS_EDITOR_TABLE ##### --> -<para> - -</para> - -@t: - - -<!-- ##### STRUCT GladeEditorTable ##### --> -<para> - -</para> - -@editor: -@adaptor: -@table_widget: -@name_entry: -@properties: -@type: -@rows: - -<!-- ##### ENUM GladeEditorTableType ##### --> -<para> - -</para> - -@TABLE_TYPE_GENERAL: -@TABLE_TYPE_COMMON: -@TABLE_TYPE_PACKING: -@TABLE_TYPE_ATK: -@TABLE_TYPE_QUERY: - -<!-- ##### STRUCT GladeEditor ##### --> -<para> - -</para> - - -<!-- ##### SIGNAL GladeEditor::gtk-doc-search ##### --> -<para> - -</para> - -@gladeeditor: the object which received the signal. -@arg1: -@arg2: -@arg3: - -<!-- ##### ARG GladeEditor:show-context-info ##### --> -<para> - -</para> - -<!-- ##### ARG GladeEditor:show-info ##### --> -<para> - -</para> - -<!-- ##### FUNCTION glade_editor_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_editor_load_widget ##### --> -<para> - -</para> - -@editor: -@widget: - - -<!-- ##### FUNCTION glade_editor_refresh ##### --> -<para> - -</para> - -@editor: - - -<!-- ##### FUNCTION glade_editor_update_widget_name ##### --> -<para> - -</para> - -@editor: - - -<!-- ##### FUNCTION glade_editor_query_dialog ##### --> -<para> - -</para> - -@editor: -@widget: -@Returns: - - -<!-- ##### FUNCTION glade_editor_show_info ##### --> -<para> - -</para> - -@editor: - - -<!-- ##### FUNCTION glade_editor_show_context_info ##### --> -<para> - -</para> - -@editor: - - -<!-- ##### FUNCTION glade_editor_hide_info ##### --> -<para> - -</para> - -@editor: - - -<!-- ##### FUNCTION glade_editor_hide_context_info ##### --> -<para> - -</para> - -@editor: - - diff --git a/doc/tmpl/glade-fixed.sgml b/doc/tmpl/glade-fixed.sgml deleted file mode 100644 index cfca29c8..00000000 --- a/doc/tmpl/glade-fixed.sgml +++ /dev/null @@ -1,78 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GladeFixed - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GladeFixed ##### --> -<para> - -</para> - - -<!-- ##### SIGNAL GladeFixed::configure-begin ##### --> -<para> - -</para> - -@gladefixed: the object which received the signal. -@arg1: -@Returns: - -<!-- ##### SIGNAL GladeFixed::configure-child ##### --> -<para> - -</para> - -@gladefixed: the object which received the signal. -@arg1: -@arg2: -@Returns: - -<!-- ##### SIGNAL GladeFixed::configure-end ##### --> -<para> - -</para> - -@gladefixed: the object which received the signal. -@arg1: -@Returns: - -<!-- ##### ARG GladeFixed:can-resize ##### --> -<para> - -</para> - -<!-- ##### ARG GladeFixed:height-prop ##### --> -<para> - -</para> - -<!-- ##### ARG GladeFixed:width-prop ##### --> -<para> - -</para> - -<!-- ##### ARG GladeFixed:x-prop ##### --> -<para> - -</para> - -<!-- ##### ARG GladeFixed:y-prop ##### --> -<para> - -</para> - diff --git a/doc/tmpl/glade-inspector.sgml b/doc/tmpl/glade-inspector.sgml deleted file mode 100644 index e1d13707..00000000 --- a/doc/tmpl/glade-inspector.sgml +++ /dev/null @@ -1,88 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GladeInspector - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GladeInspector ##### --> -<para> - -</para> - - -<!-- ##### SIGNAL GladeInspector::item-activated ##### --> -<para> - -</para> - -@gladeinspector: the object which received the signal. - -<!-- ##### SIGNAL GladeInspector::selection-changed ##### --> -<para> - -</para> - -@gladeinspector: the object which received the signal. - -<!-- ##### ARG GladeInspector:project ##### --> -<para> - -</para> - -<!-- ##### FUNCTION glade_inspector_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_inspector_new_with_project ##### --> -<para> - -</para> - -@project: -@Returns: - - -<!-- ##### FUNCTION glade_inspector_set_project ##### --> -<para> - -</para> - -@inspector: -@project: - - -<!-- ##### FUNCTION glade_inspector_get_project ##### --> -<para> - -</para> - -@inspector: -@Returns: - - -<!-- ##### FUNCTION glade_inspector_get_selected_items ##### --> -<para> - -</para> - -@inspector: -@Returns: - - diff --git a/doc/tmpl/glade-palette.sgml b/doc/tmpl/glade-palette.sgml deleted file mode 100644 index 27ad19cc..00000000 --- a/doc/tmpl/glade-palette.sgml +++ /dev/null @@ -1,147 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GladePalette - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GladePalette ##### --> -<para> - -</para> - - -<!-- ##### SIGNAL GladePalette::toggled ##### --> -<para> - -</para> - -@gladepalette: the object which received the signal. - -<!-- ##### ARG GladePalette:catalogs ##### --> -<para> - -</para> - -<!-- ##### ARG GladePalette:current-item ##### --> -<para> - -</para> - -<!-- ##### ARG GladePalette:item-appearance ##### --> -<para> - -</para> - -<!-- ##### ARG GladePalette:show-selector-button ##### --> -<para> - -</para> - -<!-- ##### ARG GladePalette:use-small-item-icons ##### --> -<para> - -</para> - -<!-- ##### ENUM GladeItemAppearance ##### --> -<para> - -</para> - -@GLADE_ITEM_ICON_AND_LABEL: -@GLADE_ITEM_ICON_ONLY: -@GLADE_ITEM_LABEL_ONLY: - -<!-- ##### FUNCTION glade_palette_new ##### --> -<para> - -</para> - -@catalogs: -@Returns: - - -<!-- ##### FUNCTION glade_palette_deselect_current_item ##### --> -<para> - -</para> - -@palette: -@sticky_aware: - - -<!-- ##### FUNCTION glade_palette_get_current_item ##### --> -<para> - -</para> - -@palette: -@Returns: - - -<!-- ##### FUNCTION glade_palette_get_item_appearance ##### --> -<para> - -</para> - -@palette: -@Returns: - - -<!-- ##### FUNCTION glade_palette_set_item_appearance ##### --> -<para> - -</para> - -@palette: -@item_appearance: - - -<!-- ##### FUNCTION glade_palette_get_use_small_item_icons ##### --> -<para> - -</para> - -@palette: -@Returns: - - -<!-- ##### FUNCTION glade_palette_set_use_small_item_icons ##### --> -<para> - -</para> - -@palette: -@use_small_item_icons: - - -<!-- ##### FUNCTION glade_palette_set_show_selector_button ##### --> -<para> - -</para> - -@palette: -@show_selector_button: - - -<!-- ##### FUNCTION glade_palette_get_show_selector_button ##### --> -<para> - -</para> - -@palette: -@Returns: - - diff --git a/doc/tmpl/glade-parameter.sgml b/doc/tmpl/glade-parameter.sgml deleted file mode 100644 index 8d4ea6ce..00000000 --- a/doc/tmpl/glade-parameter.sgml +++ /dev/null @@ -1,102 +0,0 @@ -<!-- ##### SECTION Title ##### --> -glade-parameter - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GladeParameter ##### --> -<para> - -</para> - -@key: -@value: - -<!-- ##### FUNCTION glade_parameter_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_parameter_clone ##### --> -<para> - -</para> - -@parameter: -@Returns: - - -<!-- ##### FUNCTION glade_parameter_free ##### --> -<para> - -</para> - -@parameter: - - -<!-- ##### FUNCTION glade_parameter_get_float ##### --> -<para> - -</para> - -@parameters: -@key: -@value: - - -<!-- ##### FUNCTION glade_parameter_get_integer ##### --> -<para> - -</para> - -@parameters: -@key: -@value: - - -<!-- ##### FUNCTION glade_parameter_get_boolean ##### --> -<para> - -</para> - -@parameters: -@key: -@value: - - -<!-- ##### FUNCTION glade_parameter_get_string ##### --> -<para> - -</para> - -@parameters: -@key: -@value: - - -<!-- ##### FUNCTION glade_parameter_list_new_from_node ##### --> -<para> - -</para> - -@list: -@node: -@Returns: - - diff --git a/doc/tmpl/glade-parser.sgml b/doc/tmpl/glade-parser.sgml deleted file mode 100644 index ea8e0d2c..00000000 --- a/doc/tmpl/glade-parser.sgml +++ /dev/null @@ -1,19 +0,0 @@ -<!-- ##### SECTION Title ##### --> -glade-parser - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - diff --git a/doc/tmpl/glade-placeholder.sgml b/doc/tmpl/glade-placeholder.sgml deleted file mode 100644 index eca25ec4..00000000 --- a/doc/tmpl/glade-placeholder.sgml +++ /dev/null @@ -1,42 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GladePlaceholder - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GladePlaceholder ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION glade_placeholder_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_placeholder_get_parent ##### --> -<para> - -</para> - -@placeholder: -@Returns: - - diff --git a/doc/tmpl/glade-project.sgml b/doc/tmpl/glade-project.sgml deleted file mode 100644 index 92af8f6c..00000000 --- a/doc/tmpl/glade-project.sgml +++ /dev/null @@ -1,501 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GladeProject - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GladeProject ##### --> -<para> - -</para> - - -<!-- ##### SIGNAL GladeProject::add-widget ##### --> -<para> - -</para> - -@gladeproject: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL GladeProject::changed ##### --> -<para> - -</para> - -@gladeproject: the object which received the signal. -@arg1: -@arg2: - -<!-- ##### SIGNAL GladeProject::close ##### --> -<para> - -</para> - -@gladeproject: the object which received the signal. - -<!-- ##### SIGNAL GladeProject::parse-finished ##### --> -<para> - -</para> - -@gladeproject: the object which received the signal. - -<!-- ##### SIGNAL GladeProject::remove-widget ##### --> -<para> - -</para> - -@gladeproject: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL GladeProject::resource-added ##### --> -<para> - -</para> - -@gladeproject: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL GladeProject::resource-removed ##### --> -<para> - -</para> - -@gladeproject: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL GladeProject::selection-changed ##### --> -<para> - -</para> - -@gladeproject: the object which received the signal. - -<!-- ##### SIGNAL GladeProject::widget-name-changed ##### --> -<para> - -</para> - -@gladeproject: the object which received the signal. -@arg1: - -<!-- ##### ARG GladeProject:has-selection ##### --> -<para> - -</para> - -<!-- ##### ARG GladeProject:modified ##### --> -<para> - -</para> - -<!-- ##### ARG GladeProject:path ##### --> -<para> - -</para> - -<!-- ##### ARG GladeProject:read-only ##### --> -<para> - -</para> - -<!-- ##### ENUM GladeProjectFormat ##### --> -<para> - -</para> - -@GLADE_PROJECT_FORMAT_LIBGLADE: -@GLADE_PROJECT_FORMAT_GTKBUILDER: - -<!-- ##### FUNCTION glade_project_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_project_get_format ##### --> -<para> - -</para> - -@project: -@Returns: - - -<!-- ##### FUNCTION glade_project_set_format ##### --> -<para> - -</para> - -@project: -@format: - - -<!-- ##### FUNCTION glade_project_load_from_file ##### --> -<para> - -</para> - -@project: -@path: -@Returns: - - -<!-- ##### FUNCTION glade_project_load ##### --> -<para> - -</para> - -@path: -@Returns: - - -<!-- ##### FUNCTION glade_project_save ##### --> -<para> - -</para> - -@project: -@path: -@error: -@Returns: - - -<!-- ##### FUNCTION glade_project_get_path ##### --> -<para> - -</para> - -@project: -@Returns: - - -<!-- ##### FUNCTION glade_project_get_name ##### --> -<para> - -</para> - -@project: -@Returns: - - -<!-- ##### FUNCTION glade_project_undo ##### --> -<para> - -</para> - -@project: - - -<!-- ##### FUNCTION glade_project_redo ##### --> -<para> - -</para> - -@project: - - -<!-- ##### FUNCTION glade_project_next_undo_item ##### --> -<para> - -</para> - -@project: -@Returns: - - -<!-- ##### FUNCTION glade_project_next_redo_item ##### --> -<para> - -</para> - -@project: -@Returns: - - -<!-- ##### FUNCTION glade_project_push_undo ##### --> -<para> - -</para> - -@project: -@cmd: - - -<!-- ##### FUNCTION glade_project_undo_items ##### --> -<para> - -</para> - -@project: -@Returns: - - -<!-- ##### FUNCTION glade_project_redo_items ##### --> -<para> - -</para> - -@project: -@Returns: - - -<!-- ##### FUNCTION glade_project_reset_path ##### --> -<para> - -</para> - -@project: - - -<!-- ##### FUNCTION glade_project_get_readonly ##### --> -<para> - -</para> - -@project: -@Returns: - - -<!-- ##### FUNCTION glade_project_get_objects ##### --> -<para> - -</para> - -@project: -@Returns: - - -<!-- ##### FUNCTION glade_project_add_object ##### --> -<para> - -</para> - -@project: -@old_project: -@object: - - -<!-- ##### FUNCTION glade_project_remove_object ##### --> -<para> - -</para> - -@project: -@object: - - -<!-- ##### FUNCTION glade_project_has_object ##### --> -<para> - -</para> - -@project: -@object: -@Returns: - - -<!-- ##### FUNCTION glade_project_get_widget_by_name ##### --> -<para> - -</para> - -@project: -@name: -@Returns: - - -<!-- ##### FUNCTION glade_project_new_widget_name ##### --> -<para> - -</para> - -@project: -@base_name: -@Returns: - - -<!-- ##### FUNCTION glade_project_widget_name_changed ##### --> -<para> - -</para> - -@project: -@widget: -@old_name: - - -<!-- ##### FUNCTION glade_project_is_selected ##### --> -<para> - -</para> - -@project: -@object: -@Returns: - - -<!-- ##### FUNCTION glade_project_selection_set ##### --> -<para> - -</para> - -@project: -@object: -@emit_signal: - - -<!-- ##### FUNCTION glade_project_selection_add ##### --> -<para> - -</para> - -@project: -@object: -@emit_signal: - - -<!-- ##### FUNCTION glade_project_selection_remove ##### --> -<para> - -</para> - -@project: -@object: -@emit_signal: - - -<!-- ##### FUNCTION glade_project_selection_clear ##### --> -<para> - -</para> - -@project: -@emit_signal: - - -<!-- ##### FUNCTION glade_project_selection_changed ##### --> -<para> - -</para> - -@project: - - -<!-- ##### FUNCTION glade_project_selection_get ##### --> -<para> - -</para> - -@project: -@Returns: - - -<!-- ##### FUNCTION glade_project_get_has_selection ##### --> -<para> - -</para> - -@project: -@Returns: - - -<!-- ##### FUNCTION glade_project_set_accel_group ##### --> -<para> - -</para> - -@project: -@accel_group: - - -<!-- ##### FUNCTION glade_project_set_resource ##### --> -<para> - -</para> - -@project: -@property: -@resource: - - -<!-- ##### FUNCTION glade_project_list_resources ##### --> -<para> - -</para> - -@project: -@Returns: - - -<!-- ##### FUNCTION glade_project_resource_fullpath ##### --> -<para> - -</para> - -@project: -@resource: -@Returns: - - -<!-- ##### FUNCTION glade_project_is_loading ##### --> -<para> - -</para> - -@project: -@Returns: - - -<!-- ##### FUNCTION glade_project_get_file_mtime ##### --> -<para> - -</para> - -@project: -@Returns: - - -<!-- ##### FUNCTION glade_project_get_instance_count ##### --> -<para> - -</para> - -@project: -@Returns: - - -<!-- ##### FUNCTION glade_project_set_instance_count ##### --> -<para> - -</para> - -@project: -@instance_count: - - -<!-- ##### FUNCTION glade_project_get_modified ##### --> -<para> - -</para> - -@project: -@Returns: - - diff --git a/doc/tmpl/glade-property-class.sgml b/doc/tmpl/glade-property-class.sgml deleted file mode 100644 index 1ea82509..00000000 --- a/doc/tmpl/glade-property-class.sgml +++ /dev/null @@ -1,234 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GladeProperty - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### MACRO GPC_OBJECT_DELIMITER ##### --> -<para> - -</para> - - - -<!-- ##### MACRO GPC_PROPERTY_NAMELEN ##### --> -<para> - -</para> - - - -<!-- ##### STRUCT GladePropertyClass ##### --> -<para> - -</para> - -@handle: -@pspec: -@id: -@name: -@tooltip: -@virt: -@def: -@orig_def: -@parameters: -@displayable_values: -@query: -@optional: -@optional_default: -@construct_only: -@common: -@atk: -@packing: -@translatable: -@visible_lines: -@save: -@save_always: -@visible: -@ignore: -@is_modified: -@resource: -@themed_icon: -@transfer_on_paste: -@weight: - -<!-- ##### FUNCTION glade_property_class_new ##### --> -<para> - -</para> - -@handle: -@Returns: - - -<!-- ##### FUNCTION glade_property_class_new_from_spec ##### --> -<para> - -</para> - -@handle: -@spec: -@Returns: - - -<!-- ##### FUNCTION glade_property_class_clone ##### --> -<para> - -</para> - -@property_class: -@Returns: - - -<!-- ##### FUNCTION glade_property_class_free ##### --> -<para> - -</para> - -@property_class: - - -<!-- ##### FUNCTION glade_property_class_is_visible ##### --> -<para> - -</para> - -@property_class: -@Returns: - - -<!-- ##### FUNCTION glade_property_class_is_object ##### --> -<para> - -</para> - -@property_class: -@Returns: - - -<!-- ##### FUNCTION glade_property_class_make_gvalue_from_string ##### --> -<para> - -</para> - -@property_class: -@string: -@project: -@Returns: - - -<!-- ##### FUNCTION glade_property_class_make_string_from_gvalue ##### --> -<para> - -</para> - -@property_class: -@value: -@Returns: - - -<!-- ##### FUNCTION glade_property_class_make_gvalue_from_vl ##### --> -<para> - -</para> - -@property_class: -@vl: -@Returns: - - -<!-- ##### FUNCTION glade_property_class_set_vl_from_gvalue ##### --> -<para> - -</para> - -@klass: -@value: -@vl: - - -<!-- ##### FUNCTION glade_property_class_make_gvalue ##### --> -<para> - -</para> - -@klass: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION glade_property_class_get_from_gvalue ##### --> -<para> - -</para> - -@klass: -@value: -@Varargs: - - -<!-- ##### FUNCTION glade_property_class_update_from_node ##### --> -<para> - -</para> - -@node: -@module: -@object_type: -@property_class: -@domain: -@Returns: - - -<!-- ##### FUNCTION glade_property_class_get_displayable_value ##### --> -<para> - -</para> - -@klass: -@value: -@Returns: - - -<!-- ##### FUNCTION glade_property_class_make_adjustment ##### --> -<para> - -</para> - -@property_class: -@Returns: - - -<!-- ##### FUNCTION glade_property_class_match ##### --> -<para> - -</para> - -@klass: -@comp: -@Returns: - - -<!-- ##### FUNCTION glade_property_class_void_value ##### --> -<para> - -</para> - -@klass: -@value: -@Returns: - - diff --git a/doc/tmpl/glade-property.sgml b/doc/tmpl/glade-property.sgml deleted file mode 100644 index b46e2c59..00000000 --- a/doc/tmpl/glade-property.sgml +++ /dev/null @@ -1,399 +0,0 @@ -<!-- ##### SECTION Title ##### --> -glade-property - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GladeProperty ##### --> -<para> - -</para> - - -<!-- ##### SIGNAL GladeProperty::tooltip-changed ##### --> -<para> - -</para> - -@gladeproperty: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL GladeProperty::value-changed ##### --> -<para> - -</para> - -@gladeproperty: the object which received the signal. -@arg1: -@arg2: - -<!-- ##### ARG GladeProperty:enabled ##### --> -<para> - -</para> - -<!-- ##### ARG GladeProperty:i18n-comment ##### --> -<para> - -</para> - -<!-- ##### ARG GladeProperty:i18n-has-context ##### --> -<para> - -</para> - -<!-- ##### ARG GladeProperty:i18n-translatable ##### --> -<para> - -</para> - -<!-- ##### ARG GladeProperty:sensitive ##### --> -<para> - -</para> - -<!-- ##### FUNCTION glade_property_new ##### --> -<para> - -</para> - -@klass: -@widget: -@value: -@Returns: - - -<!-- ##### FUNCTION glade_property_dup ##### --> -<para> - -</para> - -@template_prop: -@widget: -@Returns: - - -<!-- ##### FUNCTION glade_property_reset ##### --> -<para> - -</para> - -@property: - - -<!-- ##### FUNCTION glade_property_original_reset ##### --> -<para> - -</para> - -@property: - - -<!-- ##### FUNCTION glade_property_default ##### --> -<para> - -</para> - -@property: -@Returns: - - -<!-- ##### FUNCTION glade_property_original_default ##### --> -<para> - -</para> - -@property: -@Returns: - - -<!-- ##### FUNCTION glade_property_equals_value ##### --> -<para> - -</para> - -@property: -@value: -@Returns: - - -<!-- ##### FUNCTION glade_property_equals ##### --> -<para> - -</para> - -@property: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION glade_property_set_value ##### --> -<para> - -</para> - -@property: -@value: - - -<!-- ##### FUNCTION glade_property_set_va_list ##### --> -<para> - -</para> - -@property: -@vl: - - -<!-- ##### FUNCTION glade_property_set ##### --> -<para> - -</para> - -@property: -@Varargs: - - -<!-- ##### FUNCTION glade_property_get_value ##### --> -<para> - -</para> - -@property: -@value: - - -<!-- ##### FUNCTION glade_property_get_default ##### --> -<para> - -</para> - -@property: -@value: - - -<!-- ##### FUNCTION glade_property_get_va_list ##### --> -<para> - -</para> - -@property: -@vl: - - -<!-- ##### FUNCTION glade_property_get ##### --> -<para> - -</para> - -@property: -@Varargs: - - -<!-- ##### FUNCTION glade_property_add_object ##### --> -<para> - -</para> - -@property: -@object: - - -<!-- ##### FUNCTION glade_property_remove_object ##### --> -<para> - -</para> - -@property: -@object: - - -<!-- ##### FUNCTION glade_property_sync ##### --> -<para> - -</para> - -@property: - - -<!-- ##### FUNCTION glade_property_load ##### --> -<para> - -</para> - -@property: - - -<!-- ##### FUNCTION glade_property_read ##### --> -<para> - -</para> - -@property: -@project: -@node: - - -<!-- ##### FUNCTION glade_property_write ##### --> -<para> - -</para> - -@property: -@context: -@node: - - -<!-- ##### FUNCTION glade_property_get_tooltip ##### --> -<para> - -</para> - -@property: -@Returns: - - -<!-- ##### FUNCTION glade_property_set_sensitive ##### --> -<para> - -</para> - -@property: -@sensitive: -@reason: - - -<!-- ##### FUNCTION glade_property_get_sensitive ##### --> -<para> - -</para> - -@property: -@Returns: - - -<!-- ##### FUNCTION glade_property_set_save_always ##### --> -<para> - -</para> - -@property: -@setting: - - -<!-- ##### FUNCTION glade_property_get_save_always ##### --> -<para> - -</para> - -@property: -@Returns: - - -<!-- ##### FUNCTION glade_property_set_enabled ##### --> -<para> - -</para> - -@property: -@enabled: - - -<!-- ##### FUNCTION glade_property_get_enabled ##### --> -<para> - -</para> - -@property: -@Returns: - - -<!-- ##### FUNCTION glade_property_i18n_set_comment ##### --> -<para> - -</para> - -@property: -@str: - - -<!-- ##### FUNCTION glade_property_i18n_get_comment ##### --> -<para> - -</para> - -@property: -@Returns: - - -<!-- ##### FUNCTION glade_property_i18n_set_translatable ##### --> -<para> - -</para> - -@property: -@translatable: - - -<!-- ##### FUNCTION glade_property_i18n_get_translatable ##### --> -<para> - -</para> - -@property: -@Returns: - - -<!-- ##### FUNCTION glade_property_i18n_set_has_context ##### --> -<para> - -</para> - -@property: -@has_context: - - -<!-- ##### FUNCTION glade_property_i18n_get_has_context ##### --> -<para> - -</para> - -@property: -@Returns: - - -<!-- ##### FUNCTION glade_property_push_superuser ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION glade_property_pop_superuser ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION glade_property_superuser ##### --> -<para> - -</para> - -@Returns: - - diff --git a/doc/tmpl/glade-signal-editor.sgml b/doc/tmpl/glade-signal-editor.sgml deleted file mode 100644 index a404adbb..00000000 --- a/doc/tmpl/glade-signal-editor.sgml +++ /dev/null @@ -1,62 +0,0 @@ -<!-- ##### SECTION Title ##### --> -glade-signal-editor - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GladeSignalEditor ##### --> -<para> - -</para> - -@main_window: -@widget: -@adaptor: -@editor: -@signals_list: -@model: -@tree_view: -@handler_store: -@completion: -@iters: - -<!-- ##### FUNCTION glade_signal_editor_get_widget ##### --> -<para> - -</para> - -@editor: -@Returns: - - -<!-- ##### FUNCTION glade_signal_editor_new ##### --> -<para> - -</para> - -@editor: -@Returns: - - -<!-- ##### FUNCTION glade_signal_editor_load_widget ##### --> -<para> - -</para> - -@editor: -@widget: - - diff --git a/doc/tmpl/glade-signal.sgml b/doc/tmpl/glade-signal.sgml deleted file mode 100644 index 29179ff0..00000000 --- a/doc/tmpl/glade-signal.sgml +++ /dev/null @@ -1,87 +0,0 @@ -<!-- ##### SECTION Title ##### --> -glade-signal - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GladeSignal ##### --> -<para> - -</para> - -@name: -@handler: -@userdata: -@after: - -<!-- ##### FUNCTION glade_signal_new ##### --> -<para> - -</para> - -@name: -@handler: -@userdata: -@after: -@Returns: - - -<!-- ##### FUNCTION glade_signal_clone ##### --> -<para> - -</para> - -@signal: -@Returns: - - -<!-- ##### FUNCTION glade_signal_free ##### --> -<para> - -</para> - -@signal: - - -<!-- ##### FUNCTION glade_signal_equal ##### --> -<para> - -</para> - -@sig1: -@sig2: -@Returns: - - -<!-- ##### FUNCTION glade_signal_read ##### --> -<para> - -</para> - -@node: -@Returns: - - -<!-- ##### FUNCTION glade_signal_write ##### --> -<para> - -</para> - -@signal: -@context: -@node: - - diff --git a/doc/tmpl/glade-utils.sgml b/doc/tmpl/glade-utils.sgml deleted file mode 100644 index ca0df4fe..00000000 --- a/doc/tmpl/glade-utils.sgml +++ /dev/null @@ -1,391 +0,0 @@ -<!-- ##### SECTION Title ##### --> -glade-utils - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### ENUM GladeUtilFileDialogType ##### --> -<para> - -</para> - -@GLADE_FILE_DIALOG_ACTION_OPEN: -@GLADE_FILE_DIALOG_ACTION_SAVE: - -<!-- ##### ENUM GladeUIMessageType ##### --> -<para> - -</para> - -@GLADE_UI_INFO: -@GLADE_UI_WARN: -@GLADE_UI_ERROR: -@GLADE_UI_ARE_YOU_SURE: -@GLADE_UI_YES_OR_NO: - -<!-- ##### FUNCTION glade_util_widget_set_tooltip ##### --> -<para> - -</para> - -@widget: -@str: - - -<!-- ##### FUNCTION glade_util_get_type_from_name ##### --> -<para> - -</para> - -@name: -@have_func: -@Returns: - - -<!-- ##### FUNCTION glade_utils_get_pspec_from_funcname ##### --> -<para> - -</para> - -@funcname: -@Returns: - - -<!-- ##### FUNCTION glade_util_ui_message ##### --> -<para> - -</para> - -@parent: -@type: -@format: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION glade_util_flash_message ##### --> -<para> - -</para> - -@statusbar: -@context_id: -@format: -@Varargs: - - -<!-- ##### FUNCTION glade_util_compare_stock_labels ##### --> -<para> - -</para> - -@a: -@b: -@Returns: - - -<!-- ##### FUNCTION glade_util_hide_window ##### --> -<para> - -</para> - -@window: - - -<!-- ##### FUNCTION glade_util_gtk_combo_func ##### --> -<para> - -</para> - -@data: -@Returns: - - -<!-- ##### FUNCTION glade_util_gtk_combo_find ##### --> -<para> - -</para> - -@combo: -@Returns: - - -<!-- ##### FUNCTION glade_util_file_dialog_new ##### --> -<para> - -</para> - -@title: -@parent: -@action: -@Returns: - - -<!-- ##### FUNCTION glade_util_replace ##### --> -<para> - -</para> - -@str: -@a: -@b: - - -<!-- ##### FUNCTION glade_util_read_prop_name ##### --> -<para> - -</para> - -@str: -@Returns: - - -<!-- ##### FUNCTION glade_util_duplicate_underscores ##### --> -<para> - -</para> - -@name: -@Returns: - - -<!-- ##### FUNCTION glade_util_add_selection ##### --> -<para> - -</para> - -@widget: - - -<!-- ##### FUNCTION glade_util_remove_selection ##### --> -<para> - -</para> - -@widget: - - -<!-- ##### FUNCTION glade_util_has_selection ##### --> -<para> - -</para> - -@widget: -@Returns: - - -<!-- ##### FUNCTION glade_util_clear_selection ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION glade_util_get_selection ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_util_container_get_all_children ##### --> -<para> - -</para> - -@container: -@Returns: - - -<!-- ##### FUNCTION glade_util_count_placeholders ##### --> -<para> - -</para> - -@parent: -@Returns: - - -<!-- ##### FUNCTION glade_util_find_iter_by_widget ##### --> -<para> - -</para> - -@model: -@findme: -@column: -@Returns: - - -<!-- ##### FUNCTION glade_util_basenames_match ##### --> -<para> - -</para> - -@path1: -@path2: -@Returns: - - -<!-- ##### FUNCTION glade_util_purify_list ##### --> -<para> - -</para> - -@list: -@Returns: - - -<!-- ##### FUNCTION glade_util_added_in_list ##### --> -<para> - -</para> - -@old_list: -@new_list: -@Returns: - - -<!-- ##### FUNCTION glade_util_removed_from_list ##### --> -<para> - -</para> - -@old_list: -@new_list: -@Returns: - - -<!-- ##### FUNCTION glade_util_canonical_path ##### --> -<para> - -</para> - -@path: -@Returns: - - -<!-- ##### FUNCTION glade_util_copy_file ##### --> -<para> - -</para> - -@src_path: -@dest_path: -@Returns: - - -<!-- ##### FUNCTION glade_util_class_implements_interface ##### --> -<para> - -</para> - -@class_type: -@iface_type: -@Returns: - - -<!-- ##### FUNCTION glade_util_load_library ##### --> -<para> - -</para> - -@library_name: -@Returns: - - -<!-- ##### FUNCTION glade_util_file_is_writeable ##### --> -<para> - -</para> - -@path: -@Returns: - - -<!-- ##### FUNCTION glade_util_have_devhelp ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_util_get_devhelp_icon ##### --> -<para> - -</para> - -@size: -@Returns: - - -<!-- ##### FUNCTION glade_util_search_devhelp ##### --> -<para> - -</para> - -@book: -@page: -@search: - - -<!-- ##### FUNCTION glade_util_get_placeholder_from_pointer ##### --> -<para> - -</para> - -@container: -@Returns: - - -<!-- ##### FUNCTION glade_util_object_is_loading ##### --> -<para> - -</para> - -@object: -@Returns: - - -<!-- ##### FUNCTION glade_util_url_show ##### --> -<para> - -</para> - -@url: -@Returns: - - -<!-- ##### FUNCTION glade_util_get_file_mtime ##### --> -<para> - -</para> - -@filename: -@error: -@Returns: - - -<!-- ##### FUNCTION glade_util_draw_selection_nodes ##### --> -<para> - -</para> - -@expose_win: - - diff --git a/doc/tmpl/glade-widget-action.sgml b/doc/tmpl/glade-widget-action.sgml deleted file mode 100644 index f4ec3662..00000000 --- a/doc/tmpl/glade-widget-action.sgml +++ /dev/null @@ -1,77 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GladeWidgetAction - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GWActionClass ##### --> -<para> - -</para> - -@id: -@path: -@label: -@stock: -@important: -@actions: - -<!-- ##### STRUCT GladeWidgetAction ##### --> -<para> - -</para> - -@parent_instance: -@klass: -@sensitive: -@actions: - -<!-- ##### FUNCTION glade_widget_action_class_free ##### --> -<para> - -</para> - -@action: - - -<!-- ##### FUNCTION glade_widget_action_class_clone ##### --> -<para> - -</para> - -@action: -@Returns: - - -<!-- ##### FUNCTION glade_widget_action_remove ##### --> -<para> - -</para> - -@action: -@child: -@Returns: - - -<!-- ##### FUNCTION glade_widget_action_set_sensitive ##### --> -<para> - -</para> - -@action: -@sensitive: - - diff --git a/doc/tmpl/glade-widget-adaptor.sgml b/doc/tmpl/glade-widget-adaptor.sgml deleted file mode 100644 index f17046a5..00000000 --- a/doc/tmpl/glade-widget-adaptor.sgml +++ /dev/null @@ -1,752 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GladeWidgetAdaptor - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### ENUM GladeCreateReason ##### --> -<para> - -</para> - -@GLADE_CREATE_USER: -@GLADE_CREATE_COPY: -@GLADE_CREATE_LOAD: -@GLADE_CREATE_REBUILD: -@GLADE_CREATE_REASONS: - -<!-- ##### MACRO GWA_IS_FIXED ##### --> -<para> - -</para> - -@obj: - - -<!-- ##### MACRO GWA_IS_TOPLEVEL ##### --> -<para> - -</para> - -@obj: - - -<!-- ##### MACRO GWA_USE_PLACEHOLDERS ##### --> -<para> - -</para> - -@obj: - - -<!-- ##### MACRO GWA_DEFAULT_WIDTH ##### --> -<para> - -</para> - -@obj: - - -<!-- ##### MACRO GWA_DEFAULT_HEIGHT ##### --> -<para> - -</para> - -@obj: - - -<!-- ##### MACRO GWA_GET_CLASS ##### --> -<para> - -</para> - -@type: - - -<!-- ##### MACRO GWA_GET_OCLASS ##### --> -<para> - -</para> - -@type: - - -<!-- ##### MACRO GLADE_VALID_CREATE_REASON ##### --> -<para> - -</para> - -@reason: - - -<!-- ##### MACRO GLADE_TYPE_CREATE_REASON ##### --> -<para> - -</para> - - - -<!-- ##### USER_FUNCTION GladeSetPropertyFunc ##### --> -<para> - -</para> - -@adaptor: -@object: -@property_name: -@value: - - -<!-- ##### USER_FUNCTION GladeGetPropertyFunc ##### --> -<para> - -</para> - -@adaptor: -@object: -@property_name: -@value: - - -<!-- ##### USER_FUNCTION GladeVerifyPropertyFunc ##### --> -<para> - -</para> - -@adaptor: -@object: -@property_name: -@value: -@Returns: - - -<!-- ##### USER_FUNCTION GladeChildSetPropertyFunc ##### --> -<para> - -</para> - -@adaptor: -@container: -@child: -@property_name: -@value: - - -<!-- ##### USER_FUNCTION GladeChildGetPropertyFunc ##### --> -<para> - -</para> - -@adaptor: -@container: -@child: -@property_name: -@value: - - -<!-- ##### USER_FUNCTION GladeChildVerifyPropertyFunc ##### --> -<para> - -</para> - -@adaptor: -@container: -@child: -@property_name: -@value: -@Returns: - - -<!-- ##### USER_FUNCTION GladeGetChildrenFunc ##### --> -<para> - -</para> - -@adaptor: -@container: -@Returns: - - -<!-- ##### USER_FUNCTION GladeAddChildFunc ##### --> -<para> - -</para> - -@adaptor: -@parent: -@child: - - -<!-- ##### USER_FUNCTION GladeRemoveChildFunc ##### --> -<para> - -</para> - -@adaptor: -@parent: -@child: - - -<!-- ##### USER_FUNCTION GladeReplaceChildFunc ##### --> -<para> - -</para> - -@adaptor: -@container: -@old_obj: -@new_obj: - - -<!-- ##### USER_FUNCTION GladePostCreateFunc ##### --> -<para> - -</para> - -@adaptor: -@object: -@reason: - - -<!-- ##### USER_FUNCTION GladeGetInternalFunc ##### --> -<para> - -</para> - -@adaptor: -@parent: -@name: -@Returns: - - -<!-- ##### USER_FUNCTION GladeActionActivateFunc ##### --> -<para> - -</para> - -@adaptor: -@object: -@action_path: - - -<!-- ##### USER_FUNCTION GladeChildActionActivateFunc ##### --> -<para> - -</para> - -@adaptor: -@container: -@object: -@action_path: - - -<!-- ##### USER_FUNCTION GladeReadWidgetFunc ##### --> -<para> - -</para> - -@adaptor: -@widget: -@node: - - -<!-- ##### USER_FUNCTION GladeWriteWidgetFunc ##### --> -<para> - -</para> - -@adaptor: -@widget: -@context: -@node: - - -<!-- ##### USER_FUNCTION GladeCreateEPropFunc ##### --> -<para> - -</para> - -@adaptor: -@klass: -@use_command: -@Returns: - - -<!-- ##### USER_FUNCTION GladeStringFromValueFunc ##### --> -<para> - -</para> - -@adaptor: -@klass: -@value: -@Returns: - - -<!-- ##### STRUCT GladeWidgetAdaptor ##### --> -<para> - -</para> - -@parent_instance: -@type: -@name: -@generic_name: -@icon_name: -@title: -@properties: -@packing_props: -@signals: -@child_packings: -@actions: -@packing_actions: -@priv: - -<!-- ##### MACRO glade_widget_adaptor_create_widget ##### --> -<para> - -</para> - -@adaptor: -@query: -@...: - - -<!-- ##### FUNCTION glade_widget_adaptor_create_eprop ##### --> -<para> - -</para> - -@adaptor: -@klass: -@use_command: -@Returns: - - -<!-- ##### MACRO glade_widget_adaptor_from_pclass ##### --> -<para> - -</para> - -@pclass: - - -<!-- ##### MACRO glade_widget_adaptor_from_pspec ##### --> -<para> - -</para> - -@pspec: - - -<!-- ##### FUNCTION glade_widget_adaptor_from_catalog ##### --> -<para> - -</para> - -@class_node: -@catname: -@icon_prefix: -@module: -@domain: -@book: -@Returns: - - -<!-- ##### FUNCTION glade_widget_adaptor_register ##### --> -<para> - -</para> - -@adaptor: - - -<!-- ##### FUNCTION glade_widget_adaptor_create_internal ##### --> -<para> - -</para> - -@parent: -@internal_object: -@internal_name: -@parent_name: -@anarchist: -@reason: -@Returns: - - -<!-- ##### FUNCTION glade_widget_adaptor_create_widget_real ##### --> -<para> - -</para> - -@query: -@first_property: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION glade_widget_adaptor_get_by_name ##### --> -<para> - -</para> - -@name: -@Returns: - - -<!-- ##### FUNCTION glade_widget_adaptor_get_by_type ##### --> -<para> - -</para> - -@type: -@Returns: - - -<!-- ##### FUNCTION glade_widget_adaptor_get_property_class ##### --> -<para> - -</para> - -@adaptor: -@name: -@Returns: - - -<!-- ##### FUNCTION glade_widget_adaptor_get_pack_property_class ##### --> -<para> - -</para> - -@adaptor: -@name: -@Returns: - - -<!-- ##### FUNCTION glade_widget_adaptor_default_params ##### --> -<para> - -</para> - -@adaptor: -@construct: -@n_params: -@Returns: - - -<!-- ##### FUNCTION glade_widget_adaptor_post_create ##### --> -<para> - -</para> - -@adaptor: -@object: -@reason: - - -<!-- ##### FUNCTION glade_widget_adaptor_get_internal_child ##### --> -<para> - -</para> - -@adaptor: -@object: -@internal_name: -@Returns: - - -<!-- ##### FUNCTION glade_widget_adaptor_set_property ##### --> -<para> - -</para> - -@adaptor: -@object: -@property_name: -@value: - - -<!-- ##### FUNCTION glade_widget_adaptor_get_property ##### --> -<para> - -</para> - -@adaptor: -@object: -@property_name: -@value: - - -<!-- ##### FUNCTION glade_widget_adaptor_verify_property ##### --> -<para> - -</para> - -@adaptor: -@object: -@property_name: -@value: -@Returns: - - -<!-- ##### FUNCTION glade_widget_adaptor_add ##### --> -<para> - -</para> - -@adaptor: -@container: -@child: - - -<!-- ##### FUNCTION glade_widget_adaptor_remove ##### --> -<para> - -</para> - -@adaptor: -@container: -@child: - - -<!-- ##### FUNCTION glade_widget_adaptor_get_children ##### --> -<para> - -</para> - -@adaptor: -@container: -@Returns: - - -<!-- ##### FUNCTION glade_widget_adaptor_has_child ##### --> -<para> - -</para> - -@adaptor: -@container: -@child: -@Returns: - - -<!-- ##### FUNCTION glade_widget_adaptor_child_set_property ##### --> -<para> - -</para> - -@adaptor: -@container: -@child: -@property_name: -@value: - - -<!-- ##### FUNCTION glade_widget_adaptor_child_get_property ##### --> -<para> - -</para> - -@adaptor: -@container: -@child: -@property_name: -@value: - - -<!-- ##### FUNCTION glade_widget_adaptor_child_verify_property ##### --> -<para> - -</para> - -@adaptor: -@container: -@child: -@property_name: -@value: -@Returns: - - -<!-- ##### FUNCTION glade_widget_adaptor_replace_child ##### --> -<para> - -</para> - -@adaptor: -@container: -@old_obj: -@new_obj: - - -<!-- ##### FUNCTION glade_widget_adaptor_read_child ##### --> -<para> - -</para> - -@adaptor: -@widget: -@node: - - -<!-- ##### FUNCTION glade_widget_adaptor_read_widget ##### --> -<para> - -</para> - -@adaptor: -@widget: -@node: - - -<!-- ##### FUNCTION glade_widget_adaptor_write_child ##### --> -<para> - -</para> - -@adaptor: -@widget: -@context: -@node: - - -<!-- ##### FUNCTION glade_widget_adaptor_write_widget ##### --> -<para> - -</para> - -@adaptor: -@widget: -@context: -@node: - - -<!-- ##### FUNCTION glade_widget_adaptor_query ##### --> -<para> - -</para> - -@adaptor: -@Returns: - - -<!-- ##### FUNCTION glade_widget_adaptor_get_packing_default ##### --> -<para> - -</para> - -@child_adaptor: -@container_adaptor: -@id: -@Returns: - - -<!-- ##### FUNCTION glade_widget_adaptor_is_container ##### --> -<para> - -</para> - -@adaptor: -@Returns: - - -<!-- ##### FUNCTION glade_widget_adaptor_action_add ##### --> -<para> - -</para> - -@adaptor: -@action_path: -@label: -@stock: -@important: -@Returns: - - -<!-- ##### FUNCTION glade_widget_adaptor_pack_action_add ##### --> -<para> - -</para> - -@adaptor: -@action_path: -@label: -@stock: -@important: -@Returns: - - -<!-- ##### FUNCTION glade_widget_adaptor_action_remove ##### --> -<para> - -</para> - -@adaptor: -@action_path: -@Returns: - - -<!-- ##### FUNCTION glade_widget_adaptor_pack_action_remove ##### --> -<para> - -</para> - -@adaptor: -@action_path: -@Returns: - - -<!-- ##### FUNCTION glade_widget_adaptor_pack_actions_new ##### --> -<para> - -</para> - -@adaptor: -@Returns: - - -<!-- ##### FUNCTION glade_widget_adaptor_action_activate ##### --> -<para> - -</para> - -@adaptor: -@object: -@action_path: - - -<!-- ##### FUNCTION glade_widget_adaptor_child_action_activate ##### --> -<para> - -</para> - -@adaptor: -@container: -@object: -@action_path: - - -<!-- ##### FUNCTION glade_widget_adaptor_string_from_value ##### --> -<para> - -</para> - -@adaptor: -@klass: -@value: -@Returns: - - diff --git a/doc/tmpl/glade-widget-class.sgml b/doc/tmpl/glade-widget-class.sgml deleted file mode 100644 index 4a16b593..00000000 --- a/doc/tmpl/glade-widget-class.sgml +++ /dev/null @@ -1,144 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GladeWidgetClass - -<!-- ##### SECTION Short_Description ##### --> -Object Class-wide metadata - -<!-- ##### SECTION Long_Description ##### --> -<para> -#GladeWidgetClass is a structure based on a #GType and parameters -from the Glade catalog files and is the central metadata for object -classes; it also provides an abstraction later to container apis. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GladeWidgetClass ##### --> -<para> - -</para> - -@parent_class: -@add_child: -@remove_child: -@replace_child: -@add_signal_handler: -@remove_signal_handler: -@change_signal_handler: -@button_press_event: -@button_release_event: -@motion_notify_event: -@event: - -<!-- ##### STRUCT GladeSignalClass ##### --> -<para> - -</para> - -@query: -@name: -@type: - -<!-- ##### ENUM GladeCreateReason ##### --> -<para> - -</para> - -@GLADE_CREATE_USER: -@GLADE_CREATE_COPY: -@GLADE_CREATE_LOAD: -@GLADE_CREATE_REBUILD: -@GLADE_CREATE_REASONS: - -<!-- ##### USER_FUNCTION GladePostCreateFunc ##### --> -<para> - -</para> - -@adaptor: -@object: -@reason: - - -<!-- ##### USER_FUNCTION GladeChildSetPropertyFunc ##### --> -<para> - -</para> - -@adaptor: -@container: -@child: -@property_name: -@value: - - -<!-- ##### USER_FUNCTION GladeChildGetPropertyFunc ##### --> -<para> - -</para> - -@adaptor: -@container: -@child: -@property_name: -@value: - - -<!-- ##### USER_FUNCTION GladeGetChildrenFunc ##### --> -<para> - -</para> - -@adaptor: -@container: -@Returns: - - -<!-- ##### USER_FUNCTION GladeAddChildFunc ##### --> -<para> - -</para> - -@adaptor: -@parent: -@child: - - -<!-- ##### USER_FUNCTION GladeRemoveChildFunc ##### --> -<para> - -</para> - -@adaptor: -@parent: -@child: - - -<!-- ##### USER_FUNCTION GladeReplaceChildFunc ##### --> -<para> - -</para> - -@adaptor: -@container: -@old_obj: -@new_obj: - - -<!-- ##### USER_FUNCTION GladeGetInternalFunc ##### --> -<para> - -</para> - -@adaptor: -@parent: -@name: -@Returns: - - diff --git a/doc/tmpl/glade-widget.sgml b/doc/tmpl/glade-widget.sgml deleted file mode 100644 index 5e4bf2a5..00000000 --- a/doc/tmpl/glade-widget.sgml +++ /dev/null @@ -1,877 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GladeWidget - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GladeWidget ##### --> -<para> - -</para> - - -<!-- ##### SIGNAL GladeWidget::add-signal-handler ##### --> -<para> - -</para> - -@gladewidget: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL GladeWidget::button-press-event ##### --> -<para> - -</para> - -@gladewidget: the object which received the signal. -@event: -@Returns: - -<!-- ##### SIGNAL GladeWidget::button-release-event ##### --> -<para> - -</para> - -@gladewidget: the object which received the signal. -@event: -@Returns: - -<!-- ##### SIGNAL GladeWidget::change-signal-handler ##### --> -<para> - -</para> - -@gladewidget: the object which received the signal. -@arg1: -@arg2: - -<!-- ##### SIGNAL GladeWidget::motion-notify-event ##### --> -<para> - -</para> - -@gladewidget: the object which received the signal. -@event: -@Returns: - -<!-- ##### SIGNAL GladeWidget::remove-signal-handler ##### --> -<para> - -</para> - -@gladewidget: the object which received the signal. -@arg1: - -<!-- ##### ARG GladeWidget:adaptor ##### --> -<para> - -</para> - -<!-- ##### ARG GladeWidget:anarchist ##### --> -<para> - -</para> - -<!-- ##### ARG GladeWidget:internal ##### --> -<para> - -</para> - -<!-- ##### ARG GladeWidget:internal-name ##### --> -<para> - -</para> - -<!-- ##### ARG GladeWidget:name ##### --> -<para> - -</para> - -<!-- ##### ARG GladeWidget:object ##### --> -<para> - -</para> - -<!-- ##### ARG GladeWidget:parent ##### --> -<para> - -</para> - -<!-- ##### ARG GladeWidget:project ##### --> -<para> - -</para> - -<!-- ##### ARG GladeWidget:properties ##### --> -<para> - -</para> - -<!-- ##### ARG GladeWidget:reason ##### --> -<para> - -</para> - -<!-- ##### ARG GladeWidget:template ##### --> -<para> - -</para> - -<!-- ##### ARG GladeWidget:toplevel-height ##### --> -<para> - -</para> - -<!-- ##### ARG GladeWidget:toplevel-width ##### --> -<para> - -</para> - -<!-- ##### FUNCTION glade_widget_get_from_gobject ##### --> -<para> - -</para> - -@object: -@Returns: - - -<!-- ##### FUNCTION glade_widget_add_child ##### --> -<para> - -</para> - -@parent: -@child: -@at_mouse: - - -<!-- ##### FUNCTION glade_widget_remove_child ##### --> -<para> - -</para> - -@parent: -@child: - - -<!-- ##### FUNCTION glade_widget_replace ##### --> -<para> - -</para> - -@parent: -@old_object: -@new_object: - - -<!-- ##### FUNCTION glade_widget_rebuild ##### --> -<para> - -</para> - -@gwidget: - - -<!-- ##### FUNCTION glade_widget_read ##### --> -<para> - -</para> - -@project: -@parent: -@node: -@internal: -@Returns: - - -<!-- ##### FUNCTION glade_widget_write ##### --> -<para> - -</para> - -@widget: -@context: -@node: - - -<!-- ##### FUNCTION glade_widget_read_child ##### --> -<para> - -</para> - -@widget: -@node: - - -<!-- ##### FUNCTION glade_widget_write_child ##### --> -<para> - -</para> - -@widget: -@context: -@node: - - -<!-- ##### FUNCTION glade_widget_write_placeholder ##### --> -<para> - -</para> - -@parent: -@object: -@context: -@node: - - -<!-- ##### FUNCTION glade_widget_write_special_child_prop ##### --> -<para> - -</para> - -@parent: -@object: -@context: -@node: - - -<!-- ##### FUNCTION glade_widget_create_editor_property ##### --> -<para> - -</para> - -@widget: -@property: -@packing: -@use_command: -@Returns: - - -<!-- ##### FUNCTION glade_widget_set_child_type_from_node ##### --> -<para> - -</para> - -@parent: -@child: -@node: - - -<!-- ##### FUNCTION glade_widget_dup ##### --> -<para> - -</para> - -@template_widget: -@exact: -@Returns: - - -<!-- ##### FUNCTION glade_widget_copy_signals ##### --> -<para> - -</para> - -@widget: -@template_widget: - - -<!-- ##### FUNCTION glade_widget_copy_properties ##### --> -<para> - -</para> - -@widget: -@template_widget: - - -<!-- ##### FUNCTION glade_widget_set_packing_properties ##### --> -<para> - -</para> - -@widget: -@container: - - -<!-- ##### FUNCTION glade_widget_get_property ##### --> -<para> - -</para> - -@widget: -@id_property: -@Returns: - - -<!-- ##### FUNCTION glade_widget_get_pack_property ##### --> -<para> - -</para> - -@widget: -@id_property: -@Returns: - - -<!-- ##### FUNCTION glade_widget_dup_properties ##### --> -<para> - -</para> - -@template_props: -@as_load: -@Returns: - - -<!-- ##### FUNCTION glade_widget_remove_property ##### --> -<para> - -</para> - -@widget: -@id_property: - - -<!-- ##### FUNCTION glade_widget_show ##### --> -<para> - -</para> - -@widget: - - -<!-- ##### FUNCTION glade_widget_hide ##### --> -<para> - -</para> - -@widget: - - -<!-- ##### FUNCTION glade_widget_add_signal_handler ##### --> -<para> - -</para> - -@widget: -@signal_handler: - - -<!-- ##### FUNCTION glade_widget_remove_signal_handler ##### --> -<para> - -</para> - -@widget: -@signal_handler: - - -<!-- ##### FUNCTION glade_widget_change_signal_handler ##### --> -<para> - -</para> - -@widget: -@old_signal_handler: -@new_signal_handler: - - -<!-- ##### FUNCTION glade_widget_list_signal_handlers ##### --> -<para> - -</para> - -@widget: -@signal_name: -@Returns: - - -<!-- ##### FUNCTION glade_widget_has_decendant ##### --> -<para> - -</para> - -@widget: -@type: -@Returns: - - -<!-- ##### FUNCTION glade_widget_event ##### --> -<para> - -</para> - -@gwidget: -@event: -@Returns: - - -<!-- ##### FUNCTION glade_widget_placeholder_relation ##### --> -<para> - -</para> - -@parent: -@widget: -@Returns: - - -<!-- ##### FUNCTION glade_widget_get_action ##### --> -<para> - -</para> - -@widget: -@action_path: -@Returns: - - -<!-- ##### FUNCTION glade_widget_get_pack_action ##### --> -<para> - -</para> - -@widget: -@action_path: -@Returns: - - -<!-- ##### FUNCTION glade_widget_set_action_sensitive ##### --> -<para> - -</para> - -@widget: -@action_path: -@sensitive: -@Returns: - - -<!-- ##### FUNCTION glade_widget_set_pack_action_sensitive ##### --> -<para> - -</para> - -@widget: -@action_path: -@sensitive: -@Returns: - - -<!-- ##### FUNCTION glade_widget_remove_action ##### --> -<para> - -</para> - -@widget: -@action_path: - - -<!-- ##### FUNCTION glade_widget_remove_pack_action ##### --> -<para> - -</para> - -@widget: -@action_path: - - -<!-- ##### FUNCTION glade_widget_create_action_menu ##### --> -<para> - -</para> - -@widget: -@action_path: -@Returns: - - -<!-- ##### FUNCTION glade_widget_project_notify ##### --> -<para> - -</para> - -@widget: -@project: - - -<!-- ##### FUNCTION glade_widget_add_prop_ref ##### --> -<para> - -</para> - -@widget: -@property: - - -<!-- ##### FUNCTION glade_widget_remove_prop_ref ##### --> -<para> - -</para> - -@widget: -@property: - - -<!-- ##### FUNCTION glade_widget_object_set_property ##### --> -<para> - -</para> - -@widget: -@property_name: -@value: - - -<!-- ##### FUNCTION glade_widget_object_get_property ##### --> -<para> - -</para> - -@widget: -@property_name: -@value: - - -<!-- ##### FUNCTION glade_widget_child_set_property ##### --> -<para> - -</para> - -@widget: -@child: -@property_name: -@value: - - -<!-- ##### FUNCTION glade_widget_child_get_property ##### --> -<para> - -</para> - -@widget: -@child: -@property_name: -@value: - - -<!-- ##### FUNCTION glade_widget_property_get ##### --> -<para> - -</para> - -@widget: -@id_property: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION glade_widget_property_set ##### --> -<para> - -</para> - -@widget: -@id_property: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION glade_widget_pack_property_get ##### --> -<para> - -</para> - -@widget: -@id_property: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION glade_widget_pack_property_set ##### --> -<para> - -</para> - -@widget: -@id_property: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION glade_widget_property_reset ##### --> -<para> - -</para> - -@widget: -@id_property: -@Returns: - - -<!-- ##### FUNCTION glade_widget_pack_property_reset ##### --> -<para> - -</para> - -@widget: -@id_property: -@Returns: - - -<!-- ##### FUNCTION glade_widget_property_default ##### --> -<para> - -</para> - -@widget: -@id_property: -@Returns: - - -<!-- ##### FUNCTION glade_widget_property_original_default ##### --> -<para> - -</para> - -@widget: -@id_property: -@Returns: - - -<!-- ##### FUNCTION glade_widget_pack_property_default ##### --> -<para> - -</para> - -@widget: -@id_property: -@Returns: - - -<!-- ##### FUNCTION glade_widget_property_set_sensitive ##### --> -<para> - -</para> - -@widget: -@id_property: -@sensitive: -@reason: -@Returns: - - -<!-- ##### FUNCTION glade_widget_pack_property_set_sensitive ##### --> -<para> - -</para> - -@widget: -@id_property: -@sensitive: -@reason: -@Returns: - - -<!-- ##### FUNCTION glade_widget_property_set_enabled ##### --> -<para> - -</para> - -@widget: -@id_property: -@enabled: -@Returns: - - -<!-- ##### FUNCTION glade_widget_pack_property_set_enabled ##### --> -<para> - -</para> - -@widget: -@id_property: -@enabled: -@Returns: - - -<!-- ##### FUNCTION glade_widget_property_set_save_always ##### --> -<para> - -</para> - -@widget: -@id_property: -@setting: -@Returns: - - -<!-- ##### FUNCTION glade_widget_pack_property_set_save_always ##### --> -<para> - -</para> - -@widget: -@id_property: -@setting: -@Returns: - - -<!-- ##### FUNCTION glade_widget_property_string ##### --> -<para> - -</para> - -@widget: -@id_property: -@value: -@Returns: - - -<!-- ##### FUNCTION glade_widget_pack_property_string ##### --> -<para> - -</para> - -@widget: -@id_property: -@value: -@Returns: - - -<!-- ##### FUNCTION glade_widget_set_name ##### --> -<para> - -</para> - -@widget: -@name: - - -<!-- ##### FUNCTION glade_widget_get_name ##### --> -<para> - -</para> - -@widget: -@Returns: - - -<!-- ##### FUNCTION glade_widget_set_internal ##### --> -<para> - -</para> - -@widget: -@internal: - - -<!-- ##### FUNCTION glade_widget_get_internal ##### --> -<para> - -</para> - -@widget: -@Returns: - - -<!-- ##### FUNCTION glade_widget_set_object ##### --> -<para> - -</para> - -@gwidget: -@new_object: - - -<!-- ##### FUNCTION glade_widget_get_object ##### --> -<para> - -</para> - -@widget: -@Returns: - - -<!-- ##### FUNCTION glade_widget_set_project ##### --> -<para> - -</para> - -@widget: -@project: - - -<!-- ##### FUNCTION glade_widget_get_project ##### --> -<para> - -</para> - -@widget: -@Returns: - - -<!-- ##### FUNCTION glade_widget_get_adaptor ##### --> -<para> - -</para> - -@widget: -@Returns: - - -<!-- ##### FUNCTION glade_widget_get_parent ##### --> -<para> - -</para> - -@widget: -@Returns: - - -<!-- ##### FUNCTION glade_widget_set_parent ##### --> -<para> - -</para> - -@widget: -@parent: - - -<!-- ##### FUNCTION glade_widget_superuser ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_widget_push_superuser ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION glade_widget_pop_superuser ##### --> -<para> - -</para> - - - diff --git a/doc/tmpl/gladeui-unused.sgml b/doc/tmpl/gladeui-unused.sgml deleted file mode 100644 index ec18e6d3..00000000 --- a/doc/tmpl/gladeui-unused.sgml +++ /dev/null @@ -1,494 +0,0 @@ -<!-- ##### SECTION ./tmpl/glade-parser.sgml:Long_Description ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/glade-parser.sgml:See_Also ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/glade-parser.sgml:Short_Description ##### --> - - - -<!-- ##### SECTION ./tmpl/glade-parser.sgml:Stability_Level ##### --> - - - -<!-- ##### SECTION ./tmpl/glade-parser.sgml:Title ##### --> -glade-parser - - -<!-- ##### SECTION ./tmpl/glade-project-view.sgml:Long_Description ##### --> -<para> -The #GladeProjectView is a heirarchical treeview that allows the -user to control selection and cut/copy/paste/delete #GladeWidget -objects in the #GladeProject. -</para> - - -<!-- ##### SECTION ./tmpl/glade-project-view.sgml:See_Also ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/glade-project-view.sgml:Short_Description ##### --> -A widget to view the project hierarchy - - -<!-- ##### SECTION ./tmpl/glade-project-view.sgml:Stability_Level ##### --> - - - -<!-- ##### SECTION ./tmpl/glade-project-view.sgml:Title ##### --> -GladeProjectView - - -<!-- ##### SECTION ./tmpl/glade-widget-class.sgml:Long_Description ##### --> -<para> -#GladeWidgetClass is a structure based on a #GType and parameters -from the Glade catalog files and is the central metadata for object -classes; it also provides an abstraction later to container apis. -</para> - - -<!-- ##### SECTION ./tmpl/glade-widget-class.sgml:See_Also ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/glade-widget-class.sgml:Short_Description ##### --> -Object Class-wide metadata - - -<!-- ##### SECTION ./tmpl/glade-widget-class.sgml:Stability_Level ##### --> - - - -<!-- ##### SECTION ./tmpl/glade-widget-class.sgml:Title ##### --> -GladeWidgetClass - - -<!-- ##### MACRO CAST_BAD ##### --> -<para> - -</para> - - -<!-- ##### MACRO GLADE_ENV_CATALOG_PATH ##### --> -<para> - -</para> - - -<!-- ##### MACRO GLADE_ENV_MODULE_PATH ##### --> -<para> - -</para> - - -<!-- ##### MACRO GLADE_FIXED_CURSOR_BOTTOM ##### --> -<para> - -</para> - -@type: - -<!-- ##### MACRO GLADE_FIXED_CURSOR_LEFT ##### --> -<para> - -</para> - -@type: - -<!-- ##### MACRO GLADE_FIXED_CURSOR_RIGHT ##### --> -<para> - -</para> - -@type: - -<!-- ##### MACRO GLADE_FIXED_CURSOR_TOP ##### --> -<para> - -</para> - -@type: - -<!-- ##### MACRO GLADE_IS_PROPERTY_KLASS ##### --> -<para> - -</para> - -@klass: - -<!-- ##### MACRO GLADE_PROPERTY_GET_KLASS ##### --> -<para> - -</para> - -@o: - -<!-- ##### MACRO GLADE_PROPERTY_KLASS ##### --> -<para> - -</para> - -@klass: - -<!-- ##### MACRO GLADE_TYPE_POINTER_MODE ##### --> -<para> - -</para> - - -<!-- ##### ENUM GPCType ##### --> -<para> - -</para> - -@GPC_NORMAL: -@GPC_ATK_PROPERTY: -@GPC_ATK_RELATION: -@GPC_ATK_ACTION: -@GPC_ACCEL_PROPERTY: - -<!-- ##### STRUCT GladeAccelInfo ##### --> -<para> - -</para> - -@key: -@modifiers: -@signal: - -<!-- ##### STRUCT GladeAppPrivate ##### --> -<para> - -</para> - - -<!-- ##### STRUCT GladeAtkActionInfo ##### --> -<para> - -</para> - -@action_name: -@description: - -<!-- ##### STRUCT GladeAtkRelationInfo ##### --> -<para> - -</para> - -@target: -@type: - -<!-- ##### STRUCT GladeBaseEditorPrivate ##### --> -<para> - -</para> - - -<!-- ##### STRUCT GladeChildInfo ##### --> -<para> - -</para> - -@properties: -@n_properties: -@child: -@internal_child: - -<!-- ##### STRUCT GladeDesignLayoutPrivate ##### --> -<para> - -</para> - - -<!-- ##### STRUCT GladeDesignViewPrivate ##### --> -<para> - -</para> - - -<!-- ##### STRUCT GladeInspectorPrivate ##### --> -<para> - -</para> - - -<!-- ##### STRUCT GladeInterface ##### --> -<para> - -</para> - -@requires: -@n_requires: -@toplevels: -@n_toplevels: -@names: -@strings: -@comment: - -<!-- ##### STRUCT GladePackingDefault ##### --> -<para> - -</para> - -@id: -@value: - -<!-- ##### STRUCT GladePalettePrivate ##### --> -<para> - -</para> - - -<!-- ##### STRUCT GladeProjectPrivate ##### --> -<para> - -</para> - - -<!-- ##### STRUCT GladePropInfo ##### --> -<para> - -</para> - -@name: -@value: -@comment: -@translatable: -@has_context: - -<!-- ##### STRUCT GladePropertyKlass ##### --> -<para> - -</para> - -@parent_class: -@dup: -@equals_value: -@set_value: -@get_value: -@get_default: -@sync: -@load: -@get_tooltip: -@value_changed: -@tooltip_changed: - -<!-- ##### STRUCT GladeSignalClass ##### --> -<para> - -</para> - -@query: -@name: -@type: - -<!-- ##### STRUCT GladeSignalInfo ##### --> -<para> - -</para> - -@name: -@handler: -@object: -@after: -@lookup: - -<!-- ##### ARG GladeWidget:info ##### --> -<para> - -</para> - - -<!-- ##### STRUCT GladeWidgetAdaptorPrivate ##### --> -<para> - -</para> - - -<!-- ##### STRUCT GladeWidgetClass ##### --> -<para> - -</para> - -@parent_class: -@add_child: -@remove_child: -@replace_child: -@add_signal_handler: -@remove_signal_handler: -@change_signal_handler: -@button_press_event: -@button_release_event: -@motion_notify_event: -@event: - -<!-- ##### STRUCT GladeWidgetInfo ##### --> -<para> - -</para> - -@parent: -@classname: -@name: -@properties: -@n_properties: -@atk_props: -@n_atk_props: -@signals: -@n_signals: -@atk_actions: -@n_atk_actions: -@relations: -@n_relations: -@accels: -@n_accels: -@children: -@n_children: - -<!-- ##### FUNCTION glade_create_reason_get_type ##### --> -<para> - -</para> - -@Returns: - -<!-- ##### FUNCTION glade_editor_property_new ##### --> -<para> - -</para> - -@klass: -@use_command: -@Returns: - -<!-- ##### FUNCTION glade_editor_property_new_from_widget ##### --> -<para> - -</para> - -@widget: -@property: -@packing: -@use_command: -@Returns: - -<!-- ##### FUNCTION glade_editor_property_supported ##### --> -<para> - -</para> - -@pspec: -@Returns: - -<!-- ##### FUNCTION glade_parser_interface_destroy ##### --> -<para> - -</para> - -@interface: - -<!-- ##### FUNCTION glade_parser_interface_dump ##### --> -<para> - -</para> - -@interface: -@filename: -@error: -@Returns: - -<!-- ##### FUNCTION glade_parser_interface_new ##### --> -<para> - -</para> - -@Returns: - -<!-- ##### FUNCTION glade_parser_interface_new_from_buffer ##### --> -<para> - -</para> - -@buffer: -@len: -@domain: -@Returns: - -<!-- ##### FUNCTION glade_parser_interface_new_from_file ##### --> -<para> - -</para> - -@file: -@domain: -@Returns: - -<!-- ##### FUNCTION glade_parser_pvalue_from_winfo ##### --> -<para> - -</para> - -@winfo: -@pname: -@Returns: - -<!-- ##### FUNCTION glade_project_get_tooltips ##### --> -<para> - -</para> - -@project: -@Returns: - -<!-- ##### FUNCTION glade_property_class_accel_property ##### --> -<para> - -</para> - -@handle: -@owner_type: -@Returns: - -<!-- ##### FUNCTION glade_property_class_atk_realname ##### --> -<para> - -</para> - -@atk_name: -@Returns: - -<!-- ##### FUNCTION glade_property_class_list_atk_relations ##### --> -<para> - -</para> - -@handle: -@owner_type: -@Returns: - -<!-- ##### FUNCTION glade_signal_new_from_signal_info ##### --> -<para> - -</para> - -@info: -@Returns: - -<!-- ##### FUNCTION glade_util_queue_draw_nodes ##### --> -<para> - -</para> - -@window: - diff --git a/doc/widgetclasses.sgml b/doc/widgetclasses.sgml index 4125f91e..f3f2d99e 100644 --- a/doc/widgetclasses.sgml +++ b/doc/widgetclasses.sgml @@ -1,6 +1,6 @@ <refentry id="widgetclasses" revision="8 Feb 2006"> <refmeta> - <refentrytitle>Widget Class Definitions</refentrytitle> + <refentrytitle>Widget Adaptor Definitions</refentrytitle> <refmiscinfo>Glade UI</refmiscinfo> </refmeta> <refnamediv> @@ -14,54 +14,85 @@ Adding support for custom widgets <title>Forward</title> <para> -#GladeWidgetClass stuctures are added to a global pool using the `glade-widget-class' tag -and then later added to the palette through the `glade-widget-group' section; class-wide -parameters can be set on non-instantiatable classes; for example, parameters for -#GtkBox are valid for #GtkHBox and #GtkVBox. +Widget support in Glade is provided by the #GladeWidgetAdaptor object, each +`glade-widget-class' definition in the catalog will result in the creation +of an adaptor, which inherits the funcionality of the adaptor created for its +parent, or the closest adaptor available in the ancestry. Adaptor methods can +be overridden by functions in the plugin by specifying them in the catalog. +There is also a wealth of options you can use in the `glade-widget-class' without +writing code. </para> <para> -Note that there are alot of features to support alot of special-cases from -toolkits; but assuming that a widget is completely configurable via properties -and does not implement any special container relationships (which we will -explain in further detail later on) the catalog entry should really just be -a one liner like this: +A typical basic example of a widget class definition is as follows: <programlisting> -<![CDATA[<glade-widget-class name="GtkLabel" get-type-function="gtk_label_get_type" generic-name="label" title="Label"/>]]></programlisting> +<![CDATA[<glade-widget-class name="FooFrobnicator" generic-name="frobnicator" title="Frobnicator"/>]]></programlisting> </para> <para> -To delve further into details; the complex layout looks like this: +Here is the complete example of the form of the `glade-widget-class' definition: <programlisting> -<![CDATA[<glade-widget-class name="GtkLabel" get-type-function="gtk_label_get_type" generic-name="label" title="Label"> +<![CDATA[<glade-widget-class name="FooFrobnicator" generic-name="frobnicator" title="Frobnicator"/> + + <post-create-function>foo_frobnicator_plugin_post_create</post-create-function> ... widget class support functions go here <properties> + <property id="frobnicated" default="False"/> + ... property definitions go here </properties> - <children> + <packing-properties> + + ... child packing property definitions go here + + </packing-properties> + + <actions> + + <action id="launch_editor" name="Edit Frob" stock="gtk-edit"/> + + ... context menu action definitions go here + + </actions> - ... child specific parameters go here + <packing-actions> + + ... context menu action definitions for child objects go here + + </packing-actions> + + <packing-defaults> + + <parent-class name="GtkVBox"> + <child-property id="expand" default="false"/> + </parent-class> + + ... packing default definitions go here + + </packing-defaults> - </children> </glade-widget-class>]]></programlisting> </para> </refsect1> <refsect1> - <title>Widget Class Parameters</title> + <title>Widget Class Properties</title> + <para> +The following are all properies of the `glade-widget-class' tag + </para> <variablelist> <varlistentry> <term>name</term> <listitem> <para> -The 'name' property is the class name of the widget; unless the 'get-type-function' -property is present, this will essentially be used to instantiate the actual class -by deriving 'gtk_label_get_type' from 'GtkLabel' and searching for 'gtk_label_get_type' -in the support library. +The class name of the widget; unless the 'get-type-function' property is present, +this will essentially be used to instantiate the actual class by deriving +'gtk_label_get_type' from 'GtkLabel' and searching for 'gtk_label_get_type' in the +support library. </para> </listitem> </varlistentry> @@ -70,10 +101,9 @@ in the support library. <term>get-type-function</term> <listitem> <para> -The 'get-type-function' property is used to explicitly specify the name of the -function used to get the type of the widget. It is optional, but if it is not -present, the 'name' property will be used to guess the name of the function, -a process that could lead to unexpected results. +Used to explicitly specify the name of the function used to get the type of the widget. +It is optional, but if it is not present, the 'name' property will be used to guess the +name of the function, a process that could lead to unexpected results. </para> </listitem> </varlistentry> @@ -82,18 +112,18 @@ a process that could lead to unexpected results. <term>generic-name</term> <listitem> <para> -The 'generic-name' is used to generate a default name for instances of the +Used to generate a default name for instances of the widget in the UI editor. It is also used in conjunction with the 'icon-prefix' to form an icon name for the widget. </para> </listitem> </varlistentry> - <varlistentry> + <varlistentry> <term>icon-name</term> <listitem> <para> -The 'icon-name' property is used to explicitly set an icon name for this widget. +Used to explicitly set an icon name for this widget. These icon names are looked up in the current icon theme to retrieve an icon for the widget. </para> @@ -104,7 +134,7 @@ the widget. <term>title</term> <listitem> <para> -The'title' property is used to display the name of the class in the palette and widget +Used to display the name of the class in the palette and widget tree and will be translated before use in the interface. </para> </listitem> @@ -114,8 +144,67 @@ tree and will be translated before use in the interface. <term>toplevel</term> <listitem> <para> -The'toplevel' property is used to know whether this widget class is toplevel or not -in Glade context. +Used to know whether this widget class is toplevel or not +in Glade context. This property will be inherited from the adaptors parent. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>fixed</term> + <listitem> + <para> +Used to mark a #GladeWidgetClass for free form placement capacities +to be handled with a #GladeFixed. This property will be inherited from the adaptors parent. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>use-placeholders</term> + <listitem> + <para> +Used to inform the core about adaptors that implement +#GtkContainer editing, and whether or not they use #GladePlaceholder. This property will +be inherited from the adaptors parent. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>default-width</term> + <listitem> + <para> +The default width to load a #GtkWindow derived widget in the #GladeDesignView. +This property will be inherited from the adaptors parent. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>default-height</term> + <listitem> + <para> +The default height to load a #GtkWindow derived widget in the #GladeDesignView. +This property will be inherited from the adaptors parent. + </para> + </listitem> + </varlistentry> + + </variablelist> + </refsect1> + + <refsect1> + <title>Adapter Methods</title> + <para> +The following are all child tags of the `glade-widget-class' tag + </para> + <variablelist> + <varlistentry> + <term>constructor-function</term> + <listitem> + <para> +Used to override the actual #GObject constructor of the said #GladeWidgetAdaptor </para> </listitem> </varlistentry> @@ -124,20 +213,110 @@ in Glade context. <term>post-create-function</term> <listitem> <para> -The 'post-create-function' tag is a #GladePostCreateFunc support function that -gets called whenever a widget of 'this class' (or a widget derived from 'this class' -that didn't provide its own post-create-function) is instantiated. +A #GladePostCreateFunc support function that gets called whenever a widget of the said class is instantiated. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>deep-post-create-function</term> + <listitem> + <para> +Same as `post-create-function' except in that you must always chain up +to the super class definition as a rule. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>get-property-function</term> + <listitem> + <para> +A #GladeGetPropertyFunc to get values of properties on an instance in the +runtime. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>set-property-function</term> + <listitem> + <para> +A #GladeSetPropertyFunc to set values of properties on an instance in the +runtime. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>verify-function</term> + <listitem> + <para> +A #GladeVerifyPropertyFunc to set values of properties on an instance in the +runtime. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>add-child-function</term> + <listitem> + <para> +A #GladeAddChildFunc to add children to instances in the runtime. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>remove-child-function</term> + <listitem> + <para> +A #GladeRemoveChildFunc to remove children from instances in the runtime. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>replace-child-function</term> + <listitem> + <para> +A #GladeReplaceChildFunc to replace children inside instances in the runtime. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>get-children-function</term> + <listitem> + <para> +A #GladeGetChildrenFunc to get a list of children inside instances in the runtime. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>child-get-property-function</term> + <listitem> + <para> +A #GladeChildGetPropertyFunc to get packing properties from instances in the runtime. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>child-set-property-function</term> + <listitem> + <para> +A #GladeChildSetPropertyFunc to set packing properties on instances in the runtime. </para> </listitem> </varlistentry> <varlistentry> - <term>launch-editor-function</term> + <term>child-verify-function</term> <listitem> <para> -The 'launch-editor-function' tag is a #GladeEditorLaunchFunc support function used to -launch a custom editor for this class; a good example for this is the #GtkMenuBar -which needs a special editor in order to be easier to use. +A #GladeChildVerifyPropertyFunc to verify packing properties on instances in the runtime. </para> </listitem> </varlistentry> @@ -146,54 +325,187 @@ which needs a special editor in order to be easier to use. <term>get-internal-child-function</term> <listitem> <para> -The 'get-internal-child-function' tag is a #GladeGetInternalFunc support function -used to retrieve an internal child of a composite object (like a button in a -filechooser or something); support for internal children must also be added to -your application via libglade. +A #GladeGetInternalFunc to retrieve an internal child of a composite object in the runtime. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>action-activate-function</term> + <listitem> + <para> +A #GladeActionActivateFunc to run a routine for a plugin defined #GladeWidgetAction. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>child-action-activate-function</term> + <listitem> + <para> +A #GladeChildActionActivateFunc to run a routine for a plugin defined packing #GladeWidgetAction. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>read-widget-function</term> + <listitem> + <para> +A #GladeReadWidgetFunc to load a widget from the xml. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>write-widget-function</term> + <listitem> + <para> +A #GladeWriteWidgetFunc to write a widget from the xml. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>read-child-function</term> + <listitem> + <para> +A #GladeReadWidgetFunc to read a child to the xml. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>write-child-function</term> + <listitem> + <para> +A #GladeWriteWidgetFunc to write a child to the xml. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>create-editor-property-function</term> + <listitem> + <para> +A #GladeCreateEPropFunc to create widgets to be used in Glade's property editor. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>string-from-value-function</term> + <listitem> + <para> +A #GladeStringFromValueFunc to create a string from a #GValue. </para> </listitem> </varlistentry> </variablelist> </refsect1> - + + <refsect1> + <title>Action Definitions</title> + <para> +Actions are added under the `actions' and `packing-actions' tags, actions can also +be nested so as to allow grouping in context menus, example: + <programlisting> +<![CDATA[... + +<action id="manage_frobs" name="Manage Frobs"> + <action id="add_frob" name="Add" stock="gtk-add"/> + <action id="remove_frob" name="Remove" stock="gtk-remove"/> +</action> + +...]]></programlisting> + </para> + <para> +Here are the meanings of the `action' tag's properties: + </para> + <variablelist> + <varlistentry> + <term>id</term> + <listitem> + <para> +The string identifier for this action, the action_path argument to your #GladeActionActivateFunc +will be a combination if this id and any parents, for the above example: +<literal>"manage_frobs/add_frob"</literal>. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>name</term> + <listitem> + <para> +A string to be displayed in the UI for this action. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>stock</term> + <listitem> + <para> +An optional Gtk stock icon to represent this action. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>important</term> + <listitem> + <para> +A boolean option to add emphasis to this action; currently actions marked as `important' +are added to the toolbar. + </para> + </listitem> + </varlistentry> + + </variablelist> + </refsect1> + + <refsect1> + <title>Packing Defaults</title> + <para> +Default values can be specified for packing properties on your widget when added +to a said type of parent, as the example shows above; use the `parent-class' to +specify what parent (or derivative of that parent) you are targetting and fill +in any `child-property' tags you need for that parent using `id' property to +specify the property name and the `default' property for the value. + </para> + </refsect1> + <refsect1> - <title>Icons</title> - <para>The Glade palette and other components use icons to represent the various widget classes. - It is a good idea to provide icons for your widget classes, as this - enhances the user interface.</para> + <title>Icons</title> + <para> +The Glade palette and other components use icons to represent the various widget classes. +It is a good idea to provide icons for your widget classes, as this +enhances the user interface. + </para> - <para>Glade uses the GTK+ GtkIconTheme facility to provide icons for widget classes. Any icon - available in the current icon theme can be used as an icon for a widget class.</para> - - <para>By default, an icon name of the format "widget-CATALOG_NAME-GENERIC_NAME" - is assigned to every widget class. CATALOG_NAME is the value of catalog name attribute, and GENERIC_NAME is - the value of an widget class's generic name attribute.</para> - - <para>To explicity set an icon name for a widget class, the "icon-name" attribute of the "glade-widget-class" - element can be specified. This will override the default icon name assigned to the widget class.</para> + <para> +Glade uses the GTK+ GtkIconTheme facility to provide icons for widget classes. Any icon +available in the current icon theme can be used as an icon for a widget class. + </para> - <para>Icon files can be installed under any system icon theme folder, but we recommend - that you install them in glade's private icon theme folder:</para> + <para> +By default, an icon name of the format "widget-CATALOG_NAME-GENERIC_NAME" +is assigned to every widget class. CATALOG_NAME is the value of catalog name attribute, +and GENERIC_NAME is the value of an widget class's generic name attribute. + </para> - <programlisting>pkg-config --variable=pixmapdir gladeui-1.0</programlisting> + <para> +To explicity set an icon name for a widget class, the "icon-name" attribute of the +"glade-widget-class" element can be specified. This will override the default icon +name assigned to the widget class. + </para> - </refsect1> - <refsect1> - <title>Grouping widget classes in the catalog</title> <para> -The widgets are groups in different groups in the Glade UI. Those groups -are defined in the catalog file as follows: - <programlisting> -<![CDATA[ -<glade-widget-group name="my-widgets" title="My widgets"> - <glade-widget-class-ref name="MyFirstWidget"/> - <glade-widget-class-ref name="MysecondWidget"/> - - ... - -</glade-widget-group>]]></programlisting> -The file should contain one or more widget groups. +Icon files can be installed under any system icon theme folder, but we recommend +that you install them in Glade's icon theme as previosly described. </para> </refsect1> + </refentry> |