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

API reference - Class Action

Description: This class implements an event handler for a menu event

Class hierarchy: Action » ActionBase

Public constructors
Public methods
Detailed description

This class allows to reimplement the "triggered" handler to receive menu events. The "Action" class is derived from "ActionBase" and inherits all it's methods.

Public constructors

Action

new

Creates a new object of this class

Public methods

[const]	void	assign	(const Action other)	Assign the contents of another object to self
	void	create		Ensures the C++ object is created
	void	destroy		Explicitly destroy the object
[const]	bool	destroyed?		Returns a value indicating whether the object was already destroyed
[const]	Action	dup		Creates a copy of self
[const]	bool	is_const_object?		Returns a value indicating whether the reference is a const reference
[event]	void	on_triggered		This event is called if the menu item is selected
[virtual]	void	triggered		This method is called if the menu item is selected

Detailed description

[const] void assign(const Action 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.

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 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: 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] Action dup

Description: Creates a copy of self

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

[static] Action new

Description: Creates a new object of this class

[event] void on_triggered

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

This event has been introduced in version 0.21.

[virtual] void triggered

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