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

* en/Gtk/Button.xml: Result of running the updater.

Browse source 
* en/Gtk/SizeGroup*.xml: First draft of docs for GtkSizeGroup.

svn path=/trunk/gtk-sharp/; revision=14777
This commit is contained in:
Lee Mallabone 2003-05-21 21:31:19 +00:00
parent 89a5fdaf12
commit 9d286a36ed
4 changed files with 87 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/ChangeLog
View file

@ -1,6 +1,8 @@
2003-05-21 Lee Mallabone <gnome@fonicmonkey.net> 2003-05-21 Lee Mallabone <gnome@fonicmonkey.net>
* en/Gtk/*.xml: Remove some private bits of Gtk assembly. * en/Gtk/*.xml: Remove some private bits of Gtk assembly.
* en/Gtk/Button.xml: Result of running the updater.
* en/Gtk/SizeGroup*.xml: First draft of docs for GtkSizeGroup.
2003-05-20 Hector E. Gomez Morales <hgomez_36@flashmail.com> 2003-05-20 Hector E. Gomez Morales <hgomez_36@flashmail.com>

44
doc/en/Gtk/Button.xml
View file

@ -44,8 +44,7 @@
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>The GLib type for Gtk.Button.</summary> <summary>The GLib type for Gtk.Button.</summary>
<returns>The GLib type for the Gtk.Button <see <returns>The GLib type for the Gtk.Button <see langword="class" />.</returns>
langword="class" />.</returns>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -59,14 +58,11 @@
<Parameter Name="value" Type="System.Boolean" /> <Parameter Name="value" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Gets or sets if wether the Button should use a <see <summary>Gets or sets if wether the Button should use a <see cref="T:Gtk.Stock" /> or not.</summary>
cref="T:Gtk.Stock" /> or not.</summary>
<param name="value">Boolean value to select if the <param name="value">Boolean value to select if the
Button uses a <see cref="T:Gtk.Stock" /> or not.</param> Button uses a <see cref="T:Gtk.Stock" /> or not.</param>
<returns>Gets a value indicating if the Button uses a <see <returns>Gets a value indicating if the Button uses a <see cref="T:Gtk.Stock" />.</returns>
cref="T:Gtk.Stock" />.</returns> <remarks>It's possible to create a Button from <see cref="T:Gtk.Stock" />, which is recommended for consistency in Gnome
<remarks>It's possible to create a Button from <see
cref="T:Gtk.Stock" />, which is recommended for consistency in Gnome
apps. They also provide a <see cref="T:Gtk.Label" /> and a key shortcut. apps. They also provide a <see cref="T:Gtk.Label" /> and a key shortcut.
</remarks> </remarks>
</Docs> </Docs>
@ -134,7 +130,8 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary><see langword="event" /> launched when the button is activated.</summary> <summary>
<see langword="event" /> launched when the button is activated.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -144,7 +141,8 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary><see langword="event" /> launched when the button is clicked.</summary> <summary>
<see langword="event" /> launched when the button is clicked.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -154,7 +152,8 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary><see langword="event" /> launched when the cursor <summary>
<see langword="event" /> launched when the cursor
leaves the button area.</summary> leaves the button area.</summary>
<remarks /> <remarks />
</Docs> </Docs>
@ -165,7 +164,8 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary><see langword="event" /> launched when the button is pressed.</summary> <summary>
<see langword="event" /> launched when the button is pressed.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -175,7 +175,8 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary><see langword="event" /> launched when the button is released.</summary> <summary>
<see langword="event" /> launched when the button is released.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -185,7 +186,8 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary><see langword="event" /> launched when the cursor <summary>
<see langword="event" /> launched when the cursor
enters the button area.</summary> enters the button area.</summary>
<remarks /> <remarks />
</Docs> </Docs>
@ -354,5 +356,19 @@
shows the string passed as parameter.</remarks> shows the string passed as parameter.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Button (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Gtk.Button'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members> </Members>
</Type> </Type>

62
doc/en/Gtk/SizeGroup.xml
View file

@ -1,5 +1,5 @@
<Type Name="SizeGroup" FullName="Gtk.SizeGroup"> <Type Name="SizeGroup" FullName="Gtk.SizeGroup">
<TypeSignature Language="C#" Value="public class SizeGroup : GLib.Object, IWrapper, IDisposable" Maintainer="auto" /> <TypeSignature Language="C#" Value="public class SizeGroup : GLib.Object, IWrapper, IDisposable" Maintainer="Lee Mallabone" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,26 @@
</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>Group widgets so they request the same size.</summary>
<remarks>To be added</remarks> <remarks>
<para>
A SizeGroup provides a mechanism for grouping a number of widgets together so they all request the same amount of space. This is typically useful when you want a column of widgets to have the same size, but you can't use a <see cref="T:Gtk.Table"/> widget. Its use is effectively demonstrated by the Human Interface Guidelines of the Gnome project.
</para>
<para>
In detail, the size requested for each widget in a SizeGroup is the maximum of the sizes that would have been requested for each widget in the SizeGroup without a SizeGroup. The <see cref="P:Gtk.SizeGroup.Mode"/> of the size group determines whether this applies to the horizontal size, the vertical size, or both sizes.
</para>
<para>
Note that SizeGroups only affect the amount of space requested, not the size that the widgets finally receive. If you want the widgets in a SizeGroup to actually be the same size, you need to pack them in such a way that they get the size they request and not more. For example, if you are packing your widgets into a table, you would not include the Fill flag.
</para>
<para>
SizeGroup objects are referenced by each widget in the size group, so once you have added all widgets to a SizeGroup, you can drop the initial reference to the SizeGroup by calling <see cref="M:GLib.Object.Unref"/>. If the widgets in the SizeGroup are subsequently destroyed, then they will be removed from the SizeGroup and drop their references on the SizeGroup; when all widgets have been removed, the size group will be freed.
</para>
<para>
Widgets can be part of multiple size groups; GTK will compute the horizontal size of a widget from the horizontal requisition of all widgets that can be reached from the widget by a chain of size groups of type <see cref="P:Gtk.SizeGroupMode.Horizontal"/> or <see cref="P:Gtk.SizeGroupMode.Both"/>. Likewise, the vertical size is computed from the vertical requisition of all widgets that can be reached from the widget by a chain of size groups of type <see cref="P:Gtk.SizeGroupMode.Vertical"/> or <see cref="P:Gtk.SizeGroupMode.Both"/>.
</para>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>GLib.Object</BaseTypeName> <BaseTypeName>GLib.Object</BaseTypeName>
@ -33,9 +51,9 @@
<Parameter Name="widget" Type="Gtk.Widget" /> <Parameter Name="widget" Type="Gtk.Widget" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Places a widget in this SizeGroup</summary>
<param name="widget">To be added: an object of type 'Gtk.Widget'</param> <param name="widget">A Widget whose size should be tied to widgets in a group.</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RemoveWidget"> <Member MemberName="RemoveWidget">
@ -48,9 +66,9 @@
<Parameter Name="widget" Type="Gtk.Widget" /> <Parameter Name="widget" Type="Gtk.Widget" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Removes a widget from this SizeGroup</summary>
<param name="widget">To be added: an object of type 'Gtk.Widget'</param> <param name="widget">A Widget whose size should no longer be tied to the widgets in this group.</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Finalize"> <Member MemberName="Finalize">
@ -89,10 +107,10 @@
<Parameter Name="mode" Type="Gtk.SizeGroupMode" /> <Parameter Name="mode" Type="Gtk.SizeGroupMode" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Create a new SizeGroup.</summary>
<param name="mode">To be added: an object of type 'Gtk.SizeGroupMode'</param> <param name="mode">The mode to indicate direction(s) that should have their sizes tied together.</param>
<returns>To be added: an object of type 'Gtk.SizeGroup'</returns> <returns>A new SizeGroup</returns>
<remarks>To be added</remarks> <remarks><para>The direction that size is tied can be altered later using the <see cref="P:Gtk.SizeGroup.Mode"/> property.</para></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -101,9 +119,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.SizeGroup'</returns> <returns></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -128,10 +146,14 @@
<Parameter Name="value" Type="Gtk.SizeGroupMode" /> <Parameter Name="value" Type="Gtk.SizeGroupMode" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets a mode to determine which direction this SizeGroup controls.</summary>
<param name="value">To be added: an object of type 'Gtk.SizeGroupMode'</param> <param name="value">A new direction 'mode' for this SizeGroup to tie together.</param>
<returns>To be added: an object of type 'Gtk.SizeGroupMode'</returns> <returns>The current 'mode' that indicates the direction this SizeGroup ties together.</returns>
<remarks>To be added</remarks> <remarks>
<para>
The mode of the size group determines whether the widgets in the SizeGroup should all have the same <see cref="P:Gtk.SizeGroupMode.Horizontal"/> or <see cref="P:Gtk.SizeGroupMode.Vertical"/> requisition, or should all have the same requisition in <see cref="P:Gtk.SizeGroupMode.Both"/> directions.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">

26
doc/en/Gtk/SizeGroupMode.xml
View file

@ -1,5 +1,5 @@
<Type Name="SizeGroupMode" FullName="Gtk.SizeGroupMode"> <Type Name="SizeGroupMode" FullName="Gtk.SizeGroupMode">
<TypeSignature Language="C#" Value="public sealed struct SizeGroupMode;" Maintainer="auto" /> <TypeSignature Language="C#" Value="public sealed struct SizeGroupMode;" Maintainer="Lee Mallabone" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-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>Determine the direction that is affected by a <see cref="T:Gtk.SizeGroup"/>.</summary>
<remarks>To be added</remarks> <remarks><para>The mode of the <see cref="T:Gtk.SizeGroup"/> determines the directions in which the <see cref="T:Gtk.SizeGroup"/> affects the requested sizes of its component widgets.</para></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>Has no effect on widget size requisitions.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Horizontal"> <Member MemberName="Horizontal">
@ -46,8 +46,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Affects widget size requisitions horizontally.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Vertical"> <Member MemberName="Vertical">
@ -58,8 +58,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Affects widget size requisitions horizontally.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Both"> <Member MemberName="Both">
@ -70,8 +70,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Affects widget size requisitions both horizontally and vertically.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="value__"> <Member MemberName="value__">
@ -82,8 +82,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>