itom  4.1.0
ito::WorkspaceDockWidget Class Reference

docking widget for contents of type workspace widget More...

Inheritance diagram for ito::WorkspaceDockWidget:
ito::AbstractDockWidget

Public Slots

void checkToggleUnpack ()
 
void propertiesChanged ()
 
- Public Slots inherited from ito::AbstractDockWidget
void setEnabled (bool)
 
virtual void setVisible (bool visible)
 
virtual void pythonStateChanged (tPythonTransitions pyTransition)
 slot invoked if python state changed. Sets the specific member variables according to the python transition. More...
 
void raiseAndActivate ()
 activates this dock widget or window and raises it on top of all opened windows More...
 
void mini ()
 
void setDockSize (int newWidth, int newHeight)
 
void dockWidget ()
 docks this dockWidget. More...
 
void undockWidget (bool show_it=true)
 undocks this dockWidget. More...
 
RetVal setAdvancedWindowTitle (QString newCompleteTitle=QString(), bool appendToBasicTitle=true)
 changes the title of widget More...
 

Signals

void setStatusInformation (QString text, int timeout=0)
 
- Signals inherited from ito::AbstractDockWidget
void dockStateChanged (bool docked)
 emitted if the widget is either docked or undocked from the main window
 

Public Member Functions

 WorkspaceDockWidget (const QString &title, const QString &objName, bool globalNotLocal, QWidget *parent=NULL, bool docked=true, bool isDockAvailable=true, tFloatingStyle floatingStyle=floatingNone, tMovingStyle movingStyle=movingEnabled)
 constructor More...
 
 ~WorkspaceDockWidget ()
 destructor More...
 
- Public Member Functions inherited from ito::AbstractDockWidget
 AbstractDockWidget (bool docked, bool isDockAvailable, tFloatingStyle floatingStyle, tMovingStyle movingStyle, const QString &title=QString(), const QString &objName=QString(), QWidget *parent=0)
 constructor More...
 
virtual ~AbstractDockWidget ()
 destructor
 
bool docked () const
 
RetVal setTopLevel (tTopLevelStyle topLevel, bool showWindow=true)
 
void setParent (QWidget *parent)
 
QWidget * getActiveInstance ()
 
QRect frameGeometry () const
 
const QRect & geometry () const
 
QRect normalGeometry () const
 
int x () const
 
int y () const
 
QPoint pos () const
 
QSize frameSize () const
 
QSize size () const
 
int width () const
 
int height () const
 
QRect rect () const
 
QRect childrenRect () const
 
QRegion childrenRegion () const
 
void move (int x, int y)
 
void move (const QPoint &)
 
void resize (int w, int h)
 
void resize (const QSize &)
 
void setGeometry (int x, int y, int w, int h)
 
void setGeometry (const QRect &)
 
void setMinimumSize (const QSize &size)
 
QString windowTitle ()
 
void setWindowTitle (const QString &title)
 
bool isEnabled () const
 
bool isVisible () const
 
void saveState (const QString &iniName) const
 
void restoreState (const QString &iniName)
 
void synchronizeTopLevelState ()
 synchronizes the top level state of the dock widget with the floating settings of this abstract dock widget More...
 
virtual QSize sizeHint () const
 
virtual QSize minimumSizeHint () const
 

Protected Member Functions

void dragEnterEvent (QDragEnterEvent *event)
 
void dropEvent (QDropEvent *event)
 
void createActions ()
 implementation for virtual method createActions in AbstractDockWidget. More...
 
void createMenus ()
 
void createToolBars ()
 implementation for virtual method createToolBars in AbstractDockWidget. More...
 
void createStatusBar ()
 
void updateActions ()
 updates the status of all actions of this widget More...
 
void updatePythonActions ()
 
- Protected Member Functions inherited from ito::AbstractDockWidget
bool eventFilter (QObject *obj, QEvent *event)
 eventFilter for m_pWindow More...
 
void init ()
 init method, called by constructor More...
 
virtual void closeEvent (QCloseEvent *event)
 closeEvent invoked if this AbstractDockWidget should be closed More...
 
Qt::WindowFlags modifyFlags (const Qt::WindowFlags &flags, const Qt::WindowFlags &setFlags, const Qt::WindowFlags &unsetFlags)
 
virtual void windowStateChanged (bool)
 
void setContentWidget (QWidget *widget)
 sets any given QWidget as central widget of QMainWindow and inversely sets this QWidget's parent to the instance of QMainWindget More...
 
QWidget * getContentWidget () const
 
QMainWindow * getCanvas ()
 
bool pythonBusy () const
 
bool pythonDebugMode () const
 
bool pythonInWaitingMode () const
 
QToolBar * getToolBar (QString key) const
 returns reference to toolbar with given key-value More...
 
QMenuBar * getMenuBar () const
 
RetVal addToolBar (QToolBar *tb, const QString &key, Qt::ToolBarArea area=Qt::TopToolBarArea, int section=1)
 
RetVal removeToolBar (const QString &key)
 

Private Slots

void mnuDeleteItem ()
 slot invoked if the delete button has been clicked More...
 
void mnuExportItem ()
 slot invoked if the import button has been clicked More...
 
void mnuImportItem ()
 slot invoked if the import button has been clicked More...
 
void mnuRenameItem ()
 slot invoked if the rename button has been clicked in the menu More...
 
void mnuToggleUnpack ()
 slot invoked if the unpack dictionary button has been clicked in the menu More...
 
void mnuPlot1D ()
 
void mnuPlot2D ()
 
void mnuPlot25D ()
 
void mnuClearAll ()
 
void treeWidgetItemSelectionChanged ()
 

Private Member Functions

void mnuPlotGeneric (const QString &plotClass)
 
void treeWidgetItemChanged (QTreeWidgetItem *item, int column)
 slot invoked if name of element in workspaceWidget (TreeView) has been changed. More...
 
void treeViewContextMenuRequested (const QPoint &pos)
 

Private Attributes

bool m_globalNotLocal
 
WorkspaceWidgetm_pWorkspaceWidget
 
ShortcutActionm_actDelete
 
ShortcutActionm_actRename
 
ShortcutActionm_actExport
 
ShortcutActionm_actImport
 
QAction * m_actUnpack
 
ShortcutActionm_actClearAll
 
QAction * m_separatorSpecialActionsToolBar
 
QAction * m_separatorSpecialActionsContextMenu
 
ShortcutActionm_dObjPlot1d
 
ShortcutActionm_dObjPlot2d
 
ShortcutActionm_dObjPlot25d
 
ShortcutActionm_dObjPlot3d
 
QToolBar * m_pMainToolBar
 
QMenu * m_pContextMenu
 
QTreeWidgetItem * m_firstCurrentItem
 
QString m_firstCurrentItemKey
 

Additional Inherited Members

- Public Types inherited from ito::AbstractDockWidget
enum  tFloatingStyle { floatingNone, floatingStandard, floatingWindow }
 The floating style of a widget, derived from AbstractDockWidget. More...
 
enum  tMovingStyle { movingDisabled, movingEnabled }
 The configuration if a docked AbstractDockWidget can be moved from one docking area to another one. More...
 
enum  tTopLevelStyle { topLevelOverall, topLevelParentOnly, topLevelNothing }
 The top level style of a widget, derived from AbstractDockWidget. More...
 
- Protected Attributes inherited from ito::AbstractDockWidget
QAction * m_actStayOnTop
 
QAction * m_actStayOnTopOfApp
 
- Properties inherited from ito::AbstractDockWidget
bool visible
 
bool enabled
 
QRect geometry
 
QRect frameGeometry
 
QRect normalGeometry
 
int x
 
int y
 
QPoint pos
 
QSize frameSize
 
QSize size
 
int width
 
int height
 
QRect rect
 
QRect childrenRect
 
QRegion childrenRegion
 
QString windowTitle
 

Detailed Description

docking widget for contents of type workspace widget

Constructor & Destructor Documentation

ito::WorkspaceDockWidget::WorkspaceDockWidget ( const QString &  title,
const QString &  objName,
bool  globalNotLocal,
QWidget *  parent = NULL,
bool  docked = true,
bool  isDockAvailable = true,
tFloatingStyle  floatingStyle = floatingNone,
tMovingStyle  movingStyle = movingEnabled 
)

constructor

long description

Parameters
title[in] is the docking widget's title
globalNotLocaldefines whether this widget contains global (true) or local (false) variables
parentis a pointer to the parent widget [default: NULL]
dockedindicates whether this widget should appear docked (true) or undocked (false) [default: true]
isDockAvailableindicates if this widget can be docked (true) or not (false) [default: true]
floatingStyleindicates the style for the floating mode [default: floatingNone]
movingStyleindicates the style for movement of the docked widget [default: movingEnabled]
ito::WorkspaceDockWidget::~WorkspaceDockWidget ( )

destructor

long description

Parameters
namedescription
Returns
description
See also
(see also) keywords (comma-separated)

Member Function Documentation

void ito::WorkspaceDockWidget::createActions ( )
protectedvirtual

implementation for virtual method createActions in AbstractDockWidget.

! loads the given python dictionary by calling the appropriate method in its workspaceWidget. *!

creates all actions related to this widget. These actions will be used in the toolbars.

Implements ito::AbstractDockWidget.

void ito::WorkspaceDockWidget::createToolBars ( )
protectedvirtual

implementation for virtual method createToolBars in AbstractDockWidget.

Creates the toolbar for this dock-widget with the necessary buttons, connected to existing actions.

Implements ito::AbstractDockWidget.

void ito::WorkspaceDockWidget::mnuDeleteItem ( )
privateslot

slot invoked if the delete button has been clicked

After accepting a security query, the selected variables will be deleted by invoking the slot deleteVariable in pythonEngine.

See also
deleteVariable
void ito::WorkspaceDockWidget::mnuExportItem ( )
privateslot

slot invoked if the import button has been clicked

A file-dialog appears where an idc (pickle)-file can be chosen, where the selected variables should be pickled to. An error message will appear if the export failed.

See also
uiExportPyWorkspaceVars
void ito::WorkspaceDockWidget::mnuImportItem ( )
privateslot

slot invoked if the import button has been clicked

A file-dialog appears where an idc (pickle)-file can be chosen, whose content should be load to the python workspace. An error message will appear if the import failed.

See also
uiImportPyWorkspaceVars
void ito::WorkspaceDockWidget::mnuRenameItem ( )
privateslot

slot invoked if the rename button has been clicked in the menu

this slot forces the current item in the treeview to become editable (editMode)

void ito::WorkspaceDockWidget::mnuToggleUnpack ( )
privateslot

slot invoked if the unpack dictionary button has been clicked in the menu

when importing an *.idc or *.mat file to the workspace, it is either possible to unpack all values within the file and load them as separate variables to the workspace or to load the content of the file as one single dictionary (name of the dictionary will be requested by an input dialog)

void ito::WorkspaceDockWidget::treeWidgetItemChanged ( QTreeWidgetItem *  item,
int  column 
)
private

slot invoked if name of element in workspaceWidget (TreeView) has been changed.

calls pythonEngine's method renameVariable in order to initiate the renaming operation in python.

Parameters
item[in] is the corresponding QTreeWidgetItem, whose name has manually been changed
See also
renameVariable
void ito::WorkspaceDockWidget::updateActions ( )
protectedvirtual

updates the status of all actions of this widget

The update concerns mainly the visible and enabled-status of each action, depending on different influences, like e.g. the python status.

See also
pythonInWaitingMode, pythonBusy

Reimplemented from ito::AbstractDockWidget.


The documentation for this class was generated from the following files: