Class MainWindow (version 0.18)Description: The main application window and central controller object 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.
Method Overview
add_current_view_observer( ref 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.
add_new_view_observer( ref 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.
cancelDescription: Cancel current editing operations This method call cancels all current editing operations and restores normal mouse mode.
clone_current_viewDescription: Clone the current view and make it current
close_allDescription: 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_viewDescription: 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.
cm_adjust_originDescription: 'cm_adjust_origin' action (bound to a menu) This method has been added in version 0.18.
cm_bookmark_viewDescription: 'cm_bookmark_view' action (bound to a menu)
cm_cancelDescription: 'cm_cancel' action (bound to a menu)
cm_cell_deleteDescription: 'cm_cell_delete ' action (bound to a menu) This method has been added in version 0.18.
cm_cell_hideDescription: 'cm_cell_hide' action (bound to a menu)
cm_cell_renameDescription: 'cm_cell_rename ' action (bound to a menu) This method has been added in version 0.18.
cm_cell_selectDescription: 'cm_cell_select' action (bound to a menu)
cm_cell_showDescription: 'cm_cell_show' action (bound to a menu)
cm_cell_show_allDescription: 'cm_cell_show_all' action (bound to a menu)
cm_clear_layerDescription: 'cm_clear_layer ' action (bound to a menu) This method has been added in version 0.18.
cm_cloneDescription: 'cm_clone' action (bound to a menu)
cm_closeDescription: 'cm_close' action (bound to a menu)
cm_consoleDescription: 'cm_console' action (bound to a menu) This method has been added in version 0.18.
cm_copyDescription: 'cm_copy' action (bound to a menu)
cm_cutDescription: 'cm_cut' action (bound to a menu)
cm_dec_max_hierDescription: 'cm_dec_max_hier' action (bound to a menu)
cm_deleteDescription: 'cm_delete' action (bound to a menu)
cm_delete_layerDescription: 'cm_delete_layer ' action (bound to a menu) This method has been added in version 0.18.
cm_edit_booleanDescription: 'cm_edit_boolean ' action (bound to a menu) This method has been added in version 0.18.
cm_edit_layerDescription: 'cm_edit_layer ' action (bound to a menu) This method has been added in version 0.18.
cm_edit_mergeDescription: 'cm_edit_merge ' action (bound to a menu) This method has been added in version 0.18.
cm_edit_sizeDescription: 'cm_edit_size ' action (bound to a menu) This method has been added in version 0.18.
cm_exitDescription: 'cm_exit' action (bound to a menu)
cm_goto_positionDescription: 'cm_goto_position' action (bound to a menu)
cm_help_aboutDescription: 'cm_help_about' action (bound to a menu)
cm_inc_max_hierDescription: 'cm_inc_max_hier' action (bound to a menu)
cm_last_display_stateDescription: 'cm_last_display_state' action (bound to a menu)
cm_layout_propsDescription: 'cm_layout_props' action (bound to a menu)
cm_load_bookmarksDescription: 'cm_load_bookmarks' action (bound to a menu)
cm_load_layer_propsDescription: 'cm_load_layer_props' action (bound to a menu)
cm_lv_add_missingDescription: 'cm_lv_add_missing' action (bound to a menu)
cm_lv_deleteDescription: 'cm_lv_delete' action (bound to a menu)
cm_lv_expand_allDescription: 'cm_lv_expand_all' action (bound to a menu)
cm_lv_groupDescription: 'cm_lv_group' action (bound to a menu)
cm_lv_hideDescription: 'cm_lv_hide' action (bound to a menu)
cm_lv_insertDescription: 'cm_lv_insert' action (bound to a menu)
cm_lv_regroup_by_datatypeDescription: 'cm_lv_regroup_by_datatype' action (bound to a menu)
cm_lv_regroup_by_indexDescription: 'cm_lv_regroup_by_index' action (bound to a menu)
cm_lv_regroup_by_layerDescription: 'cm_lv_regroup_by_layer' action (bound to a menu)
cm_lv_regroup_flattenDescription: 'cm_lv_regroup_flatten' action (bound to a menu)
cm_lv_remove_unusedDescription: 'cm_lv_remove_unused' action (bound to a menu)
cm_lv_renameDescription: 'cm_lv_rename' action (bound to a menu)
cm_lv_select_allDescription: 'cm_lv_select_all' action (bound to a menu)
cm_lv_showDescription: 'cm_lv_show' action (bound to a menu)
cm_lv_sort_by_dliDescription: 'cm_lv_sort_by_dli' action (bound to a menu)
cm_lv_sort_by_idlDescription: 'cm_lv_sort_by_idl' action (bound to a menu)
cm_lv_sort_by_ildDescription: 'cm_lv_sort_by_ild' action (bound to a menu)
cm_lv_sort_by_ldiDescription: 'cm_lv_sort_by_ldi' action (bound to a menu)
cm_lv_sort_by_nameDescription: 'cm_lv_sort_by_name' action (bound to a menu)
cm_lv_sourceDescription: 'cm_lv_source' action (bound to a menu)
cm_lv_ungroupDescription: 'cm_lv_ungroup' action (bound to a menu)
cm_manage_bookmarksDescription: 'cm_manage_bookmarks' action (bound to a menu)
cm_max_hierDescription: 'cm_max_hier' action (bound to a menu)
cm_max_hier_0Description: 'cm_max_hier_0' action (bound to a menu)
cm_max_hier_1Description: 'cm_max_hier_1' action (bound to a menu)
cm_new_cellDescription: 'cm_new_cell' action (bound to a menu) This method has been added in version 0.18.
cm_new_layerDescription: 'cm_new_layer' action (bound to a menu) This method has been added in version 0.18.
cm_new_layoutDescription: 'cm_new_layout' action (bound to a menu) This method has been added in version 0.18.
cm_next_display_stateDescription: 'cm_next_display_state' action (bound to a menu)
cm_openDescription: 'cm_open' action (bound to a menu)
cm_open_current_cellDescription: 'cm_open_current_cell ' action (bound to a menu) This method has been added in version 0.18.
cm_open_new_viewDescription: 'cm_open_new_view' action (bound to a menu)
cm_open_tooDescription: 'cm_open_too' action (bound to a menu)
cm_pan_downDescription: 'cm_pan_down' action (bound to a menu)
cm_pan_leftDescription: 'cm_pan_left' action (bound to a menu)
cm_pan_rightDescription: 'cm_pan_right' action (bound to a menu)
cm_pan_upDescription: 'cm_pan_up' action (bound to a menu)
cm_pasteDescription: 'cm_paste' action (bound to a menu)
cm_reader_optionsDescription: 'cm_reader_options' action (bound to a menu) This method has been added in version 0.18.
cm_redoDescription: 'cm_redo' action (bound to a menu)
cm_redrawDescription: 'cm_redraw' action (bound to a menu)
cm_reloadDescription: 'cm_reload' action (bound to a menu)
cm_restore_sessionDescription: 'cm_restore_session' action (bound to a menu) This method has been added in version 0.18.
cm_saveDescription: 'cm_save' action (bound to a menu) This method has been added in version 0.18.
cm_save_asDescription: 'cm_save_as' action (bound to a menu) This method has been added in version 0.18.
cm_save_bookmarksDescription: 'cm_save_bookmarks' action (bound to a menu)
cm_save_current_cell_asDescription: 'cm_save_current_cell_as ' action (bound to a menu) This method has been added in version 0.18.
cm_save_layer_propsDescription: 'cm_save_layer_props' action (bound to a menu)
cm_save_sessionDescription: 'cm_save_session' action (bound to a menu) This method has been added in version 0.18.
cm_screenshotDescription: 'cm_screenshot' action (bound to a menu)
cm_sel_flip_xDescription: 'cm_sel_flip_x ' action (bound to a menu) This method has been added in version 0.18.
cm_sel_flip_yDescription: 'cm_sel_flip_y ' action (bound to a menu) This method has been added in version 0.18.
cm_sel_free_rotDescription: 'cm_sel_free_rot ' action (bound to a menu) This method has been added in version 0.18.
cm_sel_moveDescription: 'cm_sel_move ' action (bound to a menu) This method has been added in version 0.18.
cm_sel_rot_ccwDescription: 'cm_sel_rot_ccw ' action (bound to a menu) This method has been added in version 0.18.
cm_sel_rot_cwDescription: 'cm_sel_rot_cw ' action (bound to a menu) This method has been added in version 0.18.
cm_sel_scaleDescription: 'cm_sel_scale ' action (bound to a menu) This method has been added in version 0.18.
cm_select_cellDescription: 'cm_select_cell' action (bound to a menu)
cm_select_current_cellDescription: 'cm_select_current_cell' action (bound to a menu)
cm_setupDescription: 'cm_setup' action (bound to a menu)
cm_show_propertiesDescription: 'cm_show_properties' action (bound to a menu)
cm_undoDescription: 'cm_undo' action (bound to a menu)
cm_zoom_fitDescription: 'cm_zoom_fit' action (bound to a menu)
cm_zoom_fit_selDescription: 'cm_zoom_fit_sel' action (bound to a menu) This method has been added in version 0.18.
cm_zoom_inDescription: 'cm_zoom_in' action (bound to a menu)
cm_zoom_outDescription: 'cm_zoom_out' action (bound to a menu)
const ref 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.
ref LayoutView current_viewDescription: Return a reference to the current view's object
[const] int current_view_indexDescription: Return the current view's index This method will return the index of the current view.
destroyDescription: 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 destroyedDescription: Tell, if the object was 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.
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 be called with a 'false' argument. Calling it with a 'true' parameter enables all edits again.
exitDescription: 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_micronDescription: 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.
const ref 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.
ref AbstractMenu menuDescription: Return a reference to the abstract menu
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.
ref LoadLayoutOptions reader_optionsDescription: Access to the current reader options Modifying the current reader options will have an effect on the next load_layout operation 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.
redrawDescription: 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.
remove_current_view_observer( ref ObserverBase observer )Description: Remove an observer for the change of the "current view changed" event
remove_new_view_observer( ref ObserverBase observer )Description: Remove an observer for a "new view" event
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
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.
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.
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.
synchroneous=( bool sync_mode )Description: Put the main window into synchroneous mode In synchroneous mode, an application is allowed to block on redraw. While redrawing, no user interactions are possible. Although this is not desireable 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.
ref LayoutView view( int )Description: Return a reference to a view object by index
[const] unsigned int viewsDescription: Return the number of views
|