API reference - Class LayoutView

Add

Signature: [static,const] LayoutView::SelectionMode Add

Description: Adds to any existing selection

Python specific notes:
The object exposes a readable attribute 'Add'. This is the getter.

Invert

Signature: [static,const] LayoutView::SelectionMode Invert

Description: Adds to any existing selection, if it's not there yet or removes it from the selection if it's already selected

Python specific notes:
The object exposes a readable attribute 'Invert'. This is the getter.

LV_Naked

Signature: [static,const] unsigned int LV_Naked

Description: With this option, no separate views will be provided

Use this value with the constructor's 'options' argument. This option is basically equivalent to using LV_NoLayers+LV_NoHierarchyPanel+LV_NoLibrariesView+LV_NoBookmarksView

This constant has been introduced in version 0.27.

Python specific notes:
The object exposes a readable attribute 'LV_Naked'. This is the getter.

LV_NoBookmarksView

Signature: [static,const] unsigned int LV_NoBookmarksView

Description: With this option, no bookmarks view will be provided (see bookmarks_frame)

Use this value with the constructor's 'options' argument.

This constant has been introduced in version 0.27.

Python specific notes:
The object exposes a readable attribute 'LV_NoBookmarksView'. This is the getter.

LV_NoEditorOptionsPanel

Signature: [static,const] unsigned int LV_NoEditorOptionsPanel

Description: With this option, no editor options panel will be provided (see editor_options_frame)

Use this value with the constructor's 'options' argument.

This constant has been introduced in version 0.27.

Python specific notes:
The object exposes a readable attribute 'LV_NoEditorOptionsPanel'. This is the getter.

LV_NoGrid

Signature: [static,const] unsigned int LV_NoGrid

Description: With this option, the grid background is not shown

Use this value with the constructor's 'options' argument.

This constant has been introduced in version 0.27.

Python specific notes:
The object exposes a readable attribute 'LV_NoGrid'. This is the getter.

LV_NoHierarchyPanel

Signature: [static,const] unsigned int LV_NoHierarchyPanel

Description: With this option, no cell hierarchy view will be provided (see hierarchy_control_frame)

Use this value with the constructor's 'options' argument.

This constant has been introduced in version 0.27.

Python specific notes:
The object exposes a readable attribute 'LV_NoHierarchyPanel'. This is the getter.

LV_NoLayers

Signature: [static,const] unsigned int LV_NoLayers

Description: With this option, no layers view will be provided (see layer_control_frame)

Use this value with the constructor's 'options' argument.

This constant has been introduced in version 0.27.

Python specific notes:
The object exposes a readable attribute 'LV_NoLayers'. This is the getter.

LV_NoLibrariesView

Signature: [static,const] unsigned int LV_NoLibrariesView

Description: With this option, no library view will be provided (see libraries_frame)

Use this value with the constructor's 'options' argument.

This constant has been introduced in version 0.27.

Python specific notes:
The object exposes a readable attribute 'LV_NoLibrariesView'. This is the getter.

LV_NoMove

Signature: [static,const] unsigned int LV_NoMove

Description: With this option, move operations are not supported

Use this value with the constructor's 'options' argument.

This constant has been introduced in version 0.27.

Python specific notes:
The object exposes a readable attribute 'LV_NoMove'. This is the getter.

LV_NoPlugins

Signature: [static,const] unsigned int LV_NoPlugins

Description: With this option, all plugins are disabled

Use this value with the constructor's 'options' argument.

This constant has been introduced in version 0.27.

Python specific notes:
The object exposes a readable attribute 'LV_NoPlugins'. This is the getter.

LV_NoPropertiesPopup

Signature: [static,const] unsigned int LV_NoPropertiesPopup

Description: This option disables the properties popup on double click

Use this value with the constructor's 'options' argument.

This constant has been introduced in version 0.28.

Python specific notes:
The object exposes a readable attribute 'LV_NoPropertiesPopup'. This is the getter.

LV_NoSelection

Signature: [static,const] unsigned int LV_NoSelection

Description: With this option, objects cannot be selected

Use this value with the constructor's 'options' argument.

This constant has been introduced in version 0.27.

Python specific notes:
The object exposes a readable attribute 'LV_NoSelection'. This is the getter.

LV_NoServices

Signature: [static,const] unsigned int LV_NoServices

Description: This option disables all services except the ones for pure viewing

Use this value with the constructor's 'options' argument. With this option, all manipulation features are disabled, except zooming. It is equivalent to LV_NoMove + LV_NoTracker + LV_NoSelection + LV_NoPlugins.

This constant has been introduced in version 0.27.

Python specific notes:
The object exposes a readable attribute 'LV_NoServices'. This is the getter.

LV_NoTracker

Signature: [static,const] unsigned int LV_NoTracker

Description: With this option, mouse position tracking is not supported

Use this value with the constructor's 'options' argument. This option is not useful currently as no mouse tracking support is provided.

This constant has been introduced in version 0.27.

Python specific notes:
The object exposes a readable attribute 'LV_NoTracker'. This is the getter.

LV_NoZoom

Signature: [static,const] unsigned int LV_NoZoom

Description: With this option, zooming is disabled

Use this value with the constructor's 'options' argument.

This constant has been introduced in version 0.27.

Python specific notes:
The object exposes a readable attribute 'LV_NoZoom'. This is the getter.

Replace

Signature: [static,const] LayoutView::SelectionMode Replace

Description: Replaces the existing selection

Python specific notes:
The object exposes a readable attribute 'Replace'. This is the getter.

Reset

Signature: [static,const] LayoutView::SelectionMode Reset

Description: Removes from any existing selection

Python specific notes:
The object exposes a readable attribute 'Reset'. This is the getter.

_const_cast

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

active_cellview

Signature: CellView active_cellview

Description: Gets the active cellview (shown in hierarchy browser)

This is a convenience method which is equivalent to "cellview(active_cellview_index)".

This method has been introduced in version 0.19. Starting from version 0.25, the returned object can be manipulated which will have an immediate effect on the display.

active_cellview_index

Signature: [const] int active_cellview_index

Description: Gets the index of the active cellview (shown in hierarchy browser)

Python specific notes:
The object exposes a readable attribute 'active_cellview_index'. This is the getter.

active_cellview_index=

Signature: void active_cellview_index= (int index)

Description: Makes the cellview with the given index the active one (shown in hierarchy browser)

See active_cellview_index.

This method has been renamed from set_active_cellview_index to active_cellview_index= in version 0.25. The original name is still available, but is deprecated.

Python specific notes:
The object exposes a writable attribute 'active_cellview_index'. This is the setter.
The object exposes a writable attribute 'active_setview_index'. This is the setter.

active_setview_index=

Signature: void active_setview_index= (int index)

Description: Makes the cellview with the given index the active one (shown in hierarchy browser)

Use of this method is deprecated. Use active_cellview_index= instead

See active_cellview_index.

This method has been renamed from set_active_cellview_index to active_cellview_index= in version 0.25. The original name is still available, but is deprecated.

Python specific notes:
The object exposes a writable attribute 'active_cellview_index'. This is the setter.
The object exposes a writable attribute 'active_setview_index'. This is the setter.

add_l2ndb

Signature: unsigned int add_l2ndb (LayoutToNetlist ptr db)

Description: Adds the given netlist database to the view

This method will add an existing database to the view. It will then appear in the netlist database browser. A similar method is create_l2ndb which will create a new database within the view.

This method has been added in version 0.26.

add_line_style

(1) Signature: unsigned int add_line_style (string name, unsigned int data, unsigned int bits)

Description: Adds a custom line style

This method has been introduced in version 0.25.

(2) Signature: unsigned int add_line_style (string name, string string)

Description: Adds a custom line style from a string

This method has been introduced in version 0.25.

add_lvsdb

Signature: unsigned int add_lvsdb (LayoutVsSchematic ptr db)

Description: Adds the given database to the view

This method will add an existing database to the view. It will then appear in the netlist database browser. A similar method is create_lvsdb which will create a new database within the view.

This method has been added in version 0.26.

add_marker

Signature: void add_marker (Marker ptr marker)

Description: Adds a persistent marker to the view (transferring ownership)

This method allows creating markers and transferring ownership to the view, hence making them persistent. This means, when the variable with the marker object goes out of scope, the marker will still exist in the view.

To create a persistent marker, use the following code:

marker = RBA::Marker::new
# ... configure marker ...
view.add_marker(marker)

To remove all persistent markers owned by the view, use clear_markers.

Persistent markers have been introduced in version 0.29.3

add_missing_layers

Signature: void add_missing_layers

Description: Adds new layers to layer list

This method was introduced in version 0.19.

add_rdb

Signature: unsigned int add_rdb (ReportDatabase ptr db)

Description: Adds the given report database to the view

This method will add an existing database to the view. It will then appear in the marker database browser. A similar method is create_rdb which will create a new database within the view.

This method has been added in version 0.26.

add_stipple

(1) Signature: unsigned int add_stipple (string name, unsigned int[] data, unsigned int bits)

Description: Adds a stipple pattern

'data' is an array of unsigned integers describing the bits that make up the stipple pattern. If the array has less than 32 entries, the pattern will be repeated vertically. The number of bits used can be less than 32 bit which can be specified by the 'bits' parameter. Logically, the pattern will be put at the end of the list.

(2) Signature: unsigned int add_stipple (string name, string string)

Description: Adds a stipple pattern given by a string

'string' is a string describing the pattern. It consists of one or more lines composed of '.' or '*' characters and separated by newline characters. A '.' is for a missing pixel and '*' for a set pixel. The length of each line must be the same. Blanks before or after each line are ignored.

This method has been introduced in version 0.25.

annotation

Signature: Annotation annotation (int id)

Description: Gets the annotation given by an ID

Returns a reference to the annotation given by the respective ID or an invalid annotation if the ID is not valid. Use Annotation#is_valid? to determine whether the returned annotation is valid or not.

The returned annotation is a 'live' object and changing it will update the view.

This method has been introduced in version 0.25.

annotation_templates

Signature: variant[][] annotation_templates

Description: Gets a list of Annotation objects representing the annotation templates.

Annotation templates are the rulers available in the ruler drop-down (preset ruler types). This method will fetch the templates available. This method returns triplets '(annotation, title, mode)'. The first member of the triplet is the annotation object representing the template. The second member is the title string displayed in the menu for this templates. The third member is the mode value (one of the RulerMode... constants - e.g RulerModeNormal).

The positions of the returned annotation objects are undefined.

This method has been introduced in version 0.28.

ascend

Signature: InstElement ascend (int index)

Description: Ascends upwards in the hierarchy.

Removes one element from the specific path of the cellview with the given index. Returns the element removed.

begin_layers

(1) Signature: [const] LayerPropertiesIterator begin_layers

Description: Begin iterator for the layers

This iterator delivers the layers of this view, either in a recursive or non-recursive fashion, depending which iterator increment methods are used. The iterator delivered by end_layers is the past-the-end iterator. It can be compared against a current iterator to check, if there are no further elements.

Starting from version 0.25, an alternative solution is provided with 'each_layer' which is based on the LayerPropertiesNodeRef class.

(2) Signature: [const] LayerPropertiesIterator begin_layers (unsigned int index)

Description: Begin iterator for the layers

This iterator delivers the layers of this view, either in a recursive or non-recursive fashion, depending which iterator increment methods are used. The iterator delivered by end_layers is the past-the-end iterator. It can be compared against a current iterator to check, if there are no further elements. This version addresses a specific list in a multi-tab layer properties arrangement with the "index" parameter. This method has been introduced in version 0.21.

bookmark_view

Signature: void bookmark_view (string name)

Description: Bookmarks the current view under the given name

box

Signature: [const] DBox box

Description: Returns the displayed box in micron space

call_menu

Signature: void call_menu (string symbol)

Description: Calls the menu item with the provided symbol.

To obtain all symbols, use menu_symbols.

This method has been introduced in version 0.27.

cancel

Signature: void cancel

Description: Cancels all edit operations

This method will stop all pending edit operations (i.e. drag and drop) and cancel the current selection. Calling this method is useful to ensure there are no potential interactions with the script's functionality.

cellview

Signature: CellView cellview (unsigned int cv_index)

Description: Gets the cellview object for a given index

Starting with version 0.25, this method returns a CellView object that can be manipulated to directly reflect any changes in the display.

cellviews

Signature: [const] unsigned int cellviews

Description: Gets the number of cellviews

clear_annotations

Signature: void clear_annotations

Description: Clears all annotations on this view

clear_config

Signature: void clear_config

Description: Clears the local configuration parameters

See set_config for a description of the local configuration parameters.

clear_images

Signature: void clear_images

Description: Clear all images on this view

clear_layers

(1) Signature: void clear_layers

Description: Clears all layers

(2) Signature: void clear_layers (unsigned int index)

Description: Clears all layers for the given layer properties list

This version addresses a specific list in a multi-tab layer properties arrangement with the "index" parameter. This method has been introduced in version 0.21.

clear_line_styles

Signature: void clear_line_styles

Description: Removes all custom line styles

All line styles except the fixed ones are removed. If any of the custom styles is still used by the layers displayed, the results will be undefined. This method has been introduced in version 0.25.

clear_markers

Signature: void clear_markers

Description: Clears all persistent markers from the view

See add_marker for details about persistent markers.

Persistent markers have been introduced in version 0.29.3

clear_object_selection

Signature: [const] void clear_object_selection

Description: Clears the selection of geometrical objects (shapes or cell instances)

The selection of other objects (such as annotations and images) will not be affected.

This method has been introduced in version 0.24

clear_selection

Signature: void clear_selection

Description: Clears the selection of all objects (shapes, annotations, images ...)

This method has been introduced in version 0.26.2

clear_stipples

Signature: void clear_stipples

Description: Removes all custom line styles

All stipple pattern except the fixed ones are removed. If any of the custom stipple pattern is still used by the layers displayed, the results will be undefined.

clear_transactions

Signature: void clear_transactions

Description: Clears all transactions

Discard all actions in the undo buffer. After clearing that buffer, no undo is available. It is important to clear the buffer when making database modifications outside transactions, i.e after that modifications have been done. If failing to do so, 'undo' operations are likely to produce invalid results. This method was introduced in version 0.16.

clear_transient_selection

Signature: void clear_transient_selection

Description: Clears the transient selection (mouse-over hightlights) of all objects (shapes, annotations, images ...)

This method has been introduced in version 0.26.2

close

Signature: void close

Description: Closes the view

This method has been added in version 0.27.

commit

Signature: void commit

Description: Ends a transaction

See transaction for a detailed description of transactions. This method was introduced in version 0.16.

commit_config

Signature: void commit_config

Description: Commits the configuration settings

Some configuration options are queued for performance reasons and become active only after 'commit_config' has been called. After a sequence of set_config calls, this method should be called to activate the settings made by these calls.

This method has been introduced in version 0.25.

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.

create_l2ndb

Signature: unsigned int create_l2ndb (string name)

Description: Creates a new netlist database and returns the index of the new database

This method returns an index of the new netlist database. Use l2ndb to get the actual object. If a netlist database with the given name already exists, a unique name will be created. The name will be replaced by the file name when a file is loaded into the netlist database.

This method has been added in version 0.26.

create_layout

(1) Signature: unsigned int create_layout (bool add_cellview)

Description: Creates a new, empty layout

The add_cellview parameter controls whether to create a new cellview (true) or clear all cellviews before (false).

This version will associate the new layout with the default technology.

(2) Signature: unsigned int create_layout (string tech, bool add_cellview)

Description: Create a new, empty layout and associate it with the given technology

The add_cellview parameter controls whether to create a new cellview (true) or clear all cellviews before (false).

This variant has been introduced in version 0.22.

(3) Signature: unsigned int create_layout (string tech, bool add_cellview, bool init_layers)

Description: Create a new, empty layout and associate it with the given technology

The add_cellview parameter controls whether to create a new cellview (true) or clear all cellviews before (false). This variant also allows one to control whether the layer properties are initialized (init_layers = true) or not (init_layers = false).

This variant has been introduced in version 0.22.

create_lvsdb

Signature: unsigned int create_lvsdb (string name)

Description: Creates a new netlist database and returns the index of the new database

This method returns an index of the new netlist database. Use lvsdb to get the actual object. If a netlist database with the given name already exists, a unique name will be created. The name will be replaced by the file name when a file is loaded into the netlist database.

This method has been added in version 0.26.

create_measure_ruler

Signature: Annotation create_measure_ruler (const DPoint point, int ac = Annotation#AngleAny)

Description: Createas an auto-measure ruler at the given point.

The ac parameters takes one of the Angle... constants from Annotation.

This method will create a ruler with a measurement, looking to the sides of the seed point for visible layout in the vicinity. The angle constraint determines the main directions where to look. If suitable edges are found, the method will pull a line between the closest edges. The ruler's endpoints will sit on these lines and the ruler's length will be the distance. Only visible layers will participate in the measurement.

The new ruler is inserted into the view already. It is created with the default style of rulers. If the measurement fails because there is no layout in the vicinity, a ruler with identical start and end points will be created.

This method was introduced in version 0.26.

create_rdb

Signature: unsigned int create_rdb (string name)

Description: Creates a new report database and returns the index of the new database

This method returns an index of the new report database. Use rdb to get the actual object. If a report database with the given name already exists, a unique name will be created. The name will be replaced by the file name when a file is loaded into the report database.

current

Signature: [static] LayoutView ptr current

Description: Returns the current view

The current view is the one that is shown in the current tab. Returns nil if no layout is loaded.

This method has been introduced in version 0.23.

current_layer

Signature: [const] LayerPropertiesIterator current_layer

Description: Gets the current layer view

Returns the LayerPropertiesIterator pointing to the current layer view (the one that has the focus). If no layer view is active currently, a null iterator is returned.

Python specific notes:
The object exposes a readable attribute 'current_layer'. This is the getter.

current_layer=

Signature: void current_layer= (const LayerPropertiesIterator iter)

Description: Sets the current layer view

Specifies an LayerPropertiesIterator pointing to the new current layer view.

This method has been introduced in version 0.23.

Python specific notes:
The object exposes a writable attribute 'current_layer'. This is the setter.

current_layer_list

Signature: [const] unsigned int current_layer_list

Description: Gets the index of the currently selected layer properties tab

This method has been introduced in version 0.21.

Python specific notes:
The object exposes a readable attribute 'current_layer_list'. This is the getter.

current_layer_list=

Signature: void current_layer_list= (unsigned int index)

Description: Sets the index of the currently selected layer properties tab

This method has been introduced in version 0.21.

Python specific notes:
The object exposes a writable attribute 'current_layer_list'. This is the setter.

delete_layer

(1) Signature: void delete_layer (LayerPropertiesIterator iter)

Description: Deletes the layer properties node specified by the iterator

This method deletes the object that the iterator points to and invalidates the iterator since the object that the iterator points to is no longer valid.

(2) Signature: void delete_layer (unsigned int index, LayerPropertiesIterator iter)

Description: Deletes the layer properties node specified by the iterator

This method deletes the object that the iterator points to and invalidates the iterator since the object that the iterator points to is no longer valid. This version addresses a specific list in a multi-tab layer properties arrangement with the "index" parameter. This method has been introduced in version 0.21.

delete_layer_list

Signature: void delete_layer_list (unsigned int index)

Description: Deletes the given properties list

At least one layer properties list must remain. This method may change the current properties list. This method has been introduced in version 0.21.

delete_layers

(1) Signature: void delete_layers (LayerPropertiesIterator[] iterators)

Description: Deletes the layer properties nodes specified by the iterator

This method deletes the nodes specifies by the iterators. This method is the most convenient way to delete multiple entries.

This method has been added in version 0.22.

(2) Signature: void delete_layers (unsigned int index, LayerPropertiesIterator[] iterators)

Description: Deletes the layer properties nodes specified by the iterator

This method deletes the nodes specifies by the iterators. This method is the most convenient way to delete multiple entries. This version addresses a specific list in a multi-tab layer properties arrangement with the "index" parameter. This method has been introduced in version 0.22.

descend

Signature: void descend (InstElement[] path, int index)

Description: Descends further into the hierarchy.

Adds the given path (given as an array of InstElement objects) to the specific path of the cellview with the given index. In effect, the cell addressed by the terminal of the new path components can be shown in the context of the upper cells, if the minimum hierarchy level is set to a negative value. The path is assumed to originate from the current cell and contain specific instances sorted from top to bottom.

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.

each_annotation

Signature: [iter] Annotation each_annotation

Description: Iterates over all annotations attached to this view

each_annotation_selected

Signature: [const,iter] Annotation each_annotation_selected

Description: Iterate over each selected annotation objects, yielding a Annotation object for each of them

This method was introduced in version 0.19.

each_image

Signature: [iter] Image each_image

Description: Iterate over all images attached to this view

With version 0.25, the objects returned by the iterator are references and can be manipulated to change their appearance.

each_image_selected

Signature: [const,iter] Image each_image_selected

Description: Iterate over each selected image object, yielding a Image object for each of them

This method was introduced in version 0.19.

each_layer

(1) Signature: [iter] LayerPropertiesNodeRef each_layer

Description: Hierarchically iterates over the layers in the first layer list

This iterator will recursively deliver the layers in the first layer list of the view. The objects presented by the iterator are LayerPropertiesNodeRef objects. They can be manipulated to apply changes to the layer settings or even the hierarchy of layers:

RBA::LayoutViewBase::current.each_layer do |lref|
  # lref is a RBA::LayerPropertiesNodeRef object
  lref.visible = false
end

This method was introduced in version 0.25.

(2) Signature: [iter] LayerPropertiesNodeRef each_layer (unsigned int layer_list)

Description: Hierarchically iterates over the layers in the given layer list

This version of this method allows specification of the layer list to be iterated over. The layer list is specified by its index which is a value between 0 and num_layer_lists-1.For details see the parameter-less version of this method.

This method was introduced in version 0.25.

each_object_selected

Signature: [const,iter] ObjectInstPath each_object_selected

Description: Iterates over each selected geometrical object, yielding a ObjectInstPath object for each of them

This iterator will deliver const objects - they cannot be modified. In order to modify the selection, create a copy of the ObjectInstPath objects, modify them and install the new selection using select_object or object_selection=.

Another way of obtaining the selection is object_selection, which returns an array of ObjectInstPath objects.

each_object_selected_transient

Signature: [const,iter] ObjectInstPath each_object_selected_transient

Description: Iterates over each geometrical objects in the transient selection, yielding a ObjectInstPath object for each of them

This method was introduced in version 0.18.

enable_edits

Signature: void enable_edits (bool enable)

Description: Enables or disables edits

This method allows putting the view into read-only mode by disabling all edit functions. For doing so, this method has to be called with a 'false' argument. Calling it with a 'true' parameter enables all edits again. This method must not be confused with the edit/viewer mode. The LayoutView's enable_edits method is intended to temporarily disable all menu entries and functions which could allow the user to alter the database. In 0.25, this method has been moved from MainWindow to LayoutView.

end_layers

(1) Signature: [const] LayerPropertiesIterator end_layers

Description: End iterator for the layers

See begin_layers for a description about this iterator

(2) Signature: [const] LayerPropertiesIterator end_layers (unsigned int index)

Description: End iterator for the layers

See begin_layers for a description about this iterator This version addresses a specific list in a multi-tab layer properties arrangement with the "index" parameter. This method has been introduced in version 0.21.

erase_annotation

Signature: void erase_annotation (int id)

Description: Erases the annotation given by the id

Deletes an existing annotation given by the id parameter. The id of an annotation can be obtained through Annotation#id.

This method has been introduced in version 0.24. Starting with version 0.25, the annotation's Annotation#delete method can also be used to delete an annotation.

erase_cellview

Signature: void erase_cellview (unsigned int index)

Description: Erases the cellview with the given index

This closes the given cellview and unloads the layout associated with it, unless referred to by another cellview.

erase_image

Signature: void erase_image (unsigned long id)

Description: Erase the given image

Erases the image with the given Id. The Id can be obtained with if "id" method of the image object.

This method has been introduced in version 0.20.

With version 0.25, Image#delete can be used to achieve the same results.

expand_layer_properties

(1) Signature: void expand_layer_properties

Description: Expands the layer properties for all tabs

This method will expand all wildcard specifications in the layer properties by iterating over the specified objects (i.e. layers, cellviews) and by replacing default colors and stipples by the ones specified with the palettes.

This method was introduced in version 0.21.

(2) Signature: void expand_layer_properties (unsigned int index)

Description: Expands the layer properties for the given tab

This method will expand all wildcard specifications in the layer properties by iterating over the specified objects (i.e. layers, cellviews) and by replacing default colors and stipples by the ones specified with the palettes.

This method was introduced in version 0.21.

get_config

Signature: [const] string get_config (string name)

Description: Gets the value of a local configuration parameter

See set_config for a description of the local configuration parameters.

get_config_names

Signature: string[] get_config_names

Description: Gets the configuration parameter names

This method returns the names of all known configuration parameters. These names can be used to get and set configuration parameter values.

This method was introduced in version 0.25.

get_current_cell_path

Signature: [const] unsigned int[] get_current_cell_path (int cv_index)

Description: Gets the cell path of the current cell

Use of this method is deprecated

The current cell is the one highlighted in the browser with the focus rectangle. The current path is returned for the cellview given by cv_index. The cell path is a list of cell indices from the top cell to the current cell.

This method is was deprecated in version 0.25 since from then, the CellView object can be used to obtain an manipulate the selected cell.

get_image

Signature: QImage get_image (unsigned int width, unsigned int height)

Description: Gets the layout image as a QImage

The image contains the current scene (layout, annotations etc.). The image is drawn synchronously with the given width and height. Drawing may take some time.

get_image_with_options

Signature: QImage get_image_with_options (unsigned int width, unsigned int height, int linewidth = 0, int oversampling = 0, double resolution = 0, const DBox target = current, bool monochrome = false)

Description: Gets the layout image as a QImage (with options)

The image contains the current scene (layout, annotations etc.). The image is drawn synchronously with the given width and height. Drawing may take some time. Monochrome images don't have background or annotation objects currently.

This method has been introduced in version 0.23.10.

get_line_style

Signature: string get_line_style (unsigned int index)

Description: Gets the line style string for the style with the given index

This method will return the line style string for the style with the given index. The format of the string is the same than the string accepted by add_line_style. An empty string corresponds to 'solid line'.

This method has been introduced in version 0.25.

get_pixels

Signature: PixelBuffer get_pixels (unsigned int width, unsigned int height)

Description: Gets the layout image as a PixelBuffer

The image contains the current scene (layout, annotations etc.). The image is drawn synchronously with the given width and height. Drawing may take some time. This method has been introduced in 0.28.

get_pixels_with_options

Signature: PixelBuffer get_pixels_with_options (unsigned int width, unsigned int height, int linewidth = 0, int oversampling = 0, double resolution = 0, const DBox target = current)

Description: Gets the layout image as a PixelBuffer (with options)

The image contains the current scene (layout, annotations etc.). The image is drawn synchronously with the given width and height. Drawing may take some time. This method has been introduced in 0.28.

get_pixels_with_options_mono

Signature: BitmapBuffer get_pixels_with_options_mono (unsigned int width, unsigned int height, int linewidth = 0, const DBox target = current)

Description: Gets the layout image as a PixelBuffer (with options)

The image contains the current scene (layout, annotations etc.). The image is drawn synchronously with the given width and height. Drawing may take some time. Monochrome images don't have background or annotation objects currently.

This method has been introduced in 0.28.

get_screenshot

Signature: QImage get_screenshot

Description: Gets a screenshot as a QImage

Getting the image requires the drawing to be complete. Ideally, synchronous mode is switched on for the application to guarantee this condition. The image will have the size of the viewport showing the current layout.

get_screenshot_pixels

Signature: PixelBuffer get_screenshot_pixels

Description: Gets a screenshot as a PixelBuffer

Getting the image requires the drawing to be complete. Ideally, synchronous mode is switched on for the application to guarantee this condition. The image will have the size of the viewport showing the current layout. This method has been introduced in 0.28.

get_stipple

Signature: string get_stipple (unsigned int index)

Description: Gets the stipple pattern string for the pattern with the given index

This method will return the stipple pattern string for the pattern with the given index. The format of the string is the same than the string accepted by add_stipple.

This method has been introduced in version 0.25.

has_annotation_selection?

Signature: [const] bool has_annotation_selection?

Description: Returns true, if annotations (rulers) are selected in this view

This method was introduced in version 0.19.

has_image_selection?

Signature: [const] bool has_image_selection?

Description: Returns true, if images are selected in this view

This method was introduced in version 0.19.

has_object_selection?

Signature: [const] bool has_object_selection?

Description: Returns true, if geometrical objects (shapes or cell instances) are selected in this view

has_selection?

Signature: bool has_selection?

Description: Indicates whether any objects are selected

This method has been introduced in version 0.27

has_transient_object_selection?

Signature: [const] bool has_transient_object_selection?

Description: Returns true, if geometrical objects (shapes or cell instances) are selected in this view in the transient selection

The transient selection represents the objects selected when the mouse hovers over the layout windows. This selection is not used for operations but rather to indicate which object would be selected if the mouse is clicked.

This method was introduced in version 0.18.

hide_cell

Signature: void hide_cell (unsigned int cell_index, int cv_index)

Description: Hides the given cell for the given cellview

icon_for_layer

Signature: PixelBuffer icon_for_layer (const LayerPropertiesIterator iter, unsigned int w, unsigned int h, double dpr, unsigned int di_off = 0, bool no_state = false)

Description: Creates an icon pixmap for the given layer.

The icon will have size w times h pixels multiplied by the device pixel ratio (dpr). The dpr is The number of physical pixels per logical pixels on high-DPI displays.

'di_off' will shift the dither pattern by the given number of (physical) pixels. If 'no_state' is true, the icon will not reflect visibility or validity states but rather the display style.

This method has been introduced in version 0.28.

image

Signature: Image image (unsigned long id)

Description: Gets the image given by an ID

Returns a reference to the image given by the respective ID or an invalid image if the ID is not valid. Use Image#is_valid? to determine whether the returned image is valid or not.

The returned image is a 'live' object and changing it will update the view.

This method has been introduced in version 0.25.

init_layer_properties

Signature: [const] void init_layer_properties (LayerProperties props)

Description: Fills the layer properties for a new layer

This method initializes a layer properties object's color and stipples according to the defaults for the given layer source specification. The layer's source must be set already on the layer properties object.

This method was introduced in version 0.19.

insert_annotation

Signature: void insert_annotation (Annotation ptr obj)

Description: Inserts an annotation object into the given view

Inserts a new annotation into the view. Existing annotation will remain. Use clear_annotations to delete them before inserting new ones. Use replace_annotation to replace an existing one with a new one. Starting with version 0.25 this method modifies self's ID to reflect the ID of the ruler created. After an annotation is inserted into the view, it can be modified and the changes of properties will become reflected immediately in the view.

insert_image

Signature: void insert_image (Image obj)

Description: Insert an image object into the given view

Insert the image object given by obj into the view.

With version 0.25, this method will attach the image object to the view and the image object will become a 'live' object - i.e. changes to the object will change the appearance of the image on the screen.

insert_layer

(1) Signature: LayerPropertiesNodeRef insert_layer (const LayerPropertiesIterator iter, const LayerProperties node = LayerProperties())

Description: Inserts the given layer properties node into the list before the given position

This method inserts the new properties node before the position given by "iter" and returns a const reference to the element created. The iterator that specified the position will remain valid after the node was inserted and will point to the newly created node. It can be used to add further nodes. To add children to the node inserted, use iter.last_child as insertion point for the next insert operations.

Since version 0.22, this method accepts LayerProperties and LayerPropertiesNode objects. A LayerPropertiesNode object can contain a hierarchy of further nodes. Since version 0.26 the node parameter is optional and the reference returned by this method can be used to set the properties of the new node.

(2) Signature: LayerPropertiesNodeRef insert_layer (unsigned int index, const LayerPropertiesIterator iter, const LayerProperties node = LayerProperties())

Description: Inserts the given layer properties node into the list before the given position

This version addresses a specific list in a multi-tab layer properties arrangement with the "index" parameter. This method inserts the new properties node before the position given by "iter" and returns a const reference to the element created. The iterator that specified the position will remain valid after the node was inserted and will point to the newly created node. It can be used to add further nodes. This method has been introduced in version 0.21. Since version 0.22, this method accepts LayerProperties and LayerPropertiesNode objects. A LayerPropertiesNode object can contain a hierarchy of further nodes. Since version 0.26 the node parameter is optional and the reference returned by this method can be used to set the properties of the new node.

insert_layer_list

Signature: void insert_layer_list (unsigned int index)

Description: Inserts a new layer properties list at the given index

This method inserts a new tab at the given position. The current layer properties list will be changed to the new list. This method has been introduced in version 0.21.

is_cell_hidden?

Signature: [const] bool is_cell_hidden? (unsigned int cell_index, int cv_index)

Description: Returns true, if the cell is hidden

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.

is_dirty?

Signature: bool is_dirty?

Description: Gets a flag indicating whether one of the layouts displayed needs saving

A layout is 'dirty' if it is modified and needs saving. This method returns true if this is the case for at least one of the layouts shown in the view.

This method has been introduced in version 0.29.

is_editable?

Signature: [const] bool is_editable?

Description: Returns true if the view is in editable mode

This read-only attribute has been added in version 0.27.5.

is_transacting?

Signature: bool is_transacting?

Description: Indicates if a transaction is ongoing

See transaction for a detailed description of transactions. This method was introduced in version 0.16.

l2ndb

Signature: LayoutToNetlist ptr l2ndb (int index)

Description: Gets the netlist database with the given index

This method has been added in version 0.26.

load_layer_props

(1) Signature: void load_layer_props (string fn)

Description: Loads the layer properties

Load the layer properties from the file given in "fn"

(2) Signature: void load_layer_props (string fn, bool add_default)

Description: Loads the layer properties with options

Load the layer properties from the file given in "fn". This version allows one to specify whether defaults should be used for all other layers by setting "add_default" to true.

This variant has been added on version 0.21.

(3) Signature: void load_layer_props (string fn, int cv_index, bool add_default)

Description: Loads the layer properties with options

Load the layer properties from the file given in "fn". This version allows one to specify whether defaults should be used for all other layers by setting "add_default" to true. It can be used to load the layer properties for a specific cellview by setting "cv_index" to the index for which the layer properties file should be applied. All present definitions for this layout will be removed before the properties file is loaded. "cv_index" can be set to -1. In that case, the layer properties file is applied to each of the layouts individually.

Note that this version will override all cellview index definitions in the layer properties file.

This variant has been added on version 0.21.

load_layout

(1) Signature: unsigned int load_layout (string filename, const LoadLayoutOptions options, string technology, bool add_cellview = true)

Description: Loads a (new) file into the layout view with the given technology

Loads the file given by the "filename" parameter and associates it with the given technology. The options specify various options for reading the file. The add_cellview param controls whether to create a new cellview (true) or clear all cellviews before (false).

This version has been introduced in version 0.22. The 'add_cellview' argument has been made optional in version 0.28.

(2) Signature: unsigned int load_layout (string filename, const LoadLayoutOptions options, bool add_cellview = true)

Description: Loads a (new) file into the layout view

Loads the file given by the "filename" parameter. The options specify various options for reading the file. The add_cellview param controls whether to create a new cellview (true) or clear all cellviews before (false).

This method has been introduced in version 0.18. The 'add_cellview' argument has been made optional in version 0.28.

(3) Signature: unsigned int load_layout (string filename, string technology, bool add_cellview = true)

Description: Loads a (new) file into the layout view with the given technology

Loads the file given by the "filename" parameter and associates it with the given technology. The add_cellview param controls whether to create a new cellview (true) or clear all cellviews before (false).

This version has been introduced in version 0.22. The 'add_cellview' argument has been made optional in version 0.28.

(4) Signature: unsigned int load_layout (string filename, bool add_cellview = true)

Description: Loads a (new) file into the layout view

Loads the file given by the "filename" parameter. The add_cellview param controls whether to create a new cellview (true) or clear all cellviews before (false).

lvsdb

Signature: LayoutVsSchematic ptr lvsdb (unsigned int index)

Description: Gets the netlist database with the given index

This method has been added in version 0.26.

max_hier

Signature: void max_hier

Description: Selects all hierarchy levels available

Show the layout in full depth down to the deepest level of hierarchy. This method may cause a redraw.

max_hier_levels

Signature: [const] int max_hier_levels

Description: Returns the maximum hierarchy level up to which to display geometries

Python specific notes:
The object exposes a readable attribute 'max_hier_levels'. This is the getter.

max_hier_levels=

Signature: void max_hier_levels= (int level)

Description: Sets the maximum hierarchy level up to which to display geometries

This methods allows setting the maximum hierarchy below which to display geometries.This method may cause a redraw if required.

Python specific notes:
The object exposes a writable attribute 'max_hier_levels'. This is the setter.

menu

Signature: AbstractMenu ptr menu

Description: Gets the AbstractMenu associated with this view.

In normal UI application mode this is the main window's view. For a detached view or in non-UI applications this is the view's private menu.

This method has been introduced in version 0.28.

menu_symbols

Signature: [static] string[] menu_symbols

Description: Gets all available menu symbols (see call_menu).

NOTE: currently this method delivers a superset of all available symbols. Depending on the context, no all symbols may trigger actual functionality.

This method has been introduced in version 0.27.

min_hier_levels

Signature: [const] int min_hier_levels

Description: Returns the minimum hierarchy level at which to display geometries

Python specific notes:
The object exposes a readable attribute 'min_hier_levels'. This is the getter.

min_hier_levels=

Signature: void min_hier_levels= (int level)

Description: Sets the minimum hierarchy level at which to display geometries

This methods allows setting the minimum hierarchy level above which to display geometries.This method may cause a redraw if required.

Python specific notes:
The object exposes a writable attribute 'min_hier_levels'. This is the setter.

mode_name

Signature: [const] string mode_name

Description: Gets the name of the current mode.

See switch_mode about a method to change the mode and mode_names for a method to retrieve all available mode names.

This method has been introduced in version 0.28.

mode_names

Signature: [const] string[] mode_names

Description: Gets the names of the available modes.

This method allows asking the view for the available mode names for switch_mode and for the value returned by mode.

This method has been introduced in version 0.28.

netlist_browser

Signature: NetlistBrowserDialog ptr netlist_browser

Description: Gets the netlist browser object for the given layout view

This method has been added in version 0.27.

new

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

Description: Creates a standalone view

This constructor is for special purposes only. To create a view in the context of a main window, use MainWindow#create_view and related methods.

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.

num_l2ndbs

Signature: [const] unsigned int num_l2ndbs

Description: Gets the number of netlist databases loaded into this view

This method has been added in version 0.26.

num_layer_lists

Signature: [const] unsigned int num_layer_lists

Description: Gets the number of layer properties tabs present

This method has been introduced in version 0.23.

num_rdbs

Signature: [const] unsigned int num_rdbs

Description: Gets the number of report databases loaded into this view

object_selection

Signature: [const] ObjectInstPath[] object_selection

Description: Returns a list of selected objects

This method will deliver an array of ObjectInstPath objects listing the selected geometrical objects. Other selected objects such as annotations and images will not be contained in that list.

The list returned is an array of copies of ObjectInstPath objects. They can be modified, but they will become a new selection only after re-introducing them into the view through object_selection= or select_object.

Another way of obtaining the selected objects is each_object_selected.

This method has been introduced in version 0.24.

Python specific notes:
The object exposes a readable attribute 'object_selection'. This is the getter.

object_selection=

Signature: [const] void object_selection= (ObjectInstPath[] sel)

Description: Sets the list of selected objects

This method will set the selection of geometrical objects such as shapes and instances. It is the setter which complements the object_selection method.

Another way of setting the selection is through clear_object_selection and select_object.

This method has been introduced in version 0.24.

Python specific notes:
The object exposes a writable attribute 'object_selection'. This is the setter.

on_active_cellview_changed

Signature: [signal] void on_active_cellview_changed

Description: An event indicating that the active cellview has changed

If the active cellview is changed by selecting a new one from the drop-down list, this event is triggered. When this event is triggered, the cellview has already been changed. Before version 0.25 this event was based on the observer pattern obsolete now. The corresponding methods (add_active_cellview_changed/remove_active_cellview_changed) have been removed in 0.25.

Python specific notes:
The object exposes a readable attribute 'on_active_cellview_changed'. This is the getter.
The object exposes a writable attribute 'on_active_cellview_changed'. This is the setter.

on_annotation_changed

Signature: [signal] void on_annotation_changed (int id)

Description: A event indicating that an annotation has been modified

The argument of the event is the ID of the annotation that was changed. This event has been added in version 0.25.

Python specific notes:
The object exposes a readable attribute 'on_annotation_changed'. This is the getter.
The object exposes a writable attribute 'on_annotation_changed'. This is the setter.

on_annotation_selection_changed

Signature: [signal] void on_annotation_selection_changed

Description: A event indicating that the annotation selection has changed

This event has been added in version 0.25.

Python specific notes:
The object exposes a readable attribute 'on_annotation_selection_changed'. This is the getter.
The object exposes a writable attribute 'on_annotation_selection_changed'. This is the setter.

on_annotations_changed

Signature: [signal] void on_annotations_changed

Description: A event indicating that annotations have been added or removed

This event has been added in version 0.25.

Python specific notes:
The object exposes a readable attribute 'on_annotations_changed'. This is the getter.
The object exposes a writable attribute 'on_annotations_changed'. This is the setter.

on_apply_technology

Signature: [signal] void on_apply_technology (int cellview_index)

Description: An event indicating that a cellview has requested a new technology

If the technology of a cellview is changed, this event is triggered. The integer parameter of this event will indicate the cellview that has changed.

This event has been introduced in version 0.28.

Python specific notes:
The object exposes a readable attribute 'on_apply_technology'. This is the getter.
The object exposes a writable attribute 'on_apply_technology'. This is the setter.

on_cell_visibility_changed

Signature: [signal] void on_cell_visibility_changed

Description: An event indicating that the visibility of one or more cells has changed

This event is triggered after the visibility of one or more cells has changed.

Before version 0.25 this event was based on the observer pattern obsolete now. The corresponding methods (add_cell_visibility_observer/remove_cell_visibility_observer) have been removed in 0.25.

Python specific notes:
The object exposes a readable attribute 'on_cell_visibility_changed'. This is the getter.
The object exposes a writable attribute 'on_cell_visibility_changed'. This is the setter.

on_cellview_changed

Signature: [signal] void on_cellview_changed (int cellview_index)

Description: An event indicating that a cellview has changed

If a cellview is modified, this event is triggered. When this event is triggered, the cellview have already been changed. The integer parameter of this event will indicate the cellview that has changed.

Before version 0.25 this event was based on the observer pattern obsolete now. The corresponding methods (add_cellview_observer/remove_cellview_observer) have been removed in 0.25.

Python specific notes:
The object exposes a readable attribute 'on_cellview_changed'. This is the getter.
The object exposes a writable attribute 'on_cellview_changed'. This is the setter.

on_cellviews_changed

Signature: [signal] void on_cellviews_changed

Description: An event indicating that the cellview collection has changed

If new cellviews are added or cellviews are removed, this event is triggered. When this event is triggered, the cellviews have already been changed. Before version 0.25 this event was based on the observer pattern obsolete now. The corresponding methods (add_cellview_list_observer/remove_cellview_list_observer) have been removed in 0.25.

Python specific notes:
The object exposes a readable attribute 'on_cellviews_changed'. This is the getter.
The object exposes a writable attribute 'on_cellviews_changed'. This is the setter.

on_close

Signature: [signal] void on_close

Description: A event indicating that the view is about to close

This event is triggered when the view is going to be closed entirely.

It has been added in version 0.25.

Python specific notes:
The object exposes a readable attribute 'on_close'. This is the getter.
The object exposes a writable attribute 'on_close'. This is the setter.

on_current_layer_list_changed

Signature: [signal] void on_current_layer_list_changed (int index)

Description: An event indicating the current layer list (the selected tab) has changed

This event is triggered after the current layer list was changed - i.e. a new tab was selected.

This event was introduced in version 0.25.

Python specific notes:
The object exposes a readable attribute 'on_current_layer_list_changed'. This is the getter.
The object exposes a writable attribute 'on_current_layer_list_changed'. This is the setter.

on_file_open

Signature: [signal] void on_file_open

Description: An event indicating that a file was opened

If a file is loaded, this event is triggered. When this event is triggered, the file was already loaded and the new file is the new active cellview. Despite its name, this event is also triggered if a layout object is loaded into the view.

Before version 0.25 this event was based on the observer pattern obsolete now. The corresponding methods (add_file_open_observer/remove_file_open_observer) have been removed in 0.25.

Python specific notes:
The object exposes a readable attribute 'on_file_open'. This is the getter.
The object exposes a writable attribute 'on_file_open'. This is the setter.

on_hide

Signature: [signal] void on_hide

Description: A event indicating that the view is going to become invisible

It has been added in version 0.25.

Python specific notes:
The object exposes a readable attribute 'on_hide'. This is the getter.
The object exposes a writable attribute 'on_hide'. This is the setter.

on_image_changed

Signature: [signal] void on_image_changed (int id)

Description: A event indicating that an image has been modified

The argument of the event is the ID of the image that was changed. This event has been added in version 0.25.

Python specific notes:
The object exposes a readable attribute 'on_image_changed'. This is the getter.
The object exposes a writable attribute 'on_image_changed'. This is the setter.

on_image_selection_changed

Signature: [signal] void on_image_selection_changed

Description: A event indicating that the image selection has changed

This event has been added in version 0.25.

Python specific notes:
The object exposes a readable attribute 'on_image_selection_changed'. This is the getter.
The object exposes a writable attribute 'on_image_selection_changed'. This is the setter.

on_images_changed

Signature: [signal] void on_images_changed

Description: A event indicating that images have been added or removed

This event has been added in version 0.25.

Python specific notes:
The object exposes a readable attribute 'on_images_changed'. This is the getter.
The object exposes a writable attribute 'on_images_changed'. This is the setter.

on_l2ndb_list_changed

Signature: [signal] void on_l2ndb_list_changed

Description: An event that is triggered the list of netlist databases is changed

If a netlist database is added or removed, this event is triggered.

This method has been added in version 0.26.

Python specific notes:
The object exposes a readable attribute 'on_l2ndb_list_changed'. This is the getter.
The object exposes a writable attribute 'on_l2ndb_list_changed'. This is the setter.

on_layer_list_changed

Signature: [signal] void on_layer_list_changed (int flags)

Description: An event indicating that the layer list has changed

This event is triggered after the layer list has changed its configuration. The integer argument gives a hint about the nature of the changed: Bit 0 is set, if the properties (visibility, color etc.) of one or more layers have changed. Bit 1 is set if the hierarchy has changed. Bit 2 is set, if layer names have changed. Before version 0.25 this event was based on the observer pattern obsolete now. The corresponding methods (add_layer_list_observer/remove_layer_list_observer) have been removed in 0.25.

Python specific notes:
The object exposes a readable attribute 'on_layer_list_changed'. This is the getter.
The object exposes a writable attribute 'on_layer_list_changed'. This is the setter.

on_layer_list_deleted

Signature: [signal] void on_layer_list_deleted (int index)

Description: An event indicating that a layer list (a tab) has been removed

This event is triggered after the layer list has been removed - i.e. a tab was deleted.

This event was introduced in version 0.25.

Python specific notes:
The object exposes a readable attribute 'on_layer_list_deleted'. This is the getter.
The object exposes a writable attribute 'on_layer_list_deleted'. This is the setter.

on_layer_list_inserted

Signature: [signal] void on_layer_list_inserted (int index)

Description: An event indicating that a layer list (a tab) has been inserted

This event is triggered after the layer list has been inserted - i.e. a new tab was created.

This event was introduced in version 0.25.

Python specific notes:
The object exposes a readable attribute 'on_layer_list_inserted'. This is the getter.
The object exposes a writable attribute 'on_layer_list_inserted'. This is the setter.

on_rdb_list_changed

Signature: [signal] void on_rdb_list_changed

Description: An event that is triggered the list of report databases is changed

If a report database is added or removed, this event is triggered.

This event was translated from the Observer pattern to an event in version 0.25.

Python specific notes:
The object exposes a readable attribute 'on_rdb_list_changed'. This is the getter.
The object exposes a writable attribute 'on_rdb_list_changed'. This is the setter.

on_selection_changed

Signature: [signal] void on_selection_changed

Description: An event that is triggered if the selection is changed

If the selection changed, this event is triggered.

This event was translated from the Observer pattern to an event in version 0.25.

Python specific notes:
The object exposes a readable attribute 'on_selection_changed'. This is the getter.
The object exposes a writable attribute 'on_selection_changed'. This is the setter.

on_show

Signature: [signal] void on_show

Description: A event indicating that the view is going to become visible

It has been added in version 0.25.

Python specific notes:
The object exposes a readable attribute 'on_show'. This is the getter.
The object exposes a writable attribute 'on_show'. This is the setter.

on_transient_selection_changed

Signature: [signal] void on_transient_selection_changed

Description: An event that is triggered if the transient selection is changed

If the transient selection is changed, this event is triggered. The transient selection is the highlighted selection when the mouse hovers over some object(s). This event was translated from the Observer pattern to an event in version 0.25.

Python specific notes:
The object exposes a readable attribute 'on_transient_selection_changed'. This is the getter.
The object exposes a writable attribute 'on_transient_selection_changed'. This is the setter.

on_viewport_changed

Signature: [signal] void on_viewport_changed

Description: An event indicating that the viewport (the visible rectangle) has changed

This event is triggered after a new display rectangle was chosen - for example, because the user zoomed into the layout.

Before version 0.25 this event was based on the observer pattern obsolete now. The corresponding methods (add_viewport_changed_observer/remove_viewport_changed_observer) have been removed in 0.25.

Python specific notes:
The object exposes a readable attribute 'on_viewport_changed'. This is the getter.
The object exposes a writable attribute 'on_viewport_changed'. This is the setter.

open_d25_view

Signature: D25View ptr open_d25_view

Description: Opens the 2.5d view window and returns a reference to the D25View object.

This method has been introduced in version 0.28.

pan_center

Signature: void pan_center (const DPoint p)

Description: Pans to the given point

The window is positioned such that "p" becomes the new center

pan_down

Signature: void pan_down

Description: Pans down

pan_left

Signature: void pan_left

Description: Pans to the left

pan_right

Signature: void pan_right

Description: Pans to the right

pan_up

Signature: void pan_up

Description: Pans upward

rdb

Signature: ReportDatabase ptr rdb (int index)

Description: Gets the report database with the given index

register_annotation_template

Signature: void register_annotation_template (const Annotation annotation, string title, int mode = RulerModeNormal)

Description: Registers the given annotation as a template for this particular view

@annotation The annotation to use for the template (positions are ignored)

See Annotation#register_template for a method doing the same on application level. This method is hardly useful normally, but can be used when customizing layout views as individual widgets.

This method has been added in version 0.28.

reload_layout

Signature: void reload_layout (unsigned int cv)

Description: Reloads the given cellview

remove_l2ndb

Signature: void remove_l2ndb (unsigned int index)

Description: Removes a netlist database with the given index

This method has been added in version 0.26.

remove_line_style

Signature: void remove_line_style (unsigned int index)

Description: Removes the line style with the given index

The line styles with an index less than the first custom style. If a style is removed that is still used, the results are undefined.

This method has been introduced in version 0.25.

remove_rdb

Signature: void remove_rdb (unsigned int index)

Description: Removes a report database with the given index

remove_stipple

Signature: void remove_stipple (unsigned int index)

Description: Removes the stipple pattern with the given index

The pattern with an index less than the first custom pattern cannot be removed. If a stipple pattern is removed that is still used, the results are undefined.

remove_unused_layers

Signature: void remove_unused_layers

Description: Removes unused layers from layer list

This method was introduced in version 0.19.

rename_cellview

Signature: void rename_cellview (string name, int index)

Description: Renames the cellview with the given index

If the name is not unique, a unique name will be constructed from the name given. The name may be different from the filename but is associated with the layout object. If a layout is shared between multiple cellviews (which may happen due to a clone of the layout view for example), all cellviews are renamed.

rename_layer_list

Signature: void rename_layer_list (unsigned int index, string name)

Description: Sets the title of the given layer properties tab

This method has been introduced in version 0.21.

replace_annotation

Signature: void replace_annotation (int id, const Annotation obj)

Description: Replaces the annotation given by the id with the new one

Replaces an existing annotation given by the id parameter with the new one. The id of an annotation can be obtained through Annotation#id.

This method has been introduced in version 0.24.

replace_image

Signature: void replace_image (unsigned long id, Image new_obj)

Description: Replace an image object with the new image

Replaces the image with the given Id with the new object. The Id can be obtained with if "id" method of the image object.

This method has been introduced in version 0.20.

replace_l2ndb

Signature: unsigned int replace_l2ndb (unsigned int db_index, LayoutToNetlist ptr db)

Description: Replaces the netlist database with the given index

If the index is not valid, the database will be added to the view (see add_lvsdb).

This method has been added in version 0.26.

replace_layer_node

(1) Signature: void replace_layer_node (const LayerPropertiesIterator iter, const LayerProperties node)

Description: Replaces the layer node at the position given by "iter" with a new one

Since version 0.22, this method accepts LayerProperties and LayerPropertiesNode objects. A LayerPropertiesNode object can contain a hierarchy of further nodes.

(2) Signature: void replace_layer_node (unsigned int index, const LayerPropertiesIterator iter, const LayerProperties node)

Description: Replaces the layer node at the position given by "iter" with a new one

This version addresses a specific list in a multi-tab layer properties arrangement with the "index" parameter. This method has been introduced in version 0.21. Since version 0.22, this method accepts LayerProperties and LayerPropertiesNode objects. A LayerPropertiesNode object can contain a hierarchy of further nodes.

replace_lvsdb

Signature: unsigned int replace_lvsdb (unsigned int db_index, LayoutVsSchematic ptr db)

Description: Replaces the database with the given index

If the index is not valid, the database will be added to the view (see add_lvsdb).

This method has been added in version 0.26.

replace_rdb

Signature: unsigned int replace_rdb (unsigned int db_index, ReportDatabase ptr db)

Description: Replaces the report database with the given index

If the index is not valid, the database will be added to the view (see add_rdb).

This method has been added in version 0.26.

reset_title

Signature: void reset_title

Description: Resets the title to the standard title

See set_title and title for a description about how titles are handled.

resize

Signature: void resize (unsigned int w, unsigned int h)

Description: Resizes the layout view to the given dimension

This method has been made available in all builds in 0.28.

save_as

(1) Signature: void save_as (unsigned int index, string filename, bool gzip, const SaveLayoutOptions options)

Description: Saves a layout to the given stream file

Use of this method is deprecated

The layout with the given index is written to the stream file with the given options. 'options' is a SaveLayoutOptions object that specifies which format to write and further options such as scaling factor etc. Calling this method is equivalent to calling 'write' on the respective layout object.

This method is deprecated starting from version 0.23. The compression mode is determined from the file name automatically and the gzip parameter is ignored.

(2) Signature: void save_as (unsigned int index, string filename, const SaveLayoutOptions options)

Description: Saves a layout to the given stream file

The layout with the given index is written to the stream file with the given options. 'options' is a SaveLayoutOptions object that specifies which format to write and further options such as scaling factor etc. Calling this method is equivalent to calling 'write' on the respective layout object.

If the file name ends with a suffix ".gz" or ".gzip", the file is compressed with the zlib algorithm.

save_image

Signature: void save_image (string filename, unsigned int width, unsigned int height)

Description: Saves the layout as an image to the given file

The image contains the current scene (layout, annotations etc.). The image is written as a PNG file to the given file. The image is drawn synchronously with the given width and height. Drawing may take some time.

save_image_with_options

Signature: void save_image_with_options (string filename, unsigned int width, unsigned int height, int linewidth = 0, int oversampling = 0, double resolution = 0, const DBox target = current, bool monochrome = false)

Description: Saves the layout as an image to the given file (with options)

The image contains the current scene (layout, annotations etc.). The image is written as a PNG file to the given file. The image is drawn synchronously with the given width and height. Drawing may take some time. Monochrome images don't have background or annotation objects currently.

The 'linewidth' factor scales the layout style line widths.

The 'oversampling' factor will use multiple passes passes to create a single image pixels. An oversampling factor of 2 uses 2x2 virtual pixels to generate an output pixel. This results in a smoother image. This however comes with a corresponding memory and run time penalty. When using oversampling, you can set linewidth and resolution to 0. This way, line widths and stipple pattern are scaled such that the resulting image is equivalent to the standard image.

The 'resolution' is the pixel size used to translate font sizes and stipple pattern. A resolution of 0.5 renders twice as large fonts and stipple pattern. When combining this value with an oversampling factor of 2 and a line width factor of 2, the resulting image is an oversampled version of the standard image.

Examples:

# standard image 500x500 pixels (oversampling as configured in the view)
layout_view.save_image_with_options("image.png", 500, 500)

# 2x oversampled image with 500x500 pixels
layout_view.save_image_with_options("image.png", 500, 500, 0, 2, 0)

# 2x scaled image with 1000x1000 pixels
layout_view.save_image_with_options("image.png", 1000, 1000, 2, 1, 0.5)

This method has been introduced in 0.23.10.

save_layer_props

Signature: void save_layer_props (string fn)

Description: Saves the layer properties

Save the layer properties to the file given in "fn"

save_screenshot

Signature: void save_screenshot (string filename)

Description: Saves a screenshot to the given file

The screenshot is written as a PNG file to the given file. This requires the drawing to be complete. Ideally, synchronous mode is switched on for the application to guarantee this condition. The image will have the size of the viewport showing the current layout.

select_all

Signature: void select_all

Description: Selects all objects from the view

This method has been introduced in version 0.27

select_cell

Signature: void select_cell (unsigned int cell_index, int cv_index)

Description: Selects a cell by index for a certain cell view

Use of this method is deprecated

Select the current (top) cell by specifying a path (a list of cell indices from top to the actual cell) and the cellview index for which this cell should become the currently shown one. This method selects the cell to be drawn. In constrast, the set_current_cell_path method selects the cell that is highlighted in the cell tree (but not necessarily drawn). This method is was deprecated in version 0.25 since from then, the CellView object can be used to obtain an manipulate the selected cell.

select_cell_path

Signature: void select_cell_path (unsigned int[] cell_index, int cv_index)

Description: Selects a cell by cell index for a certain cell view

Use of this method is deprecated

Select the current (top) cell by specifying a cell indexand the cellview index for which this cell should become the currently shown one. The path to the cell is constructed by selecting one that leads to a top cell. This method selects the cell to be drawn. In constrast, the set_current_cell_path method selects the cell that is highlighted in the cell tree (but not necessarily drawn). This method is was deprecated in version 0.25 since from then, the CellView object can be used to obtain an manipulate the selected cell.

select_from

(1) Signature: void select_from (const DPoint point, LayoutView::SelectionMode mode = Replace)

Description: Selects the objects from a given point

The mode indicates whether to add to the selection, replace the selection, remove from selection or invert the selected status of the objects found around the given point.

This method has been introduced in version 0.27

(2) Signature: void select_from (const DBox box, LayoutView::SelectionMode mode = Replace)

Description: Selects the objects from a given box

The mode indicates whether to add to the selection, replace the selection, remove from selection or invert the selected status of the objects found inside the given box.

This method has been introduced in version 0.27

select_object

Signature: [const] void select_object (const ObjectInstPath obj)

Description: Adds the given selection to the list of selected objects

The selection provided by the ObjectInstPath descriptor is added to the list of selected objects. To clear the previous selection, use clear_object_selection.

The selection of other objects (such as annotations and images) will not be affected.

Another way of selecting objects is object_selection=.

This method has been introduced in version 0.24

selected_cells_paths

Signature: [const] unsigned int[][] selected_cells_paths (int cv_index)

Description: Gets the paths of the selected cells

Gets a list of cell paths to the cells selected in the cellview given by cv_index. The "selected cells" are the ones selected in the cell list or cell tree. This is not the "current cell" which is the one that is shown in the layout window.

The cell paths are arrays of cell indexes where the last element is the actual cell selected.

This method has be introduced in version 0.25.

selected_layers

Signature: [const] LayerPropertiesIterator[] selected_layers

Description: Gets the selected layers

Returns an array of LayerPropertiesIterator objects pointing to the currently selected layers. If no layer view is selected currently, an empty array is returned.

selection_bbox

Signature: DBox selection_bbox

Description: Returns the bounding box of the current selection

This method has been introduced in version 0.26.2

selection_size

Signature: unsigned long selection_size

Description: Returns the number of selected objects

This method has been introduced in version 0.27

send_enter_event

Signature: void send_enter_event

Description: Sends a mouse window leave event

This method is intended to emulate the mouse mouse window leave events sent by Qt normally in environments where Qt is not present. This method was introduced in version 0.28.

send_key_press_event

Signature: void send_key_press_event (unsigned int key, unsigned int buttons)

Description: Sends a key press event

This method is intended to emulate the key press events sent by Qt normally in environments where Qt is not present. The arguments follow the conventions used within Plugin#key_event for example.

This method was introduced in version 0.28.

send_leave_event

Signature: void send_leave_event

Description: Sends a mouse window leave event

This method is intended to emulate the mouse mouse window leave events sent by Qt normally in environments where Qt is not present. This method was introduced in version 0.28.

send_mouse_double_clicked_event

Signature: void send_mouse_double_clicked_event (const DPoint pt, unsigned int buttons)

Description: Sends a mouse button double-click event

This method is intended to emulate the mouse button double-click events sent by Qt normally in environments where Qt is not present. The arguments follow the conventions used within Plugin#mouse_moved_event for example.

This method was introduced in version 0.28.

send_mouse_move_event

Signature: void send_mouse_move_event (const DPoint pt, unsigned int buttons)

Description: Sends a mouse move event

This method is intended to emulate the mouse move events sent by Qt normally in environments where Qt is not present. The arguments follow the conventions used within Plugin#mouse_moved_event for example.

This method was introduced in version 0.28.

send_mouse_press_event

Signature: void send_mouse_press_event (const DPoint pt, unsigned int buttons)

Description: Sends a mouse button press event

This method is intended to emulate the mouse button press events sent by Qt normally in environments where Qt is not present. The arguments follow the conventions used within Plugin#mouse_moved_event for example.

This method was introduced in version 0.28.

send_mouse_release_event

Signature: void send_mouse_release_event (const DPoint pt, unsigned int buttons)

Description: Sends a mouse button release event

This method is intended to emulate the mouse button release events sent by Qt normally in environments where Qt is not present. The arguments follow the conventions used within Plugin#mouse_moved_event for example.

This method was introduced in version 0.28.

send_wheel_event

Signature: void send_wheel_event (int delta, bool horizontal, const DPoint pt, unsigned int buttons)

Description: Sends a mouse wheel event

This method is intended to emulate the mouse wheel events sent by Qt normally in environments where Qt is not present. The arguments follow the conventions used within Plugin#wheel_event for example.

This method was introduced in version 0.28.

set_active_cellview_index

Signature: void set_active_cellview_index (int index)

Description: Makes the cellview with the given index the active one (shown in hierarchy browser)

Use of this method is deprecated. Use active_cellview_index= instead

See active_cellview_index.

This method has been renamed from set_active_cellview_index to active_cellview_index= in version 0.25. The original name is still available, but is deprecated.

Python specific notes:
The object exposes a writable attribute 'active_cellview_index'. This is the setter.
The object exposes a writable attribute 'active_setview_index'. This is the setter.

set_config

Signature: void set_config (string name, string value)

Description: Sets a local configuration parameter with the given name to the given value

This method sets a local configuration parameter with the given name to the given value. Values can only be strings. Numerical values have to be converted into strings first. Local configuration parameters override global configurations for this specific view. This allows for example to override global settings of background colors. Any local settings are not written to the configuration file.

set_current_cell_path

Signature: void set_current_cell_path (int cv_index, unsigned int[] cell_path)

Description: Sets the path to the current cell

Use of this method is deprecated

The current cell is the one highlighted in the browser with the focus rectangle. The cell given by the path is highlighted and scrolled into view. To select the cell to be drawn, use the select_cell or select_cell_path method.

This method is was deprecated in version 0.25 since from then, the CellView object can be used to obtain an manipulate the selected cell.

set_current_layer_list

Signature: void set_current_layer_list (unsigned int index)

Description: Sets the index of the currently selected layer properties tab

Use of this method is deprecated. Use current_layer_list= instead

This method has been introduced in version 0.21.

Python specific notes:
The object exposes a writable attribute 'current_layer_list'. This is the setter.

set_layer_properties

(1) Signature: void set_layer_properties (const LayerPropertiesIterator iter, const LayerProperties props)

Description: Sets the layer properties of the layer pointed to by the iterator

This method replaces the layer properties of the element pointed to by "iter" by the properties given by "props". It will not change the hierarchy but just the properties of the given node.

(2) Signature: void set_layer_properties (unsigned int index, const LayerPropertiesIterator iter, const LayerProperties props)

Description: Sets the layer properties of the layer pointed to by the iterator

This method replaces the layer properties of the element pointed to by "iter" by the properties given by "props" in the tab given by "index". It will not change the hierarchy but just the properties of the given node.This version addresses a specific list in a multi-tab layer properties arrangement with the "index" parameter. This method has been introduced in version 0.21.

set_title

Signature: void set_title (string title)

Description: Sets the title of the view

Use of this method is deprecated. Use title= instead

Override the standard title of the view indicating the file names loaded by the specified title string. The title string can be reset with reset_title to the standard title again.

Python specific notes:
The object exposes a writable attribute 'title'. This is the setter.

show_all_cells

(1) Signature: void show_all_cells

Description: Makes all cells shown (cancel effects of hide_cell)

(2) Signature: void show_all_cells (int cv_index)

Description: Makes all cells shown (cancel effects of hide_cell) for the specified cell view

Unlike show_all_cells, this method will only clear the hidden flag on the cell view selected by cv_index.

This variant has been added in version 0.25.

show_cell

Signature: void show_cell (unsigned int cell_index, int cv_index)

Description: Shows the given cell for the given cellview (cancel effect of hide_cell)

show_image

Signature: void show_image (unsigned long id, bool visible)

Description: Shows or hides the given image

Sets the visibility of the image with the given Id. The Id can be obtained with if "id" method of the image object.

This method has been introduced in version 0.20.

With version 0.25, Image#visible= can be used to achieve the same results.

show_l2ndb

Signature: void show_l2ndb (int l2ndb_index, int cv_index)

Description: Shows a netlist database in the marker browser on a certain layout

The netlist browser is opened showing the netlist database with the index given by "l2ndb_index". It will be attached (i.e. navigate to) the layout with the given cellview index in "cv_index".

This method has been added in version 0.26.

show_layout

(1) Signature: unsigned int show_layout (Layout ptr layout, bool add_cellview)

Description: Shows an existing layout in the view

Shows the given layout in the view. If add_cellview is true, the new layout is added to the list of cellviews in the view.

Note: once a layout is passed to the view with show_layout, it is owned by the view and must not be destroyed with the 'destroy' method.

This method has been introduced in version 0.22.

(2) Signature: unsigned int show_layout (Layout ptr layout, string tech, bool add_cellview)

Description: Shows an existing layout in the view

Shows the given layout in the view. If add_cellview is true, the new layout is added to the list of cellviews in the view. The technology to use for that layout can be specified as well with the 'tech' parameter. Depending on the definition of the technology, layer properties may be loaded for example. The technology string can be empty for the default technology.

Note: once a layout is passed to the view with show_layout, it is owned by the view and must not be destroyed with the 'destroy' method.

This method has been introduced in version 0.22.

(3) Signature: unsigned int show_layout (Layout ptr layout, string tech, bool add_cellview, bool init_layers)

Description: Shows an existing layout in the view

Shows the given layout in the view. If add_cellview is true, the new layout is added to the list of cellviews in the view. The technology to use for that layout can be specified as well with the 'tech' parameter. Depending on the definition of the technology, layer properties may be loaded for example. The technology string can be empty for the default technology. This variant also allows one to control whether the layer properties are initialized (init_layers = true) or not (init_layers = false).

Note: once a layout is passed to the view with show_layout, it is owned by the view and must not be destroyed with the 'destroy' method.

This method has been introduced in version 0.22.

show_lvsdb

Signature: void show_lvsdb (int lvsdb_index, int cv_index)

Description: Shows a netlist database in the marker browser on a certain layout

The netlist browser is opened showing the netlist database with the index given by "lvsdb_index". It will be attached (i.e. navigate to) the layout with the given cellview index in "cv_index".

This method has been added in version 0.26.

show_rdb

Signature: void show_rdb (int rdb_index, int cv_index)

Description: Shows a report database in the marker browser on a certain layout

The marker browser is opened showing the report database with the index given by "rdb_index". It will be attached (i.e. navigate to) the layout with the given cellview index in "cv_index".

stop

Signature: void stop

Description: Stops redraw thread and close any browsers

This method usually does not need to be called explicitly. The redraw thread is stopped automatically.

stop_redraw

Signature: void stop_redraw

Description: Stops the redraw thread

It is very important to stop the redraw thread before applying changes to the layout or the cell views and the LayoutView configuration. This is usually done automatically. For rare cases, where this is not the case, this method is provided.

switch_mode

Signature: void switch_mode (string mode)

Description: Switches the mode.

See mode_name about a method to get the name of the current mode and mode_names for a method to retrieve all available mode names.

This method has been introduced in version 0.28.

title

Signature: [const] string title

Description: Returns the view's title string

The title string is either a string composed of the file names loaded (in some "readable" manner) or a customized title string set by set_title.

Python specific notes:
The object exposes a readable attribute 'title'. This is the getter.

title=

Signature: void title= (string title)

Description: Sets the title of the view

Override the standard title of the view indicating the file names loaded by the specified title string. The title string can be reset with reset_title to the standard title again.

Python specific notes:
The object exposes a writable attribute 'title'. This is the setter.

transaction

Signature: void transaction (string description)

Description: Begins a transaction

A transaction brackets a sequence of database modifications that appear as a single undo action. Only modifications that are wrapped inside a transaction..commit call pair can be undone. Each transaction must be terminated with a commit method call, even if some error occurred. It is advisable therefore to catch errors and issue a commit call in this case.

This method was introduced in version 0.16.

transient_to_selection

Signature: void transient_to_selection

Description: Turns the transient selection into the actual selection

The current selection is cleared before. All highlighted objects under the mouse will become selected. This applies to all types of objects (rulers, shapes, images ...).

This method has been introduced in version 0.26.2

unregister_annotation_templates

Signature: void unregister_annotation_templates (string category)

Description: Unregisters the template or templates with the given category string on this particular view

See Annotation#unregister_templates for a method doing the same on application level.This method is hardly useful normally, but can be used when customizing layout views as individual widgets.

This method has been added in version 0.28.

unselect_object

Signature: [const] void unselect_object (const ObjectInstPath obj)

Description: Removes the given selection from the list of selected objects

The selection provided by the ObjectInstPath descriptor is removed from the list of selected objects. If the given object was not part of the selection, nothing will be changed. The selection of other objects (such as annotations and images) will not be affected.

This method has been introduced in version 0.24

update_content

Signature: void update_content

Description: Updates the layout view to the current state

This method triggers an update of the hierarchy tree and layer view tree. Usually, this method does not need to be called. The widgets are updated automatically in most cases.

Currently, this method should be called however, after the layer view tree has been changed by the insert_layer, replace_layer_node or delete_layer methods.

viewport_height

Signature: [const] int viewport_height

Description: Return the viewport height in pixels

This method was introduced in version 0.18.

viewport_trans

Signature: [const] DCplxTrans viewport_trans

Description: Returns the transformation that converts micron coordinates to pixels

Hint: the transformation returned will convert any point in micron coordinate space into a pixel coordinate. Contrary to usual convention, the y pixel coordinate is given in a mathematically oriented space - which means the bottom coordinate is 0. This method was introduced in version 0.18.

viewport_width

Signature: [const] int viewport_width

Description: Returns the viewport width in pixels

This method was introduced in version 0.18.

widget

Signature: QWidget ptr widget

Description: Gets the QWidget object of the view

This method has been introduced in version 0.28.7.

zoom_box

Signature: void zoom_box (const DBox box)

Description: Sets the viewport to the given box

zoom_fit

Signature: void zoom_fit

Description: Fits the contents of the current view into the window

zoom_fit_sel

Signature: void zoom_fit_sel

Description: Fits the contents of the current selection into the window

This method has been introduced in version 0.25.

zoom_in

Signature: void zoom_in

Description: Zooms in somewhat

zoom_out

Signature: void zoom_out

Description: Zooms out somewhat