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

Add documentation, based a little on the C API docs.

Browse source 
svn path=/trunk/gtk-sharp/; revision=11784
This commit is contained in:
Lee Mallabone 2003-02-20 20:55:24 +00:00
parent 2a82ba7d27
commit 56cc116358
4 changed files with 90 additions and 88 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

68
doc/en/Gtk/ButtonBox.xml
View file

@ -5,10 +5,10 @@
<AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyVersion>0.0.0.0</AssemblyVersion>
<Attributes /> <Attributes />
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>To be added</ThreadSafetyStatement> <ThreadSafetyStatement>ButtonBox is not a thread-safe object</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>ButtonBox is a container for laying out <see cref="T:Gtk.Button"/> widgets.</summary>
<remarks>To be added</remarks> <remarks><para>A button box should be used to provide a consistent layout of buttons throughout your application. Specific button boxes are <see cref="T:Gtk.HButtonBox"/> for horizontal groups of buttons, and <see cref="T:Gtk.VButtonBox"/> for vertical button groups.</para></remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>Gtk.Box</BaseTypeName> <BaseTypeName>Gtk.Box</BaseTypeName>
@ -37,9 +37,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The <see cref="T:Glib.Object"/> type ID for the <see cref="T:Gtk.ButtonBoxStyle"/> enumerated type.</summary>
<returns>To be added: an object of type 'uint'</returns> <returns></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetChildSecondary"> <Member MemberName="SetChildSecondary">
@ -53,10 +53,10 @@
<Parameter Name="is_secondary" Type="System.Boolean" /> <Parameter Name="is_secondary" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets whether <paramref name="child"/> should appear in a secondary group of children. A typical use of a secondary child is the help button in a dialog.</summary>
<param name="child">To be added: an object of type 'Gtk.Widget'</param> <param name="child">A widget that is already packed into this button box</param>
<param name="is_secondary">To be added: an object of type 'bool'</param> <param name="is_secondary"><see langword="true"/> if <paramref name="child"/> should be placed in a secondary group, <see langword="false"/> otherwise.</param>
<remarks>To be added</remarks> <remarks><para>A secondary group appears after the other children if the style is <see cref="P:Gtk.ButtonBoxStyle.Start"/>, <see cref="P:Gtk.ButtonBoxStyle.Spread"/> or <see cref="P:Gtk.ButtonBoxStyle.Edge"/>, and before the the other children if the style is <see cref="P:Gtk.ButtonBoxStyle.End"/>. For horizontal button boxes, the definition of before/after depends on direction of the widget (see <see cref="P:Gtk.Widget.Direction"/>). If the style is <see cref="P:Gtk.ButtonBoxStyle.Start"/> or <see cref="P:Gtk.ButtonBoxStyle.End"/>, then the secondary children are aligned at the other end of the button box from the main children. For the other styles, they appear immediately next to the main children.</para></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Finalize"> <Member MemberName="Finalize">
@ -67,8 +67,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Destroy and free all resources used by this widget</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -79,10 +79,10 @@
<Parameter Name="gtype" Type="System.UInt32" /> <Parameter Name="gtype" Type="System.UInt32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal constructor</summary>
<param name="gtype">To be added: an object of type 'uint'</param> <param name="gtype"></param>
<returns>To be added: an object of type 'Gtk.ButtonBox'</returns> <returns></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -93,10 +93,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Used for language bindings only.</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param> <param name="raw">A pointer to a GtkButtonBox, as returned by the Gtk+ C API.</param>
<returns>To be added: an object of type 'Gtk.ButtonBox'</returns> <returns>A C# Gtk.ButtonBox that wraps the <paramref name="raw"/> parameter.</returns>
<remarks>To be added</remarks> <remarks><para>If you don't already know that you need this constructor, it should not be used.</para></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -105,9 +105,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal constructor</summary>
<returns>To be added: an object of type 'Gtk.ButtonBox'</returns> <returns></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -117,9 +117,9 @@
<ReturnType>System.UInt32</ReturnType> <ReturnType>System.UInt32</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Get the type of this object, as registered with the GLib object system.</summary>
<returns>To be added: an object of type 'uint'</returns> <returns>A number that uniquely identifies this type in the GLib object system.</returns>
<remarks>To be added</remarks> <remarks><para>Mostly for internal use.</para></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Layout"> <Member MemberName="Layout">
@ -132,10 +132,10 @@
<Parameter Name="value" Type="Gtk.ButtonBoxStyle" /> <Parameter Name="value" Type="Gtk.ButtonBoxStyle" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Alter the way the buttons in this box are arranged.</summary>
<param name="value">To be added: an object of type 'Gtk.ButtonBoxStyle'</param> <param name="value">the new style to arrange the buttons in.</param>
<returns>To be added: an object of type 'Gtk.ButtonBoxStyle'</returns> <returns>The style that the child widgets are currently arranged in.</returns>
<remarks>To be added</remarks> <remarks>See <see cref="T:Gtk.ButtonBoxStyle"/> for more information about the styles of button boxes.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="LayoutStyle"> <Member MemberName="LayoutStyle">
@ -148,10 +148,10 @@
<Parameter Name="value" Type="Gtk.ButtonBoxStyle" /> <Parameter Name="value" Type="Gtk.ButtonBoxStyle" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>See <see cref="P:Gtk.ButtonBox.Layout"/></summary>
<param name="value">To be added: an object of type 'Gtk.ButtonBoxStyle'</param> <param name="value"></param>
<returns>To be added: an object of type 'Gtk.ButtonBoxStyle'</returns> <returns></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

28
doc/en/Gtk/ButtonBoxStyle.xml
View file

@ -5,10 +5,10 @@
<AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyVersion>0.0.0.0</AssemblyVersion>
<Attributes /> <Attributes />
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>To be added</ThreadSafetyStatement> <ThreadSafetyStatement></ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>Used to dictate the style that a <see cref="T:Gtk.ButtonBox"/> uses to layout the buttons it contains. (See also: <see cref="T:Gtk.VButtonBox"/> and <see cref="T:Gtk.HButtonBox"/>).</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Enum</BaseTypeName> <BaseTypeName>System.Enum</BaseTypeName>
@ -34,8 +34,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Default packing.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Spread"> <Member MemberName="Spread">
@ -46,8 +46,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Buttons are evenly spread across the ButtonBox.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Edge"> <Member MemberName="Edge">
@ -58,8 +58,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Buttons are placed at the edges of the ButtonBox.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Start"> <Member MemberName="Start">
@ -70,8 +70,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Buttons are grouped towards the start of box, (on the left for a <see cref="T:Gtk.HBox"/>, or the top for a <see cref="T:Gtk.VBox"/>).</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="End"> <Member MemberName="End">
@ -82,7 +82,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Buttons are grouped towards the end of a box, (on the right for a <see cref="T:Gtk.HBox"/>, or the bottom for a <see cref="T:Gtk.VBox"/>).</summary>
<remarks>To be added</remarks> <remarks>To be added</remarks>
</Docs> </Docs>
</Member> </Member>
@ -94,8 +94,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary></summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

41
doc/en/Gtk/HButtonBox.xml
View file

@ -5,11 +5,12 @@
<AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyVersion>0.0.0.0</AssemblyVersion>
<Attributes /> <Attributes />
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>To be added</ThreadSafetyStatement> <ThreadSafetyStatement>HButtonBox is not a thread-safe object</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>A button box should be used to provide a consistent layout of buttons throughout your application. This box provides a way of laying out buttons horizontally.</summary>
<remarks>To be added</remarks> <remarks><para>The specific layout of buttons in this type of box is determined by the box's <see cref="T:Gtk.ButtonBoxStyle"/>.</para>
</Docs> <para>Methods for manipulating button boxes are provided in the super classes, <see cref="T:Gtk.ButtonBox"/> and <see cref="T:Gtk.Box"/>.</para></remarks>
</Docs>
<Base> <Base>
<BaseTypeName>Gtk.ButtonBox</BaseTypeName> <BaseTypeName>Gtk.ButtonBox</BaseTypeName>
</Base> </Base>
@ -37,8 +38,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Destroy and free all resources used by this widget</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -49,10 +50,10 @@
<Parameter Name="gtype" Type="System.UInt32" /> <Parameter Name="gtype" Type="System.UInt32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal constructor</summary>
<param name="gtype">To be added: an object of type 'uint'</param> <param name="gtype"></param>
<returns>To be added: an object of type 'Gtk.HButtonBox'</returns> <returns></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -63,10 +64,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Used for language bindings only.</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param> <param name="raw">A pointer to a GtkHButtonBox, as returned by the Gtk+ C API.</param>
<returns>To be added: an object of type 'Gtk.HButtonBox'</returns> <returns>A C# Gtk.HButtonBox that wraps the <paramref name="raw"/> parameter.</returns>
<remarks>To be added</remarks> <remarks><para>If you don't already know that you need this constructor, it should not be used.</para></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -75,9 +76,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The normal way to construct a horizontal button box</summary>
<returns>To be added: an object of type 'Gtk.HButtonBox'</returns> <returns>A new HBox</returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -87,9 +88,9 @@
<ReturnType>System.UInt32</ReturnType> <ReturnType>System.UInt32</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Get the type of this object, as registered with the GLib object system.</summary>
<returns>To be added: an object of type 'uint'</returns> <returns>A number that uniquely identifies this type in the GLib object system.</returns>
<remarks>To be added</remarks> <remarks><para>Mostly for internal use.</para></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

41
doc/en/Gtk/VButtonBox.xml
View file

@ -5,10 +5,11 @@
<AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyVersion>0.0.0.0</AssemblyVersion>
<Attributes /> <Attributes />
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>To be added</ThreadSafetyStatement> <ThreadSafetyStatement>VButtonBox is not a thread-safe object</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>A button box should be used to provide a consistent layout of buttons throughout your application. This box provides a way of</summary>
<remarks>To be added</remarks> <remarks><para>The layout of buttons in this type of box is determined by the box's <see cref="T:Gtk.ButtonBoxStyle"/>.</para>
<para>Methods for manipulating button boxes are provided in the super classes, <see cref="T:Gtk.ButtonBox"/> and <see cref="T:Gtk.Box"/>.</para></remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>Gtk.ButtonBox</BaseTypeName> <BaseTypeName>Gtk.ButtonBox</BaseTypeName>
@ -37,8 +38,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Destroy and free all resources used by this widget</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -49,11 +50,11 @@
<Parameter Name="gtype" Type="System.UInt32" /> <Parameter Name="gtype" Type="System.UInt32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal constructor</summary>
<param name="gtype">To be added: an object of type 'uint'</param> <param name="gtype"></param>
<returns>To be added: an object of type 'Gtk.VButtonBox'</returns> <returns></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public VButtonBox (IntPtr raw);" /> <MemberSignature Language="C#" Value="public VButtonBox (IntPtr raw);" />
@ -63,10 +64,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Used for language bindings only.</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param> <param name="raw">A pointer to a GtkVButtonBox, as returned by the Gtk+ C API.</param>
<returns>To be added: an object of type 'Gtk.VButtonBox'</returns> <returns>A C# Gtk.VButtonBox that wraps the <paramref name="raw"/> parameter.</returns>
<remarks>To be added</remarks> <remarks><para>If you don't already know that you need this constructor, it should not be used.</para></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -75,9 +76,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The normal way to construct a vertical button box</summary>
<returns>To be added: an object of type 'Gtk.VButtonBox'</returns> <returns>A new VBox</returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -87,9 +88,9 @@
<ReturnType>System.UInt32</ReturnType> <ReturnType>System.UInt32</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Get the type of this object, as registered with the GLib object system.</summary>
<returns>To be added: an object of type 'uint'</returns> <returns>A number that uniquely identifies this type in the GLib object system.</returns>
<remarks>To be added</remarks> <remarks><para>Mostly for internal use.</para></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>