Notation used in Ruby API documentation
Module: lay
Description: The abstraction for an action (i.e. used inside menus)
Class hierarchy: Action
Actions act as a generalisation of menu entries. The action provides the appearance of a menu entry such as title, key shortcut etc. and dispatches the menu events. The action can be manipulated to change to appearance of a menu entry and can be attached an observer that receives the events when the menu item is selected.
Multiple action objects can refer to the same action internally, in which case the information and event handler is copied between the incarnations. This way, a single implementation can be provided for multiple places where an action appears, for example inside the toolbar and in addition as a menu entry. Both actions will shared the same icon, text, shortcut etc.
Actions are mainly used for providing new menu items inside the AbstractMenu class. This is some sample Ruby code for that case:
a = RBA::Action.new
a.title = "Push Me!"
a.on_triggered do
puts "I was pushed!"
end
app = RBA::Application.instance
mw = app.main_window
menu = mw.menu
menu.insert_separator("@toolbar.end", "name")
menu.insert_item("@toolbar.end", "my_action", a)
This code will register a custom action in the toolbar. When the toolbar button is pushed a message is printed. The toolbar is addressed by a path starting with the pseudo root "@toolbar".
In Version 0.23, the Action class has been merged with the ActionBase class.
| new Action ptr | new | Creates a new object of this class |
| void | _assign | (const Action other) | Assigns another object to self | |
| void | _create | Ensures the C++ object is created | ||
| void | _destroy | Explicitly destroys the object | ||
| [const] | bool | _destroyed? | Returns a value indicating whether the object was already destroyed | |
| [const] | new Action ptr | _dup | Creates a copy of self | |
| [const] | bool | _is_const_object? | Returns a value indicating whether the reference is a const reference | |
| void | _manage | Marks the object as managed by the script side. | ||
| void | _unmanage | Marks the object as no longer owned by the script side. | ||
| void | assign | (const Action other) | Assigns another object to self | |
| void | checkable= | (bool checkable) | Make the item(s) checkable or not | |
| void | checked= | (bool checked) | Check or uncheck | |
| [const] | string | default_shortcut | Gets the default keyboard shortcut | |
| void | default_shortcut= | (string shortcut) | Sets the default keyboard shortcut | |
| [const] | new Action ptr | dup | Creates a copy of self | |
| [const] | string | effective_shortcut | Gets the effective keyboard shortcut | |
| void | enabled= | (bool enabled) | Enable or disable the action | |
| void | hidden= | (bool hidden) | Sets a value that makes the item hidden always | |
| void | icon= | (string file) | Set the icon to the given picture | |
| [const] | string | icon_text | Get the icon's text | |
| void | icon_text= | (string icon_text) | Set the icon's text | |
| [const] | bool | is_checkable? | Gets a value indicating whether the item is checkable | |
| [const] | bool | is_checked? | Gets a value indicating whether the item is checked | |
| [const] | bool | is_effective_visible? | Gets a value indicating whether the item is really visible | |
| [const] | bool | is_enabled? | Gets a value indicating whether the item is enabled | |
| [const] | bool | is_hidden? | Gets a value indicating whether the item is hidden | |
| [const] | bool | is_separator? | Gets a value indicating whether the item is a separator | |
| [const] | bool | is_visible? | Gets a value indicating whether the item is visible | |
| [const] | Macro ptr | macro | Gets the macro associated with the action | |
| [signal] | void | on_triggered | This event is called if the menu item is selected | |
| void | separator= | (bool separator) | Makes an item a separator or not | |
| [const] | string | shortcut | Gets the keyboard shortcut | |
| void | shortcut= | (string shortcut) | Sets the keyboard shortcut | |
| [const] | string | title | Gets the title | |
| void | title= | (string title) | Sets the title | |
| [const] | string | tool_tip | Get the tool tip text | |
| void | tool_tip= | (string text) | Set the tool tip text | |
| void | trigger | Trigger the action programmatically | ||
| [virtual] | void | triggered | This method is called if the menu item is selected | |
| void | visible= | (bool visible) | Show or hide |
| [static,const] | string | NoKeyBound | Gets a shortcut value indicating that no shortcut shall be assigned |
| void | create | Use of this method is deprecated. Use _create instead | ||
| void | destroy | Use of this method is deprecated. Use _destroy instead | ||
| [const] | bool | destroyed? | Use of this method is deprecated. Use _destroyed? instead | |
| [const] | bool | is_const_object? | Use of this method is deprecated. Use _is_const_object? instead |
NoKeyBound | Signature: [static,const] string NoKeyBound Description: Gets a shortcut value indicating that no shortcut shall be assigned This method has been introduced in version 0.26. | ||
_assign | Signature: void _assign (const Action other) Description: Assigns another object to self | ||
_create | Signature: void _create Description: Ensures the C++ object is created Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created. | ||
_destroy | Signature: void _destroy Description: Explicitly destroys the object Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing. | ||
_destroyed? | Signature: [const] bool _destroyed? Description: Returns a value indicating whether the object was already destroyed This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself. | ||
_dup | Signature: [const] new Action ptr _dup Description: Creates a copy of self | ||
_is_const_object? | Signature: [const] bool _is_const_object? Description: Returns a value indicating whether the reference is a const reference This method returns true, if self is a const reference. In that case, only const methods may be called on self. | ||
_manage | Signature: void _manage Description: Marks the object as managed by the script side. After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required. Usually it's not required to call this method. It has been introduced in version 0.24. | ||
_unmanage | Signature: void _unmanage Description: Marks the object as no longer owned by the script side. Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur. Usually it's not required to call this method. It has been introduced in version 0.24. | ||
assign | Signature: void assign (const Action other) Description: Assigns another object to self | ||
checkable= | Signature: void checkable= (bool checkable) Description: Make the item(s) checkable or not
Python specific notes: | ||
checked= | Signature: void checked= (bool checked) Description: Check or uncheck
Python specific notes: | ||
create | Signature: void create Description: Ensures the C++ object is created Use of this method is deprecated. Use _create instead | ||
default_shortcut | Signature: [const] string default_shortcut Description: Gets the default keyboard shortcut
This attribute has been introduced in version 0.25. Python specific notes: | ||
default_shortcut= | Signature: void default_shortcut= (string shortcut) Description: Sets the default keyboard shortcut The default shortcut is used, if shortcut is empty. This attribute has been introduced in version 0.25. Python specific notes: | ||
destroy | Signature: void destroy Description: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead | ||
destroyed? | Signature: [const] bool destroyed? Description: Returns a value indicating whether the object was already destroyed Use of this method is deprecated. Use _destroyed? instead | ||
dup | Signature: [const] new Action ptr dup Description: Creates a copy of self | ||
effective_shortcut | Signature: [const] string effective_shortcut Description: Gets the effective keyboard shortcut
The effective shortcut is the one that is taken. It's either shortcut or default_shortcut. This attribute has been introduced in version 0.25. | ||
enabled= | Signature: void enabled= (bool enabled) Description: Enable or disable the action
Python specific notes: | ||
hidden= | Signature: void hidden= (bool hidden) Description: Sets a value that makes the item hidden always See is_hidden? for details. This attribute has been introduced in version 0.25 Python specific notes: | ||
icon= | Signature: void icon= (string file) Description: Set the icon to the given picture
Passing an empty string will reset the icon Python specific notes: | ||
icon_text | Signature: [const] string icon_text Description: Get the icon's text Python specific notes: | ||
icon_text= | Signature: void icon_text= (string icon_text) Description: Set the icon's text If an icon text is set, this will be used for the text below the icon. If no icon text is set, the normal text will be used for the icon. Passing an empty string will reset the icon's text. Python specific notes: | ||
is_checkable? | Signature: [const] bool is_checkable? Description: Gets a value indicating whether the item is checkable | ||
is_checked? | Signature: [const] bool is_checked? Description: Gets a value indicating whether the item is checked | ||
is_const_object? | Signature: [const] bool is_const_object? Description: Returns a value indicating whether the reference is a const reference Use of this method is deprecated. Use _is_const_object? instead | ||
is_effective_visible? | Signature: [const] bool is_effective_visible? Description: Gets a value indicating whether the item is really visible This is the combined visibility from is_visible? and is_hidden?. This attribute has been introduced in version 0.25. | ||
is_enabled? | Signature: [const] bool is_enabled? Description: Gets a value indicating whether the item is enabled | ||
is_hidden? | Signature: [const] bool is_hidden? Description: Gets a value indicating whether the item is hidden If an item is hidden, it's always hidden and is_visible? does not have an effect. This attribute has been introduced in version 0.25. | ||
is_separator? | Signature: [const] bool is_separator? Description: Gets a value indicating whether the item is a separator This method has been introduced in version 0.25. | ||
is_visible? | Signature: [const] bool is_visible? Description: Gets a value indicating whether the item is visible The visibility combines with is_hidden?. To get the true visiblity, use is_effective_visible?. | ||
macro | Signature: [const] Macro ptr macro Description: Gets the macro associated with the action If the action is associated with a macro, this method returns a reference to the Macro object. Otherwise, this method returns nil. This method has been added in version 0.25. | ||
new | Signature: [static] new Action ptr new Description: Creates a new object of this class Python specific notes: | ||
on_triggered | Signature: [signal] void on_triggered Description: This event is called if the menu item is selected This event has been introduced in version 0.21. Python specific notes: | ||
separator= | Signature: void separator= (bool separator) Description: Makes an item a separator or not
This method has been introduced in version 0.25. Python specific notes: | ||
shortcut | Signature: [const] string shortcut Description: Gets the keyboard shortcut
Python specific notes: | ||
shortcut= | Signature: void shortcut= (string shortcut) Description: Sets the keyboard shortcut
If the shortcut string is empty, the default shortcut will be used. If the string is equal to Action#NoKeyBound, no keyboard shortcut will be assigned. The NoKeyBound option has been added in version 0.26. Python specific notes: | ||
title | Signature: [const] string title Description: Gets the title
Python specific notes: | ||
title= | Signature: void title= (string title) Description: Sets the title
Python specific notes: | ||
tool_tip | Signature: [const] string tool_tip Description: Get the tool tip text This method has been added in version 0.22. Python specific notes: | ||
tool_tip= | Signature: void tool_tip= (string text) Description: Set the tool tip text The tool tip text is displayed in the tool tip window of the menu entry. This is in particular useful for entries in the tool bar. This method has been added in version 0.22. Python specific notes: | ||
trigger | Signature: void trigger Description: Trigger the action programmatically | ||
triggered | Signature: [virtual] void triggered Description: This method is called if the menu item is selected | ||
visible= | Signature: void visible= (bool visible) Description: Show or hide
Python specific notes: |