API reference - Class Cursor

Notation used in Ruby API documentation

Description: The namespace for the cursor constants

This class defines the constants for the cursor setting (for example for class Plugin, method set_cursor). This class has been introduced in version 0.22.

Public constructors

CursornewCreates a new object of this class

Public methods

[const]voidassign(const Cursor other)Assign the contents of another object to self
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]CursordupCreates a copy of self
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference

Public static methods and constants

intArrow'Arrow cursor' constant
intBlank'Blank cursor' constant
intBusy'Busy state cursor' constant
intClosedHand'Closed hand cursor' constant
intCross'Cross cursor' constant
intForbidden'Forbidden area cursor' constant
intIBeam'I beam (text insert) cursor' constant
intNone'No cursor (default)' constant for set_cursor (resets cursor to default)
intOpenHand'Open hand cursor' constant
intPointingHand'Pointing hand cursor' constant
intSizeAll'Size all directions cursor' constant
intSizeBDiag'Backward diagonal resize cursor' constant
intSizeFDiag'Forward diagonal resize cursor' constant
intSizeHor'Horizontal resize cursor' constant
intSizeVer'Vertical resize cursor' constant
intSplitH'split_horizontal cursor' constant
intSplitV'Split vertical cursor' constant
intUpArrow'Upward arrow cursor' constant
intWait'Waiting cursor' constant
intWhatsThis'Question mark cursor' constant

Detailed description

[static] int Arrow

Description: 'Arrow cursor' constant

[static] int Blank

Description: 'Blank cursor' constant

[static] int Busy

Description: 'Busy state cursor' constant

[static] int ClosedHand

Description: 'Closed hand cursor' constant

[static] int Cross

Description: 'Cross cursor' constant

[static] int Forbidden

Description: 'Forbidden area cursor' constant

[static] int IBeam

Description: 'I beam (text insert) cursor' constant

[static] int None

Description: 'No cursor (default)' constant for set_cursor (resets cursor to default)

[static] int OpenHand

Description: 'Open hand cursor' constant

[static] int PointingHand

Description: 'Pointing hand cursor' constant

[static] int SizeAll

Description: 'Size all directions cursor' constant

[static] int SizeBDiag

Description: 'Backward diagonal resize cursor' constant

[static] int SizeFDiag

Description: 'Forward diagonal resize cursor' constant

[static] int SizeHor

Description: 'Horizontal resize cursor' constant

[static] int SizeVer

Description: 'Vertical resize cursor' constant

[static] int SplitH

Description: 'split_horizontal cursor' constant

[static] int SplitV

Description: 'Split vertical cursor' constant

[static] int UpArrow

Description: 'Upward arrow cursor' constant

[static] int Wait

Description: 'Waiting cursor' constant

[static] int WhatsThis

Description: 'Question mark cursor' constant

[const] void assign(const Cursor 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] Cursor 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] Cursor new

Description: Creates a new object of this class