GtkSharp/doc/en/Gtk/FontButton.xml

<Type Name="FontButton" FullName="Gtk.FontButton">
  <TypeSignature Language="C#" Maintainer="auto" Value="public class FontButton : Gtk.Button" />
  <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.10.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>This class extends <see cref="T:Gtk.Button" />, providing an simple button for font selection.</summary>
    <remarks>
      <para>When clicked, a <see cref="T:Gtk.FontButton" /> shows a <see cref="T:Gtk.FontSelectionDialog" /> and when the dialog closes with a change, <see cref="E:Gtk.FontButton.FontSet" /> is evoked.</para>
      <example>
        <para>In the following example, a <see cref="T:Gtk.FontButton" /> is used to modify the font of a <see cref="T:Gtk.Label" />.</para>
        <code lang="C#">using System;
using Gtk;
using Pango;

public class FontButtonExample
{
	static Label label;
	static FontButton button;
	
	public static void Main ()
	{
		Application.Init ();
		
		Window myWindow = new Window ("FontButton Example");
		myWindow.DeleteEvent += OnDelete;

		button = new FontButton ();
		button.FontSet += OnFontSet;
		
		label = new Label ("Sample text");
		
		VBox box = new VBox ();
		box.Add (button);
		box.Add (label);
		
		myWindow.Add (box);
		myWindow.ShowAll ();
		Application.Run ();
	}
	
	static void OnFontSet (object o, EventArgs e)
	{
		label.ModifyFont (FontDescription.FromString (button.FontName));
	}
	
	static void OnDelete (object o, DeleteEventArgs e)
	{
		Application.Quit ();
	}
}</code>
      </example>
    </remarks>
    <since version="Gtk# 2.4" />
  </Docs>
  <Base>
    <BaseTypeName>Gtk.Button</BaseTypeName>
  </Base>
  <Interfaces>
  </Interfaces>
  <Members>
    <Member MemberName="OnFontSet">
      <MemberSignature Language="C#" Value="protected virtual void OnFontSet ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Default handler for the <see cref="M:Gtk.FontButton.FontSet" /> event.</summary>
        <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.FontButton.FontSet" /> event.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected FontButton (GLib.GType gtype);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="gtype" Type="GLib.GType" />
      </Parameters>
      <Docs>
        <summary>Constructs and initializes a new instance of <see cref="T:Gtk.FontButton" /> for a specified native GLib type.</summary>
        <param name="gtype">A <see cref="T:GLib.GType" /> object containing the native GLib type for the new instance.</param>
        <remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>System.Obsolete</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public FontButton (IntPtr raw);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="raw" Type="System.IntPtr" />
      </Parameters>
      <Docs>
        <summary>Constructs and initializes a new instance of <see cref="T:Gtk.FontButton" /> using an existing unmanaged object as its base.</summary>
        <param name="raw">A <see cref="T:System.IntPtr" /> pointing to the raw object to be managed by the new instance.</param>
        <remarks>This is not typically used by managed code. It is primarily used for enclosing an existing object, created by unmanaged code, in a managed wrapper.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public FontButton ();" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>Constructs and initializes a new instance of <see cref="T:Gtk.FontButton" /> with the default font.</summary>
        <remarks>To specify the default font on creation, use <see cref="C:Gtk.FontButton(System.String)" />.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public FontButton (string fontname);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="fontname" Type="System.String" />
      </Parameters>
      <Docs>
        <summary>Constructs and initializes a new instance of <see cref="T:Gtk.FontButton" /> with a specified initial font.</summary>
        <param name="fontname">A <see cref="T:System.String" /> object containing the name of the initial font to use in the new instance.</param>
        <remarks>The value of <paramref name="fontname" /> is in the same format as described in the remarks on <see cref="P:Gtk.FontButton.FontName" />.</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>Gets the GLib type of the current instance.</summary>
        <value>A <see cref="T:GLib.GType" /> value representing the native GLib type of <see cref="T:Gtk.FontButton" />.</value>
        <remarks>The value is used internally by the GLib type management system.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ShowSize">
      <MemberSignature Language="C#" Value="public bool ShowSize { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Gets and sets whether or not to show the font size in the button.</summary>
        <value>
          <para>A <see cref="T:System.Boolean" />. If <see langword="true" />, the font size will be displayed in the button.</para>
        </value>
        <remarks>Default Value: <see langword="true" /></remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("show-size")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="UseSize">
      <MemberSignature Language="C#" Value="public bool UseSize { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Gets and sets whether or not button label should be displayed using the selected font size.</summary>
        <value>
          <para>A <see cref="T:System.Boolean" />. If <see langword="true" />, the button label will be displayed using the selected font size. Otherwise in the default system font size.</para>
        </value>
        <remarks>For a more WYSIWYG way to show the selected size, see the <see cref="P:Gtk.FontButton.UseFont" /> property.</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("use-size")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="FontName">
      <MemberSignature Language="C#" Value="public string FontName { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Gets and sets the name of the currently selected font, including the style and size.</summary>
        <value>A <see cref="T:System.String" /> object containing the name of the currently selected font, including the style and font.</value>
        <remarks>
          <para>The font name contains the name, style, and size. For example, <c>"Bistream Vera Serif Bold Italic 24"</c>. If the style is not specified, <c>"Regular"</c> is assumed, and if the size is not specified, <c>"0"</c> is assumed.</para>
          <para>Default Value: <c>"Sans 12"</c>. This value is identical to the one that would be used by <see cref="M:Gdk.Font.Load(System.String)" /> and <see cref="M:Pango.FontDescription.FromString(System.String)" />.</para>
        </remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("font-name")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="UseFont">
      <MemberSignature Language="C#" Value="public bool UseFont { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Gets and sets whether or not button label should be displayed using the selected font.</summary>
        <value>
          <para>A <see cref="T:System.Boolean" />. If <see langword="true" />, the button label will be displayed using the selected font. Otherwise in the default system font.</para>
        </value>
        <remarks>Default Value: <see langword="false" /></remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("use-font")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="Title">
      <MemberSignature Language="C#" Value="public string Title { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Gets and sets the title used for the <see cref="T:Gtk.FontSelectionDialog" /> created by the currrent instance.</summary>
        <value>A <see cref="T:System.String" /> object containing the title used for the <see cref="T:Gtk.FontSelectionDialog" /> created by the currrent instance.</value>
        <remarks>Default Value: <c>"Pick a Font"</c> or a translated version.</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("title")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="ShowStyle">
      <MemberSignature Language="C#" Value="public bool ShowStyle { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Gets and sets whether or not the font style will be shown with the font name in the button.</summary>
        <value>
          <para>A <see cref="T:System.Boolean" />. If <see langword="true" />, the font style will be displayed along with the name of the selected font, unless the style is "Regular".</para>
        </value>
        <remarks>Default Value: <see langword="true" /></remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("show-style")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="FontSet">
      <MemberSignature Language="C#" Value="public event EventHandler FontSet;" />
      <MemberType>Event</MemberType>
      <ReturnValue>
        <ReturnType>System.EventHandler</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>This event is raised when the user closes the child <see cref="T:Gtk.FontSelectionDialog" /> after making a change.</summary>
        <remarks>Child classes should override <see cref="M:Gtk.FontButton.OnFontSet" /> instead of adding a handler to this event.</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Signal("font-set")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="SetFontName">
      <MemberSignature Language="C#" Value="public bool SetFontName (string fontname);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="fontname" Type="System.String" />
      </Parameters>
      <Docs>
        <summary>Sets or updates the font displayed in the child <see cref="T:Gtk.FontSelectionDialog" />.</summary>
        <param name="fontname">A <see cref="T:System.String" /> object containing the name of the font to display in the child <see cref="T:Gtk.FontSelectionDialog" />.</param>
        <returns>The result of <see cref="M:Gtk.FontSelectionDialog.SetFontName(System.String)" /> if the child dialog exists. Otherwise <see langword="false" />.</returns>
        <remarks>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>