From d77d6bbcea17f74e196a9c1951342320d793ad3a Mon Sep 17 00:00:00 2001 From: John Luke Date: Sat, 31 May 2003 01:14:01 +0000 Subject: [PATCH] fix bulleted list in Fixed.xml Add First draft for MessageDialog.xml and InputDialog.xml svn path=/trunk/gtk-sharp/; revision=15015 --- doc/ChangeLog | 4 +- doc/en/Gtk/Fixed.xml | 11 +++-- doc/en/Gtk/InputDialog.xml | 45 ++++++++++++------ doc/en/Gtk/MessageDialog.xml | 89 +++++++++++++++++++++++++++--------- 4 files changed, 108 insertions(+), 41 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 5a9c75077..0182726f7 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,9 +1,11 @@ 2003-05-30 John Luke - * en/Gtk/ToggleButton.xml: Fix typo. + * en/Gtk/ToggleButton.xml: Fix typo, bulleted list. * en/Gtk/Progress.xml: Fix typo. * en/Gtk/Tooltips.xml: Fix method signature. * en/Gtk/Button.xml: Add some info. + * en/Gtk/MessageDialog.xml: Add first draft + * en/Gtk/InputDialog: Add first draft 2003-05-29 Lee Mallabone diff --git a/doc/en/Gtk/Fixed.xml b/doc/en/Gtk/Fixed.xml index 132fadf68..916e1ffb6 100644 --- a/doc/en/Gtk/Fixed.xml +++ b/doc/en/Gtk/Fixed.xml @@ -12,11 +12,12 @@ The widget is a container which can place child widgets at fixed positions and with fixed sizes, given in pixels. performs no automatic layout management. For most applications, you should not use this container! It keeps you from having to learn about the other Gtk# containers, but it results in broken applications. With , the following things will result in truncated text, overlapping widgets, and other display bugs: - Themes, which may change widget sizes. - Fonts other than the one you used to write the app will of course change the size of widgets containing text; keep in mind that users may use a larger font because of difficulty reading the default, or they may be using Windows or the framebuffer port of GTK+, where different fonts are available. - Translation of text into other languages changes its size. Also, display of non-English text will use a different font in many cases. - - In addition, the fixed widget can't properly be mirrored in right-to-left languages such as Hebrew and Arabic. i.e. normally GTK+ will flip the interface to put labels to the right of the thing they label, but it can't do that with . So your application will not be usable in right-to-left languages. + Themes, which may change widget sizes. + Fonts other than the one you used to write the app will of course change the size of widgets containing text; keep in mind that users may use a larger font because of difficulty reading the default, or they may be using Windows or the framebuffer port of GTK+, where different fonts are available. + Translation of text into other languages changes its size. Also, display of non-English text will use a different font in many cases. + + + In addition, the fixed widget can't properly be mirrored in right-to-left languages such as Hebrew and Arabic. i.e. normally Gtk# will flip the interface to put labels to the right of the thing they label, but it can't do that with . So your application will not be usable in right-to-left languages. Finally, fixed positioning makes it kind of annoying to add/remove GUI elements, since you have to reposition all the other elements. This is a long-term maintenance problem for your application. If you know none of these things are an issue for your application, and prefer the simplicity of , by all means use the widget. But you should be aware of the tradeoffs. diff --git a/doc/en/Gtk/InputDialog.xml b/doc/en/Gtk/InputDialog.xml index 4edca2531..f3dd3dc2f 100644 --- a/doc/en/Gtk/InputDialog.xml +++ b/doc/en/Gtk/InputDialog.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,23 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Configure devices for the XInput extension. + + + NOTE: this is considered too specialized/little-used for Gtk#, and will in the future be moved to some other package. + If your application needs this , feel free to use it, as the does work and is useful in some applications; it's just not of general interest. + However, we are not accepting new features for the , and it will eventually move out of the Gtk# distribution. + + + displays a which allows the user to configure XInput extension devices. + For each device, they can control the mode of the device (disabled, screen-relative, or window-relative), the mapping of axes to coordinates, and the mapping of the devices macro keys to key press events. + + + contains two s to which the application can connect; one for closing the , and one for saving the changes. + No actions are bound to these by default. + The changes that the user makes take effect immediately. + + Gtk.Dialog @@ -63,9 +78,9 @@ - To be added - To be added: an object of type 'Gtk.InputDialog' - To be added + Creates an instance of + an object of type + Creates an instance of @@ -75,8 +90,8 @@ System.UInt32 - The GLib Type for Gtk.InputDialog - The GLib Type for the Gtk.InputDialog class. + The for + The for the class. @@ -86,8 +101,10 @@ - To be added - To be added + Emitted when the user changes the mode of a device from a GDK_MODE_SCREEN or GDK_MODE_WINDOW to GDK_MODE_ENABLED. + + This signal is emitted when the user changes the mode of a device from a GDK_MODE_SCREEN or GDK_MODE_WINDOW to GDK_MODE_ENABLED. + @@ -96,8 +113,10 @@ - To be added - To be added + Emitted when the user changes the mode of a device from GDK_MODE_DISABLED to a GDK_MODE_SCREEN or GDK_MODE_WINDOW. + + This signal is emitted when the user changes the mode of a device from GDK_MODE_DISABLED to a GDK_MODE_SCREEN or GDK_MODE_WINDOW. + @@ -117,4 +136,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/MessageDialog.xml b/doc/en/Gtk/MessageDialog.xml index 5e82568c2..ee8a1bbac 100644 --- a/doc/en/Gtk/MessageDialog.xml +++ b/doc/en/Gtk/MessageDialog.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,42 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Convenient message window + + + presents a with an image representing the (Error, Question, etc.) alongside some message text. + It's simply a convenience ; you could construct the equivalent of from without too much effort, but saves typing. + + + The easiest way to do a modal message dialog is to use , + though you can also pass in the flag, automatically makes the from modal and waits for the user to respond to it. + returns when any in the is clicked. + + A modal dialog + + +MessageDialog md = new MessageDialog + (parent_window, Gtk.DialogFlags.DestroyWithParent, + Gtk.MessageType.Error, Gtk.ButtonsType.Close, "Error loading file"); + +md.Run (); +md.Destroy (); + + + + A non-modal dialog + + +MessageDialog md = new MessageDialog + (parent_window, Gtk.DialogFlags.DestroyWithParent, + Gtk.MessageType.Error, Gtk.ButtonsType.Close, "Error loading file"); + +// Destroy the dialog when the user responds to it (e.g. clicks a button) +// ::add signal handler code here:: + + + + Gtk.Dialog @@ -51,7 +85,7 @@ Internal constructor Pointer to the C object. - An instance of MessageDialog, wrapping the C object. + An instance of , wrapping the C object. This is an internal constructor, and should not be used by user code. @@ -63,9 +97,11 @@ - To be added - To be added: an object of type 'Gtk.MessageDialog' - To be added + Internal constructor + an object of type + + This is an internal constructor, and should not be used by user code. + @@ -80,14 +116,23 @@ - To be added - To be added: an object of type 'Gtk.Window' - To be added: an object of type 'Gtk.DialogFlags' - To be added: an object of type 'Gtk.MessageType' - To be added: an object of type 'Gtk.ButtonsType' - To be added: an object of type 'string' - To be added: an object of type 'Gtk.MessageDialog' - To be added + Creates an instance of + an object of type + an object of type + an object of type + an object of type + an object of type + an object of type + + Creates an instance of + + +MessageDialog md = new MessageDialog + (parent_window, Gtk.DialogFlags.DestroyWithParent, + Gtk.MessageType.Error, Gtk.ButtonsType.Close, "Error loading file"); + + + @@ -97,8 +142,8 @@ System.UInt32 - The GLib Type for Gtk.MessageDialog - The GLib Type for the Gtk.MessageDialog class. + The for + The for the class. @@ -109,9 +154,9 @@ Gtk.MessageType - To be added - To be added: an object of type 'Gtk.MessageType' - To be added + The of the + an object of type + The of the @@ -124,11 +169,11 @@ Internal constructor GLib type for the type - Creates a new instance of MessageDialog, using the GLib-provided type + Creates a new instance of , using the GLib-provided type This is a constructor used by derivative types of that would have their own GLib type assigned to it. This is not typically used by C# code. - \ No newline at end of file +