From 0656b6f4950f4c0329c10474cd78cd08d05294ce Mon Sep 17 00:00:00 2001 From: Lee Mallabone Date: Tue, 25 Feb 2003 08:27:52 +0000 Subject: [PATCH] Add documentation to Font selectors. svn path=/trunk/gtk-sharp/; revision=11944 --- doc/ChangeLog | 5 ++++ doc/en/Gtk/FontSelection.xml | 43 +++++++++++++++++------------- doc/en/Gtk/FontSelectionDialog.xml | 42 ++++++++++++++--------------- 3 files changed, 51 insertions(+), 39 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 5c6f8014f..4930aa351 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,8 @@ +2003-02-25 Lee Mallabone + + * en/Gtk/FontSelection.xml: + * en/Gtk/FontSelectionDialog.xml: docs for Font widgets + 2003-02-24 Kevin Breit * en/Gtk/ArrowType.xml: Fixed a tag mismatch error that caused it to break compile. diff --git a/doc/en/Gtk/FontSelection.xml b/doc/en/Gtk/FontSelection.xml index 00356b96e..be9bee2db 100644 --- a/doc/en/Gtk/FontSelection.xml +++ b/doc/en/Gtk/FontSelection.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,15 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A FontSelection is a widget that allows the user to select a font. + + The FontSelection widget lists the available fonts, styles and sizes, allowing the user to select a font. It is used in the widget to provide a box for selecting fonts. + + 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). + + + 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. + Gtk.VBox @@ -79,9 +86,9 @@ - To be added - To be added: an object of type 'Gtk.FontSelection' - To be added + The main way to construct a new FontSelection + + Creates a new FontSelection widget that allows the user to select from the available fonts. @@ -106,10 +113,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + Manage the name of the font that is selected in this widget. + The name of a system font to select. + The name of the currently selected font. + 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. @@ -122,10 +129,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + The text used to display a preview of the selected font. + Text that should be displayed using the selected font. + The text currently displaying the selected font. + This property determines the exact string that is displayed in the 'preview area' of the FontSelection. @@ -135,10 +142,10 @@ Gdk.Font - To be added - To be added: an object of type 'Gdk.Font' - To be added + Get the that is currently selected. + A Gdk font object representing the selected font, or null if no font is selected. + - \ No newline at end of file + diff --git a/doc/en/Gtk/FontSelectionDialog.xml b/doc/en/Gtk/FontSelectionDialog.xml index 1837ed452..44ca41bf7 100644 --- a/doc/en/Gtk/FontSelectionDialog.xml +++ b/doc/en/Gtk/FontSelectionDialog.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A FontSelectionDialog is a widget that opens a window requesting the user to select a font + The FontSelectionDialog widget displays a window listing the available fonts, styles and sizes, allowing the user to select a font. It effectively places a widget in a . Gtk.Dialog @@ -39,10 +39,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'bool' - To be added + Sets the name of the font that is selected in this widget. + The name of a system font to select. + if was a valid font, otherwise. + 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. @@ -97,10 +97,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.FontSelectionDialog' - To be added + Create a new FontSelectionDialog + A title that will appear in the window's title bar. + A new FontSelectionDialog + @@ -109,9 +109,9 @@ - To be added - To be added: an object of type 'Gtk.FontSelectionDialog' - To be added + Internal constructor. Should not be used. + + @@ -133,9 +133,9 @@ System.String - To be added - To be added: an object of type 'string' - To be added + The name of the font that is selected in this widget + The name of the currently selected font. + @@ -148,10 +148,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + The text used to display a preview of the selected font. + Text that should be displayed using the selected font. + The text currently displaying the selected font. + This property determines the exact string that is displayed in the 'preview area' of the FontSelectionDialog.