MenuCatalog Class Reference

The MenuCatalog class provides access to members that work on the collection of application menus. More...

#include <MenuCatalog.h>

Inherits IMenuCatalog.

Public Member Functions
	MenuCatalog (QMenuBar &menuBar)
QMenu *	addMenu (const QString &title)
QMenu *	addMenu (const QIcon &icon, const QString &title)
QMenu *	addPopup (const QString &title)
QMenu *	addPopup (const QIcon &icon, const QString &title)
void	deleteMenu (const QString &title)
void	deleteMenu (QMenu *menu)
bool	eventFilter (QObject *obj, QEvent *event)
QMenu *	findMenu (const QString &title)
const QMenu *	findMenu (const QString &title) const
QMenu *	findMenuEverywhere (const QString &title)
const QMenu *	findMenuEverywhere (const QString &title) const
QMenu *	findPopup (const QString &title)
const QMenu *	findPopup (const QString &title) const
QList< QMenu * >	menus () const
QList< QMenu * >	popups () const
void	removeMenu (const QString &title)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Protected Member Functions
QMenu *	findMenu (const QString &title, QMenu *inMenu) const
virtual void	onMenuAdded (QMenu *menu)
virtual void	onMenuRemoved (QMenu *menu)
virtual void	onSubMenuAdded (QMenu *newMenu)
virtual void	onSubMenuRemoved (QMenu *menu)
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Signals inherited from IMenuCatalog
void	menuAdded (QMenu *menu)
void	menuRemoved (QMenu *menu)
void	subMenuAdded (QMenu *menu)
void	subMenuRemoved (QMenu *menu)
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

The MenuCatalog class provides access to members that work on the collection of application menus.

MenuCatalog knows about collection of all the menus available to an application. This class allows you to add new menu to the main bar or to the inner menu found by its title. It is also used in Custimozation dialog. Use IInteractionService::catalogs().menuCatalog() to get a reference to the menus collection to insert operations specific to your extensions.

Constructor & Destructor Documentation

MenuCatalog::MenuCatalog

(

QMenuBar &

menuBar

)

Initializes a new instance of the MenuCatalog class with specified menuBar where menus will be added.

Member Function Documentation

QMenu* MenuCatalog::addMenu ( const QString &  title )

virtual

Appends a new QMenu with title to the menu bar. The menu bar takes ownership of the menu. Returns the new menu.

To add menu item to the menu use OperationCatalog:

*   QMenu *fileMenu = menuCatalog.findMenuEverywhere(tr("File"));
*   fileMenu->addAction(operationCatalog->add(new MyPrintOperation()));
* 

See Also

OperationCatalog::register();

Implements IMenuCatalog.

QMenu* MenuCatalog::addMenu ( const QIcon &  icon, const QString &  title  )

virtual

Appends a new QMenu with icon and title to the menu bar. The menu bar takes ownership of the menu. Returns the new menu.

Implements IMenuCatalog.

QMenu* MenuCatalog::addPopup ( const QString &  title )

virtual

Adds a new QMenu with title to the catalog (it takes ownership of the menu). You can use this menu later for the popup, using findPopup(). Returns the new menu.

Implements IMenuCatalog.

QMenu* MenuCatalog::addPopup ( const QIcon &  icon, const QString &  title  )

virtual

Adds a new QMenu with icon and title to the catalog (it takes ownership of the menu). You can use this menu later for the popup, using findPopup(). Returns the new menu.

Implements IMenuCatalog.

void MenuCatalog::deleteMenu ( const QString &  title )

virtual

Searches for the menu specified by title, removes if any from containter and calls delete.

Usualy you should not use this method directly - it is used only by IComponentConfigurationDelegate to deconfigure component and revert changes is did.

To remove menu from menu bar without deleting use removeMenu().

Implements IMenuCatalog.

void MenuCatalog::deleteMenu ( QMenu *  menu )

virtual

Removes specified menu from containter and calls delete.

Usualy you should not use this method directly - it is used only by IComponentConfigurationDelegate to deconfigure component and revert changes is did.

To remove menu from menu bar without deleting use removeMenu().

Implements IMenuCatalog.

QMenu* MenuCatalog::findMenu ( const QString &  title )

virtual

Searches for the menu specified by title in the menu bar and other menus.

Returns

Found menu. Null, if there are no menus with such title.

Implements IMenuCatalog.

const QMenu* MenuCatalog::findMenu ( const QString &  title ) const

virtual

Searches for the menu specified by title in the menu bar and other menus.

Returns

Found menu. Null, if there are no menus with such title.

Implements IMenuCatalog.

QMenu* MenuCatalog::findMenuEverywhere ( const QString &  title )

virtual

Searches for the menu specified by title in the menu bar, other menus and in removed menus list.

Returns

Found menu. Null, if there are no menus with such title.

Implements IMenuCatalog.

const QMenu* MenuCatalog::findMenuEverywhere ( const QString &  title ) const

virtual

Searches for the menu specified by title in the menu bar, other menus and in removed menus list.

Returns

Found menu. Null, if there are no menus with such title.

Implements IMenuCatalog.

QMenu* MenuCatalog::findPopup ( const QString &  title )

virtual

Searches for the popup menu specified by title.

Returns

Found menu. Null, if there are no popup menus with such title.

Implements IMenuCatalog.

const QMenu* MenuCatalog::findPopup ( const QString &  title ) const

virtual

Searches for the popup menu specified by title.

Returns

Found menu. Null, if there are no popup menus with such title.

Implements IMenuCatalog.

QList<QMenu *> MenuCatalog::menus ( ) const

virtual

Returns all menus, found in the menu bar, other menus and in removed menus list.

Implements IMenuCatalog.

void MenuCatalog::removeMenu ( const QString &  title )

virtual

Removes QMenu with title from the menu bar and stores it in its internal collection. The menu catalog takes ownership of the removed menu.

To remove menu item from the menu use QMenu::removeAction().

Implements IMenuCatalog.

QList<QMenu *> MenuCatalog::popups ( ) const

virtual

Returns all popups menus, registered in the catalog.

Implements IMenuCatalog.

bool MenuCatalog::eventFilter ( QObject *  obj, QEvent *  event  )

virtual

MenuCatalog installs itself as QObject's event filter to handle menus adding and removing.

Reimplemented from QObject.

QMenu* MenuCatalog::findMenu ( const QString &  title, QMenu *  inMenu  ) const

protected

Searches for the menu specified by title in the inMenu and its childer menus.

Returns

Found menu. Null, if there are no menus with such title.

virtual void MenuCatalog::onMenuAdded ( QMenu *  menu )

protectedvirtual

Emits a menuAdded() signal when menu is added to the main menu.

virtual void MenuCatalog::onMenuRemoved ( QMenu *  menu )

protectedvirtual

Emits a menuAdded() signal when menu is removed from the main menu.

virtual void MenuCatalog::onSubMenuAdded ( QMenu *  newMenu )

protectedvirtual

Emits a subMenuAdded() signal when specified menu is added to existed menu.

virtual void MenuCatalog::onSubMenuRemoved ( QMenu *  menu )

protectedvirtual

Emits a subMenuRemoved() signal when menu is removed from existed menu.