Index: Accel.xml =================================================================== RCS file: /mono/gtk-sharp/doc/en/Gtk/Accel.xml,v retrieving revision 1.7 diff -u -r1.7 Accel.xml --- Accel.xml 5 Mar 2004 13:40:12 -0000 1.7 +++ Accel.xml 15 Mar 2004 00:58:28 -0000 @@ -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,21 @@ - To be added - a - a - To be added + + + + Loops over the entries in the accelerator whose accel path doesn't match any of the + filters added with , and exectute foreach_fun on each. + The signature of foreach_func is that of , the changed + parameter indicates wheather this accelerator was changed during runtime (thus, would need + saving during an accelerator map dump). + + + + the data to be passed into foreach_func + a function to be exacuted for each + accel map entry which is not filtered out + @@ -46,9 +60,17 @@ - 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 +85,20 @@ - To be added - a - a - a - a - To be added + + + + Finds the first accelerator in any attached to objekt that + matches accel_key and accel_mods, and activates that accelerator. + + + + a which is usually a , on which + to activate the accelerator + a accelerator keyval from a key event + a keyboard state mask from a key event + a returns TRUE if the accelerator was handled, FALSE otherwise + @@ -84,13 +114,23 @@ - To be added - a - a - a - a - a - To be added + + + + Changes the accel_key and accel_mods currently associated with accel_path. Due to conflicts + with other accelerators, a change may not always be possible, replace 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). + + + + a valid accelerator path + a is the new accelerator key + a is the new accelerator modifier + a TRUE if other accelerators may be deleted + upon conflicts + a TRUE if the accelerator could be changed, FALSE otherwise + @@ -104,11 +144,17 @@ - To be added - a - a - a - To be added + + + + Looks up the accelerator entry for accel_path and fills in key. + + + + a valid accelerator path + a the accelerator key to be filled in (optional) + a TRUE if accel_path is known, FALSE otherwise + @@ -121,9 +167,15 @@ - To be added - a - To be added + + + + Filedescriptor variant of + + + + a valid readable file descriptor + Note that the file descriptor will not be closed by this function. @@ -138,11 +190,28 @@ - To be added - a - a - a - To be added + + + + Registers a new accelerator with the global accelerator map. This function should only be called + once per accel_path with the canonical accel_key and accel_mods 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..". + + + + a valid accelerator path + a accelerator key + a accelerator modifier + @@ -155,9 +224,15 @@ - To be added - a - To be added + + + + Filedescriptor variant of . + + + + a valid writeable file descriptor + Note that the file descriptor will not be closed by this function @@ -171,10 +246,19 @@ - To be added - a - a - To be added + + + + Loops over all the entries in the accelerator map, and executes foreach_func on each. The signature of + foreach_func is that of , the changed parameter indicates whether this + accelerator was changed during runtime (thus, would need saving during an accelerator map dump). + + + + a data to be passed into foreach_func + a function to be exacuted for each accel + map entry + @@ -187,9 +271,19 @@ - To be added - a - To be added + + + + Adds a filter to the global list of accel path filters. + 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. + + + + a pattern + @@ -202,9 +296,16 @@ - To be added - a - To be added + + + + Saves current accelerator specifications (accelerator path, key, modifiers to file_name. The file + is written in a format suitable to be read back in by . + + + + a file to contain accelerator specifications. + @@ -213,9 +314,9 @@ - To be added - a - To be added + + a Default constructor + @@ -228,10 +329,16 @@ - To be added - a - a - To be added + + + + Gets a list of all accel groups which are attached to obj. + + + + a usually a + a list of all accel groups which are attached to obj +