diff --git a/doc/ChangeLog b/doc/ChangeLog index 70e1b9e2d..1042dc29f 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2004-11-09 John Luke + + * en/Gtk/Action.xml: doc + 2004-11-09 Dan Winship * en/GLib/Object.xml: diff --git a/doc/en/Gtk/Action.xml b/doc/en/Gtk/Action.xml index 18151d393..9f0763880 100644 --- a/doc/en/Gtk/Action.xml +++ b/doc/en/Gtk/Action.xml @@ -9,8 +9,47 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + An action which can be triggered by a menu or toolbar item. + + +Actions represent operations that the user can be perform, along with some information how it should be presented in the interface. Each action provides methods to create icons, menu items and toolbar items representing itself. + + +As well as the callback that is called when the action gets activated, the following also gets associated with the action: + + + a name (not translated, for path lookup) + + + a label (translated, for display) + + + an accelerator + + + whether label indicates a stock id + + + a tooltip (optional, translated) + + + a toolbar label (optional, shorter than label) + + +The action will also have some state information: + + + visible (shown/hidden) + + + sensitive (enabled/disabled) + + +Apart from regular actions, there are toggle actions, which can be toggled between two states and radio actions, of which only one in a group can be in the "active" state. Other actions can be implemented as subclasses. + +Each action can have one or more proxy menu item, toolbar button or other proxy widgets. Proxies mirror the state of the action (text label, tooltip, icon, visible, sensitive, etc), and should change when the action's state changes. When the proxy is activated, it should activate its action. + + GLib.Object @@ -59,9 +98,10 @@ - To be added + Disables calls to the function by signals on the given proxy widget. a - To be added + This is used to break notification loops for things like check or radio actions. +This function is intended for use by action implementations. @@ -72,9 +112,9 @@ - To be added - a - To be added + Creates a menu item widget that proxies for the given action. + a that is a menu item connected to the action. + @@ -85,8 +125,9 @@ - To be added - To be added + Emits on the specified action, if it is not insensitive. + This gets called by the proxy widgets when they get activated. +It can also be used to manually activate an action. @@ -97,8 +138,8 @@ - To be added - To be added + Undoes the effect of one call to . + @@ -111,9 +152,10 @@ - To be added + Re-enables calls to the function by signals on the given proxy widget. a - To be added + This undoes the blocking done by . +This function is intended for use by action implementations. @@ -126,10 +168,10 @@ - To be added - a - a - To be added + This function is intended for use by action implementations to create icons displayed in the proxy widgets. + a , the size of the icon that should be created. + a that displays the icon for this action. + @@ -140,8 +182,10 @@ - To be added - To be added + Installs the accelerator for action if action has an AccelPath and AccelGroup. + See and +Since multiple proxies may independently trigger the installation of the accelerator, the action counts the number of times this function has been called and does not remove the accelerator until has been called as many times. + @@ -152,9 +196,9 @@ - To be added - a - To be added + Creates a toolbar item widget that proxies for the given action. + a that is a toolbar item connected to the action. + @@ -167,9 +211,10 @@ - To be added + Connects a widget to an action object as a proxy. a - To be added + Synchronises various properties of the action with the widget (such as label text, icon, tooltip, etc), and attaches a callback so that the action gets activated when the proxy widget does. +If the widget is already connected to an action, it is disconnected first. @@ -182,9 +227,9 @@ - To be added + Disconnects a proxy widget from an action. a - To be added + Does not destroy the widget, however. @@ -195,10 +240,10 @@ - To be added + Internal constructor a a - To be added + @@ -209,10 +254,10 @@ - To be added + Internal constructor a a - To be added + @@ -226,13 +271,13 @@ - To be added - a - a - a - a + Creates a new action from the , , , and . + A unique name for the action + the label displayed in menu items and on buttons + a tooltip for the action, or for no tooltip + the stock icon to display in widgets representing the action, or a - To be added + @@ -244,11 +289,11 @@ - To be added - a - a + Creates a new action from the and . + A unique name for the action + the label displayed in menu items and on buttons a - To be added + Convenience constructor for passing in for the last two parameters. @@ -272,9 +317,11 @@ - To be added + Whether the action is considered important. a - To be added + When , toolitem proxies for this action show text in mode. + +Default value: @@ -285,9 +332,9 @@ - To be added + When , toolitem proxies for this action are represented in the toolbar overflow menu. a - To be added + Default value is @@ -298,9 +345,9 @@ - To be added + The stock icon displayed in widgets representing this action. a - To be added + Default value is @@ -311,9 +358,9 @@ - To be added + When , empty menu proxies for this action are hidden. a - To be added + Default value: @@ -324,9 +371,9 @@ - To be added + A unique name for the action. a - To be added + @@ -337,9 +384,9 @@ - To be added + A shorter label that may be used on toolbar buttons. a - To be added + Default value is @@ -350,9 +397,9 @@ - To be added + Whether the toolbar item is visible when the toolbar is in a horizontal orientation. a - To be added + Default value is @@ -376,9 +423,9 @@ - To be added + The label used for menu items and buttons that activate this action. a - To be added + Default value is @@ -389,9 +436,9 @@ - To be added + A tooltip for this action. a - To be added + Default value is @@ -402,9 +449,15 @@ - To be added + Whether the action itself is sensitive. a - To be added + + + +This does not necessarily mean effective sensitivity. See for that. + + + @@ -415,9 +468,15 @@ - To be added + Whether the action itself is visible. a - To be added + + + +This does not necessarily mean effective visibility. See for that. + + + @@ -427,9 +486,9 @@ Gtk.AccelGroup - To be added - a - To be added + The in which the accelerator for this action will be installed. + a or + @@ -440,9 +499,10 @@ - To be added + whether the action is effectively sensitive. a - To be added + + if the action and its associated action group are both sensitive. @@ -453,9 +513,10 @@ - To be added + Whether the action is effectively visible. a - To be added + + if the action and its associated action group are both visible. @@ -466,9 +527,9 @@ - To be added - a - To be added + Returns the proxy widgets for an action. + a of proxy widgets. The list is owned by the action and must not be modified. + @@ -478,9 +539,9 @@ System.String - To be added + The accel path for this action. a - To be added + All proxy widgets associated with the action will have this accel path, so that their accelerators are consistent.