GtkSharp/doc/en/Gtk/RadioAction.xml
John Luke 8855f7a5a7 add some automatic docs for the new stuff
svn path=/trunk/gtk-sharp/; revision=43452
2005-04-22 17:20:16 +00:00

180 lines
7.4 KiB
XML

<Type Name="RadioAction" FullName="Gtk.RadioAction">
<TypeSignature Language="C#" Value="public class RadioAction : Gtk.ToggleAction, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>[00 24 00 00 04 80 00 00 94 00 00 00 06 02 00 00 00 24 00 00 52 53 41 31 00 04 00 00 01 00 01 00 71 EB 6C 55 75 52 9C BF 72 44 F7 A6 EA 05 62 84 F9 EA E0 3B CF F2 CC 13 2C 9C 49 0A B3 09 EA B0 B5 6B CE 44 9D F5 03 D9 C0 A8 1E 52 05 85 CD BE 70 E2 FB 90 43 4B AC 04 FA 62 22 A8 00 98 B7 A1 A7 B3 AF 99 1A 41 23 24 BB 43 25 F6 B8 65 BB 64 EB F6 D1 C2 06 D5 73 2D DF BC 70 A7 38 9E E5 3E 0C 24 6E 32 79 74 1A D0 05 03 E4 98 42 E1 9B F3 7B 19 8B 40 21 26 CB 36 89 C2 EA 64 96 A4 7C B4]</AssemblyPublicKey>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyCulture>neutral</AssemblyCulture>
<Attributes />
</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>
<Docs>
<summary>An action controlled by a radio button.</summary>
<remarks>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.ToggleAction</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="protected override void Finalize ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Override to perform actions that must happen before object destruction.</summary>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="OnChanged">
<MemberSignature Language="C#" Value="protected virtual void OnChanged (Gtk.RadioAction current);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="current" Type="Gtk.RadioAction" />
</Parameters>
<Docs>
<summary>Default handler for the <see cref="M:Gtk.RadioAction.Changed" /> event.</summary>
<param name="current">a <see cref="T:Gtk.RadioAction" /></param>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.RadioAction.Changed" /> event.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected RadioAction (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>Protected constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gtk.RadioAction" /></returns>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RadioAction (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Constructor for internal use.</summary>
<param name="raw">a <see cref="T:System.IntPtr" />, pointer to internal C data.</param>
<returns>a <see cref="T:Gtk.RadioAction" /></returns>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RadioAction (string name, string label, string tooltip, string stock_id, int value);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="label" Type="System.String" />
<Parameter Name="tooltip" Type="System.String" />
<Parameter Name="stock_id" Type="System.String" />
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Public constructor for general use.</summary>
<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" />, the label to display on menu items and buttons</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" />, the stock icon to use.</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>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The <see cref="T:GLib.GType" /> of this object.</summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="Group">
<MemberSignature Language="C#" Value="public GLib.SList Group { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.SList</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The group this radio action belongs to.</summary>
<returns>a <see cref="T:GLib.SList" /></returns>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="Value">
<MemberSignature Language="C#" Value="public int Value { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The value returned if this action is activated.</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="CurrentValue">
<MemberSignature Language="C#" Value="public int CurrentValue { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>This action's current value.</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>Should be equivalent to <see cref="M:Gtk.RadioAction.Value" />
if this action is selected.</remarks>
</Docs>
</Member>
<Member MemberName="Changed">
<MemberSignature Language="C#" Value="public event Gtk.ChangedHandler Changed;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Gtk.ChangedHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>This event is fired whenever this radio button is toggled.</summary>
<remarks>
</remarks>
</Docs>
</Member>
</Members>
</Type>