From af529da444e7533f34f8bb8a262447085c73059c Mon Sep 17 00:00:00 2001 From: John Luke Date: Sun, 15 Jun 2003 16:44:25 +0000 Subject: [PATCH] * en/Gtk/Dialog.xml: add more info * en/Gtk/DialogFlags: add first draft svn path=/trunk/gtk-sharp/; revision=15423 --- doc/ChangeLog | 4 ++ doc/en/Gtk/Dialog.xml | 139 ++++++++++++++++++++++++------------- doc/en/Gtk/DialogFlags.xml | 20 +++--- 3 files changed, 106 insertions(+), 57 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 00473e98e..fd269f755 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2003-06-15 John Luke + * en/Gtk/Dialog.xml: add more info + * en/Gtk/DialogFlags: add first draft + 2003-06-13 John Luke * en/Gtk/ProgressBarStyle.xml * en/Gtk/ProgressBarOrientation.xml diff --git a/doc/en/Gtk/Dialog.xml b/doc/en/Gtk/Dialog.xml index 7fc493585..1abcb833b 100644 --- a/doc/en/Gtk/Dialog.xml +++ b/doc/en/Gtk/Dialog.xml @@ -9,11 +9,11 @@ Creates popup windows. - Dialog boxes are a convenient way to prompt the user for a small amount of input, eg. to display a message, ask a question, or anything else that does not require extensive effort on the user's part. - GTK+ treats a dialog as a window split vertically. The top section is a , and is where widgets such as a or an should be packed. The bottom area is known as the . This is generally used for packing buttons into the dialog which may perform functions such as cancel, ok, or apply. The two areas are separated by a . - The two primary areas of a dialog can be accessed as the property and the property. To set the dialog to be model, use the property. - If you want to block waiting for a dialog to return before returning control flow to your code, you can call . This function enters a recursive main loop and waits for the user to respond to the dialog, returning the response ID corresponding to the button the user clicked. - For the simple dialog, in reality you'd probably use a to save yourself some effort. But you'd need to create the dialog contents manually if you had more than a simple message in the dialog. + boxes are a convenient way to prompt the user for a small amount of input, eg. to display a message, ask a question, or anything else that does not require extensive effort by the user. + Gtk# treats a dialog as a window split vertically. The top section is a , and is where widgets such as a or an should be packed. The bottom area is known as the . This is generally used for packing buttons into the dialog which may perform functions such as cancel, ok, or apply. The two areas are separated by a . + The two primary areas of a dialog can be accessed as the property and the property. To set the dialog to be modal, use the property. + If you want to block waiting for a dialog to return before returning control flow to your code, you can call . This function enters a recursive main loop and waits for the user to respond to the dialog, returning the corresponding to the the user clicked. + For a simple dialog, you would probably use to save yourself some effort. However, you would need to create the contents manually if you had more than a simple message in the . @@ -46,10 +46,13 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'int' - To be added + Adds an activatable widget to the of a . + an object of type . + an object of type . + + Adds an activatable to the of a , connecting a signal handler that will on the when the is activated. + The is appended to the end of the . If you want to add a non-activatable , simply pack it into the field of the . + @@ -60,9 +63,27 @@ - To be added - To be added: an object of type 'int' - To be added + Waits for the event or the to be detroyed. + an object of type . + + + Waits for the event or the to be destroyed. + If the is destroyed during the call to , returns . + Otherwise, it returns the response ID from the event. + Before entering the recursive main loop, calls on the for you. + Note that you still need to show any children of the yourself. + + + During , the default behavior of is disabled; + if the receives , it will not be destroyed as usual, and will return . + Also, during the will be modal. + You can force to return at any time by calling to emit the event. + Destroying the during is a very bad idea, because your post-run code will not know whether the was destroyed or not. + + + After returns, you are responsible for hiding or destroying the if you wish to do so. + + @@ -75,9 +96,13 @@ - To be added - To be added: an object of type 'int' - To be added + Emits the event with the given response ID. + an object of type . + + Emits the event with the given response ID. + Used to indicate that the user has responded to the in some way; + typically either you or will be monitoring the event and take appropriate action. + @@ -91,11 +116,16 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'int' - To be added: an object of type 'Gtk.Widget' - To be added + Adds a with the given text. + an object of type . + an object of type . + an object of type + + Adds a with the given text (or a stock button, if button_text is a stock ID) + and sets things up so that clicking the will emit a with the given response_id. + The is appended to the end of the . + The is returned, but usually you do not need it. + @@ -109,10 +139,13 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'bool' - To be added + A convenient way to sensitize/desensitize dialog buttons. + an object of type . + an object of type . + + Calls for each widget in the with the given response_id. + A convenient way to sensitize/desensitize dialog buttons. + @@ -149,9 +182,12 @@ - To be added - To be added: an object of type 'Gtk.Dialog' - To be added + Creates a new dialog box. + an object of type . + + Creates a new dialog box. + This is an internal constructor, and should not be used by user code. + @@ -164,12 +200,16 @@ - To be added - To be added: an object of type 'string' - 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.Dialog' - To be added + Creates a new dialog box. + an object of type . + an object of type . + an object of type . + an object of type . + + Creates a new with the specified title and parent widget. + The argument can be used to make the dialog modal () + and/or to have it destroyed along with its parent (). + @@ -179,8 +219,8 @@ System.UInt32 - The GLib Type for Gtk.Dialog - The GLib Type for the Gtk.Dialog class. + The for . + The for the class. @@ -192,7 +232,7 @@ To be added - To be added: an object of type 'Gtk.VBox' + an object of type To be added @@ -204,7 +244,7 @@ To be added - To be added: an object of type 'Gtk.VBox' + an object of type . To be added @@ -218,10 +258,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + Sets the default response_id. + an object of type + an object of type + Sets the default response_id. @@ -234,10 +274,10 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Whether to display a . + an object of type + an object of type + Whether to display a in the above the @@ -247,7 +287,12 @@ To be added - To be added + + Emitted when an action widget is clicked, the + receives a delete event, or the application programmer calls . + On a delete event, the response ID is . + Otherwise, it depends on which action widget was clicked. + @@ -277,4 +322,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/DialogFlags.xml b/doc/en/Gtk/DialogFlags.xml index 4d965bce7..9aa0a25a9 100644 --- a/doc/en/Gtk/DialogFlags.xml +++ b/doc/en/Gtk/DialogFlags.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 + Flags used in creation. + System.Enum @@ -34,8 +34,8 @@ - To be added - To be added + Sets the property = for the . + Sets the property = for the . @@ -46,8 +46,8 @@ - To be added - To be added + Destroying the parent will also destroy the . + Destroying the parent will also destroy the . @@ -58,8 +58,8 @@ - To be added - To be added + No separator bar above the buttons. + No separator bar above the buttons. @@ -75,4 +75,4 @@ - \ No newline at end of file +