338 lines
13 KiB
XML
338 lines
13 KiB
XML
<Type Name="ToggleButton" FullName="Gtk.ToggleButton">
|
|
<TypeSignature Language="C#" Value="public class ToggleButton : Gtk.Button, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="John Luke" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>gtk-sharp</AssemblyName>
|
|
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
<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>A button that can be toggled on and off.</summary>
|
|
<remarks>
|
|
<para>A <see cref="T:Gtk.ToggleButton" /> is a <see cref="T:Gtk.Button" /> which will remain 'pressed-in' when clicked.
|
|
Clicking again will cause the toggle button to return to its normal state. This is useful if you need to maintain the state of a button.</para>
|
|
<example>
|
|
<code lang="C#" source="ToggleButton.cs">
|
|
using Gtk;
|
|
using GtkSharp;
|
|
using System;
|
|
|
|
public class ToggleButtonApp {
|
|
|
|
ToggleButton btn;
|
|
|
|
public static int Main (string[] args)
|
|
{
|
|
new ToggleButtonApp();
|
|
return 0;
|
|
}
|
|
|
|
public ToggleButtonApp()
|
|
{
|
|
Application.Init ();
|
|
Window win = new Window ("ToggleButton Tester");
|
|
win.SetDefaultSize (200, 150);
|
|
win.DeleteEvent += new DeleteEventHandler (Window_Delete);
|
|
btn = new ToggleButton ("Unselected");
|
|
btn.Active = false;
|
|
btn.Toggled += new EventHandler (btn_toggled);
|
|
win.Add (btn);
|
|
win.ShowAll ();
|
|
Application.Run ();
|
|
}
|
|
|
|
void btn_toggled (object obj, EventArgs args)
|
|
{
|
|
Console.WriteLine ("Button Toggled");
|
|
if (btn.Active)
|
|
{
|
|
btn.Label = "Unselected";
|
|
}
|
|
else
|
|
{
|
|
btn.Label = "Selected";
|
|
}
|
|
}
|
|
|
|
static void Window_Delete (object obj, DeleteEventArgs args)
|
|
{
|
|
Application.Quit ();
|
|
args.RetVal = true;
|
|
}
|
|
|
|
}
|
|
</code>
|
|
</example>
|
|
</remarks>
|
|
</Docs>
|
|
<Base>
|
|
<BaseTypeName>Gtk.Button</BaseTypeName>
|
|
</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>
|
|
<Member MemberName="NewWithLabel">
|
|
<MemberSignature Language="C#" Value="public static Gtk.ToggleButton NewWithLabel (string label);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.ToggleButton</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="label" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Creates a new <see cref="T:Gtk.ToggleButton" /> with a text label.</summary>
|
|
<param name="label">a <see cref="T:System.String" /> containing the message to be placed in the toggle button.</param>
|
|
<returns>a new <see cref="T:Gtk.ToggleButton" />.</returns>
|
|
<remarks>Creates a new <see cref="T:Gtk.ToggleButton" /> with a text label.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Toggle">
|
|
<MemberSignature Language="C#" Value="public void Toggle ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Emits the <see cref="E:Gtk.ToggleButton.Toggled" /> event</summary>
|
|
<remarks>Emits the <see cref="E:Gtk.ToggleButton.Toggled" /> event on the <see cref="T:Gtk.ToggleButton" />. There is no good reason for an application ever to call this function.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Finalize">
|
|
<MemberSignature Language="C#" Value="protected virtual void Finalize ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Disposes the resources associated with the object.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public ToggleButton (IntPtr raw);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="raw" Type="System.IntPtr" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Internal constructor</summary>
|
|
<param name="raw">Pointer to the C object.</param>
|
|
<returns>An instance of <see cref="T:Gtk.ToggleButton" />, wrapping the C object.</returns>
|
|
<remarks>
|
|
<para>This is an internal constructor, and should not be used by user code.</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public ToggleButton ();" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Creates a new <see cref="T:Gtk.ToggleButton" /> object</summary>
|
|
<returns>an object of type <see cref="T:Gtk.ToggleButton" /></returns>
|
|
<remarks>
|
|
<para>
|
|
Creates a new <see cref="T:Gtk.ToggleButton" />, which is a
|
|
<see cref="T:Gtk.Container" />. A widget should be packed
|
|
inside the toggle button using <see cref="M:Gtk.Container.Add (Gtk.Widget)" />.
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<code lang="C#">
|
|
Label label = new Label();
|
|
ToggleButton btn = new ToggleButton ();
|
|
btn.Add(label);
|
|
</code>
|
|
</example>
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public ToggleButton (string label);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="label" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Creates a new <see cref="T:Gtk.ToggleButton" /> with a text label.</summary>
|
|
<param name="label">a <see cref="T:System.String" /> containing the message to be placed in the toggle button.</param>
|
|
<returns>an object of type <see cref="T:Gtk.ToggleButton" /></returns>
|
|
<remarks>Creates a new <see cref="T:Gtk.ToggleButton" /> with a text label.
|
|
<example>
|
|
<code lang="C#">ToggleButton btn = new ToggleButton ("ToggleButton");</code>
|
|
</example></remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GType">
|
|
<MemberSignature Language="C#" Value="public static uint GType { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.UInt32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>The <see cref="T:GLib.Type" /> for <see cref="T:Gtk.ToggleButton" /></summary>
|
|
<returns>The <see cref="T:GLib.Type" /> for the <see cref="T:Gtk.ToggleButton" /></returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Mode">
|
|
<MemberSignature Language="C#" Value="public bool Mode { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>The Mode of the <see cref="T:Gtk.ToggleButton" /></summary>
|
|
<param name="value">an object of type <see cref="T:System.Boolean" /></param>
|
|
<returns>an object of type <see cref="T:System.Boolean" /></returns>
|
|
<remarks>
|
|
<para>The Mode of the <see cref="T:Gtk.ToggleButton" /></para>
|
|
<para>Sets whether the button is displayed as a separate indicator and label.
|
|
You can call this function on a <see cref="T:Gtk.CheckButton" /> or a <see cref="T:Gtk.RadioButton" /> with <see cref="P:Gtk.ToggleButton.DrawIndicator" /> = <see langword="false" /> to make the button look like a normal button
|
|
</para>
|
|
<para>This function only effects instances of classes like <see cref="T:Gtk.CheckButton" /> and <see cref="T:Gtk.RadioButton" />
|
|
that derive from <see cref="T:Gtk.ToggleButton" />, not instances of <see cref="T:Gtk.ToggleButton" /> itself.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Inconsistent">
|
|
<MemberSignature Language="C#" Value="public bool Inconsistent { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Determines if the <see cref="T:Gtk.ToggleButton" /> has an intermediate state.</summary>
|
|
<param name="value">an object of type <see cref="T:System.Boolean" /></param>
|
|
<returns>an object of type <see cref="T:System.Boolean" /></returns>
|
|
<remarks>
|
|
<para>
|
|
If the user has selected a range of elements (such as some text or spreadsheet cells) that are affected by a <see cref="T:Gtk.ToggleButton" />,
|
|
and the current values in that range are inconsistent, you may want to display the toggle in an "in between" state.
|
|
This function turns on "in between" display. Normally you would turn off the inconsistent state again if the user toggles the <see cref="T:Gtk.ToggleButton" />.
|
|
This has to be done manually, <see cref="P:Gtk.ToggleButton.Inconsistent" /> only affects visual appearance, it does not affect the semantics of the <see cref="T:Gtk.Button" />.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Active">
|
|
<MemberSignature Language="C#" Value="public bool Active { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Get or set the <see cref="T:Gtk.ToggleButton" /> active</summary>
|
|
<param name="value">an object of type <see cref="T:System.Boolean" /></param>
|
|
<returns>an object of type <see cref="T:System.Boolean" /></returns>
|
|
<remarks>
|
|
<para>Get or set the <see cref="T:Gtk.ToggleButton" /> active.</para>
|
|
<para>Get: Queries a <see cref="T:Gtk.ToggleButton" /> and returns its current state.
|
|
Returns <see langword="true" /> if the toggle button is pressed in and <see langword="false" /> if it is raised.
|
|
</para>
|
|
<example>
|
|
<code lang="C#">
|
|
if (btn.Active) {
|
|
Console.WriteLine("The ToggleButton is pressed in");
|
|
}
|
|
else {
|
|
Console.WriteLine("The ToggleButton is raised");
|
|
}
|
|
</code>
|
|
</example>
|
|
<para>Set: Sets the status of the toggle button. Set to <see langword="true" /> if you want the GtkToggleButton to be 'pressed in', and <see langword="false" /> to raise it.
|
|
This action causes the toggled signal to be emitted.
|
|
</para>
|
|
<example>
|
|
<code lang="C#">
|
|
// set the togglebutton active
|
|
// and appear "pressed in"
|
|
btn.Active = true;
|
|
</code>
|
|
</example>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="DrawIndicator">
|
|
<MemberSignature Language="C#" Value="public bool DrawIndicator { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Determines the drawing style of a <see cref="T:Gtk.RadioButton" /> or <see cref="T:Gtk.CheckButton" /></summary>
|
|
<param name="value">an object of type <see cref="T:System.Boolean" /></param>
|
|
<returns>an object of type <see cref="T:System.Boolean" /></returns>
|
|
<remarks>The DrawIndicator property can be set to <see langword="false" /> to make
|
|
<see cref="T:Gtk.CheckButton" /> or <see cref="T:Gtk.RadioButton" /> look like a normal <see cref="T:Gtk.Button" />.
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Toggled">
|
|
<MemberSignature Language="C#" Value="public event EventHandler Toggled;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue><ReturnType>System.EventHandler</ReturnType></ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Triggered when the <see cref="T:Gtk.ToggleButton" /> is clicked.</summary>
|
|
<remarks>Should be connected if you wish to perform an action whenever the <see cref="T:Gtk.ToggleButton" /> state changes.
|
|
<example>
|
|
<code lang="C#">
|
|
ToggleButton btn = new ToggleButton("ToggleButton");
|
|
btn.Toggled += new EventHandler (btn_toggled);
|
|
|
|
void btn_toggled (object obj, EventArgs args)
|
|
{
|
|
// code for toggled event here
|
|
}
|
|
</code>
|
|
</example></remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected ToggleButton (GLib.Type gtype);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="gtype" Type="GLib.Type" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Internal constructor</summary>
|
|
<param name="gtype">GLib type for the type</param>
|
|
<returns>Creates a new instance of <see cref="T:Gtk.ToggleButton" />, using the GLib-provided type</returns>
|
|
<remarks>
|
|
<para>This is a constructor used by derivative types of <see cref="T:Gtk.ToggleButton" /> that would have their own <see cref="T:GLib.Type" /> assigned to it. This is not typically used by C# code.</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type>
|