GtkSharp/doc/en/Gtk/FontButton.xml
Mike Kestner 0e47e78f96 update docs to 2.8 API and document all new members
svn path=/trunk/gtk-sharp/; revision=54175
2005-12-09 23:12:49 +00:00

255 lines
9.6 KiB
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.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 to launch a font selection dialog.</summary>
<remarks>
</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>Protected Constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></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(Message=null, IsError=False)</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>Internal constructor</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<remarks>This is not typically used by C# code.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FontButton ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Public constructor.</summary>
<remarks>
</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>Public constructor with a font name.</summary>
<param name="fontname">a <see cref="T:System.String" />, name of font to display in font selection dialog.</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>GType Property.</summary>
<value>a <see cref="T:GLib.GType" /></value>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.FontButton" />.</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>If this property is <see langword="true" />, the font size will be displayed along with the name of the selected font.</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="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>
If this property is set to <see langword="true" />, the selected font size will be shown in the label.
</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks>For a more WYSIWYG way to show the selected size, see the <see cref="P:Gtk.FontButton.UseSize" /> property.</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="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>Retrieves the name of the currently selected font.</summary>
<value>a <see cref="T:System.String" /></value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="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>Whether the label is drawn in the selected font.</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="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>The title of the font dialog.</summary>
<value>a <see cref="T:System.String" /></value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="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>Returns whether the name of the font style will be shown in the label.</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="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>Event raised when the font is set.</summary>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Signal(CName="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 currently-displayed font in font picker dialog.</summary>
<param name="fontname">a <see cref="T:System.String" />, name of font to display in font selection dialog</param>
<returns>A string containing the font name if the
font selection dialog exists, otherwise <see langword="false" />.</returns>
<remarks>
</remarks>
</Docs>
</Member>
</Members>
</Type>