From 186266a80899511471ade14f98f58818d0bb8299 Mon Sep 17 00:00:00 2001 From: "Hector E. Gomez Morales" Date: Wed, 17 Mar 2004 07:15:15 +0000 Subject: [PATCH] 2004-03-17 Alex Combas * en/Gtk/Accel.xml: Full doc. svn path=/trunk/gtk-sharp/; revision=24210 --- doc/ChangeLog | 3 + doc/en/Gtk/Accel.xml | 171 +++++++++++++++++++++++++++++-------------- doc/en/Gtk/TODO | 1 - 3 files changed, 118 insertions(+), 57 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index fd43e2e37..2628c75fb 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,6 @@ +2004-03-17 Alex Combas + * en/Gtk/Accel.xml: Full doc. + 2004-03-08 Hector E. Gomez Morales * en/Art/Global.xml * en/Art/Render.xml diff --git a/doc/en/Gtk/Accel.xml b/doc/en/Gtk/Accel.xml index 97f1cd62a..7e11c5592 100644 --- a/doc/en/Gtk/Accel.xml +++ b/doc/en/Gtk/Accel.xml @@ -1,5 +1,5 @@ - + gtk-sharp @@ -10,8 +10,11 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Accel Class + + Loadable keyboard accelerator specifications and groups. + + System.Object @@ -30,10 +33,20 @@ - To be added - a - a - To be added + Loops over the entries in the accelerator. + The data to be passed into . + A function to be executed for each accel map entry which is not filtered out. + + + Loops over the entries in the accelerator whose accel path doesn't match any of the filters added with , + and exectutes on each. + + + The signature of is that of , + the changed parameter indicates wheather this accelerator was changed during + runtime (thus, would need saving during an accelerator map dump). + + @@ -46,9 +59,9 @@ - To be added - a - To be added + Parses through a file previously saved with for accelerator specifications, and propagates them accordingly. + A file containing accelerator specifications. + @@ -63,12 +76,18 @@ - To be added - a - a - a - a - To be added + Finds the first accelerator in any . + An usually a , on which to activate the accelerator. + An accelerator keyval from a key event. + A keyboard state mask from a key event. + A returns if the accelerator was handled, and otherwise. + + + Finds the first accelerator in any attached + to that matches and + , and activates that accelerator. + + @@ -84,13 +103,19 @@ - To be added - a - a - a - a - a - To be added + Changes the and currently associated with . + A valid accelerator path. + An new accelerator key. + A new accelerator modifier. + A returns if other accelerators may be deleted upon conflicts. + A that returns if the accelerator can be changed, and otherwise. + + + Due to conflicts with other accelerators, a change may not always be possible, + indicates wheather other accelerators may be deleted to resolve such conflicts. A changed will only occur if all conflicts + could be resolved (which might not be the case if conflicting accelerators are locked). + + @@ -104,11 +129,11 @@ - To be added - a - a - a - To be added + Looks up the accelerator entry for and fills in . + A valid accelerator path. + An accelerator key to be filled in (optional). + A returns if is known, and otherwise. + @@ -121,9 +146,9 @@ - To be added - a - To be added + Filedescriptor variant of . + An valid readable file descriptor. + Note that the file descriptor will not be closed by this function. @@ -138,11 +163,26 @@ - To be added - a - a - a - To be added + Registers a new accelerator with the global accelerator map. + A valid accelerator path. + An accelerator key. + A accelerator modifier. + + + This function should only be called once per with the canonical + and for this path. + To change the accelerator during runtime programatically, use . + + + The accelerator path must consist of "<WINDOWTYPE>/Category1/Category2/.../Action", where + <WINDOWTYPE> should be a unique application-specific indentifier, that corresponds to the + kind of window the accelerator is being used in, e.g. "Gimp-Image", "Abiword-Document" or + "Gnumeric-Settings". The Category1/.../Action portion is most appropriately chosen by the action + the accelerator triggers, i.e. for accelerators on menu items, choose the items's menu path, + e.g. "File/Save As", "Image/View/Zoom" or "Edit/Select All". So a valid accelerator path may + look like this: "<Gimp-Toolbox>/File/Dialogs/ToolOptions..". + + @@ -155,9 +195,9 @@ - To be added - a - To be added + Filedescriptor variant of . + An valid writeable file descriptor. + Note that the file descriptor will not be closed by this function. @@ -171,10 +211,16 @@ - To be added - a - a - To be added + Loops over all the entries in the accelerator map, and executes on each. + An data to be passed into the . + An function to be exacuted for each accel map entry. + + + The signature of is that of , + the changed parameter indicates whether this accelerator was changed during runtime + (thus, would need saving during an accelerator map dump). + + @@ -187,9 +233,16 @@ - To be added - a - To be added + Adds a filter to the global list of accel path filters. + A pattern. + + + Accel map entries whose accel path matches one of the filters are skipped + by + this function is intended for gtk-sharp modules that create their own menus, but dont want + them to be saved into the applications accelerator map dump. + + @@ -202,9 +255,15 @@ - To be added - a - To be added + Saves current accelerator specifications. + A file to contain accelerator specifications. + + + Saves current accelerator specifications (accelerator path, key, modifiers to + . The file is written in a format suitable to be read + back in by . + + @@ -213,9 +272,9 @@ - To be added - a - To be added + + An default constructor. + @@ -228,10 +287,10 @@ - To be added - a - a - To be added + Gets a list of all accel groups which are attached to . + An usually a . + An list of all accel groups which are attached to . + diff --git a/doc/en/Gtk/TODO b/doc/en/Gtk/TODO index 243936b92..7d314cd3f 100644 --- a/doc/en/Gtk/TODO +++ b/doc/en/Gtk/TODO @@ -7,7 +7,6 @@ next to the file in this list to acknowledge that you are working in it (is reco Following is the list of undocumented xml: -Accel.xml AccelChangedArgs.xml AccelChangedHandler.xml AccelGroupActivate.xml