The QtToolBarManager class provides toolbar management for main windows. More...

#include <qttoolbardialog_p.h>

Inheritance diagram for QtToolBarManager:

Collaboration diagram for QtToolBarManager:

Public Member Functions
	QtToolBarManager (QObject *parent=0)
	Creates a toolbar manager with the given parent.

	~QtToolBarManager ()
	Destroys the toolbar manager.

void	setMainWindow (QMainWindow *mainWindow)
	Sets the main window upon which the toolbar manager operates, to be the given mainWindow.

QMainWindow *	mainWindow () const
	Returns the main window associated this toolbar manager.

void	addAction (QAction *action, const QString &category)
	Adds the given action to the given category in the manager's list of actions.

void	removeAction (QAction *action)
	Removes the specified action from the manager's list of actions.

void	addToolBar (QToolBar *toolBar, const QString &category)
	Adds the given toolBar to the manager's toolbar list.

void	removeToolBar (QToolBar *toolBar)
	Removes the specified toolBar from the manager's list.

QList< QToolBar * >	toolBars () const
	Returns the manager's toolbar list.

QByteArray	saveState (int version=0) const
	Saves the state of the toolbar manager's toolbars.

bool	restoreState (const QByteArray &state, int version=0)
	Restores the saved state of the toolbar manager's toolbars.

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T >
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Friends
class	QtToolBarDialog

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Properties inherited from QObject
QString	objectName
	the name of this object

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

The QtToolBarManager class provides toolbar management for main windows.

\inmodule QtDesigner

Since: 4.4

The QtToolBarManager is typically used with a QtToolBarDialog which allows the user to customize the toolbars for a given main window. The QtToolBarDialog class's functionality is controlled by an instance of the QtToolBarManager class, and the main window is specified using the QtToolBarManager class's setMainWindow() function.

The currently specified main window can be retrieved using the mainWindow() function.

The toolbar manager holds lists of the given main window's actions and toolbars, and can add actions and toolbars to these lists using the addAction() and addToolBar() functions respectively. The actions can in addition be categorized acccording to the user's preferences. The toolbar manager can also remove custom actions and toolbars using the removeAction() and removeToolBar() functions.

Finally, the QtToolBarManager is able to save the customized state of its toolbars using the saveState() function as well as restore the toolbars' saved state using restoreState() function.

See also: QtToolBarDialog

Definition at line 28 of file qttoolbardialog_p.h.

Constructor & Destructor Documentation

◆ QtToolBarManager()

QtToolBarManager::QtToolBarManager ( QObject * parent = 0 )

explicit

Creates a toolbar manager with the given parent.

Definition at line 751 of file qttoolbardialog.cpp.

◆ ~QtToolBarManager()

QtToolBarManager::~QtToolBarManager ( )

Destroys the toolbar manager.

Definition at line 762 of file qttoolbardialog.cpp.

Member Function Documentation

◆ addAction()

void QtToolBarManager::addAction	(	QAction *	action,
		const QString &	category )

Adds the given action to the given category in the manager's list of actions.

If the category doesn't exist it is created. Only non separator actions can be added. If the action is already added to the list, the function doesn't do anything.

See also: removeAction()

Definition at line 791 of file qttoolbardialog.cpp.

◆ addToolBar()

void QtToolBarManager::addToolBar	(	QToolBar *	toolBar,
		const QString &	category )

Adds the given toolBar to the manager's toolbar list.

All the toolBar's actions are automatically added to the given category in the manager's list of actions if they're not already there. The manager remembers which toolbar the actions belonged to, so, when the toolBar is removed, its actions will be removed as well.

Custom toolbars are created with the main window returned by the mainWindow() function, as its parent.

See also: removeToolBar()

Definition at line 823 of file qttoolbardialog.cpp.

◆ mainWindow()

QMainWindow * QtToolBarManager::mainWindow ( ) const

Returns the main window associated this toolbar manager.

Definition at line 778 of file qttoolbardialog.cpp.

◆ removeAction()

void QtToolBarManager::removeAction ( QAction * action )

Removes the specified action from the manager's list of actions.

The action is also removed from all the registered toolbars. If the specified action is the only action in its category, that category is removed as well.

See also: addAction()

Definition at line 804 of file qttoolbardialog.cpp.

◆ removeToolBar()

void QtToolBarManager::removeToolBar ( QToolBar * toolBar )

Removes the specified toolBar from the manager's list.

All the actions that existed in the specified toolBar when it was added are removed as well.

See also: addToolBar()

Definition at line 835 of file qttoolbardialog.cpp.

◆ restoreState()

bool QtToolBarManager::restoreState	(	const QByteArray &	state,
		int	version = 0 )

Restores the saved state of the toolbar manager's toolbars.

The version number is compared with the version number of the stored state.

Returns true if the version numbers are matching and the toolbar manager's state is restored; otherwise the toolbar manager's state is left unchanged and the function returns false.

Note that the state of the toolbar manager's toolbars should be restored before restoring the state of the main window's toolbars and dockwidgets using the QMainWindow::restoreState() function. In that way the restoreState() function can create the custom toolbars before the QMainWindow::restoreState() function restores the custom toolbars' positions.

See also: saveState()

Definition at line 897 of file qttoolbardialog.cpp.

Referenced by ToolBarManager::restoreState().

Here is the caller graph for this function:

◆ saveState()

QByteArray QtToolBarManager::saveState ( int version = 0 ) const

Saves the state of the toolbar manager's toolbars.

The version number is stored as part of the data.

Identifies all the QToolBar and QAction objects by their object name property. Ensure that this property is unique for each QToolBar and QAction that you add using the QtToolBarManager.

Returns an identifier for the state which can be passed along with the version number to the restoreState() function to restore the saved state.

See also: restoreState()

Definition at line 874 of file qttoolbardialog.cpp.

Referenced by ToolBarManager::saveState().

Here is the caller graph for this function:

◆ setMainWindow()

void QtToolBarManager::setMainWindow ( QMainWindow * mainWindow )

Sets the main window upon which the toolbar manager operates, to be the given mainWindow.

Definition at line 770 of file qttoolbardialog.cpp.

Referenced by ToolBarManager::ToolBarManager().

Here is the caller graph for this function:

◆ toolBars()

QList< QToolBar * > QtToolBarManager::toolBars ( ) const

Returns the manager's toolbar list.

Definition at line 843 of file qttoolbardialog.cpp.

Friends And Related Symbol Documentation

◆ QtToolBarDialog

friend class QtToolBarDialog

friend

Definition at line 52 of file qttoolbardialog_p.h.

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

qttools/src/shared/qttoolbardialog/qttoolbardialog_p.h (34ce4eccbe4f645c25181984435fe65b0b028eb0)
qttools/src/shared/qttoolbardialog/qttoolbardialog.cpp (34ce4eccbe4f645c25181984435fe65b0b028eb0)

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QtToolBarManager()

◆ ~QtToolBarManager()

Member Function Documentation

◆ addAction()

◆ addToolBar()

◆ mainWindow()

◆ removeAction()

◆ removeToolBar()

◆ restoreState()

◆ saveState()

◆ setMainWindow()

◆ toolBars()

Friends And Related Symbol Documentation

◆ QtToolBarDialog