diff --git a/doc/en/Gtk/Application.xml b/doc/en/Gtk/Application.xml index 703f75175..0db52fb4d 100644 --- a/doc/en/Gtk/Application.xml +++ b/doc/en/Gtk/Application.xml @@ -7,8 +7,16 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Application class + + + Provides the initialization and event loop iteration related + methods for the GTK widget library. Since GTK+ is an event + driven toolkit, Applications register callbacks against various + events to handle user input. These callbacks are invoked from + the main event loop when events are detected. + + System.Object @@ -24,8 +32,12 @@ - To be added - To be added + Quits the current main loop + + + Makes the innermost invocation of the main loop return when it regains control. + + @@ -36,8 +48,41 @@ - To be added - To be added + + + + Runs a single iteration of the mainloop. If no events are + waiting to be processed GTK+ will block until the next + event is noticed. If you don't want to block look at or check if + any events are pending with first. + + + + + + + Method + + System.Void + + + + + + + A boolean value, whether the iteration should block or not + + + Runs a single iteration of the mainloop. If is true, then if no events are + waiting to be processed GTK+ will block until the next + event is noticed; If is false, + then it if no events are waiting to be processed Gtk+ the + routine will return immediately. + + @@ -48,9 +93,29 @@ - To be added - To be added: an object of type 'bool' - To be added + Whether there are events on the queue + true if events are available to be processed, false otherwise + + + Checks if any events are pending. This can be used to + update the GUI and invoke timeouts etc. while doing some + time intensive computation. + + + + void LongComputation () + { + while (!done){ + ComputationChunk (); + + // Flush pending events to keep the GUI reponsive + while (Application.EventsPending ()) + Application.RunIteration (); + } + } + + + @@ -61,20 +126,80 @@ - To be added - To be added + Runs the main loop + + + Runs the main loop until is called. You can nest + calls to . In that + case will make the + innermost invocation of the main loop return. + + - + Method System.Void - + + + - To be added - To be added + Initializes GTK+ for operation. + The arguments to pass to the toolkit + + + Call this function before using any other GTK+ functions + in your GUI applications. It will initialize everything + needed to operate the toolkit. + + + This function will terminate your program if it was unable + to initialize the GUI for some reason. If you want your + program to fall back to a textual interface you want to + call instead. + + + The args values will be modified after Gtk has removed the + command line options that it handles itself. + + + + + + + Method + + System.Boolean + + + + + + Initializes GTK+ for operation, probes window system. + true if the toolkit was initialized, false if the + windowing system can not be initilized. + The arguments to pass to the toolkit + + + You use this call to initialize GTK+ for your GUI + applications. This method will allow your application to + be both GUI/text. A true return value means that the + toolkit was initialized, a false value means that the + toolkit could not be initialized. If you do not want to + do dual GUI/text applications, you can use instead. + + + This function will terminate your program if it was unable + to initialize the GUI for some reason. If you want your + program to fall back to a textual interface you want to + call instead. + + @@ -89,18 +214,32 @@ - + Method System.Void - - - + - To be added - To be added: an object of type 'String[]&' - To be added + Initializes GTK+ for operation. + + + Call this function before using any other GTK+ functions + in your GUI applications. It will initialize everything + needed to operate the toolkit. + + + This function will terminate your program if it was unable + to initialize the GUI for some reason. If you want your + program to fall back to a textual interface you want to + call instead. + + + If you want to pass arguments from the command line use + the + method instead. + +