API reference - Class ButtonState

Notation used in Ruby API documentation

Module: lay

Description: The namespace for the button state flags in the mouse events of the Plugin class.

This class defines the constants for the button state. In the event handler, the button state is indicated by a bitwise combination of these constants. See Plugin for further details. This class has been introduced in version 0.22.

Public constructors

new ButtonState ptrnewCreates a new object of this class

Public methods

void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
voidassign(const ButtonState other)Assigns another object to self
[const]new ButtonState ptrdupCreates a copy of self

Public static methods and constants

intAltKeyIndicates that the Alt key is pressed
intControlKeyIndicates that the Control key is pressed
intLeftButtonIndicates that the left mouse button is pressed
intMidButtonIndicates that the middle mouse button is pressed
intRightButtonIndicates that the right mouse button is pressed
intShiftKeyIndicates that the Shift key is pressed

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

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

AltKey

Signature: [static] int AltKey

Description: Indicates that the Alt key is pressed

This constant is combined with other constants within ButtonState

Python specific notes:
The object exposes a readable attribute 'AltKey'. This is the getter.

ControlKey

Signature: [static] int ControlKey

Description: Indicates that the Control key is pressed

This constant is combined with other constants within ButtonState

Python specific notes:
The object exposes a readable attribute 'ControlKey'. This is the getter.

LeftButton

Signature: [static] int LeftButton

Description: Indicates that the left mouse button is pressed

This constant is combined with other constants within ButtonState

Python specific notes:
The object exposes a readable attribute 'LeftButton'. This is the getter.

MidButton

Signature: [static] int MidButton

Description: Indicates that the middle mouse button is pressed

This constant is combined with other constants within ButtonState

Python specific notes:
The object exposes a readable attribute 'MidButton'. This is the getter.

RightButton

Signature: [static] int RightButton

Description: Indicates that the right mouse button is pressed

This constant is combined with other constants within ButtonState

Python specific notes:
The object exposes a readable attribute 'RightButton'. This is the getter.

ShiftKey

Signature: [static] int ShiftKey

Description: Indicates that the Shift key is pressed

This constant is combined with other constants within ButtonState

Python specific notes:
The object exposes a readable attribute 'ShiftKey'. This is the getter.

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

_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 ButtonState other)

Description: Assigns another object to self

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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

Use of this method is deprecated. Use _destroy instead

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

Use of this method is deprecated. Use _destroyed? instead

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 ButtonState ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

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

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

new

Signature: [static] new ButtonState ptr new

Description: Creates a new object of this class

Python specific notes:
This method is the default initializer of the object.