KLayout Documentation (Qt 4): Main Index » Class Index » API reference - Class MainWindow

API reference - Class MainWindow

Module: lay

Description: The main application window and central controller object

Class hierarchy: MainWindow » QMainWindow » QWidget » QObject

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

This object first is the main window but also the main controller. The main controller is the port by which access can be gained to all the data objects, view and other aspects of the program.

Public methods

	void	_create		Ensures the C++ object is created
	void	_destroy		Explicitly destroys the object
[const]	bool	_destroyed?		Returns a value indicating whether the object was already destroyed
[const]	bool	_is_const_object?		Returns a value indicating whether the reference is a const reference
	void	_manage		Marks the object as managed by the script side.
	void	_unmanage		Marks the object as no longer owned by the script side.
	void	cancel		Cancels current editing operations
	void	clone_current_view		Clones the current view and make it current
	void	close_all		Closes all views
	void	close_current_view		Closes the current view
	void	cm_adjust_origin		'cm_adjust_origin' action (bound to a menu)
	void	cm_bookmark_view		'cm_bookmark_view' action (bound to a menu)
	void	cm_cancel		'cm_cancel' action (bound to a menu)
	void	cm_cell_copy		'cm_cell_copy' action (bound to a menu)
	void	cm_cell_cut		'cm_cell_cut' action (bound to a menu)
	void	cm_cell_delete		'cm_cell_delete' action (bound to a menu)
	void	cm_cell_flatten		'cm_cell_flatten' action (bound to a menu)
	void	cm_cell_hide		'cm_cell_hide' action (bound to a menu)
	void	cm_cell_paste		'cm_cell_paste' action (bound to a menu)
	void	cm_cell_rename		'cm_cell_rename' action (bound to a menu)
	void	cm_cell_select		'cm_cell_select' action (bound to a menu)
	void	cm_cell_show		'cm_cell_show' action (bound to a menu)
	void	cm_cell_show_all		'cm_cell_show_all' action (bound to a menu)
	void	cm_clear_layer		'cm_clear_layer' action (bound to a menu)
	void	cm_clone		'cm_clone' action (bound to a menu)
	void	cm_close		'cm_close' action (bound to a menu)
	void	cm_close_all		'cm_close_all' action (bound to a menu)
	void	cm_copy		'cm_copy' action (bound to a menu)
	void	cm_copy_layer		'cm_copy_layer' action (bound to a menu)
	void	cm_cut		'cm_cut' action (bound to a menu)
	void	cm_dec_max_hier		'cm_dec_max_hier' action (bound to a menu)
	void	cm_delete		'cm_delete' action (bound to a menu)
	void	cm_delete_layer		'cm_delete_layer' action (bound to a menu)
	void	cm_edit_layer		'cm_edit_layer' action (bound to a menu)
	void	cm_exit		'cm_exit' action (bound to a menu)
	void	cm_goto_position		'cm_goto_position' action (bound to a menu)
	void	cm_help_about		'cm_help_about' action (bound to a menu)
	void	cm_inc_max_hier		'cm_inc_max_hier' action (bound to a menu)
	void	cm_layout_props		'cm_layout_props' action (bound to a menu)
	void	cm_load_bookmarks		'cm_load_bookmarks' action (bound to a menu)
	void	cm_load_layer_props		'cm_load_layer_props' action (bound to a menu)
	void	cm_lv_add_missing		'cm_lv_add_missing' action (bound to a menu)
	void	cm_lv_delete		'cm_lv_delete' action (bound to a menu)
	void	cm_lv_expand_all		'cm_lv_expand_all' action (bound to a menu)
	void	cm_lv_group		'cm_lv_group' action (bound to a menu)
	void	cm_lv_hide		'cm_lv_hide' action (bound to a menu)
	void	cm_lv_hide_all		'cm_lv_hide_all' action (bound to a menu)
	void	cm_lv_insert		'cm_lv_insert' action (bound to a menu)
	void	cm_lv_new_tab		'cm_lv_new_tab' action (bound to a menu)
	void	cm_lv_regroup_by_datatype		'cm_lv_regroup_by_datatype' action (bound to a menu)
	void	cm_lv_regroup_by_index		'cm_lv_regroup_by_index' action (bound to a menu)
	void	cm_lv_regroup_by_layer		'cm_lv_regroup_by_layer' action (bound to a menu)
	void	cm_lv_regroup_flatten		'cm_lv_regroup_flatten' action (bound to a menu)
	void	cm_lv_remove_tab		'cm_lv_remove_tab' action (bound to a menu)
	void	cm_lv_remove_unused		'cm_lv_remove_unused' action (bound to a menu)
	void	cm_lv_rename		'cm_lv_rename' action (bound to a menu)
	void	cm_lv_rename_tab		'cm_lv_rename_tab' action (bound to a menu)
	void	cm_lv_select_all		'cm_lv_select_all' action (bound to a menu)
	void	cm_lv_show		'cm_lv_show' action (bound to a menu)
	void	cm_lv_show_all		'cm_lv_show_all' action (bound to a menu)
	void	cm_lv_show_only		'cm_lv_show_only' action (bound to a menu)
	void	cm_lv_sort_by_dli		'cm_lv_sort_by_dli' action (bound to a menu)
	void	cm_lv_sort_by_idl		'cm_lv_sort_by_idl' action (bound to a menu)
	void	cm_lv_sort_by_ild		'cm_lv_sort_by_ild' action (bound to a menu)
	void	cm_lv_sort_by_ldi		'cm_lv_sort_by_ldi' action (bound to a menu)
	void	cm_lv_sort_by_name		'cm_lv_sort_by_name' action (bound to a menu)
	void	cm_lv_source		'cm_lv_source' action (bound to a menu)
	void	cm_lv_ungroup		'cm_lv_ungroup' action (bound to a menu)
	void	cm_macro_editor		'cm_macro_editor' action (bound to a menu)
	void	cm_manage_bookmarks		'cm_manage_bookmarks' action (bound to a menu)
	void	cm_max_hier		'cm_max_hier' action (bound to a menu)
	void	cm_max_hier_0		'cm_max_hier_0' action (bound to a menu)
	void	cm_max_hier_1		'cm_max_hier_1' action (bound to a menu)
	void	cm_navigator_close		'cm_navigator_close' action (bound to a menu)
	void	cm_navigator_freeze		'cm_navigator_freeze' action (bound to a menu)
	void	cm_new_cell		'cm_new_cell' action (bound to a menu)
	void	cm_new_layer		'cm_new_layer' action (bound to a menu)
	void	cm_new_layout		'cm_new_layout' action (bound to a menu)
	void	cm_new_panel		'cm_new_panel' action (bound to a menu)
	void	cm_next_display_state		'cm_next_display_state' action (bound to a menu)
	void	cm_open		'cm_open' action (bound to a menu)
	void	cm_open_current_cell		'cm_open_current_cell' action (bound to a menu)
	void	cm_open_new_view		'cm_open_new_view' action (bound to a menu)
	void	cm_open_too		'cm_open_too' action (bound to a menu)
	void	cm_packages		'cm_packages' action (bound to a menu)
	void	cm_pan_down		'cm_pan_down' action (bound to a menu)
	void	cm_pan_left		'cm_pan_left' action (bound to a menu)
	void	cm_pan_right		'cm_pan_right' action (bound to a menu)
	void	cm_pan_up		'cm_pan_up' action (bound to a menu)
	void	cm_paste		'cm_paste' action (bound to a menu)
	void	cm_prev_display_state		'cm_prev_display_state' action (bound to a menu)
	void	cm_print		'cm_print' action (bound to a menu)
	void	cm_pull_in		'cm_pull_in' action (bound to a menu)
	void	cm_reader_options		'cm_reader_options' action (bound to a menu)
	void	cm_redo		'cm_redo' action (bound to a menu)
	void	cm_redraw		'cm_redraw' action (bound to a menu)
	void	cm_reload		'cm_reload' action (bound to a menu)
	void	cm_reset_window_state		'cm_reset_window_state' action (bound to a menu)
	void	cm_restore_session		'cm_restore_session' action (bound to a menu)
	void	cm_save		'cm_save' action (bound to a menu)
	void	cm_save_all		'cm_save_all' action (bound to a menu)
	void	cm_save_as		'cm_save_as' action (bound to a menu)
	void	cm_save_bookmarks		'cm_save_bookmarks' action (bound to a menu)
	void	cm_save_current_cell_as		'cm_save_current_cell_as' action (bound to a menu)
	void	cm_save_layer_props		'cm_save_layer_props' action (bound to a menu)
	void	cm_save_session		'cm_save_session' action (bound to a menu)
	void	cm_screenshot		'cm_screenshot' action (bound to a menu)
	void	cm_sel_flip_x		'cm_sel_flip_x' action (bound to a menu)
	void	cm_sel_flip_y		'cm_sel_flip_y' action (bound to a menu)
	void	cm_sel_free_rot		'cm_sel_free_rot' action (bound to a menu)
	void	cm_sel_move		'cm_sel_move' action (bound to a menu)
	void	cm_sel_move_to		'cm_sel_move_to' action (bound to a menu)
	void	cm_sel_rot_ccw		'cm_sel_rot_ccw' action (bound to a menu)
	void	cm_sel_rot_cw		'cm_sel_rot_cw' action (bound to a menu)
	void	cm_sel_scale		'cm_sel_scale' action (bound to a menu)
	void	cm_select_all		'cm_select_all' action (bound to a menu)
	void	cm_select_cell		'cm_select_cell' action (bound to a menu)
	void	cm_select_current_cell		'cm_select_current_cell' action (bound to a menu)
	void	cm_setup		'cm_setup' action (bound to a menu)
	void	cm_show_properties		'cm_show_properties' action (bound to a menu)
	void	cm_technologies		'cm_technologies' action (bound to a menu)
	void	cm_undo		'cm_undo' action (bound to a menu)
	void	cm_unselect_all		'cm_unselect_all' action (bound to a menu)
	void	cm_view_log		'cm_view_log' action (bound to a menu)
	void	cm_zoom_fit		'cm_zoom_fit' action (bound to a menu)
	void	cm_zoom_fit_sel		'cm_zoom_fit_sel' action (bound to a menu)
	void	cm_zoom_in		'cm_zoom_in' action (bound to a menu)
	void	cm_zoom_out		'cm_zoom_out' action (bound to a menu)
	CellView	create_layout	(int mode)	Creates a new, empty layout
	CellView	create_layout	(string tech, int mode)	Creates a new, empty layout with the given technology
	int	create_view		Creates a new, empty view
	LayoutView ptr	current_view		Returns a reference to the current view's object
[const]	int	current_view_index		Returns the current view's index
	void	current_view_index=	(int index)	Selects the view with the given index
	void	exit		Schedules an exit for the application
[const]	double	grid_micron		Gets the global grid in micron
[const]	int	index_of	(const LayoutView ptr view)	Gets the index of the given view
	string	initial_technology		Gets the technology used for creating or loading layouts (unless explicitly specified)
	void	initial_technology=	(string tech)	Sets the technology used for creating or loading layouts (unless explicitly specified)
	CellView	load_layout	(string filename, int mode)	Loads a new layout
	CellView	load_layout	(string filename, string tech, int mode)	Loads a new layout and associate it with the given technology
	CellView	load_layout	(string filename, const LoadLayoutOptions options, int mode)	Loads a new layout with the given options
	CellView	load_layout	(string filename, const LoadLayoutOptions options, string tech, int mode)	Loads a new layout with the given options and associate it with the given technology
	Manager	manager		Gets the Manager object of this window
	AbstractMenu ptr	menu		Returns a reference to the abstract menu
	void	message	(string message, int time)	Displays a message in the status bar
[signal]	void	on_current_view_changed		An event indicating that the current view has changed
[signal]	void	on_view_closed	(int index)	An event indicating that a view was closed
[signal]	void	on_view_created	(int index)	An event indicating that a new view was created
	void	redraw		Redraws the current view
	void	resize	(int width, int height)	Resizes the window
	void	restore_session	(string fn)	Restores a session from the given file
	void	save_session	(string fn)	Saves the session to the given file
	void	show_macro_editor	(string cat = , bool add = false)	Shows the macro editor
	void	synchronous=	(bool sync_mode)	Puts the main window into synchronous mode
	LayoutView ptr	view	(int n)	Returns a reference to a view object by index
[const]	unsigned int	views		Returns the number of views

Public static methods and constants

MainWindow ptr

instance

Gets application's main window instance

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

void	cm_last_display_state		Use of this method is deprecated. Use cm_prev_display_state instead
void	enable_edits	(bool enable)	Use of this method is deprecated
void	select_view	(int index)	Use of this method is deprecated. Use current_view_index= instead
void	synchroneous	(bool sync_mode)	Use of this method is deprecated. Use synchronous= instead

Detailed description

_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.

cancel

Signature: void cancel

Description: Cancels current editing operations

This method call cancels all current editing operations and restores normal mouse mode.

clone_current_view

Signature: void clone_current_view

Description: Clones the current view and make it current

close_all

Signature: void close_all

Description: Closes all views

This method unconditionally closes all views. No dialog will be opened if unsaved edits exist.

This method was added in version 0.18.

close_current_view

Signature: void close_current_view

Description: Closes the current view

This method does not open a dialog to ask which cell view to close if multiple cells are opened in the view, but rather closes all cells.

cm_adjust_origin

Signature: void cm_adjust_origin

Description: 'cm_adjust_origin' action (bound to a menu)

This method has been added in version 0.18.

cm_bookmark_view

Signature: void cm_bookmark_view

Description: 'cm_bookmark_view' action (bound to a menu)

cm_cancel

Signature: void cm_cancel

Description: 'cm_cancel' action (bound to a menu)

cm_cell_copy

Signature: void cm_cell_copy

Description: 'cm_cell_copy' action (bound to a menu)

This method has been added in version 0.20.

cm_cell_cut

Signature: void cm_cell_cut

Description: 'cm_cell_cut' action (bound to a menu)

This method has been added in version 0.20.

cm_cell_delete

Signature: void cm_cell_delete

Description: 'cm_cell_delete' action (bound to a menu)

This method has been added in version 0.18.

cm_cell_flatten

Signature: void cm_cell_flatten

Description: 'cm_cell_flatten' action (bound to a menu)

cm_cell_hide

Signature: void cm_cell_hide

Description: 'cm_cell_hide' action (bound to a menu)

cm_cell_paste

Signature: void cm_cell_paste

Description: 'cm_cell_paste' action (bound to a menu)

This method has been added in version 0.20.

cm_cell_rename

Signature: void cm_cell_rename

Description: 'cm_cell_rename' action (bound to a menu)

This method has been added in version 0.18.

cm_cell_select

Signature: void cm_cell_select

Description: 'cm_cell_select' action (bound to a menu)

cm_cell_show

Signature: void cm_cell_show

Description: 'cm_cell_show' action (bound to a menu)

cm_cell_show_all

Signature: void cm_cell_show_all

Description: 'cm_cell_show_all' action (bound to a menu)

cm_clear_layer

Signature: void cm_clear_layer

Description: 'cm_clear_layer' action (bound to a menu)

This method has been added in version 0.18.

cm_clone

Signature: void cm_clone

Description: 'cm_clone' action (bound to a menu)

cm_close

Signature: void cm_close

Description: 'cm_close' action (bound to a menu)

cm_close_all

Signature: void cm_close_all

Description: 'cm_close_all' action (bound to a menu)

This method has been added in version 0.24.

cm_copy

Signature: void cm_copy

Description: 'cm_copy' action (bound to a menu)

cm_copy_layer

Signature: void cm_copy_layer

Description: 'cm_copy_layer' action (bound to a menu)

This method has been added in version 0.22.

cm_cut

Signature: void cm_cut

Description: 'cm_cut' action (bound to a menu)

cm_dec_max_hier

Signature: void cm_dec_max_hier

Description: 'cm_dec_max_hier' action (bound to a menu)

cm_delete

Signature: void cm_delete

Description: 'cm_delete' action (bound to a menu)

cm_delete_layer

Signature: void cm_delete_layer

Description: 'cm_delete_layer' action (bound to a menu)

This method has been added in version 0.18.

cm_edit_layer

Signature: void cm_edit_layer

Description: 'cm_edit_layer' action (bound to a menu)

This method has been added in version 0.18.

cm_exit

Signature: void cm_exit

Description: 'cm_exit' action (bound to a menu)

cm_goto_position

Signature: void cm_goto_position

Description: 'cm_goto_position' action (bound to a menu)

cm_help_about

Signature: void cm_help_about

Description: 'cm_help_about' action (bound to a menu)

cm_inc_max_hier

Signature: void cm_inc_max_hier

Description: 'cm_inc_max_hier' action (bound to a menu)

cm_last_display_state

Signature: void cm_last_display_state

Description: 'cm_prev_display_state' action (bound to a menu)

Use of this method is deprecated. Use cm_prev_display_state instead

cm_layout_props

Signature: void cm_layout_props

Description: 'cm_layout_props' action (bound to a menu)

cm_load_bookmarks

Signature: void cm_load_bookmarks

Description: 'cm_load_bookmarks' action (bound to a menu)

cm_load_layer_props

Signature: void cm_load_layer_props

Description: 'cm_load_layer_props' action (bound to a menu)

cm_lv_add_missing

Signature: void cm_lv_add_missing

Description: 'cm_lv_add_missing' action (bound to a menu)

cm_lv_delete

Signature: void cm_lv_delete

Description: 'cm_lv_delete' action (bound to a menu)

cm_lv_expand_all

Signature: void cm_lv_expand_all

Description: 'cm_lv_expand_all' action (bound to a menu)

cm_lv_group

Signature: void cm_lv_group

Description: 'cm_lv_group' action (bound to a menu)

cm_lv_hide

Signature: void cm_lv_hide

Description: 'cm_lv_hide' action (bound to a menu)

cm_lv_hide_all

Signature: void cm_lv_hide_all

Description: 'cm_lv_hide_all' action (bound to a menu)

cm_lv_insert

Signature: void cm_lv_insert

Description: 'cm_lv_insert' action (bound to a menu)

cm_lv_new_tab

Signature: void cm_lv_new_tab

Description: 'cm_lv_new_tab' action (bound to a menu)

cm_lv_regroup_by_datatype

Signature: void cm_lv_regroup_by_datatype

Description: 'cm_lv_regroup_by_datatype' action (bound to a menu)

cm_lv_regroup_by_index

Signature: void cm_lv_regroup_by_index

Description: 'cm_lv_regroup_by_index' action (bound to a menu)

cm_lv_regroup_by_layer

Signature: void cm_lv_regroup_by_layer

Description: 'cm_lv_regroup_by_layer' action (bound to a menu)

cm_lv_regroup_flatten

Signature: void cm_lv_regroup_flatten

Description: 'cm_lv_regroup_flatten' action (bound to a menu)

cm_lv_remove_tab

Signature: void cm_lv_remove_tab

Description: 'cm_lv_remove_tab' action (bound to a menu)

cm_lv_remove_unused

Signature: void cm_lv_remove_unused

Description: 'cm_lv_remove_unused' action (bound to a menu)

cm_lv_rename

Signature: void cm_lv_rename

Description: 'cm_lv_rename' action (bound to a menu)

cm_lv_rename_tab

Signature: void cm_lv_rename_tab

Description: 'cm_lv_rename_tab' action (bound to a menu)

cm_lv_select_all

Signature: void cm_lv_select_all

Description: 'cm_lv_select_all' action (bound to a menu)

cm_lv_show

Signature: void cm_lv_show

Description: 'cm_lv_show' action (bound to a menu)

cm_lv_show_all

Signature: void cm_lv_show_all

Description: 'cm_lv_show_all' action (bound to a menu)

cm_lv_show_only

Signature: void cm_lv_show_only

Description: 'cm_lv_show_only' action (bound to a menu)

This method has been added in version 0.20.

cm_lv_sort_by_dli

Signature: void cm_lv_sort_by_dli

Description: 'cm_lv_sort_by_dli' action (bound to a menu)

cm_lv_sort_by_idl

Signature: void cm_lv_sort_by_idl

Description: 'cm_lv_sort_by_idl' action (bound to a menu)

cm_lv_sort_by_ild

Signature: void cm_lv_sort_by_ild

Description: 'cm_lv_sort_by_ild' action (bound to a menu)

cm_lv_sort_by_ldi

Signature: void cm_lv_sort_by_ldi

Description: 'cm_lv_sort_by_ldi' action (bound to a menu)

cm_lv_sort_by_name

Signature: void cm_lv_sort_by_name

Description: 'cm_lv_sort_by_name' action (bound to a menu)

cm_lv_source

Signature: void cm_lv_source

Description: 'cm_lv_source' action (bound to a menu)

cm_lv_ungroup

Signature: void cm_lv_ungroup

Description: 'cm_lv_ungroup' action (bound to a menu)

cm_macro_editor

Signature: void cm_macro_editor

Description: 'cm_macro_editor' action (bound to a menu)

cm_manage_bookmarks

Signature: void cm_manage_bookmarks

Description: 'cm_manage_bookmarks' action (bound to a menu)

cm_max_hier

Signature: void cm_max_hier

Description: 'cm_max_hier' action (bound to a menu)

cm_max_hier_0

Signature: void cm_max_hier_0

Description: 'cm_max_hier_0' action (bound to a menu)

cm_max_hier_1

Signature: void cm_max_hier_1

Description: 'cm_max_hier_1' action (bound to a menu)

cm_navigator_close

Signature: void cm_navigator_close

Description: 'cm_navigator_close' action (bound to a menu)

cm_navigator_freeze

Signature: void cm_navigator_freeze

Description: 'cm_navigator_freeze' action (bound to a menu)

cm_new_cell

Signature: void cm_new_cell

Description: 'cm_new_cell' action (bound to a menu)

This method has been added in version 0.18.

cm_new_layer

Signature: void cm_new_layer

Description: 'cm_new_layer' action (bound to a menu)

This method has been added in version 0.18.

cm_new_layout

Signature: void cm_new_layout

Description: 'cm_new_layout' action (bound to a menu)

This method has been added in version 0.18.

cm_new_panel

Signature: void cm_new_panel

Description: 'cm_new_panel' action (bound to a menu)

This method has been added in version 0.20.

cm_next_display_state

Signature: void cm_next_display_state

Description: 'cm_next_display_state' action (bound to a menu)

cm_open

Signature: void cm_open

Description: 'cm_open' action (bound to a menu)

cm_open_current_cell

Signature: void cm_open_current_cell

Description: 'cm_open_current_cell' action (bound to a menu)

This method has been added in version 0.18.

cm_open_new_view

Signature: void cm_open_new_view

Description: 'cm_open_new_view' action (bound to a menu)

cm_open_too

Signature: void cm_open_too

Description: 'cm_open_too' action (bound to a menu)

cm_packages

Signature: void cm_packages

Description: 'cm_packages' action (bound to a menu)

This method has been added in version 0.25.

cm_pan_down

Signature: void cm_pan_down

Description: 'cm_pan_down' action (bound to a menu)

cm_pan_left

Signature: void cm_pan_left

Description: 'cm_pan_left' action (bound to a menu)

cm_pan_right

Signature: void cm_pan_right

Description: 'cm_pan_right' action (bound to a menu)

cm_pan_up

Signature: void cm_pan_up

Description: 'cm_pan_up' action (bound to a menu)

cm_paste

Signature: void cm_paste

Description: 'cm_paste' action (bound to a menu)

cm_prev_display_state

Signature: void cm_prev_display_state

Description: 'cm_prev_display_state' action (bound to a menu)

cm_print

Signature: void cm_print

Description: 'cm_print' action (bound to a menu)

This method has been added in version 0.21.13.

cm_pull_in

Signature: void cm_pull_in

Description: 'cm_pull_in' action (bound to a menu)

This method has been added in version 0.20.

cm_reader_options

Signature: void cm_reader_options

Description: 'cm_reader_options' action (bound to a menu)

This method has been added in version 0.18.

cm_redo

Signature: void cm_redo

Description: 'cm_redo' action (bound to a menu)

cm_redraw

Signature: void cm_redraw

Description: 'cm_redraw' action (bound to a menu)

cm_reload

Signature: void cm_reload

Description: 'cm_reload' action (bound to a menu)

cm_reset_window_state

Signature: void cm_reset_window_state

Description: 'cm_reset_window_state' action (bound to a menu)

This method has been added in version 0.25.

cm_restore_session

Signature: void cm_restore_session

Description: 'cm_restore_session' action (bound to a menu)

This method has been added in version 0.18.

cm_save

Signature: void cm_save

Description: 'cm_save' action (bound to a menu)

This method has been added in version 0.18.

cm_save_all

Signature: void cm_save_all

Description: 'cm_save_all' action (bound to a menu)

This method has been added in version 0.24.

cm_save_as

Signature: void cm_save_as

Description: 'cm_save_as' action (bound to a menu)

This method has been added in version 0.18.

cm_save_bookmarks

Signature: void cm_save_bookmarks

Description: 'cm_save_bookmarks' action (bound to a menu)

cm_save_current_cell_as

Signature: void cm_save_current_cell_as

Description: 'cm_save_current_cell_as' action (bound to a menu)

This method has been added in version 0.18.

cm_save_layer_props

Signature: void cm_save_layer_props

Description: 'cm_save_layer_props' action (bound to a menu)

cm_save_session

Signature: void cm_save_session

Description: 'cm_save_session' action (bound to a menu)

This method has been added in version 0.18.

cm_screenshot

Signature: void cm_screenshot

Description: 'cm_screenshot' action (bound to a menu)

cm_sel_flip_x

Signature: void cm_sel_flip_x

Description: 'cm_sel_flip_x' action (bound to a menu)

This method has been added in version 0.18.

cm_sel_flip_y

Signature: void cm_sel_flip_y

Description: 'cm_sel_flip_y' action (bound to a menu)

This method has been added in version 0.18.

cm_sel_free_rot

Signature: void cm_sel_free_rot

Description: 'cm_sel_free_rot' action (bound to a menu)

This method has been added in version 0.18.

cm_sel_move

Signature: void cm_sel_move

Description: 'cm_sel_move' action (bound to a menu)

This method has been added in version 0.18.

cm_sel_move_to

Signature: void cm_sel_move_to

Description: 'cm_sel_move_to' action (bound to a menu)

This method has been added in version 0.24.

cm_sel_rot_ccw

Signature: void cm_sel_rot_ccw

Description: 'cm_sel_rot_ccw' action (bound to a menu)

This method has been added in version 0.18.

cm_sel_rot_cw

Signature: void cm_sel_rot_cw

Description: 'cm_sel_rot_cw' action (bound to a menu)

This method has been added in version 0.18.

cm_sel_scale

Signature: void cm_sel_scale

Description: 'cm_sel_scale' action (bound to a menu)

This method has been added in version 0.18.

cm_select_all

Signature: void cm_select_all

Description: 'cm_select_all' action (bound to a menu)

This method has been added in version 0.22.

cm_select_cell

Signature: void cm_select_cell

Description: 'cm_select_cell' action (bound to a menu)

cm_select_current_cell

Signature: void cm_select_current_cell

Description: 'cm_select_current_cell' action (bound to a menu)

cm_setup

Signature: void cm_setup

Description: 'cm_setup' action (bound to a menu)

cm_show_properties

Signature: void cm_show_properties

Description: 'cm_show_properties' action (bound to a menu)

cm_technologies

Signature: void cm_technologies

Description: 'cm_technologies' action (bound to a menu)

This method has been added in version 0.22.

cm_undo

Signature: void cm_undo

Description: 'cm_undo' action (bound to a menu)

cm_unselect_all

Signature: void cm_unselect_all

Description: 'cm_unselect_all' action (bound to a menu)

This method has been added in version 0.22.

cm_view_log

Signature: void cm_view_log

Description: 'cm_view_log' action (bound to a menu)

This method has been added in version 0.20.

cm_zoom_fit

Signature: void cm_zoom_fit

Description: 'cm_zoom_fit' action (bound to a menu)

cm_zoom_fit_sel

Signature: void cm_zoom_fit_sel

Description: 'cm_zoom_fit_sel' action (bound to a menu)

This method has been added in version 0.18.

cm_zoom_in

Signature: void cm_zoom_in

Description: 'cm_zoom_in' action (bound to a menu)

cm_zoom_out

Signature: void cm_zoom_out

Description: 'cm_zoom_out' action (bound to a menu)

create_layout

Signature: CellView create_layout (int mode)

Description: Creates a new, empty layout

mode:

An integer value of 0, 1 or 2 that determines how the layout is created

Returns:

The cellview of the layout that was created

Create the layout in the current view, replacing the current layouts (mode 0), in a new view (mode 1) or adding it to the current view (mode 2). In mode 1, the new view is made the current one.

This version uses the initial technology and associates it with the new layout.

Starting with version 0.25, this method returns a cellview object that can be modified to configure the cellview.

Signature: CellView create_layout (string tech, int mode)

Description: Creates a new, empty layout with the given technology

mode:

An integer value of 0, 1 or 2 that determines how the layout is created

tech:

The name of the technology to use for that layout.

Returns:

The cellview of the layout that was created

Create the layout in the current view, replacing the current layouts (mode 0), in a new view (mode 1) or adding it to the current view (mode 2). In mode 1, the new view is made the current one.

If the technology name is not a valid technology name, the default technology will be used.

This version was introduced in version 0.22. Starting with version 0.25, this method returns a cellview object that can be modified to configure the cellview.

create_view

Signature: int create_view

Description: Creates a new, empty view

Returns:

The index of the view that was created

Creates an empty view that can be filled with layouts using the load_layout and create_layout methods on the view object. Use the view method to obtain the view object from the view index. This method has been added in version 0.22.

current_view

Signature: LayoutView ptr current_view

Description: Returns a reference to the current view's object

Returns:

A reference to a LayoutView object representing the current view.

current_view_index

Signature: [const] int current_view_index

Description: Returns the current view's index

Returns:

The index of the current view

This method will return the index of the current view.

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

current_view_index=

Signature: void current_view_index= (int index)

Description: Selects the view with the given index

index:

The index of the view to select (0 is the first)

This method will make the view with the given index the current (front) view.

This method was renamed from select_view to current_view_index= in version 0.25. The old name is still available, but deprecated.

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

enable_edits

Signature: void enable_edits (bool enable)

Description: Enables or disables editing

enable:

Enable edits if set to true

Use of this method is deprecated

exit

Signature: void exit

Description: Schedules an exit for the application

This method does not immediately exit the application but sends an exit request to the application which will cause a clean shutdown of the GUI.

grid_micron

Signature: [const] double grid_micron

Description: Gets the global grid in micron

Returns:

The global grid in micron

The global grid is used at various places, i.e. for ruler snapping, for grid display etc.

index_of

Signature: [const] int index_of (const LayoutView ptr view)

Description: Gets the index of the given view

Returns:

The index of the view that was given

If the given view is not a view object within the main window, a negative value will be returned.

This method has been added in version 0.25.

initial_technology

Signature: string initial_technology

Description: Gets the technology used for creating or loading layouts (unless explicitly specified)

Returns:

The current initial technology

This method was added in version 0.22.

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

initial_technology=

Signature: void initial_technology= (string tech)

Description: Sets the technology used for creating or loading layouts (unless explicitly specified)

tech:

The new initial technology

Setting the technology will have an effect on the next load_layout or create_layout operation which does not explicitly specify the technology but might not be reflected correctly in the reader options dialog and changes will be reset when the application is restarted.

This method was added in version 0.22.

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

instance

Signature: [static] MainWindow ptr instance

Description: Gets application's main window instance

This method has been added in version 0.24.

load_layout

Signature: CellView load_layout (string filename, int mode)

Description: Loads a new layout

filename:

The name of the file to load

mode:

An integer value of 0, 1 or 2 that determines how the file is loaded

Returns:

The cellview into which the layout was loaded

Loads the given file into the current view, replacing the current layouts (mode 0), into a new view (mode 1) or adding the layout to the current view (mode 2). In mode 1, the new view is made the current one.

This version will use the initial technology and the default reader options. Others versions are provided which allow specification of technology and reader options explicitly.

Starting with version 0.25, this method returns a cellview object that can be modified to configure the cellview.

Signature: CellView load_layout (string filename, string tech, int mode)

Description: Loads a new layout and associate it with the given technology

filename:

The name of the file to load

tech:

The name of the technology to use for that layout.

mode:

An integer value of 0, 1 or 2 that determines how the file is loaded

Returns:

The cellview into which the layout was loaded

If the technology name is not a valid technology name, the default technology will be used.

This version was introduced in version 0.22. Starting with version 0.25, this method returns a cellview object that can be modified to configure the cellview.

Signature: CellView load_layout (string filename, const LoadLayoutOptions options, int mode)

Description: Loads a new layout with the given options

filename:

The name of the file to load

options:

The reader options to use.

mode:

An integer value of 0, 1 or 2 that determines how the file is loaded

Returns:

The cellview into which the layout was loaded

This version was introduced in version 0.22. Starting with version 0.25, this method returns a cellview object that can be modified to configure the cellview.

Signature: CellView load_layout (string filename, const LoadLayoutOptions options, string tech, int mode)

Description: Loads a new layout with the given options and associate it with the given technology

filename:

The name of the file to load

options:

The reader options to use.

tech:

The name of the technology to use for that layout.

mode:

An integer value of 0, 1 or 2 that determines how the file is loaded

Returns:

The cellview into which the layout was loaded

If the technology name is not a valid technology name, the default technology will be used.

This version was introduced in version 0.22. Starting with version 0.25, this method returns a cellview object that can be modified to configure the cellview.

manager

Signature: Manager manager

Description: Gets the Manager object of this window

The manager object is responsible to managing the undo/redo stack. Usually this object is not required. It's more convenient and safer to use the related methods provided by LayoutView (LayoutView#transaction, LayoutView#commit) and MainWindow (such as MainWindow#cm_undo and MainWindow#cm_redo).

This method has been added in version 0.24.

message

Signature: void message (string message, int time)

Description: Displays a message in the status bar

message:

The message to display

time:

The time how long to display the message in ms

This given message is shown in the status bar for the given time.

This method has been added in version 0.18.

on_current_view_changed

Signature: [signal] void on_current_view_changed

Description: An event indicating that the current view has changed

This event is triggered after the current view has changed. This happens, if the user switches the layout tab.

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

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

on_view_closed

Signature: [signal] void on_view_closed (int index)

Description: An event indicating that a view was closed

index:

The index of the view that was closed

This event is triggered after a view was closed. For example, because the tab was closed.

This event has been added in version 0.25.

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

on_view_created

Signature: [signal] void on_view_created (int index)

Description: An event indicating that a new view was created

index:

The index of the view that was created

This event is triggered after a new view was created. For example, if a layout is loaded into a new panel.

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

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

redraw

Signature: void redraw

Description: Redraws the current view

Issues a redraw request to the current view. This usually happens automatically, so this method does not need to be called in most relevant cases.

resize

Signature: void resize (int width, int height)

Description: Resizes the window

width:

The new width of the window

height:

The new width of the window

This method resizes the window to the given target size including decoration such as menu bar and control panels

restore_session

Signature: void restore_session (string fn)

Description: Restores a session from the given file

fn:	The path to the session file

The session stored in the given session file is restored. All existing views are closed and all layout edits are discarded without notification.

This method was added in version 0.18.

save_session

Signature: void save_session (string fn)

Description: Saves the session to the given file

fn:	The path to the session file

The session is saved to the given session file. Any existing layout edits are not automatically saved together with the session. The session just holds display settings and annotation objects. If layout edits exist, they have to be saved explicitly in a separate step.

This method was added in version 0.18.

select_view

Signature: void select_view (int index)

Description: Selects the view with the given index

index:

The index of the view to select (0 is the first)

Use of this method is deprecated. Use current_view_index= instead

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

show_macro_editor

Signature: void show_macro_editor (string cat = , bool add = false)

Description: Shows the macro editor

If 'cat' is given, this category will be selected in the category tab. If 'add' is true, the 'new macro' dialog will be opened.

This method has been introduced in version 0.26.

synchroneous

Signature: void synchroneous (bool sync_mode)

Description: Puts the main window into synchronous mode

sync_mode:

'true' if the application should behave synchronously

Use of this method is deprecated. Use synchronous= instead

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

synchronous=

Signature: void synchronous= (bool sync_mode)

Description: Puts the main window into synchronous mode

sync_mode:

'true' if the application should behave synchronously

In synchronous mode, an application is allowed to block on redraw. While redrawing, no user interactions are possible. Although this is not desirable for smooth operation, it can be beneficial for test or automation purposes, i.e. if a screenshot needs to be produced once the application has finished drawing.

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

view

Signature: LayoutView ptr view (int n)

Description: Returns a reference to a view object by index

Returns:

The view object's reference for the view with the given index.

views

Signature: [const] unsigned int views

Description: Returns the number of views

Returns:

The number of views available so far.