KLayout 0.29.8 (2024-10-28 63dd591e5) [master]

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

API reference - Class KeyCode

Module: lay

Description: The namespace for the some key codes.

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

This namespace defines some key codes understood by built-in LayoutView components. When compiling with Qt, these codes are compatible with Qt's key codes. The key codes are intended to be used when directly interfacing with LayoutView in non-Qt-based environments.

This class has been introduced in version 0.28.

Public constructors

new KeyCode ptr

new

Creates a new object of this class

Public methods

[const]	KeyCode ptr	_const_cast		Returns a non-const reference to self.
	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 KeyCode other)	Assigns another object to self
[const]	new KeyCode ptr	dup		Creates a copy of self

Public static methods and constants

int	Backspace	Indicates the Backspace key
int	Backtab	Indicates the Backtab key
int	Delete	Indicates the Delete key
int	Down	Indicates the Down key
int	End	Indicates the End key
int	Enter	Indicates the Enter key
int	Escape	Indicates the Escape key
int	Home	Indicates the Home key
int	Insert	Indicates the Insert key
int	Left	Indicates the Left key
int	PageDown	Indicates the PageDown key
int	PageUp	Indicates the PageUp key
int	Return	Indicates the Return key
int	Right	Indicates the Right key
int	Tab	Indicates the Tab key
int	Up	Indicates the Up key

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

Backspace	Signature: [static] int Backspace Description: Indicates the Backspace key Python specific notes: The object exposes a readable attribute 'Backspace'. This is the getter.
Backtab	Signature: [static] int Backtab Description: Indicates the Backtab key Python specific notes: The object exposes a readable attribute 'Backtab'. This is the getter.
Delete	Signature: [static] int Delete Description: Indicates the Delete key Python specific notes: The object exposes a readable attribute 'Delete'. This is the getter.
Down	Signature: [static] int Down Description: Indicates the Down key Python specific notes: The object exposes a readable attribute 'Down'. This is the getter.
End	Signature: [static] int End Description: Indicates the End key Python specific notes: The object exposes a readable attribute 'End'. This is the getter.
Enter	Signature: [static] int Enter Description: Indicates the Enter key Python specific notes: The object exposes a readable attribute 'Enter'. This is the getter.
Escape	Signature: [static] int Escape Description: Indicates the Escape key Python specific notes: The object exposes a readable attribute 'Escape'. This is the getter.
Home	Signature: [static] int Home Description: Indicates the Home key Python specific notes: The object exposes a readable attribute 'Home'. This is the getter.
Insert	Signature: [static] int Insert Description: Indicates the Insert key Python specific notes: The object exposes a readable attribute 'Insert'. This is the getter.
Left	Signature: [static] int Left Description: Indicates the Left key Python specific notes: The object exposes a readable attribute 'Left'. This is the getter.
PageDown	Signature: [static] int PageDown Description: Indicates the PageDown key Python specific notes: The object exposes a readable attribute 'PageDown'. This is the getter.
PageUp	Signature: [static] int PageUp Description: Indicates the PageUp key Python specific notes: The object exposes a readable attribute 'PageUp'. This is the getter.
Return	Signature: [static] int Return Description: Indicates the Return key Python specific notes: The object exposes a readable attribute 'Return'. This is the getter.
Right	Signature: [static] int Right Description: Indicates the Right key Python specific notes: The object exposes a readable attribute 'Right'. This is the getter.
Tab	Signature: [static] int Tab Description: Indicates the Tab key Python specific notes: The object exposes a readable attribute 'Tab'. This is the getter.
Up	Signature: [static] int Up Description: Indicates the Up key Python specific notes: The object exposes a readable attribute 'Up'. This is the getter.
_const_cast	Signature: [const] KeyCode ptr _const_cast Description: Returns a non-const reference to self. Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects. This method has been introduced in version 0.29.6.
_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 KeyCode 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 KeyCode 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 KeyCode 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 KeyCode

Public constructors

Public methods

Public static methods and constants

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

Detailed description

Backspace

Backtab

Delete

Down

End

Enter

Escape

Home

Insert

Left

PageDown

PageUp

Return

Right

Tab

Up

_const_cast

_create

_destroy

_destroyed?

_is_const_object?

_manage

_unmanage

assign

create

destroy

destroyed?

dup

is_const_object?

new