GtkSharp/doc/en/Gtk/FontSelection.xml

<Type Name="FontSelection" FullName="Gtk.FontSelection">
  <TypeSignature Language="C#" Value="public class FontSelection : Gtk.VBox, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Lee Mallabone" />
  <AssemblyInfo>
    <AssemblyName>gtk-sharp</AssemblyName>
    <AssemblyPublicKey>
    </AssemblyPublicKey>
    <AssemblyVersion>0.0.0.0</AssemblyVersion>
    <AssemblyCulture>neutral</AssemblyCulture>
    <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 FontSelection is a widget that allows the user to select a font.</summary>
    <remarks>
      <para>The FontSelection widget lists the available fonts, styles and sizes, allowing the user to select a font. It is used in the <see cref="T:Gtk.FontSelectionDialog" /> widget to provide a <see cref="T:Gtk.Dialog" /> box for selecting fonts.
    </para>
      <para>Filters can be used to limit the fonts shown. There are 2 filters in the FontSelection - a base filter and a user filter. The base filter can not be changed by the user, so this can be used when the user must choose from the restricted set of fonts (e.g. for a terminal-type application you may want to force the user to select a fixed-width font).
    </para>
      <para>
    The user filter can be changed or reset by the user, by using the 'Reset Filter' button or changing the options on the 'Filter' page of the widget.
    </para>
    </remarks>
  </Docs>
  <Base>
    <BaseTypeName>Gtk.VBox</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="Finalize">
      <MemberSignature Language="C#" Value="protected override 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 FontSelection (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 FontSelection, 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 FontSelection ();" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>The main way to construct a new FontSelection</summary>
        <returns />
        <remarks>
          <para>Creates a new FontSelection widget that allows the user to select from the available fonts.</para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="FontName">
      <MemberSignature Language="C#" Value="public string FontName { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Manage the name of the font that is selected in this widget.</summary>
        <param name="value">The name of a system font to select.</param>
        <returns>The name of the currently selected font.</returns>
        <remarks>
          <para>If this property is used to alter the widget's font name to a font that could not be found, the widget will retain its original font selection. See also <see cref="M:Gtk.FontSelection.SetFontName" />, which returns a value indicating whether or not the new font name was found.</para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="PreviewText">
      <MemberSignature Language="C#" Value="public string PreviewText { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>The text used to display a preview of the selected font.</summary>
        <param name="value">Text that should be displayed using the selected font.</param>
        <returns>The text currently displaying the selected font.</returns>
        <remarks>
          <para>This property determines the exact string that is displayed in the 'preview area' of the FontSelection.</para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Font">
      <MemberSignature Language="C#" Value="public Gdk.Font Font { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Font</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Get the <see cref="T:Gdk.Font" /> that is currently selected.</summary>
        <returns>A Gdk font object representing the selected font, or null if no font is selected.</returns>
        <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>
        <returns>a <see cref="T:GLib.GType" /></returns>
        <remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.FontSelection" />.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected FontSelection (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>
        <returns>a <see cref="T:Gtk.FontSelection" /></returns>
        <remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
      </Docs>
    </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>Set the current font selection</summary>
        <param name="fontname">the name of the font to be selected</param>
        <returns><see langword="true" /> if the font was found and selected</returns>
        <remarks>This can be used instead of setting <see cref="P:Gtk.FontSelection.FontName" /> property if you need to know whether or not <paramref name="fontname" /> was valid.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>