ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add documentation to Font selectors.

Browse source 
svn path=/trunk/gtk-sharp/; revision=11944
This commit is contained in:
Lee Mallabone 2003-02-25 08:27:52 +00:00
parent 2535823e9a
commit 0656b6f495
3 changed files with 51 additions and 39 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/ChangeLog
View file

@ -1,3 +1,8 @@
2003-02-25 Lee Mallabone <mono-docs@fonicmonkey.net>
* en/Gtk/FontSelection.xml:
* en/Gtk/FontSelectionDialog.xml: docs for Font widgets
2003-02-24 Kevin Breit <mrproper@ximian.com> 2003-02-24 Kevin Breit <mrproper@ximian.com>
* en/Gtk/ArrowType.xml: Fixed a tag mismatch error that caused it to break compile. * en/Gtk/ArrowType.xml: Fixed a tag mismatch error that caused it to break compile.

43
doc/en/Gtk/FontSelection.xml
View file

@ -1,5 +1,5 @@
<Type Name="FontSelection" FullName="Gtk.FontSelection"> <Type Name="FontSelection" FullName="Gtk.FontSelection">
<TypeSignature Language="C#" Value="public class FontSelection : Gtk.VBox, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" /> <TypeSignature Language="C#" Value="public class FontSelection : Gtk.VBox, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Lee Mallabone" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,15 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>A FontSelection is a widget that allows the user to select a font.</summary>
<remarks>To be added</remarks> <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> </Docs>
<Base> <Base>
<BaseTypeName>Gtk.VBox</BaseTypeName> <BaseTypeName>Gtk.VBox</BaseTypeName>
@ -79,9 +86,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The main way to construct a new FontSelection</summary>
<returns>To be added: an object of type 'Gtk.FontSelection'</returns> <returns></returns>
<remarks>To be added</remarks> <remarks><para>Creates a new FontSelection widget that allows the user to select from the available fonts.</para></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -106,10 +113,10 @@
<Parameter Name="value" Type="System.String" /> <Parameter Name="value" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Manage the name of the font that is selected in this widget.</summary>
<param name="value">To be added: an object of type 'string'</param> <param name="value">The name of a system font to select.</param>
<returns>To be added: an object of type 'string'</returns> <returns>The name of the currently selected font.</returns>
<remarks>To be added</remarks> <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.</para></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PreviewText"> <Member MemberName="PreviewText">
@ -122,10 +129,10 @@
<Parameter Name="value" Type="System.String" /> <Parameter Name="value" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>The text used to display a preview of the selected font.</summary>
<param name="value">To be added: an object of type 'string'</param> <param name="value">Text that should be displayed using the selected font.</param>
<returns>To be added: an object of type 'string'</returns> <returns>The text currently displaying the selected font.</returns>
<remarks>To be added</remarks> <remarks><para>This property determines the exact string that is displayed in the 'preview area' of the FontSelection.</para></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Font"> <Member MemberName="Font">
@ -135,10 +142,10 @@
<ReturnType>Gdk.Font</ReturnType> <ReturnType>Gdk.Font</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Get the <see cref="T:Gdk.Font"/> that is currently selected.</summary>
<returns>To be added: an object of type 'Gdk.Font'</returns> <returns>A Gdk font object representing the selected font, or null if no font is selected.</returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

42
doc/en/Gtk/FontSelectionDialog.xml
View file

@ -1,5 +1,5 @@
<Type Name="FontSelectionDialog" FullName="Gtk.FontSelectionDialog"> <Type Name="FontSelectionDialog" FullName="Gtk.FontSelectionDialog">
<TypeSignature Language="C#" Value="public class FontSelectionDialog : Gtk.Dialog, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" /> <TypeSignature Language="C#" Value="public class FontSelectionDialog : Gtk.Dialog, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Lee Mallabone" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>A FontSelectionDialog is a widget that opens a window requesting the user to select a font</summary>
<remarks>To be added</remarks> <remarks><para>The FontSelectionDialog widget displays a window listing the available fonts, styles and sizes, allowing the user to select a font. It effectively places a <see cref="T:Gtk.FontSelection"/> widget in a <see cref="T:Gtk.Dialog"/>.</para></remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>Gtk.Dialog</BaseTypeName> <BaseTypeName>Gtk.Dialog</BaseTypeName>
@ -39,10 +39,10 @@
<Parameter Name="fontname" Type="System.String" /> <Parameter Name="fontname" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the name of the font that is selected in this widget.</summary>
<param name="fontname">To be added: an object of type 'string'</param> <param name="fontname">The name of a system font to select.</param>
<returns>To be added: an object of type 'bool'</returns> <returns><langword name="true"/> if <paramref name="fontname"/> was a valid font, <langword name="false"/> otherwise.</returns>
<remarks>To be added</remarks> <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.</para></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Finalize"> <Member MemberName="Finalize">
@ -97,10 +97,10 @@
<Parameter Name="title" Type="System.String" /> <Parameter Name="title" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Create a new FontSelectionDialog</summary>
<param name="title">To be added: an object of type 'string'</param> <param name="title">A title that will appear in the window's title bar.</param>
<returns>To be added: an object of type 'Gtk.FontSelectionDialog'</returns> <returns>A new FontSelectionDialog</returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -109,9 +109,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal constructor. Should not be used.</summary>
<returns>To be added: an object of type 'Gtk.FontSelectionDialog'</returns> <returns></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -133,9 +133,9 @@
<ReturnType>System.String</ReturnType> <ReturnType>System.String</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The name of the font that is selected in this widget</summary>
<returns>To be added: an object of type 'string'</returns> <returns>The name of the currently selected font.</returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PreviewText"> <Member MemberName="PreviewText">
@ -148,10 +148,10 @@
<Parameter Name="value" Type="System.String" /> <Parameter Name="value" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>The text used to display a preview of the selected font.</summary>
<param name="value">To be added: an object of type 'string'</param> <param name="value">Text that should be displayed using the selected font.</param>
<returns>To be added: an object of type 'string'</returns> <returns>The text currently displaying the selected font.</returns>
<remarks>To be added</remarks> <remarks><para>This property determines the exact string that is displayed in the 'preview area' of the FontSelectionDialog.</para></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>