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

API reference - Class LayoutViewWidget

Notation used in Ruby API documentation

Module: lay

Description:

Class hierarchy: LayoutViewWidget » QFrame » QWidget » QObject

This object produces a widget which embeds a LayoutView. This widget can be used inside Qt widget hierarchies. To access the LayoutView object within, use view.

This class has been introduced in version 0.28.

Public constructors

new LayoutViewWidget ptrnew(QWidget ptr parent,
bool editable = false,
Manager ptr manager = nil,
unsigned int options = 0)
Creates a standalone view widget

Public methods

[const]LayoutViewWidget ptr_const_castReturns a non-const reference to self.
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.
QWidget ptrbookmarks_frameGets the bookmarks side widget
QWidget ptrhierarchy_control_frameGets the cell view (hierarchy view) side widget
QWidget ptrlayer_control_frameGets the layer control side widget
QWidget ptrlayer_toolbox_frameGets the layer toolbox side widget
QWidget ptrlibraries_frameGets the library view side widget
LayoutView ptrviewGets the embedded view object.

Detailed description

_const_cast

Signature: [const] LayoutViewWidget 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.

bookmarks_frame

Signature: QWidget ptr bookmarks_frame

Description: Gets the bookmarks side widget

For details about side widgets see layer_control_frame.

This method has been introduced in version 0.27

hierarchy_control_frame

Signature: QWidget ptr hierarchy_control_frame

Description: Gets the cell view (hierarchy view) side widget

For details about side widgets see layer_control_frame.

This method has been introduced in version 0.27

layer_control_frame

Signature: QWidget ptr layer_control_frame

Description: Gets the layer control side widget

A 'side widget' is a widget attached to the view. It does not have a parent, so you can embed it into a different context. Please note that with embedding through 'setParent' it will be destroyed when your parent widget gets destroyed. It will be lost then to the view.

The side widget can be configured through the views configuration interface.

This method has been introduced in version 0.27

layer_toolbox_frame

Signature: QWidget ptr layer_toolbox_frame

Description: Gets the layer toolbox side widget

A 'side widget' is a widget attached to the view. It does not have a parent, so you can embed it into a different context. Please note that with embedding through 'setParent' it will be destroyed when your parent widget gets destroyed. It will be lost then to the view.

The side widget can be configured through the views configuration interface.

This method has been introduced in version 0.28

libraries_frame

Signature: QWidget ptr libraries_frame

Description: Gets the library view side widget

For details about side widgets see layer_control_frame.

This method has been introduced in version 0.27

new

Signature: [static] new LayoutViewWidget ptr new (QWidget ptr parent, bool editable = false, Manager ptr manager = nil, unsigned int options = 0)

Description: Creates a standalone view widget

parent:The parent widget in which to embed the view
editable:True to make the view editable
manager:The Manager object to enable undo/redo
options:A combination of the values in the LV_... constants from LayoutViewBase

This constructor has been introduced in version 0.25. It has been enhanced with the arguments in version 0.27.

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

view

Signature: LayoutView ptr view

Description: Gets the embedded view object.