From de7ee8c8964ef9d2a9f8a4fde1cc3fe83ae1865a Mon Sep 17 00:00:00 2001 From: Miguel de Icaza Date: Tue, 15 Apr 2003 06:11:12 +0000 Subject: [PATCH] 2003-04-15 Miguel de Icaza * en/Glade/WidgetAttribute.cs: Add docs. svn path=/trunk/gtk-sharp/; revision=13641 --- doc/ChangeLog | 4 + doc/en/Glade/WidgetAttribute.xml | 135 +++++++++++++++++++++---------- 2 files changed, 98 insertions(+), 41 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index df08702d7..4b5ba28de 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2003-04-15 Miguel de Icaza + + * en/Glade/WidgetAttribute.cs: Add docs. + 2003-04-14 Lee Mallabone * en/Gtk/Adjustment.xml: Add sane docs to ClampPage, based on the diff --git a/doc/en/Glade/WidgetAttribute.xml b/doc/en/Glade/WidgetAttribute.xml index d27f1ebf6..c2dc1afa8 100644 --- a/doc/en/Glade/WidgetAttribute.xml +++ b/doc/en/Glade/WidgetAttribute.xml @@ -1,5 +1,5 @@ - + glade-sharp @@ -9,13 +9,37 @@ Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details. - To be added - To be added + Marks a widget for auto-binding + + + This attribute when attached to a field value is used by the + Autoconnect functionality in to bind a + widget created by Glade to the field. + + + The attribute can be applied to any widgets (widgets derive + from the class) and it can be + applied to static and instance fields. + + + By default the runtime will match the tagged field name with + the name that was given to the widget on the Glade user + interface designer. An optional string argument can be + provided on the constructor to bind the widget to a different + name. + + + For the binding to take place, the method has to be invoked + on either the class or the instance. + + System.Attribute - + + System.AttributeUsageAttribute @@ -24,52 +48,81 @@ - Constructor - - - - - - To be added - To be added: an object of type 'string' - To be added: an object of type 'Glade.WidgetAttribute' - To be added - + 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 - - - - To be added - To be added: an object of type 'Glade.WidgetAttribute' - To be added - + Constructor + + + + Flags a to be auto-connected + + + This will bind the widget whose name in the Glade + designer is the same as the field name. If you want to + target a different widget in the glade file, use the + + attribute instead. + + + For the binding to take place, the method has to be invoked + on either the class or the instance. + + + - Property - - System.Boolean - - - To be added - To be added: an object of type 'bool' - To be added - + Property + + System.Boolean + + + Whether a specific binding was requsted + This returns if a specific + widget name was requested to be bound, or if the runtime has to use the field name + as the Glade name. + + - Property - - System.String - - - To be added - To be added: an object of type 'string' - To be added - + Property + + System.String + + + The name of the widget targetted + The name of the widget targeted in the Glade + definition file. + + \ No newline at end of file