swift
Signals | Public Member Functions | Protected Member Functions | List of all members
swift::gui::CInfoArea Class Referenceabstract

Info area, hosting dockable widgets. More...

Inheritance diagram for swift::gui::CInfoArea:
[legend]

Signals

void changedInfoAreaTabBarIndex (int index)
 Tab bar changed.
 
void changedInfoAreaStatus (int currentTabIndex, QList< int > dockedAreas, QList< int > floatingAreas)
 Status of info area changed.
 
void changedWholeInfoAreaFloating (bool floating)
 Whole info area floating.
 

Public Member Functions

virtual ~CInfoArea ()
 Destructor.
 
void addToContextMenu (QMenu *menu) const
 Add items to context menu.
 
bool isFloating () const
 Is the area floating?
 
bool isSelectedDockWidgetInfoArea (const CDockWidgetInfoArea *infoArea) const
 Is given widget selected. Means it is not floating, and the one selected.
 
const CDockWidgetInfoAreagetSelectedDockInfoArea () const
 Get the selected info area (non floating, selected in tabbar)
 
int getSelectedDockInfoAreaIndex () const
 Get the selected info area (non floating, selected in tabbar)
 
QList< const CDockWidgetInfoArea * > getDockWidgetInfoAreas () const
 Own dockable widgets.
 
QList< QAction * > getInfoAreaSelectActions (bool withShortcut, QWidget *parent) const
 Create a list of actions to select the info areas. This could be used in a menu or somewhere else. More...
 
QList< QAction * > getInfoAreaToggleFloatingActions (QWidget *parent) const
 Create a list of actions to select the info areas and toogle its floating state. This could be used in a menu or somewhere else. More...
 
QList< QAction * > getInfoAreaRestoreActions (QWidget *parent) const
 Create a list of actions to restore the info areas. This could be used in a menu or somewhere else. More...
 
QList< QAction * > getInfoAreaResetPositionActions (QWidget *parent) const
 Create a list of actions to reset the position the info areas. This could be used in a menu or somewhere else. More...
 
QList< int > getAreaIndexesDockedOrFloating (bool floating) const
 Docked area indexes.
 
void dockAllWidgets ()
 Dock all widgets.
 
void adjustSizeForAllDockWidgets ()
 Adjust size for all dock widgets.
 
void floatAllWidgets ()
 All widgets floating.
 
void allFloatingOnTop ()
 All floating info areas on top.
 
void resetAllFloatingWidgetSettings ()
 Reset all floating widget settings.
 
void resetAllWidgetSettings ()
 Reset all widget settings.
 
virtual void toggleFloatingWholeInfoArea ()
 Toggle dock / floating of the whole info area.
 
void toggleFloatingByIndex (int areaIndex)
 Toggle floating of index.
 
void toggleVisibility (int areaIndex)
 Toggle visibilty.
 
void selectArea (int areaIndex)
 Select area.
 
void resetPosition (int areaIndex)
 Reset position.
 
void selectArea (const CDockWidgetInfoArea *dockWidgetInfoArea)
 Set current tab bar index by given widget.
 
void selectAreaByAction ()
 Select area (sender is QAction)
 
void resetPositionByAction ()
 Reset window position of area (sender is QAction)
 
void toggleAreaFloatingByAction ()
 Toggle area floating (sender is QAction)
 
void restoreDockWidgetInfoArea ()
 Restore dock widget`s state (from settings)
 
void restoreDockWidgetInfoAreaByIndex (int areaIndex)
 Restore dock widget`s state (from settings)
 
void selectLeftTab ()
 Select next left tab.
 
void selectRightTab ()
 Select next right tab.
 
void displayStatusMessage (const swift::misc::CStatusMessage &statusMessage)
 Display status message in all info areas (according their state)
 
void displayStatusMessages (const swift::misc::CStatusMessageList &statusMessages)
 Display status messages in all info areas (according their state)
 

Protected Member Functions

 CInfoArea (QWidget *parent=nullptr)
 Constructor.
 
virtual void closeEvent (QCloseEvent *event)
 
virtual void paintEvent (QPaintEvent *event)
 
virtual void keyPressEvent (QKeyEvent *event)
 
virtual QSize getPreferredSizeWhenFloating (int areaIndex) const =0
 Preferred size when floating (size hint)
 
virtual const QPixmap & indexToPixmap (int areaIndex) const =0
 Info area (index) to icon.
 
void initInfoArea ()
 Init area after(!) GUI is initialized.
 
void setTabBarPosition (QTabWidget::TabPosition position)
 Tab position for docked widgets tab. More...
 
void toggleTabBarLocked (bool locked)
 Toogle lock tabbar.
 

Detailed Description

Info area, hosting dockable widgets.

See also
CDockWidgetInfoArea

Definition at line 40 of file infoarea.h.

Member Function Documentation

◆ closeEvent()

void swift::gui::CInfoArea::closeEvent ( QCloseEvent *  event)
protectedvirtual

Definition at line 888 of file infoarea.cpp.

◆ getInfoAreaResetPositionActions()

QList< QAction * > swift::gui::CInfoArea::getInfoAreaResetPositionActions ( QWidget *  parent) const

Create a list of actions to reset the position the info areas. This could be used in a menu or somewhere else.

Parameters
parentwhich will own the action (deletion)

Definition at line 244 of file infoarea.cpp.

◆ getInfoAreaRestoreActions()

QList< QAction * > swift::gui::CInfoArea::getInfoAreaRestoreActions ( QWidget *  parent) const

Create a list of actions to restore the info areas. This could be used in a menu or somewhere else.

Parameters
parentwhich will own the action (deletion)

Definition at line 282 of file infoarea.cpp.

◆ getInfoAreaSelectActions()

QList< QAction * > swift::gui::CInfoArea::getInfoAreaSelectActions ( bool  withShortcut,
QWidget *  parent 
) const

Create a list of actions to select the info areas. This could be used in a menu or somewhere else.

Parameters
withShortcutautomatically add a shortcut
parentwhich will own the action (deletion)

Definition at line 216 of file infoarea.cpp.

◆ getInfoAreaToggleFloatingActions()

QList< QAction * > swift::gui::CInfoArea::getInfoAreaToggleFloatingActions ( QWidget *  parent) const

Create a list of actions to select the info areas and toogle its floating state. This could be used in a menu or somewhere else.

Parameters
parentwhich will own the action (deletion)

Definition at line 263 of file infoarea.cpp.

◆ keyPressEvent()

void swift::gui::CInfoArea::keyPressEvent ( QKeyEvent *  event)
protectedvirtual

Remarks
nor fully sufficient, as the info area is hardly having focus

Definition at line 317 of file infoarea.cpp.

◆ paintEvent()

void swift::gui::CInfoArea::paintEvent ( QPaintEvent *  event)
protectedvirtual

Definition at line 311 of file infoarea.cpp.

◆ setTabBarPosition()

void swift::gui::CInfoArea::setTabBarPosition ( QTabWidget::TabPosition  position)
protected

Tab position for docked widgets tab.

Remarks
North or South working, East / West not

Definition at line 874 of file infoarea.cpp.


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