Dockable windows & toolbars list action. More...

#include <QtxDockAction.h>

Inheritance diagram for QtxDockAction:

Public Types
enum	{ ToolBar , DockWidget , Both }
	Dock windows type. More...

Public Member Functions
	QtxDockAction (QMainWindow *)
	Constructor. More...

	QtxDockAction (const QString &, const QString &, QMainWindow *)
	Constructor. More...

	QtxDockAction (const QString &, const QIcon &, const QString &, QMainWindow *)
	Constructor. More...

virtual	~QtxDockAction ()
	Desctructor. More...

void	update ()
	Update associated menu. More...

int	dockType () const
	Get dock action type. More...

void	setDockType (const int)
	Set dock action type. More...

QMainWindow *	mainWindow () const
	Get parent main window. More...

Public Member Functions inherited from QtxAction
	QtxAction (QObject *=0, bool=false, const QString &=QString())
	Constructor. More...

	QtxAction (QObject *, bool, const QString &, const QString &, const QString &=QString(), const QIcon &=QIcon())
	Constructor. More...

	QtxAction (const QString &, const QString &, int, QObject *, bool=false, const QString &=QString())
	Constructor. More...

	QtxAction (const QString &, const QString &, const QKeySequence &, QObject *, bool=false, const QString &=QString())
	Constructor. More...

	QtxAction (const QString &, const QIcon &, const QString &, int, QObject *, bool=false, const QString &=QString())
	Constructor. More...

	QtxAction (const QString &, const QIcon &, const QString &, const QKeySequence &, QObject *, bool=false, const QString &=QString())
	Constructor. More...

virtual	~QtxAction ()
	Destructor. More...

virtual bool	eventFilter (QObject , QEvent )
	Customize action events. More...

QString	shortcutActionName () const

void	setShortcutActionName (const QString &)

const QString &	ID () const
	Unique for the entire application ID. More...

void	setID (const QString &theID)

Public Attributes
enum QtxDockAction:: { ... }	DockType
	Dock windows type. More...

Protected Member Functions
virtual void	addedTo (QWidget *)
	Customize action adding to the widget operation. More...

virtual void	removedFrom (QWidget *)
	Customize action removing from the widget operation. More...

Protected Member Functions inherited from QtxAction
virtual void	customEvent (QEvent *)
	Process notification events. More...

Private Slots
void	onAboutToShow ()
	Prepare popup menu with dock windows list when parent popup menu is shown. More...

Private Member Functions
void	initialize ()
	Initialize the action. More...

void	updateMenu ()
	Update action child popup menu. More...

void	toolBars (QList< QToolBar * > &) const
	Get all toolbars owned by parent main window. More...

void	dockWidgets (QList< QDockWidget * > &) const
	Get all dockable windows owned by parent main window. More...

Private Attributes
int	myType
	dock action type More...

QMainWindow *	myMain
	parent main window More...

Detailed Description

Dockable windows & toolbars list action.

Implements the action which provides the popup menu with the list of toolbars and/or dockable windows list owned by the main window. This action can be used, for example, in the menu "Windows".

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Dock windows type.

Enumerator
ToolBar	list toolbars only
DockWidget	list dockable windows only
Both	list toolbars and dockable windows

Constructor & Destructor Documentation

◆ QtxDockAction() [1/3]

QtxDockAction::QtxDockAction ( QMainWindow * mw )

Constructor.

Parameters

mw	parent main window

References initialize().

◆ QtxDockAction() [2/3]

QtxDockAction::QtxDockAction	(	const QString &	text,
		const QString &	menuText,
		QMainWindow *	mw
	)

Constructor.

Parameters

text	description (tooltip) text
menuText	menu text
mw	parent main window

References initialize().

◆ QtxDockAction() [3/3]

QtxDockAction::QtxDockAction	(	const QString &	text,
		const QIcon &	icon,
		const QString &	menuText,
		QMainWindow *	mw
	)

Constructor.

Parameters

text	description (tooltip) text
icon	action icon
menuText	menu text
mw	parent main window

References initialize().

◆ ~QtxDockAction()

QtxDockAction::~QtxDockAction ( )

virtual

Desctructor.

Does nothing currently.

Member Function Documentation

◆ addedTo()

void QtxDockAction::addedTo ( QWidget * w )

protectedvirtual

Customize action adding to the widget operation.

Called when the action is added to the widget. Reimplemented from QtxAction class.

Parameters

w	widget this action is added to (menu or toolbar)

Reimplemented from QtxAction.

References onAboutToShow().

◆ dockType()

int QtxDockAction::dockType ( ) const

Get dock action type.

Returns: dock type (QtxDockAction::DockType)

References myType.

◆ dockWidgets()

void QtxDockAction::dockWidgets ( QList< QDockWidget * > & lst ) const

private

Get all dockable windows owned by parent main window.

Parameters

lst	returned list of all dockable windows owned by main window

References mainWindow().

◆ initialize()

void QtxDockAction::initialize ( )

private

Initialize the action.

◆ mainWindow()

QMainWindow * QtxDockAction::mainWindow ( ) const

Get parent main window.

Returns: main window pointer.

References myMain.

◆ onAboutToShow

void QtxDockAction::onAboutToShow ( )

privateslot

Prepare popup menu with dock windows list when parent popup menu is shown.

References updateMenu().

◆ removedFrom()

void QtxDockAction::removedFrom ( QWidget * w )

protectedvirtual

Customize action removing from the widget operation.

Called when the action is removed from the widget. Reimplemented from QtxAction class.

Parameters

w	widget this action is removed from to (menu or toolbar)

Reimplemented from QtxAction.

References onAboutToShow().

◆ setDockType()

void QtxDockAction::setDockType ( const int type )

Set dock action type.

Parameters

type	dock type (QtxDockAction::DockType)

References myType.

◆ toolBars()

void QtxDockAction::toolBars ( QList< QToolBar * > & lst ) const

private

Get all toolbars owned by parent main window.

Parameters

lst	returned list of all toolbars owned by main window

References mainWindow().

◆ update()

void QtxDockAction::update ( )

Update associated menu.

References updateMenu().

◆ updateMenu()

void QtxDockAction::updateMenu ( )

private

Update action child popup menu.

References Both, dockType(), DockWidget, dockWidgets(), Qtx::simplifySeparators(), ToolBar, and toolBars().

Member Data Documentation

◆

enum { ... } QtxDockAction::DockType

Dock windows type.

◆ myMain

QMainWindow* QtxDockAction::myMain

private

parent main window

◆ myType

int QtxDockAction::myType

private

dock action type

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

src/Qtx/QtxDockAction.h
src/Qtx/QtxDockAction.cxx

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Private Slots

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ QtxDockAction() [1/3]

◆ QtxDockAction() [2/3]

◆ QtxDockAction() [3/3]

◆ ~QtxDockAction()

Member Function Documentation

◆ addedTo()

◆ dockType()

◆ dockWidgets()

◆ initialize()

◆ mainWindow()

◆ onAboutToShow

◆ removedFrom()

◆ setDockType()

◆ toolBars()

◆ update()

◆ updateMenu()

Member Data Documentation

◆

◆ myMain

◆ myType