GtkSharp/doc/en/Gtk/ToolButton.xml

255 lines
9.4 KiB
XML
Raw Normal View History

<Type Name="ToolButton" FullName="Gtk.ToolButton">
<TypeSignature Language="C#" Maintainer="auto" Value="public class ToolButton : Gtk.ToolItem" />
<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.8.0.0</AssemblyVersion>
</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 for a toolbar.</summary>
<remarks>
</remarks>
<since version="Gtk# 2.4" />
</Docs>
<Base>
<BaseTypeName>Gtk.ToolItem</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Members>
<Member MemberName="OnClicked">
<MemberSignature Language="C#" Value="protected virtual void OnClicked ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Default handler for the <see cref="M:Gtk.ToolButton.Clicked" /> event.</summary>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.ToolButton.Clicked" /> event.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ToolButton (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>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete(Message=null, IsError=False)</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ToolButton (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Constructor for internal use only.</summary>
<param name="raw">a <see cref="T:System.IntPtr" />, pointer to underlying C object.</param>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ToolButton (Gtk.Widget icon_widget, string label);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="icon_widget" Type="Gtk.Widget" />
<Parameter Name="label" Type="System.String" />
</Parameters>
<Docs>
<summary>Public constructor</summary>
<param name="icon_widget">a <see cref="T:Gtk.Widget" />, a widget that will be used as icon widget, or <see langword="null" /></param>
<param name="label">a <see cref="T:System.String" />, a label for this button, or <see langword="null" /></param>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ToolButton (string stock_id);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="stock_id" Type="System.String" />
</Parameters>
<Docs>
<summary>Public constructor that uses a stock item.</summary>
<param name="stock_id">a <see cref="T:System.String" />, the name of the stock item</param>
<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>
<value>a <see cref="T:GLib.GType" /></value>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="Label">
<MemberSignature Language="C#" Value="public string Label { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The label for this button.</summary>
<value>a <see cref="T:System.String" /></value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="label")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="StockId">
<MemberSignature Language="C#" Value="public string StockId { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>If this is a stock item, the ID for the stock item.</summary>
<value>a <see cref="T:System.String" /></value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="stock-id")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="LabelWidget">
<MemberSignature Language="C#" Value="public Gtk.Widget LabelWidget { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.Widget</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The label for this button in widget form.</summary>
<value>a <see cref="T:Gtk.Widget" /></value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="label-widget")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="IconWidget">
<MemberSignature Language="C#" Value="public Gtk.Widget IconWidget { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.Widget</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The icon for this button, in widget form.</summary>
<value>a <see cref="T:Gtk.Widget" /></value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="icon-widget")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="UseUnderline">
<MemberSignature Language="C#" Value="public bool UseUnderline { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Whether the button label has the form "_Open".</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks>
<para>
If set, an underline in the label property indicates that the next character
should be used for the mnemonic accelerator key in the overflow menu. For
example, if the label property is "_Open" and this property is set,
the label on the tool button will be "Open" and the item on the overflow
menu will have an underlined 'O'.
</para>
<para>
Labels shown on tool buttons never have mnemonics on them; this property
only affects the menu item on the overflow menu.
</para>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="use-underline")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Clicked">
<MemberSignature Language="C#" Value="public event EventHandler Clicked;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>This signal is emitted when the tool button is clicked with
the mouse or activated with the keyboard.</summary>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Signal(CName="clicked")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="IconName">
<MemberSignature Language="C#" Value="public string IconName { set; get; };" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="icon-name")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Accesses the icon as a name in an Icon theme.</summary>
<value>a name in an Icon theme.</value>
<remarks />
<since version="Gtk# 2.8" />
</Docs>
</Member>
</Members>
</Type>