From 793b5ded7176bc7bb6169676e66c11c9c9851a7a Mon Sep 17 00:00:00 2001 From: Martin Willemoes Hansen Date: Mon, 4 Aug 2003 11:30:11 +0000 Subject: [PATCH] * /en/Gnome/InteractFunction.xml: * /en/Gnome/ModuleClassInitHook.xml: * /en/Gnome/ModuleHook.xml: * /en/Gnome/ModuleInitHook.xml: * /en/Gnome/TriggerActionFunction.xml: * /en/Gnome/UISignalConnectFunc.xml: documented svn path=/trunk/gtk-sharp/; revision=17047 --- doc/ChangeLog | 8 ++++++++ doc/en/Gnome/InteractFunction.xml | 20 ++++++++++++++++++-- doc/en/Gnome/ModuleClassInitHook.xml | 3 +-- doc/en/Gnome/ModuleHook.xml | 10 ++++++++-- doc/en/Gnome/ModuleInitHook.xml | 8 ++++++-- doc/en/Gnome/TriggerActionFunction.xml | 14 ++++++++++++-- doc/en/Gnome/UISignalConnectFunc.xml | 15 +++++++++++++-- 7 files changed, 66 insertions(+), 12 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 0596313df..697c6a08a 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,11 @@ +2003-08-04 Martin Willemoes Hansen + * /en/Gnome/InteractFunction.xml: + * /en/Gnome/ModuleClassInitHook.xml: + * /en/Gnome/ModuleHook.xml: + * /en/Gnome/ModuleInitHook.xml: + * /en/Gnome/TriggerActionFunction.xml: + * /en/Gnome/UISignalConnectFunc.xml: documented + 2003-08-03 Martin Willemoes Hansen * /en/Gnome/ClientState.xml: diff --git a/doc/en/Gnome/InteractFunction.xml b/doc/en/Gnome/InteractFunction.xml index dd0e82e51..f0c72cdf7 100644 --- a/doc/en/Gnome/InteractFunction.xml +++ b/doc/en/Gnome/InteractFunction.xml @@ -7,8 +7,24 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + + Used when the wishes to interact with the user at + the session manager's convenience (usually during shutdown and restarts). + + + + All other s are blocked from interacting with the user until the + key is released via a call to . + + + Although the function is not obliged to respect the passed in , + it is bad form not to do so. + + client : The instance doing the interaction. + key : A unique key. + dialog_type : The that should be used to do the interaction. + data : Application specific data that was specified at the time the callback was set up. + System.Delegate diff --git a/doc/en/Gnome/ModuleClassInitHook.xml b/doc/en/Gnome/ModuleClassInitHook.xml index d29cbc320..1a7f74c30 100644 --- a/doc/en/Gnome/ModuleClassInitHook.xml +++ b/doc/en/Gnome/ModuleClassInitHook.xml @@ -7,8 +7,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Called to perform any class specific setup that is required by each module. System.Delegate diff --git a/doc/en/Gnome/ModuleHook.xml b/doc/en/Gnome/ModuleHook.xml index c88d23506..6618839c6 100644 --- a/doc/en/Gnome/ModuleHook.xml +++ b/doc/en/Gnome/ModuleHook.xml @@ -7,8 +7,14 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + + Called to perform some initialization in a module + (which could be either the main init function or the pre or post argument parsing phase). + + + program : The instance which is being initialized. + mod_info : The current module's structure. + System.Delegate diff --git a/doc/en/Gnome/ModuleInitHook.xml b/doc/en/Gnome/ModuleInitHook.xml index b9398f5e8..bc6ea6a06 100644 --- a/doc/en/Gnome/ModuleInitHook.xml +++ b/doc/en/Gnome/ModuleInitHook.xml @@ -7,8 +7,12 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Called to allow a module to do any pre-initialization it might need to do + prior to having arguments parsed by the controlling parent module + + The parent module will do the argument parsing for all modules in the hierarchy. + mod_info : The current module's structure. + System.Delegate diff --git a/doc/en/Gnome/TriggerActionFunction.xml b/doc/en/Gnome/TriggerActionFunction.xml index 8ae8ee955..5706c38e7 100644 --- a/doc/en/Gnome/TriggerActionFunction.xml +++ b/doc/en/Gnome/TriggerActionFunction.xml @@ -7,8 +7,18 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + + Can be used as a target for + of instances. + + + + msg : The human-readable message that was passed to + . May be null. + + level : The severity level of the event. May be null. + supinfo : The section in which the event belongs. + System.Delegate diff --git a/doc/en/Gnome/UISignalConnectFunc.xml b/doc/en/Gnome/UISignalConnectFunc.xml index 82c459074..0b12c8063 100644 --- a/doc/en/Gnome/UISignalConnectFunc.xml +++ b/doc/en/Gnome/UISignalConnectFunc.xml @@ -7,8 +7,19 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Are called as a result of signals being emitted from a menu or tool bar item + + + Delegates of this type are given as the first element of a + instance. + + uiinfo : The user data that was part of the instance. + signal_name : The name of the emitted signal. + + uibdata : The user data that was part of the relevant + instance. + + System.Delegate