itom
Loading...
Searching...
No Matches
Public Slots | Signals | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
ito::HelpDockWidget Class Reference
Inheritance diagram for ito::HelpDockWidget:
ito::AbstractDockWidget

Public Slots

void mnuShowInfo (QString name, HelpTreeDockWidget::HelpItemType type)
 
- 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.
 
void raiseAndActivate ()
 activates this dock widget or window and raises it on top of all opened windows
 
void mini ()
 
void setDockSize (int newWidth, int newHeight)
 
void dockWidget ()
 docks this dockWidget.
 
void undockWidget (bool show_it=true)
 undocks this dockWidget.
 
RetVal setAdvancedWindowTitle (QString newCompleteTitle=QString(), bool appendToBasicTitle=true)
 changes the title of widget
 

Signals

void showPluginInfo (QString name, HelpTreeDockWidget::HelpItemType type, const QModelIndex modelIndex, bool fromLink)
 
- 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

 HelpDockWidget (const QString &title, const QString &objName, QWidget *parent=NULL, bool docked=true, bool isDockAvailable=true, tFloatingStyle floatingStyle=floatingNone, tMovingStyle movingStyle=movingEnabled)
 
- 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
 
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
 
virtual QSize sizeHint () const
 
virtual QSize minimumSizeHint () const
 

Protected Member Functions

void createActions ()
 
void createMenus ()
 
void createToolBars ()
 
void createStatusBar ()
 
void updateActions ()
 
void updatePythonActions ()
 
- Protected Member Functions inherited from ito::AbstractDockWidget
bool eventFilter (QObject *obj, QEvent *event)
 eventFilter for m_pWindow
 
void init ()
 init method, called by constructor
 
virtual void closeEvent (QCloseEvent *event)
 closeEvent invoked if this AbstractDockWidget should be closed
 
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
 
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
 
QMenuBar * getMenuBar () const
 
RetVal addToolBar (QToolBar *tb, const QString &key, Qt::ToolBarArea area=Qt::TopToolBarArea, int section=1)
 
RetVal removeToolBar (const QString &key)
 

Private Attributes

QAction * m_pActBackward
 
QAction * m_pActForward
 
QAction * m_pActExpand
 
QAction * m_pActCollapse
 
QWidgetAction * m_pActChanged
 
QToolBar * m_pMainToolbar
 
QLineEdit * m_pFilterEdit
 
HelpTreeDockWidget * m_pHelpWidget
 

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
 

Member Function Documentation

◆ createActions()

void ito::HelpDockWidget::createActions ( )
protectedvirtual

Implements ito::AbstractDockWidget.

◆ createMenus()

void ito::HelpDockWidget::createMenus ( )
protectedvirtual

Implements ito::AbstractDockWidget.

◆ createStatusBar()

void ito::HelpDockWidget::createStatusBar ( )
inlineprotectedvirtual

Implements ito::AbstractDockWidget.

◆ createToolBars()

void ito::HelpDockWidget::createToolBars ( )
protectedvirtual

Implements ito::AbstractDockWidget.

◆ updateActions()

void ito::HelpDockWidget::updateActions ( )
protectedvirtual

Reimplemented from ito::AbstractDockWidget.

◆ updatePythonActions()

void ito::HelpDockWidget::updatePythonActions ( )
inlineprotectedvirtual

Implements ito::AbstractDockWidget.

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