GtkSharp/doc/en/Gtk/FontSelection.xml
Mike Kestner 352fc8e849 Run the doc updater
Didn't audit any of this.
2012-03-28 22:10:46 -05:00

247 lines
10 KiB
XML

<Type Name="FontSelection" FullName="Gtk.FontSelection">
<TypeSignature Language="C#" Maintainer="Lee Mallabone" Value="public class FontSelection : Gtk.VBox" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit FontSelection extends Gtk.VBox" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
</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>
<Base>
<BaseTypeName>Gtk.VBox</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<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>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FontSelection ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>The main way to construct a new FontSelection</summary>
<remarks>
<para>Creates a new FontSelection widget that allows the user to select from the available fonts.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FontSelection (IntPtr raw);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int raw) cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="raw">Pointer to the C object.</param>
<summary>Internal constructor</summary>
<remarks>
<para>This is an internal constructor, and should not be used by user code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Face">
<MemberSignature Language="C#" Value="public Pango.FontFace Face { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Pango.FontFace Face" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.FontFace</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="FaceList">
<MemberSignature Language="C#" Value="public Gtk.Widget FaceList { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Gtk.Widget FaceList" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.Widget</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="Family">
<MemberSignature Language="C#" Value="public Pango.FontFamily Family { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Pango.FontFamily Family" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.FontFamily</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="FamilyList">
<MemberSignature Language="C#" Value="public Gtk.Widget FamilyList { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Gtk.Widget FamilyList" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.Widget</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="FontName">
<MemberSignature Language="C#" Value="public string FontName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string FontName" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("font-name")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Manage the name of the font that is selected in this widget.</summary>
<value>The name of the currently selected font.</value>
<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="GType">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; }" />
<MemberSignature Language="ILAsm" Value=".property valuetype GLib.GType GType" />
<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.FontSelection" />.</remarks>
</Docs>
</Member>
<Member MemberName="PreviewEntry">
<MemberSignature Language="C#" Value="public Gtk.Widget PreviewEntry { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Gtk.Widget PreviewEntry" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.Widget</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="PreviewText">
<MemberSignature Language="C#" Value="public string PreviewText { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string PreviewText" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("preview-text")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The text used to display a preview of the selected font.</summary>
<value>The text currently displaying the selected font.</value>
<remarks>
<para>This property determines the exact string that is displayed in the 'preview area' of the FontSelection.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="SetFontName">
<MemberSignature Language="C#" Value="public bool SetFontName (string fontname);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SetFontName(string fontname) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fontname" Type="System.String" />
</Parameters>
<Docs>
<param name="fontname">the name of the font to be selected</param>
<summary>Set the current font selection</summary>
<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>
<Member MemberName="Size">
<MemberSignature Language="C#" Value="public int Size { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Size" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="SizeEntry">
<MemberSignature Language="C#" Value="public Gtk.Widget SizeEntry { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Gtk.Widget SizeEntry" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.Widget</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="SizeList">
<MemberSignature Language="C#" Value="public Gtk.Widget SizeList { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Gtk.Widget SizeList" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.Widget</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
</Members>
</Type>