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

2004-12-17 Shane Landrum <epicene@pobox.com>

Browse source 
* en/Gtk/RadioAction.xml
	* en/Gtk/RadioActionEntry.xml
	* en/Gtk/RadioButton.xml
	* en/Gtk/RadioMenuItem.xml
	* en/Gtk/RadioToolButton.xml: Add docs


svn path=/trunk/gtk-sharp/; revision=37889
This commit is contained in:
Shane Landrum 2004-12-17 17:47:57 +00:00
parent faaccd7e0b
commit fb2a4b6c9a
6 changed files with 126 additions and 86 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/ChangeLog
View file

@ -1,3 +1,11 @@
2004-12-17 Shane Landrum <epicene@pobox.com>
* en/Gtk/RadioAction.xml
* en/Gtk/RadioActionEntry.xml
* en/Gtk/RadioButton.xml
* en/Gtk/RadioMenuItem.xml
* en/Gtk/RadioToolButton.xml: Add docs
2004-12-16 Dan Winship <danw@novell.com> 2004-12-16 Dan Winship <danw@novell.com>
* en/Gtk/InputArgs.xml (NewValue): * en/Gtk/InputArgs.xml (NewValue):

53
doc/en/Gtk/RadioAction.xml
View file

@ -9,8 +9,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>An action controlled by a radio button.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>Gtk.ToggleAction</BaseTypeName> <BaseTypeName>Gtk.ToggleAction</BaseTypeName>
@ -33,8 +33,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Override to perform actions that must happen before object destruction.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnChanged"> <Member MemberName="OnChanged">
@ -60,10 +60,10 @@
<Parameter Name="gtype" Type="GLib.GType" /> <Parameter Name="gtype" Type="GLib.GType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Protected constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param> <param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gtk.RadioAction" /></returns> <returns>a <see cref="T:Gtk.RadioAction" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -74,10 +74,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Constructor for internal use.</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param> <param name="raw">a <see cref="T:System.IntPtr" />, pointer to internal C data.</param>
<returns>a <see cref="T:Gtk.RadioAction" /></returns> <returns>a <see cref="T:Gtk.RadioAction" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -92,14 +92,14 @@
<Parameter Name="value" Type="System.Int32" /> <Parameter Name="value" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor for general use.</summary>
<param name="name">a <see cref="T:System.String" /></param> <param name="name">a <see cref="T:System.String" />, a unique name for the action</param>
<param name="label">a <see cref="T:System.String" /></param> <param name="label">a <see cref="T:System.String" />, the label to display on menu items and buttons</param>
<param name="tooltip">a <see cref="T:System.String" /></param> <param name="tooltip">a <see cref="T:System.String" />, a tooltip for this action</param>
<param name="stock_id">a <see cref="T:System.String" /></param> <param name="stock_id">a <see cref="T:System.String" />, the stock icon to use.</param>
<param name="value">a <see cref="T:System.Int32" /></param> <param name="value">a <see cref="T:System.Int32" />, the value that <see cref="M:Gtk.RadioAction.CurrentValue"/> should return if this action is activated.</param>
<returns>a <see cref="T:Gtk.RadioAction" /></returns> <returns>a <see cref="T:Gtk.RadioAction" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -112,7 +112,7 @@
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<returns>a <see cref="T:GLib.GType" /></returns> <returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Group"> <Member MemberName="Group">
@ -123,9 +123,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The group this radio action belongs to.</summary>
<returns>a <see cref="T:GLib.SList" /></returns> <returns>a <see cref="T:GLib.SList" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Value"> <Member MemberName="Value">
@ -136,9 +136,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The value returned if this action is activated.</summary>
<returns>a <see cref="T:System.Int32" /></returns> <returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="CurrentValue"> <Member MemberName="CurrentValue">
@ -149,9 +149,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>This action's current value.</summary>
<returns>a <see cref="T:System.Int32" /></returns> <returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks> <remarks>Should be equivalent to <see cref="M:Gtk.RadioAction.Value"/>
if this action is selected.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Changed"> <Member MemberName="Changed">
@ -162,9 +163,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>This event is fired whenever this radio button is toggled.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

52
doc/en/Gtk/RadioActionEntry.xml
View file

@ -108,11 +108,11 @@
<Parameter Name="stock_id" Type="System.String" /> <Parameter Name="stock_id" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Basic constructor.</summary>
<param name="name">a <see cref="T:System.String" /></param> <param name="name">a <see cref="T:System.String" /></param>
<param name="stock_id">a <see cref="T:System.String" /></param> <param name="stock_id">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.RadioActionEntry" /></returns> <returns>a <see cref="T:Gtk.RadioActionEntry" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -127,14 +127,20 @@
<Parameter Name="tooltip" Type="System.String" /> <Parameter Name="tooltip" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor with accelerator.</summary>
<param name="name">a <see cref="T:System.String" /></param> <param name="name">a <see cref="T:System.String" />, a unique name
<param name="stock_id">a <see cref="T:System.String" /></param> for the action</param>
<param name="label">a <see cref="T:System.String" /></param> <param name="stock_id">a <see cref="T:System.String" />, the stock
<param name="accelerator">a <see cref="T:System.String" /></param> icon to use.</param>
<param name="tooltip">a <see cref="T:System.String" /></param> <param name="label">a <see cref="T:System.String" />, the label to
<returns>a <see cref="T:Gtk.RadioActionEntry" /></returns> display on menu items and buttons</param>
<remarks>To be added</remarks> <param name="accelerator">a <see cref="T:System.String" />,the
accelerator string (see notes below)</param>
<param name="tooltip">a <see cref="T:System.String" />, a tooltip
for this action</param>
<remarks>The accelerator given should be in the format understood
<see cref="M:Gtk.Accelerator.Parse" />, or "" for no accelerator, or
<see langword="null"/> to use the stock accelerator </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -150,15 +156,23 @@
<Parameter Name="value" Type="System.Int32" /> <Parameter Name="value" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor with accelerator and value.</summary>
<param name="name">a <see cref="T:System.String" /></param> <param name="name">a <see cref="T:System.String" />, a unique name
<param name="stock_id">a <see cref="T:System.String" /></param> for the action</param>
<param name="label">a <see cref="T:System.String" /></param> <param name="stock_id">a <see cref="T:System.String" />, the stock
<param name="accelerator">a <see cref="T:System.String" /></param> icon to use.</param>
<param name="tooltip">a <see cref="T:System.String" /></param> <param name="label">a <see cref="T:System.String" />, the label to
<param name="value">a <see cref="T:System.Int32" /></param> display on menu items and buttons</param>
<returns>a <see cref="T:Gtk.RadioActionEntry" /></returns> <param name="accelerator">a <see cref="T:System.String" />,the
<remarks>To be added</remarks> accelerator string (see notes below)</param>
<param name="tooltip">a <see cref="T:System.String" />, a tooltip
for this action</param>
<param name="value">a <see cref="T:System.Int32" />, the value that
<see cref="M:Gtk.RadioAction.CurrentValue"/> should return if this
action is activated.</param>
<remarks>The accelerator given should be in the format understood
<see cref="M:Gtk.Accelerator.Parse" />, or "" for no accelerator, or
<see langword="null"/> to use the stock accelerator </remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

11
doc/en/Gtk/RadioButton.xml
View file

@ -166,8 +166,13 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Emitted when the group of radio buttons that a
<remarks>To be added</remarks> radio button belongs to changes.</summary>
<remarks>This is emitted when a radio button switches from
being alone to being part of a group of 2 or more buttons, or
vice-versa, and when a buttton is moved from one group of 2 or
more buttons to a different one, but not when the composition
of the group that a button belongs to changes.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnGroupChanged"> <Member MemberName="OnGroupChanged">
@ -183,4 +188,4 @@
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

27
doc/en/Gtk/RadioMenuItem.xml
View file

@ -140,8 +140,13 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Emitted when the group of radio menu items that a
<remarks>To be added</remarks> radio button belongs to changes.</summary>
<remarks>This is emitted when a radio button switches from
being alone to being part of a group of 2 or more menu items, or
vice-versa, and when a buttton is moved from one group of 2 or
more menu items to a different one, but not when the composition
of the group that a button belongs to changes.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnGroupChanged"> <Member MemberName="OnGroupChanged">
@ -164,10 +169,10 @@
<Parameter Name="group" Type="Gtk.RadioMenuItem" /> <Parameter Name="group" Type="Gtk.RadioMenuItem" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Basic constructor.</summary>
<param name="group">a <see cref="T:Gtk.RadioMenuItem" /></param> <param name="group">a <see cref="T:Gtk.RadioMenuItem" />, group the menu item is inside (XXX: this type looks wrong)</param>
<returns>a <see cref="T:Gtk.RadioMenuItem" /></returns> <returns>a <see cref="T:Gtk.RadioMenuItem" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -179,12 +184,14 @@
<Parameter Name="label" Type="System.String" /> <Parameter Name="label" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Constructor with support for mnemonic labels.</summary>
<param name="group">a <see cref="T:Gtk.RadioMenuItem" /></param> <param name="group">a <see cref="T:Gtk.RadioMenuItem" />, group the
<param name="label">a <see cref="T:System.String" /></param> menu item is inside (XXX: this type looks wrong)</param>
<param name="label">a <see cref="T:System.String" />the text of the
button, with an underscore in front of the mnemonic character</param>
<returns>a <see cref="T:Gtk.RadioMenuItem" /></returns> <returns>a <see cref="T:Gtk.RadioMenuItem" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

61
doc/en/Gtk/RadioToolButton.xml
View file

@ -9,8 +9,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>A radio-button control for a toolbar.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>Gtk.ToggleToolButton</BaseTypeName> <BaseTypeName>Gtk.ToggleToolButton</BaseTypeName>
@ -36,8 +36,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Override to perform actions before object destruction.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -48,10 +48,10 @@
<Parameter Name="gtype" Type="GLib.GType" /> <Parameter Name="gtype" Type="GLib.GType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Protected constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param> <param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gtk.RadioToolButton" /></returns> <returns>a <see cref="T:Gtk.RadioToolButton" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -62,10 +62,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Constructor for internal use only.</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param> <param name="raw">a <see cref="T:System.IntPtr" />, pointer to underlying C object</param>
<returns>a <see cref="T:Gtk.RadioToolButton" /></returns> <returns>a <see cref="T:Gtk.RadioToolButton" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -76,10 +76,12 @@
<Parameter Name="group" Type="GLib.SList" /> <Parameter Name="group" Type="GLib.SList" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Constructor with support for button groups.</summary>
<param name="group">a <see cref="T:GLib.SList" /></param> <param name="group">a <see cref="T:GLib.SList" />, an existing
radio button group, or <see langword="null"/> if you are creating
a new group</param>
<returns>a <see cref="T:Gtk.RadioToolButton" /></returns> <returns>a <see cref="T:Gtk.RadioToolButton" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -91,11 +93,14 @@
<Parameter Name="stock_id" Type="System.String" /> <Parameter Name="stock_id" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Constructor for stock buttons with groups.</summary>
<param name="group">a <see cref="T:GLib.SList" /></param> <param name="group">a <see cref="T:GLib.SList" />, an existing
<param name="stock_id">a <see cref="T:System.String" /></param> radio button group, or <see langword="null"/> if you are creating
a new group</param>
<param name="stock_id">a <see cref="T:System.String" />, the ID
for a stock item to use for an icon and label.</param>
<returns>a <see cref="T:Gtk.RadioToolButton" /></returns> <returns>a <see cref="T:Gtk.RadioToolButton" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -106,10 +111,10 @@
<Parameter Name="group" Type="Gtk.RadioToolButton" /> <Parameter Name="group" Type="Gtk.RadioToolButton" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Create a new button in the same group as another.</summary>
<param name="group">a <see cref="T:Gtk.RadioToolButton" /></param> <param name="group">a <see cref="T:Gtk.RadioToolButton" />, a button in the same group as the one to be created..</param>
<returns>a <see cref="T:Gtk.RadioToolButton" /></returns> <returns>a <see cref="T:Gtk.RadioToolButton" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -121,11 +126,11 @@
<Parameter Name="stock_id" Type="System.String" /> <Parameter Name="stock_id" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Create a new button in the same group as another from a stock item.</summary>
<param name="group">a <see cref="T:Gtk.RadioToolButton" /></param> <param name="group">a <see cref="T:Gtk.RadioToolButton" />, a button in the same group as the one to be created.</param>
<param name="stock_id">a <see cref="T:System.String" /></param> <param name="stock_id">a <see cref="T:System.String" />, the ID of the stock item to use for an icon and label.</param>
<returns>a <see cref="T:Gtk.RadioToolButton" /></returns> <returns>a <see cref="T:Gtk.RadioToolButton" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -136,9 +141,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The <see cref="T:GLib.GType" /> of this object.</summary>
<returns>a <see cref="T:GLib.GType" /></returns> <returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Group"> <Member MemberName="Group">
@ -149,10 +154,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The radio button group this button belongs to.</summary>
<returns>a <see cref="T:GLib.SList" /></returns> <returns>a <see cref="T:GLib.SList" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>