KLayout Documentation (Qt 5): Main Index » Class Index » API reference - Class Cursor

API reference - Class Cursor

Module: lay

Description: The namespace for the cursor constants

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

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

new Cursor ptr

new

Creates a new object of this class

Public methods

	void	_create		Ensures the C++ object is created
	void	_destroy		Explicitly 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	_manage		Marks the object as managed by the script side.
	void	_unmanage		Marks the object as no longer owned by the script side.
	void	assign	(const Cursor other)	Assigns another object to self
[const]	new Cursor ptr	dup		Creates a copy of self

Public static methods and constants

int	Arrow	'Arrow cursor' constant
int	Blank	'Blank cursor' constant
int	Busy	'Busy state cursor' constant
int	ClosedHand	'Closed hand cursor' constant
int	Cross	'Cross cursor' constant
int	Forbidden	'Forbidden area cursor' constant
int	IBeam	'I beam (text insert) cursor' constant
int	None	'No cursor (default)' constant for set_cursor (resets cursor to default)
int	OpenHand	'Open hand cursor' constant
int	PointingHand	'Pointing hand cursor' constant
int	SizeAll	'Size all directions cursor' constant
int	SizeBDiag	'Backward diagonal resize cursor' constant
int	SizeFDiag	'Forward diagonal resize cursor' constant
int	SizeHor	'Horizontal resize cursor' constant
int	SizeVer	'Vertical resize cursor' constant
int	SplitH	'split_horizontal cursor' constant
int	SplitV	'Split vertical cursor' constant
int	UpArrow	'Upward arrow cursor' constant
int	Wait	'Waiting cursor' constant
int	WhatsThis	'Question mark cursor' constant

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

	void	create	Use of this method is deprecated. Use _create instead
	void	destroy	Use of this method is deprecated. Use _destroy instead
[const]	bool	destroyed?	Use of this method is deprecated. Use _destroyed? instead
[const]	bool	is_const_object?	Use of this method is deprecated. Use _is_const_object? instead

Detailed description

Arrow	Signature: [static] int Arrow Description: 'Arrow cursor' constant Python specific notes: The object exposes a readable attribute 'Arrow'. This is the getter.
Blank	Signature: [static] int Blank Description: 'Blank cursor' constant Python specific notes: The object exposes a readable attribute 'Blank'. This is the getter.
Busy	Signature: [static] int Busy Description: 'Busy state cursor' constant Python specific notes: The object exposes a readable attribute 'Busy'. This is the getter.
ClosedHand	Signature: [static] int ClosedHand Description: 'Closed hand cursor' constant Python specific notes: The object exposes a readable attribute 'ClosedHand'. This is the getter.
Cross	Signature: [static] int Cross Description: 'Cross cursor' constant Python specific notes: The object exposes a readable attribute 'Cross'. This is the getter.
Forbidden	Signature: [static] int Forbidden Description: 'Forbidden area cursor' constant Python specific notes: The object exposes a readable attribute 'Forbidden'. This is the getter.
IBeam	Signature: [static] int IBeam Description: 'I beam (text insert) cursor' constant Python specific notes: The object exposes a readable attribute 'IBeam'. This is the getter.
None	Signature: [static] int None Description: 'No cursor (default)' constant for set_cursor (resets cursor to default) Python specific notes: This member is available as 'None_' in Python. The object exposes a readable attribute 'None_'. This is the getter.
OpenHand	Signature: [static] int OpenHand Description: 'Open hand cursor' constant Python specific notes: The object exposes a readable attribute 'OpenHand'. This is the getter.
PointingHand	Signature: [static] int PointingHand Description: 'Pointing hand cursor' constant Python specific notes: The object exposes a readable attribute 'PointingHand'. This is the getter.
SizeAll	Signature: [static] int SizeAll Description: 'Size all directions cursor' constant Python specific notes: The object exposes a readable attribute 'SizeAll'. This is the getter.
SizeBDiag	Signature: [static] int SizeBDiag Description: 'Backward diagonal resize cursor' constant Python specific notes: The object exposes a readable attribute 'SizeBDiag'. This is the getter.
SizeFDiag	Signature: [static] int SizeFDiag Description: 'Forward diagonal resize cursor' constant Python specific notes: The object exposes a readable attribute 'SizeFDiag'. This is the getter.
SizeHor	Signature: [static] int SizeHor Description: 'Horizontal resize cursor' constant Python specific notes: The object exposes a readable attribute 'SizeHor'. This is the getter.
SizeVer	Signature: [static] int SizeVer Description: 'Vertical resize cursor' constant Python specific notes: The object exposes a readable attribute 'SizeVer'. This is the getter.
SplitH	Signature: [static] int SplitH Description: 'split_horizontal cursor' constant Python specific notes: The object exposes a readable attribute 'SplitH'. This is the getter.
SplitV	Signature: [static] int SplitV Description: 'Split vertical cursor' constant Python specific notes: The object exposes a readable attribute 'SplitV'. This is the getter.
UpArrow	Signature: [static] int UpArrow Description: 'Upward arrow cursor' constant Python specific notes: The object exposes a readable attribute 'UpArrow'. This is the getter.
Wait	Signature: [static] int Wait Description: 'Waiting cursor' constant Python specific notes: The object exposes a readable attribute 'Wait'. This is the getter.
WhatsThis	Signature: [static] int WhatsThis Description: 'Question mark cursor' constant Python specific notes: The object exposes a readable attribute 'WhatsThis'. 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 Cursor 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 Cursor 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 Cursor ptr new Description: Creates a new object of this class Python specific notes: This method is the default initializer of the object.

API reference - Class Cursor

Public constructors

Public methods

Public static methods and constants

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

Detailed description

Arrow

Blank

Busy

ClosedHand

Cross

Forbidden

IBeam

None

OpenHand

PointingHand

SizeAll

SizeBDiag

SizeFDiag

SizeHor

SizeVer

SplitH

SplitV

UpArrow

Wait

WhatsThis

_create

_destroy

_destroyed?

_is_const_object?

_manage

_unmanage

assign

create

destroy

destroyed?

dup

is_const_object?

new