KLayout Manual: Main Index » Class Index » API reference - Class Action

API reference - Class Action

Notation used in Ruby API documentation

Description: The abstraction for an action (i.e. used inside menus)

Class hierarchy: Action

• Public constructors
• Public methods
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

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.

Public constructors

Public methods

Deprecated methods (protected, public, static, non-static and constructors)

Detailed description

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.

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.

[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.

[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.

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.

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.

void assign(const Action other)

Description: Assigns another object to self

void checkable=(bool checkable)

Description: Make the item(s) checkable or not

Python specific notes:

The object exposes a writable attribute 'checkable'. This is the setter.

void checked=(bool checked)

Description: Check or uncheck

Python specific notes:

The object exposes a writable attribute 'checked'. This is the setter.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

[const] new Action ptr dup

Description: Creates a copy of self

void enabled=(bool enabled)

Description: Enable or disable the action

Python specific notes:

The object exposes a writable attribute 'enabled'. This is the setter.

void icon=(string file)

Description: Set the icon to the given picture

Passing an empty string will reset the icon

Python specific notes:

The object exposes a writable attribute 'icon'. This is the setter.

[const] string icon_text

Description: Get the icon's text

Python specific notes:

The object exposes a readable attribute 'icon_text'. This is the getter.

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:

The object exposes a writable attribute 'icon_text'. This is the setter.

[const] bool is_checkable?

Description: "is_checkable" attribute

[const] bool is_checked?

Description: "is_checked" attribute

[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

[const] bool is_enabled?

Description: "is_enabled" attribute

[const] bool is_visible?

Description: "is_visible" attribute

[static] new Action ptr new

Description: Creates a new object of this class

Python specific notes:

This method is the default initializer of the object

[event] void on_triggered

Description: This event is called if the menu item is selected

This event has been introduced in version 0.21.

[const] string shortcut

Description: Get the keyboard shortcut

Python specific notes:

The object exposes a readable attribute 'shortcut'. This is the getter.

void shortcut=(string shortcut)

Description: Set the keyboard shortcut

Python specific notes:

The object exposes a writable attribute 'shortcut'. This is the setter.

[const] string title

Description: Get the title

Python specific notes:

The object exposes a readable attribute 'title'. This is the getter.

void title=(string title)

Description: Set the title

Python specific notes:

The object exposes a writable attribute 'title'. This is the setter.

[const] string tool_tip

Description: Get the tool tip text

This method has been added in version 0.22.

Python specific notes:

The object exposes a readable attribute 'tool_tip'. This is the getter.

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:

The object exposes a writable attribute 'tool_tip'. This is the setter.

void trigger

Description: Trigger the action programmatically

[virtual] void triggered

Description: This method is called if the menu item is selected

void visible=(bool visible)

Description: Show or hide

Python specific notes:

The object exposes a writable attribute 'visible'. This is the setter.