summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTristan Van Berkom <tvb@src.gnome.org>2006-06-09 09:43:15 +0000
committerTristan Van Berkom <tvb@src.gnome.org>2006-06-09 09:43:15 +0000
commit16743369c6d2a0cbebbf628a6250e1d8af6294ce (patch)
treec4b0dee4a9e5e0aaac3478cbaa7752c749dd7386 /doc
parent6902e0f83b875a8785364b1a498f7c41b6c1474c (diff)
downloadglade-16743369c6d2a0cbebbf628a6250e1d8af6294ce.tar.gz
Made changes for changed files.
* src/Makefile.am, po/POTFILES.in: Made changes for changed files. * src/glade-fixed.[ch]: The new GladeWidget derived free form placement support object. * src/glade-fixed-manager.[ch]: Removed. * doc/catalogintro.sgml: made mention of new 'fixed' property on 'glade-widget-class' tag * doc/gladeui-sections.txt, doc/Makefile.am, doc/tmpl/*, doc/gladeui.types: Updated for file changes. * src/glade-app.c, src/glade-command.c, src/glade-gnome.c, src/glade.h: Changed for new apis in glade-widget and glade-fixed. * src/glade-gtk.c: o Changed for new apis in glade-widget and glade-fixed. o Restructured, now *all* class supports are listed class by class * src/glade-property-class.h: Fixed docs. * src/glade-widget-class.[ch]: o Added glade_widget_class_query () o Added glade_widget_class_create_widget () o Added glade_widget_class_create_internal () * src/glade-widget.[ch]: API is stablizing now... lots of cleanup done, added construct properties used in the constructor to create properties and runtime instances. * widgets/gtk+.xml.in: o Toolbars expand=False by default in GtkVBoxes o GtkPaned now works a little stabler o GtkFixed/GtkLayout marked 'fixed'.
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am3
-rw-r--r--doc/catalogintro.sgml13
-rw-r--r--doc/gladeui-docs.sgml4
-rw-r--r--doc/gladeui-sections.txt46
-rw-r--r--doc/gladeui.types2
-rw-r--r--doc/tmpl/glade-app.sgml9
-rw-r--r--doc/tmpl/glade-fixed-manager.sgml159
-rw-r--r--doc/tmpl/glade-property-class.sgml21
-rw-r--r--doc/tmpl/glade-utils.sgml18
-rw-r--r--doc/tmpl/glade-widget-class.sgml62
-rw-r--r--doc/tmpl/glade-widget.sgml54
11 files changed, 159 insertions, 232 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index ca678514..161efe12 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -61,7 +61,8 @@ IGNORE_HFILES=\
glade.h \
glade-xml-utils.h \
glade-popup.h \
- glade-devhelp.h
+ glade-devhelp.h \
+ glade-gtk.h
# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
diff --git a/doc/catalogintro.sgml b/doc/catalogintro.sgml
index 670c46cc..12f67325 100644
--- a/doc/catalogintro.sgml
+++ b/doc/catalogintro.sgml
@@ -82,6 +82,7 @@ require it and to manage inter catalog dependancies.
</para>
</listitem>
</varlistentry>
+
<varlistentry>
<term>library</term>
<listitem>
@@ -91,6 +92,7 @@ be dlopen'd from <literal>$prefix/lib/glade-3/modules/</literal>
</para>
</listitem>
</varlistentry>
+
<varlistentry>
<term>depends</term>
<listitem>
@@ -103,6 +105,7 @@ declare: 'depends="gtk+"' for your plugin.
</para>
</listitem>
</varlistentry>
+
<varlistentry>
<term>domain</term>
<listitem>
@@ -127,6 +130,16 @@ The 'book' property is used to specify a namespace to search devhelp docs librar
</varlistentry>
<varlistentry>
+ <term>fixed</term>
+ <listitem>
+ <para>
+The 'fixed' property used to mark a #GladeWidgetClass for free form placement capacitied
+to be handled with a #GladeFixed.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term>init-function</term>
<listitem>
<para>
diff --git a/doc/gladeui-docs.sgml b/doc/gladeui-docs.sgml
index 3966f1fd..8dae2ccd 100644
--- a/doc/gladeui-docs.sgml
+++ b/doc/gladeui-docs.sgml
@@ -11,7 +11,6 @@
<!ENTITY GladeClipboard SYSTEM "xml/glade-clipboard.xml">
<!ENTITY GladeEditorProperty SYSTEM "xml/glade-editor-property.xml">
<!ENTITY GladeEditor SYSTEM "xml/glade-editor.xml">
-<!ENTITY GladeFixedManager SYSTEM "xml/glade-fixed-manager.xml">
<!ENTITY GladePalette SYSTEM "xml/glade-palette.xml">
<!ENTITY GladeParameter SYSTEM "xml/glade-parameter.xml">
<!ENTITY GladePlaceholder SYSTEM "xml/glade-placeholder.xml">
@@ -23,6 +22,7 @@
<!ENTITY GladeUtils SYSTEM "xml/glade-utils.xml">
<!ENTITY GladeWidgetClass SYSTEM "xml/glade-widget-class.xml">
<!ENTITY GladeWidget SYSTEM "xml/glade-widget.xml">
+<!ENTITY GladeFixed SYSTEM "xml/glade-fixed.xml">
<!ENTITY version SYSTEM "version.xml">
]>
<book id="index">
@@ -59,6 +59,7 @@
&GladeApp;
&GladeProject;
&GladeWidget;
+ &GladeFixed;
&GladeProperty;
&GladeWidgetClass;
&GladePropertyClass;
@@ -78,7 +79,6 @@
<part id="misc">
<title>Miscalanious utilities</title>
- &GladeFixedManager;
&GladePlaceholder;
&GladeParameter;
&GladeUtils;
diff --git a/doc/gladeui-sections.txt b/doc/gladeui-sections.txt
index 78e89659..a045d90a 100644
--- a/doc/gladeui-sections.txt
+++ b/doc/gladeui-sections.txt
@@ -18,6 +18,7 @@ glade_app_set_project
glade_app_get_project
glade_app_add_project
glade_app_remove_project
+glade_app_get_project_by_path
glade_app_get_projects
glade_app_get_config
glade_app_is_project_loaded
@@ -181,23 +182,18 @@ GladeEditorTable
</SECTION>
<SECTION>
-<FILE>glade-fixed-manager</FILE>
-<TITLE>GladeFixedManager</TITLE>
-GladeFixedManager
-glade_fixed_manager_new
-glade_fixed_manager_create_child
-glade_fixed_manager_add_child
-glade_fixed_manager_remove_child
-glade_fixed_manager_post_mouse
+<FILE>glade-fixed</FILE>
+<TITLE>GladeFixed</TITLE>
+GladeFixed
<SUBSECTION Standard>
-GLADE_FIXED_MANAGER
-GLADE_IS_FIXED_MANAGER
-GLADE_TYPE_FIXED_MANAGER
-glade_fixed_manager_get_type
-GLADE_FIXED_MANAGER_CLASS
-GLADE_IS_FIXED_MANAGER_CLASS
-GLADE_FIXED_MANAGER_GET_CLASS
-GladeFixedManagerClass
+glade_fixed_get_type
+GLADE_TYPE_FIXED
+GLADE_FIXED_GET_CLASS
+GLADE_IS_FIXED
+GLADE_IS_FIXED_CLASS
+GLADE_FIXED_CLASS
+GLADE_FIXED
+GladeFixedClass
</SECTION>
<SECTION>
@@ -302,7 +298,7 @@ GladeProjectClass
<FILE>glade-property-class</FILE>
<TITLE>GladePropertyClass</TITLE>
GladePropertyClass
-GPCAtkType
+GPCType
GladeVerifyPropertyFunc
GladeGetPropertyFunc
GladeSetPropertyFunc
@@ -325,6 +321,7 @@ glade_property_class_match
glade_property_class_void_value
glade_property_class_atk_realname
glade_property_class_list_atk_relations
+glade_property_class_accel_property
<SUBSECTION Private>
GPC_PROPERTY_NAMELEN
<SUBSECTION Standard>
@@ -407,6 +404,7 @@ GLADE_IS_SIGNAL
<FILE>glade-widget-class</FILE>
<TITLE>GladeWidgetClass</TITLE>
GladeWidgetClass
+GladeSignalClass
GladeCreateReason
GladePostCreateFunc
GladeChildSetPropertyFunc
@@ -421,6 +419,11 @@ glade_widget_class_new
glade_widget_class_free
glade_widget_class_get_by_name
glade_widget_class_get_by_type
+glade_widget_class_from_pclass
+glade_widget_class_create_widget
+glade_widget_class_create_internal
+glade_widget_class_default_params
+glade_widget_class_query
glade_widget_class_get_derived_types
glade_widget_class_dump_param_specs
glade_widget_class_get_property_class
@@ -439,18 +442,18 @@ glade_widget_class_get_type
GLADE_WIDGET_CLASS
GLADE_IS_WIDGET_CLASS
<SUBSECTION Private>
+glade_widget_class_create_widget_real
GPC_OBJECT_DELIMITER
GLADE_VALID_CREATE_REASON
GladeSupportedChild
-GladeWidgetClassSignal
</SECTION>
<SECTION>
<FILE>glade-widget</FILE>
<TITLE>GladeWidget</TITLE>
GladeWidget
-glade_widget_new
-glade_widget_new_for_internal_child
+glade_widget_add_child
+glade_widget_remove_child
glade_widget_set_name
glade_widget_set_internal
glade_widget_set_object
@@ -481,7 +484,6 @@ glade_widget_property_set_sensitive
glade_widget_pack_property_set_sensitive
glade_widget_property_set_enabled
glade_widget_pack_property_set_enabled
-glade_widget_retrieve_from_position
glade_widget_has_decendant
glade_widget_replace
glade_widget_rebuild
@@ -584,10 +586,8 @@ glade_util_copy_file
glade_util_file_is_writeable
glade_util_load_library
glade_util_class_implements_interface
-glade_util_load_devhelp
glade_util_have_devhelp
glade_util_search_devhelp
-glade_util_get_devhelp_hbuttons
</SECTION>
diff --git a/doc/gladeui.types b/doc/gladeui.types
index 79f26202..211dc32d 100644
--- a/doc/gladeui.types
+++ b/doc/gladeui.types
@@ -6,7 +6,7 @@ glade_clipboard_view_get_type
glade_command_get_type
glade_editor_get_type
glade_editor_property_get_type
-glade_fixed_manager_get_type
+glade_fixed_get_type
glade_palette_get_type
glade_placeholder_get_type
glade_project_get_type
diff --git a/doc/tmpl/glade-app.sgml b/doc/tmpl/glade-app.sgml
index 6fed3272..ea908b00 100644
--- a/doc/tmpl/glade-app.sgml
+++ b/doc/tmpl/glade-app.sgml
@@ -173,6 +173,15 @@ to initialize the Glade core.
@app:
+<!-- ##### FUNCTION glade_app_get_project_by_path ##### -->
+<para>
+
+</para>
+
+@project_path:
+@Returns:
+
+
<!-- ##### FUNCTION glade_app_get_projects ##### -->
<para>
diff --git a/doc/tmpl/glade-fixed-manager.sgml b/doc/tmpl/glade-fixed-manager.sgml
deleted file mode 100644
index 7c407462..00000000
--- a/doc/tmpl/glade-fixed-manager.sgml
+++ /dev/null
@@ -1,159 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GladeFixedManager
-
-<!-- ##### SECTION Short_Description ##### -->
-A mechanism to handle free from widget placement containers
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-This object provides a flexable layer that allows plugins to
-implement free-form placement of child widgets.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### STRUCT GladeFixedManager ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SIGNAL GladeFixedManager::add-child ##### -->
-<para>
-
-</para>
-
-@gladefixedmanager: the object which received the signal.
-@arg1:
-@Returns:
-
-<!-- ##### SIGNAL GladeFixedManager::child-created ##### -->
-<para>
-
-</para>
-
-@gladefixedmanager: the object which received the signal.
-@arg1:
-
-<!-- ##### SIGNAL GladeFixedManager::configure-begin ##### -->
-<para>
-
-</para>
-
-@gladefixedmanager: the object which received the signal.
-@arg1:
-
-<!-- ##### SIGNAL GladeFixedManager::configure-child ##### -->
-<para>
-
-</para>
-
-@gladefixedmanager: the object which received the signal.
-@arg1:
-@arg2:
-@Returns:
-
-<!-- ##### SIGNAL GladeFixedManager::configure-end ##### -->
-<para>
-
-</para>
-
-@gladefixedmanager: the object which received the signal.
-@arg1:
-
-<!-- ##### SIGNAL GladeFixedManager::create-child ##### -->
-<para>
-
-</para>
-
-@gladefixedmanager: the object which received the signal.
-@arg1:
-@Returns:
-
-<!-- ##### SIGNAL GladeFixedManager::remove-child ##### -->
-<para>
-
-</para>
-
-@gladefixedmanager: the object which received the signal.
-@arg1:
-@Returns:
-
-<!-- ##### ARG GladeFixedManager:height-prop ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GladeFixedManager:width-prop ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GladeFixedManager:x-prop ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GladeFixedManager:y-prop ##### -->
-<para>
-
-</para>
-
-<!-- ##### FUNCTION glade_fixed_manager_new ##### -->
-<para>
-
-</para>
-
-@gtkcontainer:
-@x_prop:
-@y_prop:
-@width_prop:
-@height_prop:
-@Returns:
-
-
-<!-- ##### FUNCTION glade_fixed_manager_create_child ##### -->
-<para>
-
-</para>
-
-@manager:
-@wclass:
-@Returns:
-
-
-<!-- ##### FUNCTION glade_fixed_manager_add_child ##### -->
-<para>
-
-</para>
-
-@manager:
-@child:
-@at_mouse:
-
-
-<!-- ##### FUNCTION glade_fixed_manager_remove_child ##### -->
-<para>
-
-</para>
-
-@manager:
-@child:
-
-
-<!-- ##### FUNCTION glade_fixed_manager_post_mouse ##### -->
-<para>
-
-</para>
-
-@manager:
-@x:
-@y:
-
-
diff --git a/doc/tmpl/glade-property-class.sgml b/doc/tmpl/glade-property-class.sgml
index 6784a017..29400c33 100644
--- a/doc/tmpl/glade-property-class.sgml
+++ b/doc/tmpl/glade-property-class.sgml
@@ -25,6 +25,8 @@ va_lists etc (back and forth).
</para>
+@type:
+@handle:
@pspec:
@id:
@name:
@@ -40,7 +42,6 @@ va_lists etc (back and forth).
@construct_only:
@common:
@packing:
-@atk_type:
@translatable:
@visible_lines:
@save:
@@ -52,15 +53,16 @@ va_lists etc (back and forth).
@set_function:
@get_function:
-<!-- ##### ENUM GPCAtkType ##### -->
+<!-- ##### ENUM GPCType ##### -->
<para>
</para>
-@GPC_ATK_NONE:
+@GPC_NORMAL:
@GPC_ATK_PROPERTY:
@GPC_ATK_RELATION:
@GPC_ATK_ACTION:
+@GPC_ACCEL_PROPERTY:
<!-- ##### USER_FUNCTION GladeVerifyPropertyFunc ##### -->
<para>
@@ -95,6 +97,7 @@ va_lists etc (back and forth).
</para>
+@handle:
@Returns:
@@ -103,6 +106,7 @@ va_lists etc (back and forth).
</para>
+@handle:
@spec:
@Returns:
@@ -271,6 +275,17 @@ va_lists etc (back and forth).
</para>
+@handle:
+@owner_type:
+@Returns:
+
+
+<!-- ##### FUNCTION glade_property_class_accel_property ##### -->
+<para>
+
+</para>
+
+@handle:
@owner_type:
@Returns:
diff --git a/doc/tmpl/glade-utils.sgml b/doc/tmpl/glade-utils.sgml
index 05d96dba..70dd1a5b 100644
--- a/doc/tmpl/glade-utils.sgml
+++ b/doc/tmpl/glade-utils.sgml
@@ -372,14 +372,6 @@ This is where all of that really usefull miscalanious stuff lands up.
@Returns:
-<!-- ##### FUNCTION glade_util_load_devhelp ##### -->
-<para>
-
-</para>
-
-@Returns:
-
-
<!-- ##### FUNCTION glade_util_have_devhelp ##### -->
<para>
@@ -393,18 +385,10 @@ This is where all of that really usefull miscalanious stuff lands up.
</para>
-@devhelp:
@book:
@page:
@search:
-
-
-<!-- ##### FUNCTION glade_util_get_devhelp_hbuttons ##### -->
-<para>
-
-</para>
-
+<!-- # Unused Parameters # -->
@devhelp:
-@Returns:
diff --git a/doc/tmpl/glade-widget-class.sgml b/doc/tmpl/glade-widget-class.sgml
index 10a97609..14b6a94b 100644
--- a/doc/tmpl/glade-widget-class.sgml
+++ b/doc/tmpl/glade-widget-class.sgml
@@ -29,6 +29,7 @@ classes; it also provides an abstraction later to container apis.
@catalog:
@book:
@icon:
+@fixed:
@generic_name:
@palette_name:
@properties:
@@ -40,6 +41,15 @@ classes; it also provides an abstraction later to container apis.
@get_internal_child:
@launch_editor:
+<!-- ##### STRUCT GladeSignalClass ##### -->
+<para>
+
+</para>
+
+@query:
+@name:
+@type:
+
<!-- ##### ENUM GladeCreateReason ##### -->
<para>
@@ -176,6 +186,58 @@ classes; it also provides an abstraction later to container apis.
@Returns:
+<!-- ##### MACRO glade_widget_class_from_pclass ##### -->
+<para>
+
+</para>
+
+@pclass:
+
+
+<!-- ##### MACRO glade_widget_class_create_widget ##### -->
+<para>
+
+</para>
+
+@class:
+@query:
+@...:
+
+
+<!-- ##### FUNCTION glade_widget_class_create_internal ##### -->
+<para>
+
+</para>
+
+@parent:
+@internal_object:
+@internal_name:
+@parent_name:
+@anarchist:
+@reason:
+@Returns:
+
+
+<!-- ##### FUNCTION glade_widget_class_default_params ##### -->
+<para>
+
+</para>
+
+@class:
+@construct:
+@n_params:
+@Returns:
+
+
+<!-- ##### FUNCTION glade_widget_class_query ##### -->
+<para>
+
+</para>
+
+@class:
+@Returns:
+
+
<!-- ##### FUNCTION glade_widget_class_get_derived_types ##### -->
<para>
diff --git a/doc/tmpl/glade-widget.sgml b/doc/tmpl/glade-widget.sgml
index 4a7e698f..883e0c40 100644
--- a/doc/tmpl/glade-widget.sgml
+++ b/doc/tmpl/glade-widget.sgml
@@ -60,11 +60,21 @@ convenience api for getting and setting properties (mostly from the plugin).
</para>
+<!-- ##### ARG GladeWidget:info ##### -->
+<para>
+
+</para>
+
<!-- ##### ARG GladeWidget:internal ##### -->
<para>
</para>
+<!-- ##### ARG GladeWidget:internal-name ##### -->
+<para>
+
+</para>
+
<!-- ##### ARG GladeWidget:name ##### -->
<para>
@@ -90,32 +100,33 @@ convenience api for getting and setting properties (mostly from the plugin).
</para>
-<!-- ##### FUNCTION glade_widget_new ##### -->
+<!-- ##### ARG GladeWidget:reason ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GladeWidget:template ##### -->
+<para>
+
+</para>
+
+<!-- ##### FUNCTION glade_widget_add_child ##### -->
<para>
</para>
@parent:
-@klass:
-@project:
-@query:
-@Returns:
+@child:
+@at_mouse:
-<!-- ##### FUNCTION glade_widget_new_for_internal_child ##### -->
+<!-- ##### FUNCTION glade_widget_remove_child ##### -->
<para>
</para>
@parent:
-@internal_object:
-@internal_name:
-@parent_name:
-@anarchist:
-@reason:
-@Returns:
-<!-- # Unused Parameters # -->
-@project:
+@child:
<!-- ##### FUNCTION glade_widget_set_name ##### -->
@@ -410,17 +421,6 @@ convenience api for getting and setting properties (mostly from the plugin).
@Returns:
-<!-- ##### FUNCTION glade_widget_retrieve_from_position ##### -->
-<para>
-
-</para>
-
-@base:
-@x:
-@y:
-@Returns:
-
-
<!-- ##### FUNCTION glade_widget_has_decendant ##### -->
<para>
@@ -454,8 +454,10 @@ convenience api for getting and setting properties (mostly from the plugin).
</para>
-@widget:
+@template:
@Returns:
+<!-- # Unused Parameters # -->
+@widget:
<!-- ##### FUNCTION glade_widget_add_signal_handler ##### -->