ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added some documentation for Glade.XML.

Browse source 
svn path=/trunk/gtk-sharp/; revision=16802
This commit is contained in:
Duncan Mak 2003-07-28 23:14:43 +00:00
parent a97a5d52fa
commit 28a41ea3c7
2 changed files with 152 additions and 103 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/ChangeLog
View file

@ -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

251
doc/en/Glade/XML.xml
View file

@ -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>
@ -30,13 +30,15 @@
<ReturnType>Glade.XML</ReturnType> <ReturnType>Glade.XML</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters> <Parameters>
<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">
@ -46,13 +48,13 @@
<ReturnType>System.String</ReturnType> <ReturnType>System.String</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters> <Parameters>
<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">
@ -62,12 +64,23 @@
<ReturnType>System.Void</ReturnType> <ReturnType>System.Void</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters> <Parameters>
<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">
@ -77,8 +90,8 @@
<ReturnType>System.Void</ReturnType> <ReturnType>System.Void</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters> <Parameters>
<Parameter Name="type" Type="System.Type" /> <Parameter Name="type" Type="System.Type" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="type">To be added: an object of type 'Type'</param> <param name="type">To be added: an object of type 'Type'</param>
@ -92,8 +105,8 @@
<ReturnType>System.Void</ReturnType> <ReturnType>System.Void</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters> <Parameters>
<Parameter Name="target" Type="System.Object" /> <Parameter Name="target" Type="System.Object" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="target">To be added: an object of type 'object'</param> <param name="target">To be added: an object of type 'object'</param>
@ -107,12 +120,17 @@
<ReturnType>System.Void</ReturnType> <ReturnType>System.Void</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters> <Parameters>
<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">
@ -122,12 +140,16 @@
<ReturnType>System.Void</ReturnType> <ReturnType>System.Void</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters> <Parameters>
<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">
@ -137,14 +159,26 @@
<ReturnType>System.Void</ReturnType> <ReturnType>System.Void</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters> <Parameters>
<Parameter Name="widget" Type="Gtk.Widget" /> <Parameter Name="widget" Type="Gtk.Widget" />
<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">
@ -154,14 +188,26 @@
<ReturnType>System.Void</ReturnType> <ReturnType>System.Void</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters> <Parameters>
<Parameter Name="parent" Type="Gtk.Widget" /> <Parameter Name="parent" Type="Gtk.Widget" />
<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">
@ -183,10 +229,10 @@
<ReturnType>System.Boolean</ReturnType> <ReturnType>System.Boolean</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters> <Parameters>
<Parameter Name="fname" Type="System.String" /> <Parameter Name="fname" Type="System.String" />
<Parameter Name="root" Type="System.String" /> <Parameter Name="root" Type="System.String" />
<Parameter Name="domain" Type="System.String" /> <Parameter Name="domain" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="fname">To be added: an object of type 'string'</param> <param name="fname">To be added: an object of type 'string'</param>
@ -216,11 +262,11 @@
<ReturnType>System.Void</ReturnType> <ReturnType>System.Void</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters> <Parameters>
<Parameter Name="parent" Type="Gtk.Widget" /> <Parameter Name="parent" Type="Gtk.Widget" />
<Parameter Name="child" Type="Gtk.Widget" /> <Parameter Name="child" Type="Gtk.Widget" />
<Parameter Name="name" Type="System.String" /> <Parameter Name="name" Type="System.String" />
<Parameter Name="value" Type="System.String" /> <Parameter Name="value" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="parent">To be added: an object of type 'Gtk.Widget'</param> <param name="parent">To be added: an object of type 'Gtk.Widget'</param>
@ -237,8 +283,8 @@
<ReturnType>Gtk.Widget</ReturnType> <ReturnType>Gtk.Widget</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters> <Parameters>
<Parameter Name="info" Type="Glade.WidgetInfo" /> <Parameter Name="info" Type="Glade.WidgetInfo" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="info">To be added: an object of type 'Glade.WidgetInfo'</param> <param name="info">To be added: an object of type 'Glade.WidgetInfo'</param>
@ -253,8 +299,8 @@
<ReturnType>System.String</ReturnType> <ReturnType>System.String</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters> <Parameters>
<Parameter Name="filename" Type="System.String" /> <Parameter Name="filename" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="filename">To be added: an object of type 'string'</param> <param name="filename">To be added: an object of type 'string'</param>
@ -269,8 +315,8 @@
<ReturnType>System.Void</ReturnType> <ReturnType>System.Void</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters> <Parameters>
<Parameter Name="func" Type="Glade.XMLConnectFunc" /> <Parameter Name="func" Type="Glade.XMLConnectFunc" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="func">To be added: an object of type 'Glade.XMLConnectFunc'</param> <param name="func">To be added: an object of type 'Glade.XMLConnectFunc'</param>
@ -284,10 +330,10 @@
<ReturnType>System.Void</ReturnType> <ReturnType>System.Void</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters> <Parameters>
<Parameter Name="widget" Type="Gtk.Widget" /> <Parameter Name="widget" Type="Gtk.Widget" />
<Parameter Name="prop_name" Type="System.String" /> <Parameter Name="prop_name" Type="System.String" />
<Parameter Name="value_name" Type="System.String" /> <Parameter Name="value_name" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="widget">To be added: an object of type 'Gtk.Widget'</param> <param name="widget">To be added: an object of type 'Gtk.Widget'</param>
@ -303,8 +349,8 @@
<ReturnType>GLib.List</ReturnType> <ReturnType>GLib.List</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters> <Parameters>
<Parameter Name="name" Type="System.String" /> <Parameter Name="name" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="name">To be added: an object of type 'string'</param> <param name="name">To be added: an object of type 'string'</param>
@ -319,8 +365,8 @@
<ReturnType>Gtk.Widget</ReturnType> <ReturnType>Gtk.Widget</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters> <Parameters>
<Parameter Name="name" Type="System.String" /> <Parameter Name="name" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="name">To be added: an object of type 'string'</param> <param name="name">To be added: an object of type 'string'</param>
@ -335,10 +381,10 @@
<ReturnType>System.Boolean</ReturnType> <ReturnType>System.Boolean</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters> <Parameters>
<Parameter Name="pspec" Type="System.IntPtr" /> <Parameter Name="pspec" Type="System.IntPtr" />
<Parameter Name="str1ng" Type="System.String" /> <Parameter Name="str1ng" Type="System.String" />
<Parameter Name="value" Type="GLib.Value" /> <Parameter Name="value" Type="GLib.Value" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="pspec">To be added: an object of type 'IntPtr'</param> <param name="pspec">To be added: an object of type 'IntPtr'</param>
@ -355,9 +401,9 @@
<ReturnType>System.Void</ReturnType> <ReturnType>System.Void</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters> <Parameters>
<Parameter Name="handler_name" Type="System.String" /> <Parameter Name="handler_name" Type="System.String" />
<Parameter Name="func" Type="Glade.XMLConnectFunc" /> <Parameter Name="func" Type="Glade.XMLConnectFunc" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="handler_name">To be added: an object of type 'string'</param> <param name="handler_name">To be added: an object of type 'string'</param>
@ -382,8 +428,8 @@
<MemberType>Constructor</MemberType> <MemberType>Constructor</MemberType>
<ReturnValue /> <ReturnValue />
<Parameters> <Parameters>
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Internal constructor</summary> <summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param> <param name="raw">Pointer to the C object.</param>
@ -398,10 +444,10 @@
<MemberType>Constructor</MemberType> <MemberType>Constructor</MemberType>
<ReturnValue /> <ReturnValue />
<Parameters> <Parameters>
<Parameter Name="fname" Type="System.String" /> <Parameter Name="fname" Type="System.String" />
<Parameter Name="root" Type="System.String" /> <Parameter Name="root" Type="System.String" />
<Parameter Name="domain" Type="System.String" /> <Parameter Name="domain" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="fname">To be added: an object of type 'string'</param> <param name="fname">To be added: an object of type 'string'</param>
@ -416,11 +462,11 @@
<MemberType>Constructor</MemberType> <MemberType>Constructor</MemberType>
<ReturnValue /> <ReturnValue />
<Parameters> <Parameters>
<Parameter Name="buffer" Type="System.String" /> <Parameter Name="buffer" Type="System.String" />
<Parameter Name="size" Type="System.Int32" /> <Parameter Name="size" Type="System.Int32" />
<Parameter Name="root" Type="System.String" /> <Parameter Name="root" Type="System.String" />
<Parameter Name="domain" Type="System.String" /> <Parameter Name="domain" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="buffer">To be added: an object of type 'string'</param> <param name="buffer">To be added: an object of type 'string'</param>
@ -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>
@ -498,8 +543,8 @@
<MemberType>Constructor</MemberType> <MemberType>Constructor</MemberType>
<ReturnValue /> <ReturnValue />
<Parameters> <Parameters>
<Parameter Name="gtype" Type="GLib.Type" /> <Parameter Name="gtype" Type="GLib.Type" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Internal constructor</summary> <summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param> <param name="gtype">GLib type for the type</param>
@ -514,10 +559,10 @@
<MemberType>Constructor</MemberType> <MemberType>Constructor</MemberType>
<ReturnValue /> <ReturnValue />
<Parameters> <Parameters>
<Parameter Name="s" Type="System.IO.Stream" /> <Parameter Name="s" Type="System.IO.Stream" />
<Parameter Name="root" Type="System.String" /> <Parameter Name="root" Type="System.String" />
<Parameter Name="domain" Type="System.String" /> <Parameter Name="domain" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="s">a <see cref="T:System.IO.Stream" /></param> <param name="s">a <see cref="T:System.IO.Stream" /></param>
@ -532,11 +577,11 @@
<MemberType>Constructor</MemberType> <MemberType>Constructor</MemberType>
<ReturnValue /> <ReturnValue />
<Parameters> <Parameters>
<Parameter Name="assembly" Type="System.Reflection.Assembly" /> <Parameter Name="assembly" Type="System.Reflection.Assembly" />
<Parameter Name="resource_name" Type="System.String" /> <Parameter Name="resource_name" Type="System.String" />
<Parameter Name="root" Type="System.String" /> <Parameter Name="root" Type="System.String" />
<Parameter Name="domain" Type="System.String" /> <Parameter Name="domain" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="assembly">a <see cref="T:System.Reflection.Assembly" /></param> <param name="assembly">a <see cref="T:System.Reflection.Assembly" /></param>
@ -548,4 +593,4 @@
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>