2003-02-20 04:03:15 +00:00
<Type Name= "Button" FullName= "Gtk.Button" >
<TypeSignature Language= "C#" Value= "public class Button : Gtk.Bin, Implementor, IWrapper, IWrapper, IDisposable" Maintainer= "Duncan Mak" />
2003-02-12 02:00:12 +00:00
<AssemblyInfo >
<AssemblyName > gtk-sharp</AssemblyName>
2003-12-24 01:35:30 +00:00
<AssemblyPublicKey >
</AssemblyPublicKey>
2003-02-12 02:00:12 +00:00
<AssemblyVersion > 0.0.0.0</AssemblyVersion>
2003-10-28 00:48:23 +00:00
<AssemblyCulture > neutral</AssemblyCulture>
2003-02-12 02:00:12 +00:00
<Attributes />
</AssemblyInfo>
2003-02-23 07:26:30 +00:00
<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>
2003-02-12 02:00:12 +00:00
<Docs >
2003-02-20 04:03:15 +00:00
<summary > A widget that creates a signal when clicked on.</summary>
<remarks >
<para >
2003-07-17 06:38:40 +00:00
The <see cref= "T:Gtk.Button" /> widget is generally used to attach to a function that is called when the button is pressed.
The <see cref= "T:Gtk.Button" /> widget can hold any valid child widget.
2003-05-30 04:30:12 +00:00
That is, it can hold most any other standard <see cref= "T:Gtk.Widget" /> . The most commonly used child is the <see cref= "T:Gtk.Label" /> .
2003-02-20 04:03:15 +00:00
</para>
2003-07-17 06:38:40 +00:00
<example >
<code lang= "C#" >
2003-05-30 04:30:12 +00:00
using Gtk;
using System;
public class ButtonApp {
public static int Main (string[] args)
{
Application.Init ();
Window win = new Window ("Button Tester");
2004-06-19 18:25:02 +00:00
win.SetDefaultSize (200, 150);
2003-05-30 04:30:12 +00:00
win.DeleteEvent += new DeleteEventHandler (Window_Delete);
Button btn = new Button ("Click Me");
btn.Clicked += new EventHandler (btn_click);
win.Add (btn);
win.ShowAll ();
Application.Run ();
return 0;
}
static void btn_click (object obj, EventArgs args)
{
Console.WriteLine ("Button Clicked");
}
static void Window_Delete (object obj, DeleteEventArgs args)
{
Application.Quit ();
args.RetVal = true;
}
}
</code>
2003-07-17 06:38:40 +00:00
</example>
2003-02-20 04:03:15 +00:00
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
<Base >
2003-02-20 04:03:15 +00:00
<BaseTypeName > Gtk.Bin</BaseTypeName>
2003-02-12 02:00:12 +00:00
</Base>
<Interfaces >
<Interface >
<InterfaceName > Atk.Implementor</InterfaceName>
</Interface>
<Interface >
<InterfaceName > GLib.IWrapper</InterfaceName>
</Interface>
<Interface >
<InterfaceName > GLib.IWrapper</InterfaceName>
</Interface>
<Interface >
<InterfaceName > System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members >
2003-03-15 22:50:24 +00:00
<Member MemberName= "UseStock" >
<MemberSignature Language= "C#" Value= "public bool UseStock { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-03-15 22:50:24 +00:00
<Docs >
2003-07-17 06:38:40 +00:00
<summary > Whether the <see cref= "T:Gtk.Button" /> should use a <see cref= "T:Gtk.Stock" /> .</summary>
2003-05-14 12:14:31 +00:00
<param name= "value" > Boolean value to select if the
2003-07-17 06:38:40 +00:00
<see cref= "T:Gtk.Button" /> uses a <see cref= "T:Gtk.Stock" /> or not.</param>
<returns > Gets a value indicating if the <see cref= "T:Gtk.Button" /> uses a <see cref= "T:Gtk.Stock" /> .</returns>
2003-11-05 04:30:47 +00:00
<remarks > It is possible to create a <see cref= "T:Gtk.Button" /> from <see cref= "T:Gtk.Stock" /> , which is recommended for consistency in <see cref= "N:Gnome" />
2003-05-14 12:14:31 +00:00
apps. They also provide a <see cref= "T:Gtk.Label" /> and a key shortcut.
</remarks>
2003-03-15 22:50:24 +00:00
</Docs>
</Member>
<Member MemberName= "UseUnderline" >
<MemberSignature Language= "C#" Value= "public bool UseUnderline { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-03-15 22:50:24 +00:00
<Docs >
2003-07-17 06:38:40 +00:00
<summary > Indicates if a mnemonic is associated with the <see cref= "T:Gtk.Button" /> .</summary>
<param name= "value" > Boolean value to select if the <see cref= "T:Gtk.Button" /> uses
2003-05-14 12:14:31 +00:00
underline or not.</param>
2003-07-17 06:38:40 +00:00
<returns > Gets a value indicating if the <see cref= "T:Gtk.Button" /> uses underline
2003-05-14 12:14:31 +00:00
or not.</returns>
<remarks />
2003-03-15 22:50:24 +00:00
</Docs>
</Member>
<Member MemberName= "Relief" >
<MemberSignature Language= "C#" Value= "public Gtk.ReliefStyle Relief { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > Gtk.ReliefStyle</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-03-15 22:50:24 +00:00
<Docs >
2003-07-17 06:38:40 +00:00
<summary > The <see cref= "T:Gtk.ReliefStyle" /> for the <see cref= "T:Gtk.Button" /> .</summary>
2003-05-14 12:14:31 +00:00
<param name= "value" > The <see cref= "T:Gtk.ReliefStyle" /> for
2003-07-17 06:38:40 +00:00
the <see cref= "T:Gtk.Button" /> .</param>
2003-05-14 12:14:31 +00:00
<returns > An instance of <see cref= "T:Gtk.ReliefStyle" /> that
2003-07-17 06:38:40 +00:00
represents the relief style of the <see cref= "T:Gtk.Button" /> .</returns>
2003-05-14 12:14:31 +00:00
<remarks />
2003-03-15 22:50:24 +00:00
</Docs>
</Member>
<Member MemberName= "Label" >
<MemberSignature Language= "C#" Value= "public string Label { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.String</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-03-15 22:50:24 +00:00
<Docs >
2003-07-17 06:38:40 +00:00
<summary > The text of the <see cref= "T:Gtk.Label" /> in the <see cref= "T:Gtk.Button" /> .</summary>
2003-05-30 04:30:12 +00:00
<param name= "value" > A <see cref= "T:System.String" /> to be used for
2003-07-17 06:38:40 +00:00
the <see cref= "T:Gtk.Button" /> 's <see cref= "T:Gtk.Label" /> </param>
<returns > The <see cref= "T:System.String" /> contained by the <see cref= "T:Gtk.Button" /> .</returns>
2004-01-18 22:53:54 +00:00
<remarks > If you want the Label to have a mnemonic you need to set <see cref= "P:Gtk.Button.UseUnderline" /> to <see langword= "true" /> .</remarks>
2003-03-15 22:50:24 +00:00
</Docs>
</Member>
<Member MemberName= "Activated" >
<MemberSignature Language= "C#" Value= "public event EventHandler Activated;" />
<MemberType > Event</MemberType>
2003-09-17 21:56:59 +00:00
<ReturnValue >
<ReturnType > System.EventHandler</ReturnType>
</ReturnValue>
2003-03-15 22:50:24 +00:00
<Parameters />
<Docs >
2003-05-21 21:31:19 +00:00
<summary >
2003-07-17 06:38:40 +00:00
Event launched when the <see cref= "T:Gtk.Button" /> is activated.</summary>
2003-05-14 12:14:31 +00:00
<remarks />
2003-03-15 22:50:24 +00:00
</Docs>
</Member>
<Member MemberName= "Clicked" >
<MemberSignature Language= "C#" Value= "public event EventHandler Clicked;" />
<MemberType > Event</MemberType>
2003-09-17 21:56:59 +00:00
<ReturnValue >
<ReturnType > System.EventHandler</ReturnType>
</ReturnValue>
2003-03-15 22:50:24 +00:00
<Parameters />
<Docs >
2003-05-21 21:31:19 +00:00
<summary >
2003-07-17 06:38:40 +00:00
Event launched when the <see cref= "T:Gtk.Button" /> is clicked.</summary>
2003-05-14 12:14:31 +00:00
<remarks />
2003-03-15 22:50:24 +00:00
</Docs>
</Member>
<Member MemberName= "Left" >
<MemberSignature Language= "C#" Value= "public event EventHandler Left;" />
<MemberType > Event</MemberType>
2003-09-17 21:56:59 +00:00
<ReturnValue >
<ReturnType > System.EventHandler</ReturnType>
</ReturnValue>
2003-03-15 22:50:24 +00:00
<Parameters />
<Docs >
2003-05-21 21:31:19 +00:00
<summary >
2003-07-17 06:38:40 +00:00
Event launched when the cursor leaves the <see cref= "T:Gtk.Button" /> area.</summary>
2003-05-14 12:14:31 +00:00
<remarks />
2003-03-15 22:50:24 +00:00
</Docs>
</Member>
<Member MemberName= "Pressed" >
<MemberSignature Language= "C#" Value= "public event EventHandler Pressed;" />
<MemberType > Event</MemberType>
2003-09-17 21:56:59 +00:00
<ReturnValue >
<ReturnType > System.EventHandler</ReturnType>
</ReturnValue>
2003-03-15 22:50:24 +00:00
<Parameters />
<Docs >
2003-05-21 21:31:19 +00:00
<summary >
2003-07-17 06:38:40 +00:00
Event launched when the <see cref= "T:Gtk.Button" /> is pressed.</summary>
2003-05-14 12:14:31 +00:00
<remarks />
2003-03-15 22:50:24 +00:00
</Docs>
</Member>
<Member MemberName= "Released" >
<MemberSignature Language= "C#" Value= "public event EventHandler Released;" />
<MemberType > Event</MemberType>
2003-09-17 21:56:59 +00:00
<ReturnValue >
<ReturnType > System.EventHandler</ReturnType>
</ReturnValue>
2003-03-15 22:50:24 +00:00
<Parameters />
<Docs >
2003-05-21 21:31:19 +00:00
<summary >
2003-07-17 06:38:40 +00:00
Event launched when the <see cref= "T:Gtk.Button" /> is released.</summary>
2003-05-14 12:14:31 +00:00
<remarks />
2003-03-15 22:50:24 +00:00
</Docs>
</Member>
<Member MemberName= "Entered" >
<MemberSignature Language= "C#" Value= "public event EventHandler Entered;" />
<MemberType > Event</MemberType>
2003-09-17 21:56:59 +00:00
<ReturnValue >
<ReturnType > System.EventHandler</ReturnType>
</ReturnValue>
2003-03-15 22:50:24 +00:00
<Parameters />
<Docs >
2003-05-21 21:31:19 +00:00
<summary >
2003-07-17 06:38:40 +00:00
Event launched when the cursor enters the <see cref= "T:Gtk.Button" /> area.</summary>
2003-05-14 12:14:31 +00:00
<remarks />
2003-03-15 22:50:24 +00:00
</Docs>
</Member>
<Member MemberName= "NewWithLabel" >
<MemberSignature Language= "C#" Value= "public static Gtk.Button NewWithLabel (string label);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > Gtk.Button</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "label" Type= "System.String" />
</Parameters>
2003-03-15 22:50:24 +00:00
<Docs >
2003-07-17 06:38:40 +00:00
<summary > Creates a <see cref= "T:Gtk.Button" /> widget with a <see cref= "T:Gtk.Label" /> child containing the given text.</summary>
2003-07-04 07:49:31 +00:00
<param name= "label" >
The text you want the <see cref= "T:Gtk.Label" /> to hold.
</param>
<returns > The newly created <see cref= "T:Gtk.Button" /> widget.</returns>
<remarks />
2003-03-15 22:50:24 +00:00
</Docs>
</Member>
<Member MemberName= "Leave" >
<MemberSignature Language= "C#" Value= "public void Leave ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2003-07-17 06:38:40 +00:00
<summary > Emits a <see cref= "E:Gtk.Button.Left" /> signal to the given <see cref= "T:Gtk.Button" /> .</summary>
<remarks > Emits a <see cref= "E:Gtk.Button.Left" /> signal to the given <see cref= "T:Gtk.Button" /> .</remarks>
2003-03-15 22:50:24 +00:00
</Docs>
</Member>
<Member MemberName= "Press" >
<MemberSignature Language= "C#" Value= "public void Press ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2003-07-17 06:38:40 +00:00
<summary > Emits a <see cref= "E:Gtk.Button.Pressed" /> signal to the given <see cref= "T:Gtk.Button" /> .</summary>
<remarks > Emits a <see cref= "E:Gtk.Button.Pressed" /> signal to the given <see cref= "T:Gtk.Button" /> .</remarks>
2003-03-15 22:50:24 +00:00
</Docs>
</Member>
<Member MemberName= "Release" >
<MemberSignature Language= "C#" Value= "public void Release ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2003-07-17 06:38:40 +00:00
<summary > Emits a <see cref= "E:Gtk.Button.Released" /> signal to the given <see cref= "T:Gtk.Button" /> .</summary>
<remarks > Emits a <see cref= "E:Gtk.Button.Released" /> signal to the given <see cref= "T:Gtk.Button" /> .</remarks>
2003-03-15 22:50:24 +00:00
</Docs>
</Member>
<Member MemberName= "Click" >
<MemberSignature Language= "C#" Value= "public void Click ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2003-07-17 06:38:40 +00:00
<summary > Emits a <see cref= "E:Gtk.Button.Clicked" /> signal to the given <see cref= "T:Gtk.Button" /> .</summary>
<remarks > Emits a <see cref= "E:Gtk.Button.Clicked" /> signal to the given <see cref= "T:Gtk.Button" /> .</remarks>
2003-03-15 22:50:24 +00:00
</Docs>
</Member>
<Member MemberName= "Enter" >
<MemberSignature Language= "C#" Value= "public void Enter ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2003-07-17 06:38:40 +00:00
<summary > Emits a <see cref= "E:Gtk.Button.Entered" /> signal to the given <see cref= "T:Gtk.Button" /> .</summary>
<remarks > Emits a <see cref= "E:Gtk.Button.Entered" /> signal to the given <see cref= "T:Gtk.Button" /> .</remarks>
2003-03-15 22:50:24 +00:00
</Docs>
</Member>
<Member MemberName= "Finalize" >
2003-10-13 22:55:58 +00:00
<MemberSignature Language= "C#" Value= "protected override void Finalize ();" />
2003-03-15 22:50:24 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2003-05-14 12:14:31 +00:00
<summary > Disposes the resources associated with this object.</summary>
<remarks />
2003-03-15 22:50:24 +00:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public Button ();" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs >
2003-05-14 12:14:31 +00:00
<summary > Default parameterless constructor.</summary>
2003-07-17 06:38:40 +00:00
<returns > An instance of <see cref= "T:Gtk.Button" /> .</returns>
<remarks > This is the default constructor for the <see cref= "T:Gtk.Button" /> class.</remarks>
2003-03-15 22:50:24 +00:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
2003-11-05 04:30:47 +00:00
<MemberSignature Language= "C#" Value= "public Button (IntPtr raw);" />
2003-03-15 22:50:24 +00:00
<MemberType > Constructor</MemberType>
<ReturnValue />
2003-11-05 04:30:47 +00:00
<Parameters >
<Parameter Name= "raw" Type= "System.IntPtr" />
</Parameters>
<Docs >
<summary > Internal constructor</summary>
<param name= "raw" > an object of type <see cref= "T:System.IntPtr" /> </param>
<returns > an object of type <see cref= "T:Gtk.Button" /> </returns>
<remarks > This is not typically used by C# code.</remarks>
</Docs>
</Member>
<Member MemberName= "InButton" >
<MemberSignature Language= "C#" Value= "public bool InButton { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-09-06 14:47:48 +00:00
<summary > Whether or not the cursor is inside the button.</summary>
<returns > a <see cref= "T:System.Boolean" /> , true if the cursor is inside the button.</returns>
2004-09-27 19:20:35 +00:00
<remarks />
2003-11-05 04:30:47 +00:00
</Docs>
</Member>
<Member MemberName= "NewWithMnemonic" >
<MemberSignature Language= "C#" Value= "public static Gtk.Button NewWithMnemonic (string label);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > Gtk.Button</ReturnType>
</ReturnValue>
2003-03-15 22:50:24 +00:00
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "label" Type= "System.String" />
</Parameters>
2003-03-15 22:50:24 +00:00
<Docs >
2003-11-05 04:30:47 +00:00
<summary > Creates a labeled <see cref= "T:Gtk.Button" /> .</summary>
<param name= "label" > a <see cref= "T:System.String" /> </param>
<returns > a <see cref= "T:Gtk.Button" /> </returns>
2003-07-17 06:38:40 +00:00
<remarks > Constructor that creates a labeled <see cref= "T:Gtk.Button" /> . The label
2003-05-14 12:14:31 +00:00
shows the string passed as parameter.</remarks>
2003-03-07 01:30:00 +00:00
</Docs>
</Member>
2003-05-21 21:31:19 +00:00
<Member MemberName= ".ctor" >
2003-11-05 04:30:47 +00:00
<MemberSignature Language= "C#" Value= "public Button (string stock_id);" />
2003-05-21 21:31:19 +00:00
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
2003-11-05 04:30:47 +00:00
<Parameter Name= "stock_id" Type= "System.String" />
2003-09-17 21:56:59 +00:00
</Parameters>
2003-05-21 21:31:19 +00:00
<Docs >
2003-11-05 04:30:47 +00:00
<summary > Creates a new <see cref= "T:Gtk.Button" /> containing the image and text from a stock item.</summary>
<param name= "stock_id" > a <see cref= "T:System.String" /> </param>
<returns > a <see cref= "T:Gtk.Button" /> </returns>
<remarks > The valid names of Stock items can be found in the <see cref= "T:Gtk.Stock" /> class.</remarks>
2003-05-21 21:31:19 +00:00
</Docs>
</Member>
2003-12-24 01:35:30 +00:00
<Member MemberName= "GType" >
<MemberSignature Language= "C#" Value= "public static GLib.GType GType { get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-06-21 20:14:42 +00:00
<summary > GType Property.</summary>
2003-12-24 01:35:30 +00:00
<returns > a <see cref= "T:GLib.GType" /> </returns>
2004-06-21 20:14:42 +00:00
<remarks > Returns the native <see cref= "T:GLib.GType" /> value for <see cref= "T:Gtk.Button" /> .</remarks>
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
<Member MemberName= "ActionGetType" >
<MemberSignature Language= "C#" Value= "public static GLib.GType ActionGetType ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-09-06 14:47:48 +00:00
<summary > Returns the kind of action this button does.</summary>
2003-12-24 01:35:30 +00:00
<returns > a <see cref= "T:GLib.GType" /> </returns>
2004-09-06 14:47:48 +00:00
<remarks > There are four possible options: "ignored", "selects", "drags",
and "expands".</remarks>
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
<Member MemberName= "OnEntered" >
<MemberSignature Language= "C#" Value= "protected virtual void OnEntered ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-06-15 15:41:25 +00:00
<summary > Default handler for the <see cref= "M:Gtk.Button.Entered" /> event.</summary>
<remarks > Override this method in a subclass to provide a default handler for the <see cref= "M:Gtk.Button.Entered" /> event.</remarks>
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
<Member MemberName= "OnReleased" >
<MemberSignature Language= "C#" Value= "protected virtual void OnReleased ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-06-15 15:41:25 +00:00
<summary > Default handler for the <see cref= "M:Gtk.Button.Released" /> event.</summary>
<remarks > Override this method in a subclass to provide a default handler for the <see cref= "M:Gtk.Button.Released" /> event.</remarks>
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
<Member MemberName= "OnPressed" >
<MemberSignature Language= "C#" Value= "protected virtual void OnPressed ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-06-15 15:41:25 +00:00
<summary > Default handler for the <see cref= "M:Gtk.Button.Pressed" /> event.</summary>
<remarks > Override this method in a subclass to provide a default handler for the <see cref= "M:Gtk.Button.Pressed" /> event.</remarks>
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
<Member MemberName= "OnLeft" >
<MemberSignature Language= "C#" Value= "protected virtual void OnLeft ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-06-15 15:41:25 +00:00
<summary > Default handler for the <see cref= "M:Gtk.Button.Left" /> event.</summary>
<remarks > Override this method in a subclass to provide a default handler for the <see cref= "M:Gtk.Button.Left" /> event.</remarks>
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
<Member MemberName= "OnClicked" >
<MemberSignature Language= "C#" Value= "protected virtual void OnClicked ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-06-15 15:41:25 +00:00
<summary > Default handler for the <see cref= "M:Gtk.Button.Clicked" /> event.</summary>
<remarks > Override this method in a subclass to provide a default handler for the <see cref= "M:Gtk.Button.Clicked" /> event.</remarks>
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
<Member MemberName= "OnActivated" >
<MemberSignature Language= "C#" Value= "protected virtual void OnActivated ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-06-15 15:41:25 +00:00
<summary > Default handler for the <see cref= "M:Gtk.Button.Activated" /> event.</summary>
<remarks > Override this method in a subclass to provide a default handler for the <see cref= "M:Gtk.Button.Activated" /> event.</remarks>
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "protected Button (GLib.GType gtype);" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
<Parameter Name= "gtype" Type= "GLib.GType" />
</Parameters>
<Docs >
2004-06-21 20:33:11 +00:00
<summary > Protected Constructor.</summary>
2003-12-24 01:35:30 +00:00
<param name= "gtype" > a <see cref= "T:GLib.GType" /> </param>
<returns > a <see cref= "T:Gtk.Button" /> </returns>
2004-06-21 20:33:11 +00:00
<remarks > Chain to this constructor if you have manually registered a native <see cref= "T:GLib.GType" /> value for your subclass.</remarks>
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
2004-09-27 19:20:35 +00:00
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public Button (Gtk.Widget widget);" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
<Parameter Name= "widget" Type= "Gtk.Widget" />
</Parameters>
<Docs >
<summary > Constructs a button containing a specified Child widget.</summary>
<param name= "widget" > a child <see cref= "T:Gtk.Widget" /> </param>
<returns > a <see cref= "T:Gtk.Button" /> </returns>
<remarks >
2004-11-05 21:25:40 +00:00
</remarks>
</Docs>
</Member>
<Member MemberName= "FocusOnClick" >
<MemberSignature Language= "C#" Value= "public bool FocusOnClick { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-12-31 21:06:38 +00:00
<summary >
Whether the button grabs focus when it is clicked with the mouse.
</summary>
2004-11-05 21:25:40 +00:00
<returns > a <see cref= "T:System.Boolean" /> </returns>
2005-04-21 17:10:54 +00:00
<remarks >
</remarks>
2004-11-05 21:25:40 +00:00
</Docs>
</Member>
<Member MemberName= "Xalign" >
<MemberSignature Language= "C#" Value= "public float Xalign { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Single</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-12-31 21:06:38 +00:00
<summary >
2005-04-21 17:10:54 +00:00
If the child of the button is a <see cref= "T:Gtk.Misc" />
or <see cref= "T:Gtk.Alignment" /> , this property
2004-12-31 21:06:38 +00:00
can be used to control its horizontal alignment.
</summary>
<returns > a <see cref= "T:System.Single" /> ;
0.0 is left aligned, 1.0 is right aligned.
</returns>
2005-04-21 17:10:54 +00:00
<remarks >
</remarks>
2004-11-05 21:25:40 +00:00
</Docs>
</Member>
<Member MemberName= "Yalign" >
<MemberSignature Language= "C#" Value= "public float Yalign { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Single</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-12-31 21:06:38 +00:00
<summary >
2005-04-21 17:10:54 +00:00
If the child of the button is a <see cref= "T:Gtk.Misc" />
or <see cref= "T:Gtk.Alignment" /> , this property
2004-12-31 21:06:38 +00:00
can be used to control its vertical alignment.
</summary>
<returns >
a <see cref= "T:System.Single" /> ;
0.0 is top aligned, 1.0 is bottom aligned.
</returns>
2005-04-21 17:10:54 +00:00
<remarks >
</remarks>
2004-11-05 21:25:40 +00:00
</Docs>
</Member>
<Member MemberName= "GetAlignment" >
<MemberSignature Language= "C#" Value= "public void GetAlignment (out float xalign, out float yalign);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "xalign" Type= "System.Single&" RefType= "out" />
<Parameter Name= "yalign" Type= "System.Single&" RefType= "out" />
</Parameters>
<Docs >
2004-12-31 21:06:38 +00:00
<summary > Gets the alignment of the child in the button.</summary>
<param name= "xalign" > a <see cref= "T:System.Single" /> to put the horizontal alignment in</param>
<param name= "yalign" > a <see cref= "T:System.Single" /> to put the vertical alignment in</param>
<remarks > A convenience method; shouldn't be </remarks>
2004-11-05 21:25:40 +00:00
</Docs>
</Member>
<Member MemberName= "SetAlignment" >
<MemberSignature Language= "C#" Value= "public void SetAlignment (float xalign, float yalign);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "xalign" Type= "System.Single" />
<Parameter Name= "yalign" Type= "System.Single" />
</Parameters>
<Docs >
2004-12-31 21:06:38 +00:00
<summary >
Sets the alignment of the child.
</summary>
<param name= "xalign" > a <see cref= "T:System.Single" /> ,
the horizontal position of the child; 0.0 is left aligned,
1.0 is right aligned.</param>
<param name= "yalign" > a <see cref= "T:System.Single" /> ,
the vertical position of the child; 0.0 is top aligned,
1.0 is bottom aligned.</param>
<remarks >
This has no effect
2005-04-21 17:10:54 +00:00
unless the button's child is a <see cref= "T:Gtk.Misc" />
or <see cref= "T:Gtk.Alignment" /> .
2004-12-31 21:06:38 +00:00
</remarks>
2004-09-27 19:20:35 +00:00
</Docs>
</Member>
2005-04-21 17:10:54 +00:00
<Member MemberName= "Image" >
<MemberSignature Language= "C#" Value= "public Gtk.Widget Image { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > Gtk.Widget</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
<summary > To be added</summary>
<returns > a <see cref= "T:Gtk.Widget" /> </returns>
<remarks > To be added</remarks>
</Docs>
</Member>
2003-02-12 02:00:12 +00:00
</Members>
2005-04-21 17:10:54 +00:00
</Type>