From 1b41f742f6d80c8f80df7185cd3c7bd1dd032101 Mon Sep 17 00:00:00 2001 From: Mike Kestner Date: Thu, 8 Jan 2009 16:40:35 +0000 Subject: [PATCH] glade doc update svn path=/trunk/gtk-sharp/; revision=122791 --- doc/en/Glade/AccelInfo.xml | 65 +- doc/en/Glade/ApplyCustomPropFunc.xml | 7 +- doc/en/Glade/AtkActionInfo.xml | 65 +- doc/en/Glade/AtkRelationInfo.xml | 35 +- doc/en/Glade/BuildChildrenFunc.xml | 7 +- doc/en/Glade/ChildInfo.xml | 121 +- doc/en/Glade/FindInternalChildFunc.xml | 9 +- doc/en/Glade/Global.xml | 148 +-- doc/en/Glade/HandlerNotFoundException.xml | 159 +-- doc/en/Glade/Interface.xml | 119 +- doc/en/Glade/NewFunc.xml | 9 +- doc/en/Glade/Parser.xml | 55 +- doc/en/Glade/Property.xml | 65 +- doc/en/Glade/SignalInfo.xml | 95 +- doc/en/Glade/Standard.xml | 33 +- doc/en/Glade/WidgetAttribute.xml | 97 +- doc/en/Glade/WidgetInfo.xml | 353 +++--- doc/en/Glade/XML.xml | 1323 ++++++++++----------- doc/en/Glade/XMLConnectFunc.xml | 7 +- doc/en/Glade/XMLCustomWidgetHandler.xml | 9 +- doc/en/ns-Glade.xml | 16 + 21 files changed, 1408 insertions(+), 1389 deletions(-) create mode 100644 doc/en/ns-Glade.xml diff --git a/doc/en/Glade/AccelInfo.xml b/doc/en/Glade/AccelInfo.xml index 285a9b47e..31d31eeca 100644 --- a/doc/en/Glade/AccelInfo.xml +++ b/doc/en/Glade/AccelInfo.xml @@ -4,47 +4,18 @@ glade-sharp - 2.12.0.0 Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. + + System.ValueType + + The structure is used as part of the output of libglade's XML parser. - - System.ValueType - - - - - Field - - Glade.AccelInfo - - - - Returns an empty - - - - - - Method - - Glade.AccelInfo - - - - - - Internal method - an object of type - an object of type - This is an internal method and should not be used by user code. - - Field @@ -73,6 +44,22 @@ + + + Method + + Glade.AccelInfo + + + + + + an object of type + Internal method + an object of type + This is an internal method and should not be used by user code. + + Field @@ -87,5 +74,17 @@ + + + Field + + Glade.AccelInfo + + + + Returns an empty + + + diff --git a/doc/en/Glade/ApplyCustomPropFunc.xml b/doc/en/Glade/ApplyCustomPropFunc.xml index 958b703b3..8d4a83ee9 100644 --- a/doc/en/Glade/ApplyCustomPropFunc.xml +++ b/doc/en/Glade/ApplyCustomPropFunc.xml @@ -2,9 +2,11 @@ glade-sharp - 2.12.0.0 Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. + + System.Delegate + To be added. To be added. @@ -14,9 +16,6 @@ - - System.Delegate - diff --git a/doc/en/Glade/AtkActionInfo.xml b/doc/en/Glade/AtkActionInfo.xml index 6a1998306..2bdfaaf14 100644 --- a/doc/en/Glade/AtkActionInfo.xml +++ b/doc/en/Glade/AtkActionInfo.xml @@ -4,46 +4,17 @@ glade-sharp - 2.12.0.0 Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - - This structure is used as part of the output of libglade's XML parser. - - System.ValueType + + This structure is used as part of the output of libglade's XML parser. + + - - - Field - - Glade.AtkActionInfo - - - - Returns an empty - - - - - - Method - - Glade.AtkActionInfo - - - - - - Internal method - an object of type - an object of type - This is an internal method and should not be used by user code. - - Field @@ -72,5 +43,33 @@ + + + Method + + Glade.AtkActionInfo + + + + + + an object of type + Internal method + an object of type + This is an internal method and should not be used by user code. + + + + + Field + + Glade.AtkActionInfo + + + + Returns an empty + + + diff --git a/doc/en/Glade/AtkRelationInfo.xml b/doc/en/Glade/AtkRelationInfo.xml index bfedddf6d..2af0b17f6 100644 --- a/doc/en/Glade/AtkRelationInfo.xml +++ b/doc/en/Glade/AtkRelationInfo.xml @@ -4,31 +4,18 @@ glade-sharp - 2.12.0.0 Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. + + System.ValueType + + This structure is used as part of the output of libglade's XML parser. - - System.ValueType - - - - - Field - - Glade.AtkRelationInfo - - - - Returns an empty - - - Method @@ -39,8 +26,8 @@ - Internal method an object of type + Internal method an object of type This is an internal method and should not be used by user code. @@ -73,5 +60,17 @@ + + + Field + + Glade.AtkRelationInfo + + + + Returns an empty + + + diff --git a/doc/en/Glade/BuildChildrenFunc.xml b/doc/en/Glade/BuildChildrenFunc.xml index ce6e6d86d..0c1e8692b 100644 --- a/doc/en/Glade/BuildChildrenFunc.xml +++ b/doc/en/Glade/BuildChildrenFunc.xml @@ -2,9 +2,11 @@ glade-sharp - 2.12.0.0 Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. + + System.Delegate + To be added. To be added. @@ -12,9 +14,6 @@ event handler. this delegate is used for custom methods to built the internal children of a widget. - - System.Delegate - diff --git a/doc/en/Glade/ChildInfo.xml b/doc/en/Glade/ChildInfo.xml index 3544d61a4..f9dcc1262 100644 --- a/doc/en/Glade/ChildInfo.xml +++ b/doc/en/Glade/ChildInfo.xml @@ -4,48 +4,19 @@ glade-sharp - 2.12.0.0 Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - - This structure is used as part of the output of libglade's XML parser. - Information about child widgets. - System.ValueType + + This structure is used as part of the output of libglade's XML parser. + Information about child widgets. + - - - Field - - Glade.ChildInfo - - - - Returns an empty - - - - - - Method - - Glade.ChildInfo - - - - - - Internal method - an object of type - an object of type - This is an internal method and should not be used by user code. - - - + Property Glade.WidgetInfo @@ -57,33 +28,6 @@ - - - Property - - Glade.Property - - - The widget's properties. - a - - - - - - - Field - - System.UInt32 - - - - - The number of properties this widget has. - - - - Field @@ -98,5 +42,60 @@ + + + Method + + Glade.ChildInfo + + + + + + an object of type + Internal method + an object of type + This is an internal method and should not be used by user code. + + + + + Field + + System.UInt32 + + + + + The number of properties this widget has. + + + + + + + Property + + Glade.Property + + + The widget's properties. + a + + + + + + + Field + + Glade.ChildInfo + + + + Returns an empty + + + diff --git a/doc/en/Glade/FindInternalChildFunc.xml b/doc/en/Glade/FindInternalChildFunc.xml index 08a94ab25..e95a51521 100644 --- a/doc/en/Glade/FindInternalChildFunc.xml +++ b/doc/en/Glade/FindInternalChildFunc.xml @@ -2,20 +2,19 @@ glade-sharp - 2.12.0.0 Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. + + System.Delegate + To be added. To be added. To be added. Event handler. + To be added. this delegate is used for custom methods to find the internal children of a widget. - To be added. - - System.Delegate - diff --git a/doc/en/Glade/Global.xml b/doc/en/Glade/Global.xml index b8350fe8e..45e26293f 100644 --- a/doc/en/Glade/Global.xml +++ b/doc/en/Glade/Global.xml @@ -4,9 +4,12 @@ glade-sharp - 2.12.0.0 Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. + + System.Object + + Global API elements for Global class collects certain, commonly used funtions of the underlying libglade API @@ -18,11 +21,54 @@ Glade-sharp uses the functions to load Register custom properties to a widget Read enums/flags from strings present in .glade files Register widget with XML tree, read widget name from widget pointer - - System.Object - - + + + Constructor + + + + Default constructor + The Global class has only static functions, and no methods, +which make it redundant for us to normally create this object. + + + + + Method + + System.Int32 + + + + + + + a + a + This helper routine is designed to be used by widget build routines to convert the string representations of enumeration values found in the XML descriptions to the integer values that can be used to configure the widget. + a + The string is composed of string names or nicknames for various flags separated by '|'. + + + + + Method + + System.UInt32 + + + + + + + a + a + This helper routine is designed to be used by widget build routines to convert the string representations of flags values found in the XML descriptions to the integer values that can be used to configure the widget. + a + The string is composed of string names or nicknames for various flags separated by '|'. + + Method @@ -33,8 +79,8 @@ Glade-sharp uses the functions to load - Used to get the name of a widget that was generated by a object. a + Used to get the name of a widget that was generated by a object. a Get Widget Name of current widget. @@ -49,8 +95,8 @@ Glade-sharp uses the functions to load - This function is used to get the object that built this widget. a + This function is used to get the object that built this widget. a @@ -65,38 +111,12 @@ Glade-sharp uses the functions to load - Checks the version of a module. a + Checks the version of a module. a - - - Method - - System.Void - - - - - - this method allows you to override the default behaviour when a Custom widget is found in an interface. - the to use when a custom widget is found. - - - - - - Constructor - - - - Default constructor - The Global class has only static functions, and no methods, -which make it redundant for us to normally create this object. - - Method @@ -109,49 +129,13 @@ which make it redundant for us to normally create this object. - This method provides a way to register handlers for custom properties. the of the widget. the name of the custom property the to call when the property is found. + This method provides a way to register handlers for custom properties. Some properties are not (yet) handled through the GObject property code, so can not be handled by the generic code. This function provides a way to register handlers for these properties. Such handlers will apply for the GType type and all its descendants. - - - Method - - System.UInt32 - - - - - - - This helper routine is designed to be used by widget build routines to convert the string representations of flags values found in the XML descriptions to the integer values that can be used to configure the widget. - a - a - a - The string is composed of string names or nicknames for various flags separated by '|'. - - - - - Method - - System.Int32 - - - - - - - This helper routine is designed to be used by widget build routines to convert the string representations of enumeration values found in the XML descriptions to the integer values that can be used to configure the widget. - a - a - a - The string is composed of string names or nicknames for various flags separated by '|'. - - Method @@ -165,14 +149,34 @@ which make it redundant for us to normally create this object. - This method registers new construction methods for a widget type. the of a widget. the used to construct the widget. the used to construct the children or null. the to find the internal children or null. + This method registers new construction methods for a widget type. + + + Method + + System.Void + + + + + + the to use when a custom widget is found. + this method allows you to override the default behaviour when a Custom widget is found in an interface. + + + + + System.Obsolete("Replaced by Glade.XML.CustomHandler static property.") + + + diff --git a/doc/en/Glade/HandlerNotFoundException.xml b/doc/en/Glade/HandlerNotFoundException.xml index ae3e68edd..e8e1038d2 100644 --- a/doc/en/Glade/HandlerNotFoundException.xml +++ b/doc/en/Glade/HandlerNotFoundException.xml @@ -4,9 +4,13 @@ glade-sharp - 2.12.0.0 Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. + + System.SystemException + + + Exception thrown when signal autoconnection fails. This class is the expression thrown, when signal autoconnection fails. @@ -17,60 +21,19 @@ You can rectify this exception by adding the corresponding function in your code, and recompiling the application. - - System.SystemException - - - - - - Property - - System.Type - + + + Constructor + + + + + - The type of delegate that was supposed to be connected to the signal. - a - - - - - - - Property - - System.String - - - The name of the signal that was supposed to be connected. - a - - - - - - - Property - - System.String - - - The name of the handler that was supposed to be connected. - a - - - - - - - Property - - System.Reflection.EventInfo - - - Information about the event. - a + a + a + Protected constructor. @@ -86,27 +49,11 @@ your code, and recompiling the application. - Public constructor. a a a a - - - - - - - Constructor - - - - - - - Protected constructor. - a - a + Public constructor. @@ -123,12 +70,12 @@ your code, and recompiling the application. - Public constructor. a a a a a + Public constructor. @@ -154,5 +101,75 @@ your code, and recompiling the application. + + + Property + + System.Type + + + The type of delegate that was supposed to be connected to the signal. + a + + + + + + + Property + + System.Reflection.EventInfo + + + Information about the event. + a + + + + + + + Method + + System.Void + + + + + + + serialization info. + serialization context. + Gets object data. + + + + + + + Property + + System.String + + + The name of the handler that was supposed to be connected. + a + + + + + + + Property + + System.String + + + The name of the signal that was supposed to be connected. + a + + + + diff --git a/doc/en/Glade/Interface.xml b/doc/en/Glade/Interface.xml index 657545834..53bfc6539 100644 --- a/doc/en/Glade/Interface.xml +++ b/doc/en/Glade/Interface.xml @@ -4,46 +4,17 @@ glade-sharp - 2.12.0.0 Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - - The structures described here are the output of libglade's XML parser. - These structures are really only useful for people who are extending libglade to handle other widget sets, but it could also be useful for other applications that need to read glade XML files. If you only wish to use libglade, you don't need to worry about these functions and structures. - System.ValueType + + The structures described here are the output of libglade's XML parser. + These structures are really only useful for people who are extending libglade to handle other widget sets, but it could also be useful for other applications that need to read glade XML files. If you only wish to use libglade, you don't need to worry about these functions and structures. + - - - Field - - Glade.Interface - - - - Returns an empty - - - - - - Method - - Glade.Interface - - - - - - Internal method - an object of type - an object of type - This is an internal method and should not be used by user code. - - Method @@ -66,41 +37,25 @@ - This function dumps the contents of a into a file as XML. a + This function dumps the contents of a into a file as XML. It is intended mainly as a debugging tool. - - - Property + + + Method - Glade.WidgetInfo - - - The top-level widgets. - an object of type - - - - - - System.Obsolete("Replaced by Toplevels property") - - - - - - Field - - System.String + Glade.Interface + - To be added - - + an object of type + Internal method + an object of type + This is an internal method and should not be used by user code. @@ -131,8 +86,40 @@ + + + Field + + System.String + + + + + To be added + + + + + + + Property + + Glade.WidgetInfo + + + The top-level widgets. + an object of type + + + + + + System.Obsolete("Replaced by Toplevels property") + + + - + Property Glade.WidgetInfo[] @@ -143,5 +130,17 @@ + + + Field + + Glade.Interface + + + + Returns an empty + + + diff --git a/doc/en/Glade/NewFunc.xml b/doc/en/Glade/NewFunc.xml index a51b6a726..f133a6f22 100644 --- a/doc/en/Glade/NewFunc.xml +++ b/doc/en/Glade/NewFunc.xml @@ -2,20 +2,19 @@ glade-sharp - 2.12.0.0 Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. + + System.Delegate + To be added. To be added. To be added. Event handler. + To be added. this delegate is called used for custom methods to create widgets. - To be added. - - System.Delegate - diff --git a/doc/en/Glade/Parser.xml b/doc/en/Glade/Parser.xml index 15483c346..1cfce1e2d 100644 --- a/doc/en/Glade/Parser.xml +++ b/doc/en/Glade/Parser.xml @@ -4,9 +4,12 @@ glade-sharp - 2.12.0.0 Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. + + System.Object + + Glade's parser used to turn XML into its internal format. Parser class loads / parses the .glade files from memory [buffer], or a file in disk. @@ -16,27 +19,15 @@ its connections and properties etc. - - System.Object - - - - - Method - - Glade.Interface - - - - - + + + Constructor + + - This function parses a Glade XML interface file to a object (which is libglade's internal representation of the interface data). - a - a - a - Generally, user code will not need to call this function. Instead, it should go through the interfaces. + Default constructor + @@ -50,9 +41,9 @@ its connections and properties etc. - This function is similar to , except that it parses XML data from a buffer in memory. a a + This function is similar to , except that it parses XML data from a buffer in memory. a This could be used to embed an interface into the executable, for instance. @@ -60,14 +51,22 @@ Generally, user code will not need to call this function. Instead, it should go - - - Constructor - - + + + Method + + Glade.Interface + + + + + - Default constructor - + a + a + This function parses a Glade XML interface file to a object (which is libglade's internal representation of the interface data). + a + Generally, user code will not need to call this function. Instead, it should go through the interfaces. diff --git a/doc/en/Glade/Property.xml b/doc/en/Glade/Property.xml index d052d2d52..f38fdf96a 100644 --- a/doc/en/Glade/Property.xml +++ b/doc/en/Glade/Property.xml @@ -4,46 +4,17 @@ glade-sharp - 2.12.0.0 Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - - The structure is used as part of the output of libglade's XML parser. - A name-value pair. - System.ValueType + + The structure is used as part of the output of libglade's XML parser. + A name-value pair. + - - - Field - - Glade.Property - - - - Returns an empty - - - - - - Method - - Glade.Property - - - - - - Internal method - an object of type - an object of type - This is an internal method and should not be used by user code. - - Field @@ -58,6 +29,22 @@ + + + Method + + Glade.Property + + + + + + an object of type + Internal method + an object of type + This is an internal method and should not be used by user code. + + Field @@ -72,5 +59,17 @@ + + + Field + + Glade.Property + + + + Returns an empty + + + diff --git a/doc/en/Glade/SignalInfo.xml b/doc/en/Glade/SignalInfo.xml index 191fcf8c0..c5950c480 100644 --- a/doc/en/Glade/SignalInfo.xml +++ b/doc/en/Glade/SignalInfo.xml @@ -4,58 +4,29 @@ glade-sharp - 2.12.0.0 Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - - The structure is used as part of the output of libglade's XML parser. - - System.ValueType + + The structure is used as part of the output of libglade's XML parser. + + - - - Field + + + Property - Glade.SignalInfo + System.Boolean - - Returns an empty - - - - - - Method - - Glade.SignalInfo - - - - - - Internal method - an object of type - an object of type - This is an internal method and should not be used by user code. - - - - - Field - - System.String - - - To be added - - + a + To be added + @@ -72,6 +43,36 @@ + + + Field + + System.String + + + + + To be added + + + + + + + Method + + Glade.SignalInfo + + + + + + an object of type + Internal method + an object of type + This is an internal method and should not be used by user code. + + Field @@ -86,18 +87,16 @@ - - - Property + + + Field - System.Boolean + Glade.SignalInfo - To be added - a - To be added - + Returns an empty + diff --git a/doc/en/Glade/Standard.xml b/doc/en/Glade/Standard.xml index 27adbe772..e9865b77d 100644 --- a/doc/en/Glade/Standard.xml +++ b/doc/en/Glade/Standard.xml @@ -4,18 +4,27 @@ glade-sharp - 2.12.0.0 Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - - Some standard methods used by glade to build widgets. - - System.Object + + Some standard methods used by glade to build widgets. + + + + + Constructor + + + + Default constructor + + + Method @@ -28,23 +37,13 @@ - This is the standard child building function. a a a + This is the standard child building function. It simply calls on each child to add them to the parent, and process any packing properties using the generic container packing properties interfaces. - - - Constructor - - - - Default constructor - - - Method @@ -57,10 +56,10 @@ - This is the standard widget building function. a a a + This is the standard widget building function. a It processes all the widget properties using the standard object properties interfaces. This function will be sufficient for most widget types, thus reducing the amount of work needed to wrap a library. diff --git a/doc/en/Glade/WidgetAttribute.xml b/doc/en/Glade/WidgetAttribute.xml index 6a480197f..461709314 100644 --- a/doc/en/Glade/WidgetAttribute.xml +++ b/doc/en/Glade/WidgetAttribute.xml @@ -4,9 +4,17 @@ glade-sharp - 2.12.0.0 Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details. + + System.Attribute + + + + + System.AttributeUsage(System.AttributeTargets.Field) + + Marks a widget for auto-binding @@ -33,41 +41,7 @@ - - System.Attribute - - - - - System.AttributeUsage(System.AttributeTargets.Field) - - - - - Constructor - - - - - Flags a to be auto-connected - The name of the widget in the Glade file - that this widget should be mapped to - - - This will bind the widget whose name in the Glade - designer is to the field that - the attribute is attached to. If the field name is the - same as the widget name in the Glade designer, you can - avoid the name parameter. - - - For the binding to take place, the method has to be invoked - on either the class or the instance. - - - - Constructor @@ -90,8 +64,46 @@ + + + Constructor + + + + + The name of the widget in the Glade file + that this widget should be mapped to + Flags a to be auto-connected + + + This will bind the widget whose name in the Glade + designer is to the field that + the attribute is attached to. If the field name is the + same as the widget name in the Glade designer, you can + avoid the name parameter. + + + For the binding to take place, the method has to be invoked + on either the class or the instance. + + + + + + + Property + + System.String + + + The name of the widget targetted + The name of the widget targeted in the Glade + definition file. + + + - + Property System.Boolean @@ -104,18 +116,5 @@ - - - Property - - System.String - - - The name of the widget targetted - The name of the widget targeted in the Glade - definition file. - - - diff --git a/doc/en/Glade/WidgetInfo.xml b/doc/en/Glade/WidgetInfo.xml index ec400d652..2675107b8 100644 --- a/doc/en/Glade/WidgetInfo.xml +++ b/doc/en/Glade/WidgetInfo.xml @@ -4,61 +4,19 @@ glade-sharp - 2.12.0.0 Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - - The structures described here are the output of libglade's XML parser. - These structures are really only useful for people who are extending libglade to handle other widget sets, but it could also be useful for other applications that need to read glade XML files. If you only wish to use libglade, you don't need to worry about these functions and structures. - System.ValueType + + The structures described here are the output of libglade's XML parser. + These structures are really only useful for people who are extending libglade to handle other widget sets, but it could also be useful for other applications that need to read glade XML files. If you only wish to use libglade, you don't need to worry about these functions and structures. + - - - Field - - Glade.WidgetInfo - - - - Returns an empty - - - - - - Method - - Glade.WidgetInfo - - - - - - Internal method - an object of type - an object of type - This is an internal method and should not be used by user code. - - - - - Property - - Glade.ChildInfo - - - Details about child widgets. - a - - - - - + Property Glade.AccelInfo @@ -70,21 +28,8 @@ - - - Property - - Glade.AtkRelationInfo - - - Details about this widget's relations. - a - - - - - + Property Glade.AtkActionInfo @@ -96,21 +41,8 @@ - - - Property - - Glade.SignalInfo - - - To be added - a - - - - - + Property Glade.Property @@ -122,28 +54,15 @@ - - + + Property - Glade.Property + Glade.ChildInfo - To be added - a - - - - - - - Property - - Glade.WidgetInfo - - - This widget's parent widget. - a + Details about child widgets. + a @@ -162,90 +81,6 @@ - - - Field - - System.String - - - - - This widget's name. - - - - - - - Field - - System.UInt32 - - - - - The number of properties this widget has. - - - - - - - Field - - System.UInt32 - - - - - The number of AtkProperties this widget has. - - - - - - - Field - - System.UInt32 - - - - - The number of signals this widget connects to. - - - - - - - Field - - System.UInt32 - - - - - To be added - - - - - - - Field - - System.UInt32 - - - - - To be added - - - - Field @@ -260,6 +95,48 @@ + + + Field + + System.String + + + + + This widget's name. + + + + + + + Field + + System.UInt32 + + + + + To be added + + + + + + + Field + + System.UInt32 + + + + + The number of AtkProperties this widget has. + + + + Field @@ -274,5 +151,127 @@ + + + Method + + Glade.WidgetInfo + + + + + + an object of type + Internal method + an object of type + This is an internal method and should not be used by user code. + + + + + Field + + System.UInt32 + + + + + The number of properties this widget has. + + + + + + + Field + + System.UInt32 + + + + + To be added + + + + + + + Field + + System.UInt32 + + + + + The number of signals this widget connects to. + + + + + + + Property + + Glade.WidgetInfo + + + This widget's parent widget. + a + + + + + + + Property + + Glade.Property + + + To be added + a + + + + + + + Property + + Glade.AtkRelationInfo + + + Details about this widget's relations. + a + + + + + + + Property + + Glade.SignalInfo + + + To be added + a + + + + + + + Field + + Glade.WidgetInfo + + + + Returns an empty + + + diff --git a/doc/en/Glade/XML.xml b/doc/en/Glade/XML.xml index 77fc24e27..6cacd7654 100644 --- a/doc/en/Glade/XML.xml +++ b/doc/en/Glade/XML.xml @@ -4,9 +4,13 @@ glade-sharp - 2.12.0.0 Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. + + GLib.Object + + + Allows dynamic loading of user interfaces from XML descriptions @@ -64,142 +68,160 @@ public class GladeApp - - GLib.Object - - - - - - System.Reflection.DefaultMember("Item") - - - - - Method - - Glade.XML - + + + Constructor + - + - Get the parent widget - a - - the object that built , or if is not built from Glade - + a + Protected Constructor. + Chain to this constructor if you have manually registered a native value for your subclass. + + + + System.Obsolete + + + + + + Constructor + + + + + + Pointer to the C object. + Internal constructor + + This is an internal constructor, and should not be used by user code. + + + + + + Constructor + + + + + + + a + a + Creates an Glade.XML object from a resource and root object. + This is a convenience overload for with the 1st and 4th arguments being . + + + + + Constructor + + + + + + + + a + + the widget node to start building from, or . + + + the translation domain for the XML file + ( is the default) + + + Creates an object from a + - - - Method - - System.String - + + + Constructor + - + + + - Gets the name of a Glade-built widget - a built from Glade - the name of the + the filename + + the widget node to start building from, or . + + + the translation domain for the XML file + ( is the default) + + Creates an from a file - - - Property - - Glade.XMLCustomWidgetHandler - - - Allows you to override the default behaviour when a Custom widget is found in an interface. - a - - - Setting this property 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 - - - - - - - - Method - - System.Void - + + + Constructor + - + + + + - Deprecated: Replaced by the property. - the custom widget handler - Deprecated: Replaced by the property. - - - - - Method - - System.Void - - - - - - To be added - an object of type + + an , or + to use the current assembly + + the name of the resource in + + the widget node to start building from, or . + + + the translation domain for the XML file + ( is the default) + + + Creates an object from an + - - - Method - - System.Void - + + + Constructor + - + + + + - Binds the widgets declared in the Glade interface specification, to argument's suitable fields. These fields should be marked with the attributes. Any signal declared in the interface specification should be connected using (for detailed control of signal connection) or , the mirror image -of this method. - The object whose fields are to be bound to the object + + a string containing the content of the glade XML file + + the length of + + the widget node to start building from, or . + + + the translation domain for the XML file + ( is the default) + + Creates an object from a buffer - - - Method - - System.Void - - - - - - Automatically connect signals - a with handler methods - - - Connects the signals defined in the glade file with static handler methods provided by the given , - . - - - - Method @@ -210,8 +232,8 @@ of this method. - Automatically connect signals an with handler methods + Automatically connect signals Connects the signals definied in the glade file with static handler methods provided by the given object, . @@ -219,149 +241,55 @@ of this method. - - + + Method System.Void - - + - - 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. - - - - - - - Method - - System.Void - - - - - - - - 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. - - - - - - - Method - - System.Void - - - + a with handler methods Automatically connect signals - This method uses gmodule's introspective features to look - at the application's symbol table. From here it tries to - match the signal handler names given in the interface - description with symbols in the application and connects - the signals. - + Connects the signals defined in the glade file with static handler methods provided by the given , + . + - - - Method - - System.Boolean - - - - - - - - - This routine can be used by bindings (such as gtk--) to help - construct a object, if it is - needed. - - the XML filename - the root widget node, or - the translation domain, or - - if construction succeeded - - - - - - - Method - - Gtk.AccelGroup - - - - - This function is used to get the current - . If there isn't one, a new one - is created and bound to the current toplevel window (if a - toplevel has been set). - - the current - - - - - - + + Method System.Void - - - - + - - This sets the packing property on container of widget with - to - the container widget. - the contained child - the name of the property - its stringified value + The object whose fields are to be bound to the object + Binds the widgets declared in the Glade interface specification, to argument's suitable fields. These fields should be marked with the attributes. Any signal declared in the interface specification should be connected using (for detailed control of signal connection) or , the mirror image +of this method. + + + + + + + Method + + System.Void + + + + + + an object of type + To be added @@ -376,11 +304,11 @@ of this method. + the structure for the widget. This function is not intended for people who just use libglade. - the structure for the widget. the newly created widget. @@ -402,451 +330,32 @@ of this method. - - - Method - - System.String - - - - - - - This function resolves a relative pathname, using the - directory of the XML file as a base. - - a filename - The absolute filename - - - This function resolves a relative pathname, using the - directory of the XML file as a base. If the pathname is - absolute, then the original filename is returned. - - - - - - - Method - - System.Void - - - - - - - This function is similar to - except that it will try to connect all signals in the - interface, not just a single named handler. It can be - thought of the interpeted language binding version of - , except that it does not - require gmodule to function correctly. - - the function used to connect the signals. - - - - - - - Method - - System.Void - - - - - - - - Used to set properties on s - the property the widget to set the property on. - the name of the property. - the name of the widget used as the value for the property. - - - Some widgets have properties of type . These are - represented as the widget name in the glade file. When - constructing the interface, the widget specified as the - value for a property may not exist yet. - - - Rather than setting the property directly, this function - should be used. It will perform the name to conversion, - and if the widget is yet to be constructed, defer setting the - property until the widget is constructed. - - - - - - - Method - - Gtk.Widget - - - - - - - Retrieves a widget stored in the by name - - the name of the widget to retrieve from the xml file - - the widget specified by or - if no Widgets of that name exists - - - - - - - + + Method System.Boolean - - - - - - - GParamSpec needs to be wrapped - a " /> - a - a - a - - - - - - - Method - - System.Void - - - - - - - - This function is similar to , except - that it allows you to give an arbitrary function that will - be used for actually connecting the signals. This is mainly - useful for writers of interpreted language bindings, or - applications where you need more control over the signal - connection process. - - the name of the signal handler that we want to connect. - the function to use to connect the signals. - - - - - - - Constructor - - - - - - Internal constructor - Pointer to the C object. - - This is an internal constructor, and should not be used by user code. - - - - - - Constructor - - Creates an from a file - the filename - - the widget node to start building from, or . - - - the translation domain for the XML file - ( is the default) - - - - - - - - Constructor - - - - - - - - - Creates an object from a buffer - - a string containing the content of the glade XML file - - the length of - - the widget node to start building from, or . - - - the translation domain for the XML file - ( is the default) - - - - - - - - Property - - System.String - - - the filename of the object - the filename that this Glade XML object is created from - - - - - - - Property - - Gtk.Window - - - - + the XML filename + the root widget node, or + the translation domain, or - This is used while the tree is being built to set the toplevel window that - is currently being built. + This routine can be used by bindings (such as gtk--) to help + construct a object, if it is + needed. - an object of type - - - This is used while the tree is being built to set the - toplevel window that is currently being built. It is - mainly used to enable 's to be bound to the - correct window, but could have other uses. - - - - - - - Constructor - - - - - - - - - Creates an object from a - - a - - the widget node to start building from, or . - - - the translation domain for the XML file - ( is the default) - + + if construction succeeded - - - Constructor - - - - - - - - - - Creates an object from an - - - an , or - to use the current assembly - - the name of the resource in - - the widget node to start building from, or . - - - the translation domain for the XML file - ( is the default) - - - - - - - - Method - - Glade.XML - - - - - - - - Creates a new from a stream. - a - a - a - a - Reads the contents of the stream and parses it. It must be in correct Glade format - - - - - Method - - Glade.XML - - - - - - - - - Returns a new from a resource in an assembly. - a - a - a - a - a - Reads the contents of the resource in the given assembly and parses it. If the assembly is null, the current assembly will be used. It must be in correct Glade format - - - - - Method - - Glade.XML - - - - - - - - Returns a new from a resource in the current assembly. - a - a - a - a - Reads the contents of the resource in the current assembly and parses it. If the assembly is null, the current assembly will be used. It must be in correct Glade format - - - - - Property - - GLib.GType - - - - GType Property. - a - Returns the native value for . - - - - - Constructor - - - - - - Protected Constructor. - a - Chain to this constructor if you have manually registered a native value for your subclass. - - - - System.Obsolete - - - - - - Method - - Gtk.Widget[] - - - - - - Retrieves a of widgets whose name share the same prefix. - The beginning of a widget name. - An array of widgets whose name starts with . - - - - - - Constructor - - - - - - - Creates an Glade.XML object from a resource and root object. - a - a - This is a convenience overload for with the 1st and 4th arguments being . - - - - - Property - - Gtk.Widget - - - - - - To be added. - To be added. - To be added. - To be added. - - Method @@ -870,5 +379,495 @@ of this method. + + + Property + + Glade.XMLCustomWidgetHandler + + + Allows you to override the default behaviour when a Custom widget is found in an interface. + a + + + Setting this property 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 + + + + + + + + Method + + Gtk.AccelGroup + + + + + This function is used to get the current + . If there isn't one, a new one + is created and bound to the current toplevel window (if a + toplevel has been set). + + the current + + + + + + + Property + + System.String + + + the filename of the object + the filename that this Glade XML object is created from + + + + + + + Method + + Glade.XML + + + + + + + + a + a + a + Returns a new from a resource in the current assembly. + a + Reads the contents of the resource in the current assembly and parses it. If the assembly is null, the current assembly will be used. It must be in correct Glade format + + + + + Method + + Glade.XML + + + + + + + + + a + a + a + a + Returns a new from a resource in an assembly. + a + Reads the contents of the resource in the given assembly and parses it. If the assembly is null, the current assembly will be used. It must be in correct Glade format + + + + + Method + + Glade.XML + + + + + + + + a + a + a + Creates a new from a stream. + a + Reads the contents of the stream and parses it. It must be in correct Glade format + + + + + Method + + Gtk.Widget + + + + + + the name of the widget to retrieve from the xml file + + Retrieves a widget stored in the by name + + + the widget specified by or + if no Widgets of that name exists + + + + + + + + Method + + System.String + + + + + + a built from Glade + Gets the name of a Glade-built widget + the name of the + + + + + + + Method + + Gtk.Widget[] + + + + + + The beginning of a widget name. + Retrieves a of widgets whose name share the same prefix. + An array of widgets whose name starts with . + + + + + + Method + + Glade.XML + + + + + + a + Get the parent widget + + the object that built , or if is not built from Glade + + + + + + + + Property + + GLib.GType + + + + GType Property. + a + Returns the native value for . + + + + + Method + + System.Void + + + + + + + the parent widget + the structure for the child + + This function is intended to be called by the build_children + callback for container widgets. + + + + 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. + + + + + + + Method + + System.Void + + + + + + + + the property the widget to set the property on. + the name of the property. + the name of the widget used as the value for the property. + Used to set properties on s + + + Some widgets have properties of type . These are + represented as the widget name in the glade file. When + constructing the interface, the widget specified as the + value for a property may not exist yet. + + + Rather than setting the property directly, this function + should be used. It will perform the name to conversion, + and if the widget is yet to be constructed, defer setting the + property until the widget is constructed. + + + + + + + Property + + Gtk.Widget + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + Method + + System.String + + + + + + a filename + + This function resolves a relative pathname, using the + directory of the XML file as a base. + + The absolute filename + + + This function resolves a relative pathname, using the + directory of the XML file as a base. If the pathname is + absolute, then the original filename is returned. + + + + + + + Method + + System.Void + + + + + + + the widget to set parameters on + the structure for + + Sets the common parameters on a widget, and is responsible for + inserting it into the object's internal structures. + + + + 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. + + + + + + + Method + + System.Void + + + + + + the custom widget handler + Deprecated: Replaced by the property. + Deprecated: Replaced by the property. + + + + System.Obsolete("Replaced by CustomHandler property.") + + + + + + Method + + System.Void + + + + + + + + + the container widget. + the contained child + the name of the property + its stringified value + + This sets the packing property on container of widget with + to + + + + + + + Method + + System.Boolean + + + + + + + + a " /> + a + a + GParamSpec needs to be wrapped + a + + + + + + + Method + + System.Void + + + + Automatically connect signals + + + This method uses gmodule's introspective features to look + at the application's symbol table. From here it tries to + match the signal handler names given in the interface + description with symbols in the application and connects + the signals. + + + + + + + Method + + System.Void + + + + + + the function used to connect the signals. + + This function is similar to + except that it will try to connect all signals in the + interface, not just a single named handler. It can be + thought of the interpeted language binding version of + , except that it does not + require gmodule to function correctly. + + + + + + + + Method + + System.Void + + + + + + + the name of the signal handler that we want to connect. + the function to use to connect the signals. + + This function is similar to , except + that it allows you to give an arbitrary function that will + be used for actually connecting the signals. This is mainly + useful for writers of interpreted language bindings, or + applications where you need more control over the signal + connection process. + + + + + + + + Property + + Gtk.Window + + + + + + This is used while the tree is being built to set the toplevel window that + is currently being built. + + an object of type + + + This is used while the tree is being built to set the + toplevel window that is currently being built. It is + mainly used to enable 's to be bound to the + correct window, but could have other uses. + + + + diff --git a/doc/en/Glade/XMLConnectFunc.xml b/doc/en/Glade/XMLConnectFunc.xml index 7b6403e2e..c4340b471 100644 --- a/doc/en/Glade/XMLConnectFunc.xml +++ b/doc/en/Glade/XMLConnectFunc.xml @@ -2,9 +2,11 @@ glade-sharp - 2.12.0.0 Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. + + System.Delegate + To be added. To be added. @@ -15,9 +17,6 @@ Event handler. this delegate is used for custom methods to connect the signals to methods. - - System.Delegate - diff --git a/doc/en/Glade/XMLCustomWidgetHandler.xml b/doc/en/Glade/XMLCustomWidgetHandler.xml index 9a27a4cb2..2e1fa8e32 100644 --- a/doc/en/Glade/XMLCustomWidgetHandler.xml +++ b/doc/en/Glade/XMLCustomWidgetHandler.xml @@ -2,9 +2,11 @@ glade-sharp - 2.12.0.0 Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. + + System.Delegate + To be added. To be added. @@ -14,6 +16,7 @@ To be added. To be added. Event handler. + To be added. this delegate is used for custom methods to call when a custom widget is found. @@ -44,11 +47,7 @@ public class View{ } - To be added. - - System.Delegate - diff --git a/doc/en/ns-Glade.xml b/doc/en/ns-Glade.xml new file mode 100644 index 000000000..c9a25d21d --- /dev/null +++ b/doc/en/ns-Glade.xml @@ -0,0 +1,16 @@ + + + + User interface loading at runtime. + + + + The Glade classes give applications the ability to load user + interfaces from XML files at runtime. These interface files + can be created with the Glade user interface builder. The + Glade classes are also capable of automatically connecting + handlers to the signals defined in the interface file. + + + + \ No newline at end of file