API reference - Class MainWindow

Notation used in Ruby API documentation

Description: The main application window and central controller object

• Public methods
• 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

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

Detailed description

void add_current_view_observer(ObserverBase observer)

Description: Add an observer for the "current view changed" event

If the current view changes, this observer is triggered. The integer slot of the observer will receive the number of the view active before. The current view's reference is already updated when this event is issued.

void add_new_view_observer(ObserverBase observer)

Description: Add an observer for a "new view" event

If a new view is created, this observer will receive a signal. The integer slot of this observer will receive the index of the newly created view.

void cancel

Description: Cancel current editing operations

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

void clone_current_view

Description: Clone the current view and make it current

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.

void close_current_view

Description: Close the current view

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

void cm_adjust_origin

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

This method has been added in version 0.18.

void cm_bookmark_view

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

void cm_cancel

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

void cm_cell_copy

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

This method has been added in version 0.20.

void cm_cell_cut

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

This method has been added in version 0.20.

void cm_cell_delete

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

This method has been added in version 0.18.

void cm_cell_flatten

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

void cm_cell_hide

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

void cm_cell_paste

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

This method has been added in version 0.20.

void cm_cell_rename

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

This method has been added in version 0.18.

void cm_cell_select

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

void cm_cell_show

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

void cm_cell_show_all

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

void cm_clear_layer

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

This method has been added in version 0.18.

void cm_clone

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

void cm_close

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

void cm_console

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

This method has been added in version 0.18.

void cm_copy

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

void cm_copy_layer

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

This method has been added in version 0.22.

void cm_cut

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

void cm_dec_max_hier

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

void cm_delete

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

void cm_delete_layer

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

This method has been added in version 0.18.

void cm_edit_layer

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

This method has been added in version 0.18.

void cm_exit

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

void cm_goto_position

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

void cm_help_about

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

void cm_inc_max_hier

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

void cm_last_display_state

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

void cm_layout_props

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

void cm_load_bookmarks

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

void cm_load_layer_props

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

void cm_lv_add_missing

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

void cm_lv_delete

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

void cm_lv_expand_all

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

void cm_lv_group

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

void cm_lv_hide

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

void cm_lv_hide_all

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

void cm_lv_insert

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

void cm_lv_new_tab

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

void cm_lv_regroup_by_datatype

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

void cm_lv_regroup_by_index

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

void cm_lv_regroup_by_layer

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

void cm_lv_regroup_flatten

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

void cm_lv_remove_tab

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

void cm_lv_remove_unused

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

void cm_lv_rename

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

void cm_lv_rename_tab

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

void cm_lv_select_all

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

void cm_lv_show

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

void cm_lv_show_all

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

void cm_lv_show_only

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

This method has been added in version 0.20.

void cm_lv_sort_by_dli

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

void cm_lv_sort_by_idl

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

void cm_lv_sort_by_ild

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

void cm_lv_sort_by_ldi

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

void cm_lv_sort_by_name

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

void cm_lv_source

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

void cm_lv_ungroup

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

void cm_manage_bookmarks

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

void cm_max_hier

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

void cm_max_hier_0

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

void cm_max_hier_1

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

void cm_navigator_close

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

void cm_navigator_freeze

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

void cm_new_cell

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

This method has been added in version 0.18.

void cm_new_layer

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

This method has been added in version 0.18.

void cm_new_layout

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

This method has been added in version 0.18.

void cm_new_panel

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

This method has been added in version 0.20.

void cm_next_display_state

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

void cm_open

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

void cm_open_current_cell

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

This method has been added in version 0.18.

void cm_open_new_view

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

void cm_open_too

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

void cm_pan_down

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

void cm_pan_left

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

void cm_pan_right

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

void cm_pan_up

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

void cm_paste

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

void cm_print

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

This method has been added in version 0.21.13.

void cm_pull_in

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

This method has been added in version 0.20.

void cm_reader_options

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

This method has been added in version 0.18.

void cm_redo

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

void cm_redraw

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

void cm_reload

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

void cm_restore_session

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

This method has been added in version 0.18.

void cm_save

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

This method has been added in version 0.18.

void cm_save_as

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

This method has been added in version 0.18.

void cm_save_bookmarks

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

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.

void cm_save_layer_props

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

void cm_save_session

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

This method has been added in version 0.18.

void cm_screenshot

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

void cm_sel_flip_x

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

This method has been added in version 0.18.

void cm_sel_flip_y

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

This method has been added in version 0.18.

void cm_sel_free_rot

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

This method has been added in version 0.18.

void cm_sel_move

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

This method has been added in version 0.18.

void cm_sel_rot_ccw

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

This method has been added in version 0.18.

void cm_sel_rot_cw

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

This method has been added in version 0.18.

void cm_sel_scale

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

This method has been added in version 0.18.

void cm_select_all

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

This method has been added in version 0.22.

void cm_select_cell

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

void cm_select_current_cell

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

void cm_setup

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

void cm_show_properties

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

void cm_technologies

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

This method has been added in version 0.22.

void cm_undo

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

void cm_unselect_all

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

This method has been added in version 0.22.

void cm_view_log

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

This method has been added in version 0.20.

void cm_zoom_fit

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

void cm_zoom_fit_sel

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

This method has been added in version 0.18.

void cm_zoom_in

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

void cm_zoom_out

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

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.

CellView create_layout(int mode)

Description: Create a new, empty layout

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.

CellView create_layout(string mode,int tech)

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

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.

int create_view

Description: Create a new, empty view

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.

LayoutView ptr current_view

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

[const] int current_view_index

Description: Return the current view's index

This method will return the index of the current view.

void destroy

Description: Explicitly destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, this method will do nothing.

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

void enable_edits(bool enable)

Description: Enable or disable edits

This method allows to put the application 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. That mode is a global option with heavy impact on the way, the database manages it's content. The MainWindow's enable_edits method is intended to temporarily disable all menu entries and functions which could allow to the user to alter the database.

void exit

Description: Schedule 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.

[const] double grid_micron

Description: Get the global grid in micron

The global grid is used at various places, i.e. for ruler snapping, for grid display etc. With this method it can be set to the desired value.

string initial_technology

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

This method was added in version 0.22.

void initial_technology=(string tech)

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

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.

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

CellView load_layout(string filename,int mode)

Description: Load a new layout

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. Other version is provided with allow to specify technology and reader options explicitly.

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

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

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.

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

This version was introduced in version 0.22.

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

Description: Load a new layout with the given options

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 was introduced in version 0.22.

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

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

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.

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

This version was introduced in version 0.22.

AbstractMenu menu

Description: Return a reference to the abstract menu

void message(string message,int time)

Description: Display a message in the status bar

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

This method has been added in version 0.18.

LoadLayoutOptions reader_options

Description: Access to the current reader options

Modifying the current reader options will have an effect on the next load_layout operation which does not specify options explicitly 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.18.

void redraw

Description: Redraw 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.

void remove_current_view_observer(ObserverBase observer)

Description: Remove an observer for the change of the "current view changed" event

void remove_new_view_observer(ObserverBase observer)

Description: Remove an observer for a "new view" event

void resize(int width,int height)

Description: Resize the window

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

void restore_session(string fn)

Description: Restore a session from the given 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.

void save_session(string fn)

Description: Save the session to the given 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 must be saved, this has to be done explicitly in a separate step.

This method was added in version 0.18.

void select_view(int index)

Description: Select the view with the given index

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

void synchroneous(bool sync_mode)

Description: Put the main window into synchronous mode

This method is deprecated. Use method 'synchronous=' instead

void synchronous=(bool sync_mode)

Description: Put the main window into synchronous mode

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.

LayoutView ptr view(int arg1)

Description: Return a reference to a view object by index

[const] unsigned int views

Description: Return the number of views