From 28a41ea3c7b15e4d8e32c49052241c893d9e473f Mon Sep 17 00:00:00 2001 From: Duncan Mak Date: Mon, 28 Jul 2003 23:14:43 +0000 Subject: [PATCH] Added some documentation for Glade.XML. svn path=/trunk/gtk-sharp/; revision=16802 --- doc/ChangeLog | 4 + doc/en/Glade/XML.xml | 251 +++++++++++++++++++++++++------------------ 2 files changed, 152 insertions(+), 103 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index adc267034..edcd4c6ad 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2003-07-28 Duncan Mak + + * en/Glade/XML.xml: Added some documentation. + 2003-07-27 John Luke * en/Gtk/CheckButton.xml: add small example, update diff --git a/doc/en/Glade/XML.xml b/doc/en/Glade/XML.xml index 9f711738c..7955ba047 100644 --- a/doc/en/Glade/XML.xml +++ b/doc/en/Glade/XML.xml @@ -1,5 +1,5 @@ - + glade-sharp 0.0.0.0 @@ -7,8 +7,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Allows dynamic loading of user interfaces from XML descriptions + GLib.Object @@ -30,13 +30,15 @@ Glade.XML - - + + - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'Glade.XML' - To be added + Get the parent widget + a + + the object that built , or if is not built from Glade + + @@ -46,13 +48,13 @@ System.String - - + + - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'string' - To be added + Gets the name of a Glade-built widget + a built from Glade + the name of the + @@ -62,12 +64,23 @@ System.Void - - + + - To be added - To be added: an object of type 'Glade.XMLCustomWidgetHandler' - To be added + + This function allows you to override the default behaviour + when a Custom widget is found in an interface. + + the custom widget handler + + + Calling this function allows you to override the default + behaviour when a Custom widget is found in an + interface. This could be used by a language binding to + call some other function, or to limit what functions can + be called to create custom widgets + + @@ -77,8 +90,8 @@ System.Void - - + + To be added To be added: an object of type 'Type' @@ -92,8 +105,8 @@ System.Void - - + + To be added To be added: an object of type 'object' @@ -107,12 +120,17 @@ System.Void - - + + - To be added - To be added: an object of type 'Type' - To be added + Automatically connect signals + a with handler methods + + + Connects the signals defined in the glade file with static handler methods provided by the given , + . + + @@ -122,12 +140,16 @@ System.Void - - + + - To be added - To be added: an object of type 'object' - To be added + Automatically connect signals + an with handler methods + + + Connects the signals definied in the glade file with static handler methods provided by the given object, . + + @@ -137,14 +159,26 @@ System.Void - - - + + + - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'Glade.WidgetInfo' - To be added + + Sets the common parameters on a widget, and is responsible for + inserting it into the object's internal structures. + + the widget to set parameters on + the structure for + + + Sets the common parameters on , and is responsible + for inserting it into the object's internal + structures. It will also add the children to this widget. + Usually this function is only called by + , but is exposed for difficult + cases, such as setting up buttons and the like. + + @@ -154,14 +188,26 @@ System.Void - - - + + + - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'Glade.ChildInfo' - To be added + + This function is intended to be called by the build_children + callback for container widgets. + + the parent widget + the structure for the child + + + This function is intended to be called by the + build_children callback for container widgets. If the + build_children callback encounters a child with the + internal-child attribute set, then it should call this + function to handle it and then continue on to the next + child. + + @@ -183,10 +229,10 @@ System.Boolean - - - - + + + + To be added To be added: an object of type 'string' @@ -216,11 +262,11 @@ System.Void - - - - - + + + + + To be added To be added: an object of type 'Gtk.Widget' @@ -237,8 +283,8 @@ Gtk.Widget - - + + To be added To be added: an object of type 'Glade.WidgetInfo' @@ -253,8 +299,8 @@ System.String - - + + To be added To be added: an object of type 'string' @@ -269,8 +315,8 @@ System.Void - - + + To be added To be added: an object of type 'Glade.XMLConnectFunc' @@ -284,10 +330,10 @@ System.Void - - - - + + + + To be added To be added: an object of type 'Gtk.Widget' @@ -303,8 +349,8 @@ GLib.List - - + + To be added To be added: an object of type 'string' @@ -319,8 +365,8 @@ Gtk.Widget - - + + To be added To be added: an object of type 'string' @@ -335,10 +381,10 @@ System.Boolean - - - - + + + + To be added To be added: an object of type 'IntPtr' @@ -355,9 +401,9 @@ System.Void - - - + + + To be added To be added: an object of type 'string' @@ -382,8 +428,8 @@ Constructor - - + + Internal constructor Pointer to the C object. @@ -398,10 +444,10 @@ Constructor - - - - + + + + To be added To be added: an object of type 'string' @@ -416,11 +462,11 @@ Constructor - - - - - + + + + + To be added To be added: an object of type 'string' @@ -484,8 +530,7 @@ Gtk.Window - - + To be added To be added: an object of type 'Gtk.Window' @@ -498,8 +543,8 @@ Constructor - - + + Internal constructor GLib type for the type @@ -514,10 +559,10 @@ Constructor - - - - + + + + To be added a @@ -532,11 +577,11 @@ Constructor - - - - - + + + + + To be added a @@ -548,4 +593,4 @@ - + \ No newline at end of file