Class ActionBase (version 0.18)

Description: An 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 in fact refer to the same action internally, in which case the information and event handler is copied between the incarnations. Technically, the Action objects are QAction proxies.

Class overview

Index

Method Overview

title=( string title ) Set the title

[const] string title Get the title

shortcut=( string shortcut ) Set the keyboard shortcut

[const] string shortcut Get the keyboard shortcut

[const] bool is_checkable? "is_checkable" attribute

[const] bool is_checked? "is_checked" attribute

[const] bool is_enabled? "is_enabled" attribute

[const] bool is_visible? "is_visible" attribute

checkable=( bool checkable ) Make the item(s) checkable or not

enabled=( bool enabled ) Enable or disable the action

visible=( bool visible ) Show or hide

checked=( bool checked ) Check or uncheck

icon=( string file ) Set the icon to the given picture

icon_text=( string icon_text ) Set the icon's text

[const] string icon_text Get the icon's text

trigger Trigger the action programmatically

assign( ActionBase other ) Assign the contents of another object to self

[const] ActionBase dup Creates a copy of self.

destroy Explicitly destroy the object

[const] bool destroyed Tell, if the object was destroyed

assign( ActionBase other )

Description: Assign the contents of another object to self

This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.

checkable=( bool checkable )

Description: Make the item(s) checkable or not

checkable: true to make the item checkable

checked=( bool checked )

Description: Check or uncheck

checked: true to make the item checked

destroy

Description: Explicitly destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, this method will do nothing.

[const] bool destroyed

Description: Tell, if the object was 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.

[const] ActionBase dup

Description: Creates a copy of self.

enabled=( bool enabled )

Description: Enable or disable the action

enabled: true to enable the item

icon=( string file )

Description: Set the icon to the given picture

Passing an empty string will reset the icon

file: The image file to load for the icon

[const] string icon_text

Description: Get the icon's text

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.