From 382369538c447b8255b3fca740be15dfd5a71c94 Mon Sep 17 00:00:00 2001 From: Shane Landrum Date: Fri, 31 Dec 2004 19:36:13 +0000 Subject: [PATCH] 2004-12-31 Shane Landrum * en/Gtk/FileSystem.xml: Wording tweak. * en/Gtk/ActionGroup.xml * en/Gtk/Action.xml * en/Gtk/ActionEntry.xml * en/Gtk/AccelGroup.xml * en/Gtk/AccelMap.xml: Added docs. svn path=/trunk/gtk-sharp/; revision=38218 --- doc/ChangeLog | 9 ++ doc/en/Gtk/AccelGroup.xml | 6 +- doc/en/Gtk/AccelMap.xml | 172 ++++++++++++++++++++++++++++--------- doc/en/Gtk/Action.xml | 8 +- doc/en/Gtk/ActionEntry.xml | 34 ++++---- doc/en/Gtk/ActionGroup.xml | 4 +- doc/en/Gtk/FileSystem.xml | 2 +- 7 files changed, 168 insertions(+), 67 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 6655819c1..c2710a831 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,12 @@ +2004-12-31 Shane Landrum + + * en/Gtk/FileSystem.xml: Wording tweak. + * en/Gtk/ActionGroup.xml + * en/Gtk/Action.xml + * en/Gtk/ActionEntry.xml + * en/Gtk/AccelGroup.xml + * en/Gtk/AccelMap.xml: Added docs. + 2004-12-31 Shane Landrum * en/Gtk/FileSystem.xml diff --git a/doc/en/Gtk/AccelGroup.xml b/doc/en/Gtk/AccelGroup.xml index f3c5e863f..8f2e3807b 100644 --- a/doc/en/Gtk/AccelGroup.xml +++ b/doc/en/Gtk/AccelGroup.xml @@ -321,14 +321,14 @@ - To be added + Activates the accelerator. a a a a a - To be added + - \ No newline at end of file + diff --git a/doc/en/Gtk/AccelMap.xml b/doc/en/Gtk/AccelMap.xml index d364a83d2..35468a460 100644 --- a/doc/en/Gtk/AccelMap.xml +++ b/doc/en/Gtk/AccelMap.xml @@ -9,8 +9,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Global accelerator map for an entire application. + This class is a singleton; only one can exist at a time. GLib.Object @@ -36,11 +36,11 @@ - To be added - a - a - a - To be added + Looks up the accelerator entry for and fills in . + a , a valid accelerator path + a , the accelerator key to be filled in (optional) + a , if is known, otherwise. + @@ -53,9 +53,32 @@ - To be added + + Locks the given accelerator path. If the accelerator map doesn't yet contain + an entry for , a new one is created. + a - To be added + + + Locking an accelerator path prevents its accelerator from being changed + during runtime. A locked accelerator path can be unlocked by + . + Refer to + for information about runtime accelerator changes. + + + If called more than once, remains locked until + + has been called an equivalent number of times. + + + + Note that locking of individual accelerator paths is independent from + locking the containing them. For runtime accelerator + changes to be possible both the accelerator path and its + have to be unlocked. + + @@ -68,9 +91,14 @@ - To be added - a - To be added + + Undoes the last call to + on this . + + a , a valid accelerator path + + Refer to for information + about accelerator path locking. @@ -86,13 +114,21 @@ - To be added + + Changes the and currently associated with + . + a a a a a - To be added + + Due to conflicts with other accelerators, a change may not always be possible. The + parameter indicates whether other accelerators may be deleted to resolve such + conflicts. A change will only occur if all conflicts could be resolved (which might not be the case if conflicting accelerators are locked). Successful + changes are indicated by a return value. + @@ -105,9 +141,12 @@ - To be added + + Parses a file previously saved with + for accelerator specifications, and propagates them accordingly. + a - To be added + @@ -120,9 +159,11 @@ - To be added - a - To be added + + File descriptor variant of . + + a , a valid writeable file descriptor + @@ -135,9 +176,14 @@ - To be added - a - To be added + + Saves current accelerator specifications (accelerator path, key + and modifiers) to . + The file is written in a format suitable to be read back in by + . + + a , a file to contain accelerator specifications + @@ -150,9 +196,11 @@ - To be added - a - To be added + + File descriptor variant of . + + a , a valid readable file descriptor. + @@ -167,11 +215,27 @@ - To be added + + Registers a new accelerator with the global accelerator map. + a a a - To be added + + 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 identifier, 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 item's menu path, + e.g. "File/Save As", "Image/View/Zoom" or "Edit/Select All". + So a full valid accelerator path may look like: + "<Gimp-Toolbox>/File/Dialogs/Tool Options...". + @@ -184,9 +248,21 @@ - To be added + + Adds a filter to the global list of accel path filters. + a - To be added + + + Accel map entries whose accel path matches one of the filters + are skipped by . + + + This function is intended for Gtk# modules that create their own + menus but don't want them to be saved into the applications + accelerator map dump. + + @@ -197,9 +273,14 @@ - To be added + + Gets the singleton global. object. This object + is useful only for notification of changes to the accelerator + map via the internal "changed" signal; it isn't a parameter to the + other accelerator map functions. + a - To be added + @@ -213,10 +294,18 @@ - To be added - a - a - To be added + + Loops over the entries in the accelerator map whose accel path + doesn't match any of the filters added with + + and executes on each. + + a , data to pass to + a , function to execute on each accel map entrey + + See also . + XXX: See http://bugzilla.ximian.com/show_bug.cgi?id=70912. + @@ -230,10 +319,13 @@ - To be added + Loops over all entries in the accelerator map and executes + * on each. a a - To be added + + See also . + @@ -283,9 +375,9 @@ - To be added + Protected constructor. a - To be added + @@ -302,4 +394,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/Action.xml b/doc/en/Gtk/Action.xml index 3042496d4..33a8bbbb6 100644 --- a/doc/en/Gtk/Action.xml +++ b/doc/en/Gtk/Action.xml @@ -411,9 +411,9 @@ Default value: - To be added + The GtkActionGroup this GtkAction is associated with. a - To be added + Can be set to for internal use. @@ -541,7 +541,7 @@ This does not necessarily mean effective visibility. See @@ -559,4 +559,4 @@ This does not necessarily mean effective visibility. See - To be added - a - a + Public constructor. + a , a unique name + a , a stock icon a - To be added + @@ -125,12 +125,12 @@ - To be added - a - a - a + Public constructor. + a , a unique name + a , a stock icon + a , a handler to run when the action is activated a - To be added + @@ -146,15 +146,15 @@ - To be added - a - a - a - a - a - a + Public constructor. + a , a unique name + a , a stock icon + a , label text + a , an accelerator sequence + a , tooltip text + a , a handler to run when the action is activated a - To be added + diff --git a/doc/en/Gtk/ActionGroup.xml b/doc/en/Gtk/ActionGroup.xml index 106907d7c..f279f128d 100644 --- a/doc/en/Gtk/ActionGroup.xml +++ b/doc/en/Gtk/ActionGroup.xml @@ -123,7 +123,7 @@ Accel paths are set to <Actions>/group-name/action-name. Looks up an action in the action group by name. a , the name of the action a , or if no action by that name exists - To be added + @@ -245,7 +245,7 @@ Therefore you must either set the accel path yourself with s added by . a - To be added + diff --git a/doc/en/Gtk/FileSystem.xml b/doc/en/Gtk/FileSystem.xml index 34d0d0793..d0de87f31 100644 --- a/doc/en/Gtk/FileSystem.xml +++ b/doc/en/Gtk/FileSystem.xml @@ -10,7 +10,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. Interface class for representing filesystems. - For concrete implementations, see + For more concrete implementations, see and .