Added some documentation for Glade.XML.
svn path=/trunk/gtk-sharp/; revision=16802
This commit is contained in:
Duncan Mak
parent
a97a5d52fa
commit
28a41ea3c7
2 changed files with 152 additions and 103 deletions
|
|
@ -1,3 +1,7 @@
|
||||||
|
2003-07-28 Duncan Mak <duncan@ximian.com>
|
||||||
|
|
||||||
|
* en/Glade/XML.xml: Added some documentation.
|
||||||
|
|
||||||
2003-07-27 John Luke <jluke@cfl.rr.com>
|
2003-07-27 John Luke <jluke@cfl.rr.com>
|
||||||
|
|
||||||
* en/Gtk/CheckButton.xml: add small example, update
|
* en/Gtk/CheckButton.xml: add small example, update
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
<Type Name="XML" FullName="Glade.XML">
|
<Type Name="XML" FullName="Glade.XML">
|
||||||
<TypeSignature Language="C#" Value="public class XML : GLib.Object, IWrapper, IDisposable" Maintainer="auto" />
|
<TypeSignature Language="C#" Value="public class XML : GLib.Object, IWrapper, IDisposable" Maintainer="duncan" />
|
||||||
<AssemblyInfo>
|
<AssemblyInfo>
|
||||||
<AssemblyName>glade-sharp</AssemblyName>
|
<AssemblyName>glade-sharp</AssemblyName>
|
||||||
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
||||||
|
|
@ -7,8 +7,8 @@
|
||||||
</AssemblyInfo>
|
</AssemblyInfo>
|
||||||
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
|
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Allows dynamic loading of user interfaces from XML descriptions</summary>
|
||||||
<remarks>To be added</remarks>
|
<remarks></remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
<Base>
|
<Base>
|
||||||
<BaseTypeName>GLib.Object</BaseTypeName>
|
<BaseTypeName>GLib.Object</BaseTypeName>
|
||||||
|
|
@ -33,10 +33,12 @@
|
||||||
<Parameter Name="w" Type="Gtk.Widget" />
|
<Parameter Name="w" Type="Gtk.Widget" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Get the parent <see cref="T:Glade.XML" /> widget</summary>
|
||||||
<param name="w">To be added: an object of type 'Gtk.Widget'</param>
|
<param name="w">a <see cref="T:Gtk.Widget" /></param>
|
||||||
<returns>To be added: an object of type 'Glade.XML'</returns>
|
<returns>
|
||||||
<remarks>To be added</remarks>
|
the <see cref="T:Glade.XML" /> object that built <see paramref="w" />, or <see langword="null" /> if <see paramref="w" /> is not built from Glade
|
||||||
|
</returns>
|
||||||
|
<remarks></remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="GetWidgetName">
|
<Member MemberName="GetWidgetName">
|
||||||
|
|
@ -49,10 +51,10 @@
|
||||||
<Parameter Name="w" Type="Gtk.Widget" />
|
<Parameter Name="w" Type="Gtk.Widget" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Gets the name of a Glade-built widget</summary>
|
||||||
<param name="w">To be added: an object of type 'Gtk.Widget'</param>
|
<param name="w">a <see cref="T:Gtk.Widget" /> built from Glade</param>
|
||||||
<returns>To be added: an object of type 'string'</returns>
|
<returns>the name of the <see paramref="w" /></returns>
|
||||||
<remarks>To be added</remarks>
|
<remarks></remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="SetCustomHandler">
|
<Member MemberName="SetCustomHandler">
|
||||||
|
|
@ -65,9 +67,20 @@
|
||||||
<Parameter Name="handler" Type="Glade.XMLCustomWidgetHandler" />
|
<Parameter Name="handler" Type="Glade.XMLCustomWidgetHandler" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>
|
||||||
<param name="handler">To be added: an object of type 'Glade.XMLCustomWidgetHandler'</param>
|
This function allows you to override the default behaviour
|
||||||
<remarks>To be added</remarks>
|
when a Custom widget is found in an interface.
|
||||||
|
</summary>
|
||||||
|
<param name="handler">the custom widget handler</param>
|
||||||
|
<remarks>
|
||||||
|
<para>
|
||||||
|
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
|
||||||
|
</para>
|
||||||
|
</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="BindFields">
|
<Member MemberName="BindFields">
|
||||||
|
|
@ -110,9 +123,14 @@
|
||||||
<Parameter Name="handler_class" Type="System.Type" />
|
<Parameter Name="handler_class" Type="System.Type" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Automatically connect signals</summary>
|
||||||
<param name="handler_class">To be added: an object of type 'Type'</param>
|
<param name="handler_class">a <see cref="T:System.Type" /> with handler methods</param>
|
||||||
<remarks>To be added</remarks>
|
<remarks>
|
||||||
|
<para>
|
||||||
|
Connects the signals defined in the glade file with static handler methods provided by the given <see cref="T:System.Type" />,
|
||||||
|
<see paramref="handler_class" />.
|
||||||
|
</para>
|
||||||
|
</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="Autoconnect">
|
<Member MemberName="Autoconnect">
|
||||||
|
|
@ -125,9 +143,13 @@
|
||||||
<Parameter Name="handler" Type="System.Object" />
|
<Parameter Name="handler" Type="System.Object" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Automatically connect signals</summary>
|
||||||
<param name="handler">To be added: an object of type 'object'</param>
|
<param name="handler">an <see cref="T:System.Object" /> with handler methods</param>
|
||||||
<remarks>To be added</remarks>
|
<remarks>
|
||||||
|
<para>
|
||||||
|
Connects the signals definied in the glade file with static handler methods provided by the given object, <see paramref="handler" />.
|
||||||
|
</para>
|
||||||
|
</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="SetCommonParams">
|
<Member MemberName="SetCommonParams">
|
||||||
|
|
@ -141,10 +163,22 @@
|
||||||
<Parameter Name="info" Type="Glade.WidgetInfo" />
|
<Parameter Name="info" Type="Glade.WidgetInfo" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>
|
||||||
<param name="widget">To be added: an object of type 'Gtk.Widget'</param>
|
Sets the common parameters on a widget, and is responsible for
|
||||||
<param name="info">To be added: an object of type 'Glade.WidgetInfo'</param>
|
inserting it into the <see cref="T:Glade.XML" /> object's internal structures.
|
||||||
<remarks>To be added</remarks>
|
</summary>
|
||||||
|
<param name="widget">the widget to set parameters on</param>
|
||||||
|
<param name="info">the <see cref="T:Glade.WidgetInfo" /> structure for <see paramref="widget" /></param>
|
||||||
|
<remarks>
|
||||||
|
<para>
|
||||||
|
Sets the common parameters on <see cref="widget" />, and is responsible
|
||||||
|
for inserting it into the <see cref="T:Glade.XML" /> object's internal
|
||||||
|
structures. It will also add the children to this widget.
|
||||||
|
Usually this function is only called by
|
||||||
|
<see cref="T:Glade.XML.BuildWidget(Glade.WidgetInfo)" />, but is exposed for difficult
|
||||||
|
cases, such as setting up <see cref="T:Gtk.Toolbar" /> buttons and the like.
|
||||||
|
</para>
|
||||||
|
</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="HandleInternalChild">
|
<Member MemberName="HandleInternalChild">
|
||||||
|
|
@ -158,10 +192,22 @@
|
||||||
<Parameter Name="child_info" Type="Glade.ChildInfo" />
|
<Parameter Name="child_info" Type="Glade.ChildInfo" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>
|
||||||
<param name="parent">To be added: an object of type 'Gtk.Widget'</param>
|
This function is intended to be called by the build_children
|
||||||
<param name="child_info">To be added: an object of type 'Glade.ChildInfo'</param>
|
callback for container widgets.
|
||||||
<remarks>To be added</remarks>
|
</summary>
|
||||||
|
<param name="parent">the parent widget</param>
|
||||||
|
<param name="child_info">the <see cref="T:Glade.ChildInfo" /> structure for the child</param>
|
||||||
|
<remarks>
|
||||||
|
<para>
|
||||||
|
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.
|
||||||
|
</para>
|
||||||
|
</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="SignalAutoconnect">
|
<Member MemberName="SignalAutoconnect">
|
||||||
|
|
@ -484,8 +530,7 @@
|
||||||
<ReturnValue>
|
<ReturnValue>
|
||||||
<ReturnType>Gtk.Window</ReturnType>
|
<ReturnType>Gtk.Window</ReturnType>
|
||||||
</ReturnValue>
|
</ReturnValue>
|
||||||
<Parameters>
|
<Parameters></Parameters>
|
||||||
</Parameters>
|
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>To be added</summary>
|
||||||
<param name="value">To be added: an object of type 'Gtk.Window'</param>
|
<param name="value">To be added: an object of type 'Gtk.Window'</param>
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue