API reference - Class ButtonStateNotation used in Ruby API documentation 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
Public methods
Public static methods and constants
Detailed description[static] int AltKeyDescription: Indicates that the Alt key is pressed This constant is combined with other constants within ButtonState [static] int ControlKeyDescription: Indicates that the Control key is pressed This constant is combined with other constants within ButtonState [static] int LeftButtonDescription: Indicates that the left mouse button is pressed This constant is combined with other constants within ButtonState [static] int MidButtonDescription: Indicates that the middle mouse button is pressed This constant is combined with other constants within ButtonState [static] int RightButtonDescription: Indicates that the right mouse button is pressed This constant is combined with other constants within ButtonState [static] int ShiftKeyDescription: Indicates that the Shift key is pressed This constant is combined with other constants within ButtonState [const] void assign(const ButtonState 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 createDescription: 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 destroyDescription: 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] ButtonState dupDescription: 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] ButtonState newDescription: Creates a new object of this class |