From 6e2e6f6f36b6cb8e9d504152947b02cbb8519164 Mon Sep 17 00:00:00 2001 From: Miguel de Icaza Date: Fri, 2 Nov 2007 22:13:55 +0000 Subject: [PATCH] Gorgeous and wonderul docs from maarten@alpha-cursus.nl svn path=/trunk/gtk-sharp/; revision=88753 --- doc/en/Gdk/GC.xml | 4 +-- doc/en/Gtk/ComboBox.xml | 6 ++-- doc/en/Gtk/FileChooser.xml | 4 +-- doc/en/Gtk/FileChooserAction.xml | 4 +-- doc/en/Gtk/FileChooserButton.xml | 22 +++++++----- doc/en/Gtk/FileChooserWidget.xml | 7 +++- doc/en/Gtk/FontButton.xml | 57 ++++---------------------------- doc/en/Gtk/SpinButton.xml | 4 +-- 8 files changed, 37 insertions(+), 71 deletions(-) diff --git a/doc/en/Gdk/GC.xml b/doc/en/Gdk/GC.xml index e14086057..a7fbb8be5 100644 --- a/doc/en/Gdk/GC.xml +++ b/doc/en/Gdk/GC.xml @@ -182,7 +182,7 @@ Retrieves the current values from a graphics context. - the GdkGCValues structure in which to store the results. + the structure in which to store the results. Retrieves the current values from a graphics context. @@ -671,4 +671,4 @@ - + \ No newline at end of file diff --git a/doc/en/Gtk/ComboBox.xml b/doc/en/Gtk/ComboBox.xml index 989721708..afd3b00d4 100644 --- a/doc/en/Gtk/ComboBox.xml +++ b/doc/en/Gtk/ComboBox.xml @@ -648,9 +648,9 @@ Default value: 0 - To be added + Sets or gets whether the combo box will grab focus when it is clicked with the mouse. a - To be added + Making mouse clicks not grab focus is useful in places like toolbars where you don't want the keyboard focus removed from the main area of the application. @@ -857,4 +857,4 @@ Default value: 0 - + \ No newline at end of file diff --git a/doc/en/Gtk/FileChooser.xml b/doc/en/Gtk/FileChooser.xml index c39fb9b70..6186d466f 100644 --- a/doc/en/Gtk/FileChooser.xml +++ b/doc/en/Gtk/FileChooser.xml @@ -8,7 +8,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. Interface for a file-chooser. - See for an actual implementation. + See for an actual implementation. @@ -813,4 +813,4 @@ - + \ No newline at end of file diff --git a/doc/en/Gtk/FileChooserAction.xml b/doc/en/Gtk/FileChooserAction.xml index 1c8e84eef..f105630bb 100644 --- a/doc/en/Gtk/FileChooserAction.xml +++ b/doc/en/Gtk/FileChooserAction.xml @@ -7,7 +7,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - Describes whether a is being used to open existing files or to save to a possibly new file. + Describes whether a is being used to open existing files or to save to a possibly new file. @@ -77,4 +77,4 @@ - + \ No newline at end of file diff --git a/doc/en/Gtk/FileChooserButton.xml b/doc/en/Gtk/FileChooserButton.xml index 715412dc6..769f2799d 100644 --- a/doc/en/Gtk/FileChooserButton.xml +++ b/doc/en/Gtk/FileChooserButton.xml @@ -7,8 +7,11 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A button to launch a file selection dialog + The FileChooserButton is a widget that lets the user select a file. It implements the interface. Visually, it is a file name with a button to bring up a . The user can then use that dialog to change the file associated with that button. This widget does not support setting the "select-multiple" property to TRUE. + +The GtkFileChooserButton will ellipsize the label, and thus will thus request little horizontal space. To give the button more space, you should call , set , or pack the button in such a way that other interface elements give space to the widget. + @@ -60,7 +63,7 @@ - To be added + Creates a FileChooserButton. a a To be added @@ -76,7 +79,7 @@ - To be added + Creates a FileChooserButton with a specific backend. a a a @@ -91,8 +94,11 @@ - To be added - a + Creates a FileChooserButton which uses a specific widget as it's file-picking window. + a . + +dialog must be a (or subclass) which implements the interface and must not have = . + To be added @@ -135,7 +141,7 @@ - To be added + The width of the entry and label inside the button, in characters. a To be added @@ -871,4 +877,4 @@ A connected to this event must set - + \ No newline at end of file diff --git a/doc/en/Gtk/FileChooserWidget.xml b/doc/en/Gtk/FileChooserWidget.xml index 67f7156a7..628a21cc5 100644 --- a/doc/en/Gtk/FileChooserWidget.xml +++ b/doc/en/Gtk/FileChooserWidget.xml @@ -9,6 +9,11 @@ Widget to allow the selection of files from a directory. + + is a widget suitable for selecting files. It is the main building block of a . Most applications will only need to use the latter; you can use GtkFileChooserWidget as part of a larger window if you have special needs. + +Note that does not have any methods of its own. Instead, you should use the functions that work on a . + @@ -1025,4 +1030,4 @@ A connected to this event must set - + \ No newline at end of file diff --git a/doc/en/Gtk/FontButton.xml b/doc/en/Gtk/FontButton.xml index 8ed19d892..44442ef68 100644 --- a/doc/en/Gtk/FontButton.xml +++ b/doc/en/Gtk/FontButton.xml @@ -8,52 +8,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. This class extends , providing an simple button for font selection. - - When clicked, a shows a and when the dialog closes with a change, is evoked. - - In the following example, a is used to modify the font of a . - using System; -using Gtk; -using Pango; - -public class FontButtonExample -{ - static Label label; - static FontButton button; - - public static void Main () - { - Application.Init (); - - Window myWindow = new Window ("FontButton Example"); - myWindow.DeleteEvent += OnDelete; - - button = new FontButton (); - button.FontSet += OnFontSet; - - label = new Label ("Sample text"); - - VBox box = new VBox (); - box.Add (button); - box.Add (label); - - myWindow.Add (box); - myWindow.ShowAll (); - Application.Run (); - } - - static void OnFontSet (object o, EventArgs e) - { - label.ModifyFont (FontDescription.FromString (button.FontName)); - } - - static void OnDelete (object o, DeleteEventArgs e) - { - Application.Quit (); - } -} - - + The FontButton is a button which displays the currently selected font and allows to open a font selection dialog to change the font. It is suitable widget for selecting a font in a preference dialog. @@ -153,7 +108,7 @@ public class FontButtonExample A . If , the font size will be displayed in the button. - Default Value: + For a more WYSIWYG way to show the selected size, see the property. @@ -169,11 +124,11 @@ public class FontButtonExample - Gets and sets whether or not button label should be displayed using the selected font size. + If this property is set to , the label will be drawn in the selected font size. A . If , the button label will be displayed using the selected font size. Otherwise in the default system font size. - For a more WYSIWYG way to show the selected size, see the property. + @@ -289,10 +244,10 @@ public class FontButtonExample Sets or updates the font displayed in the child . A object containing the name of the font to display in the child . - The result of if the child dialog exists. Otherwise . + The return value of if the font selection dialog exists, otherwise . - + \ No newline at end of file diff --git a/doc/en/Gtk/SpinButton.xml b/doc/en/Gtk/SpinButton.xml index 8432596c3..60790ac6b 100644 --- a/doc/en/Gtk/SpinButton.xml +++ b/doc/en/Gtk/SpinButton.xml @@ -209,7 +209,7 @@ private void OutputValue(object source, System.EventArgs args) Creates a SpinButton without the need for a manually created . Minimum allowable value. Maximum allowable value. - The value to alter the SpinButton by when a is carried out on it. + The value to alter the SpinButton by when a is carried out on it. The default value of the new SpinButton is initially set to . The default page increment is set to 10 * . @@ -575,4 +575,4 @@ private void OutputValue(object source, System.EventArgs args) - + \ No newline at end of file