Carousel
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Pages
Signals | Public Member Functions | List of all members
IMenuCatalog Class Referenceabstract

The IMenuCatalog interface provides access to members that work on the collection of application menus. More...

#include <IMenuCatalog.h>

Inherits QObject.

Inherited by MenuCatalog.

Signals

void menuAdded (QMenu *menu)
 
void menuRemoved (QMenu *menu)
 
void subMenuAdded (QMenu *menu)
 
void subMenuRemoved (QMenu *menu)
 

Public Member Functions

virtual QMenuaddMenu (const QString &title)=0
 
virtual QMenuaddMenu (const QIcon &icon, const QString &title)=0
 
virtual QMenuaddPopup (const QString &title)=0
 
virtual QMenuaddPopup (const QIcon &icon, const QString &title)=0
 
virtual void deleteMenu (const QString &title)=0
 
virtual void deleteMenu (QMenu *menu)=0
 
virtual QMenufindMenu (const QString &title)=0
 
virtual const QMenufindMenu (const QString &title) const =0
 
virtual QMenufindMenuEverywhere (const QString &title)=0
 
virtual const QMenufindMenuEverywhere (const QString &title) const =0
 
virtual QMenufindPopup (const QString &title)=0
 
virtual const QMenufindPopup (const QString &title) const =0
 
virtual QList< QMenu * > menus () const =0
 
virtual QList< QMenu * > popups () const =0
 
virtual void removeMenu (const QString &title)=0
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
bool blockSignals (bool block)
 
QObjectchild (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< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
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 QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () 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)
 
QThreadthread () const
 

Additional Inherited Members

- 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)
 
- 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
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

The IMenuCatalog interface provides access to members that work on the collection of application menus.

IMenuCatalog knows about collection of all the menus available to an application. This interface 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.

Member Function Documentation

virtual QMenu* IMenuCatalog::addMenu ( const QString title)
pure 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();

Implemented in MenuCatalog.

virtual QMenu* IMenuCatalog::addMenu ( const QIcon icon,
const QString title 
)
pure 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.

Implemented in MenuCatalog.

virtual QMenu* IMenuCatalog::addPopup ( const QString title)
pure 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.

Implemented in MenuCatalog.

virtual QMenu* IMenuCatalog::addPopup ( const QIcon icon,
const QString title 
)
pure 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.

Implemented in MenuCatalog.

virtual void IMenuCatalog::deleteMenu ( const QString title)
pure 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().

Implemented in MenuCatalog.

virtual void IMenuCatalog::deleteMenu ( QMenu menu)
pure 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().

Implemented in MenuCatalog.

virtual QMenu* IMenuCatalog::findMenu ( const QString title)
pure 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.

Implemented in MenuCatalog.

virtual const QMenu* IMenuCatalog::findMenu ( const QString title) const
pure 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.

Implemented in MenuCatalog.

virtual QMenu* IMenuCatalog::findMenuEverywhere ( const QString title)
pure 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.

Implemented in MenuCatalog.

virtual const QMenu* IMenuCatalog::findMenuEverywhere ( const QString title) const
pure 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.

Implemented in MenuCatalog.

virtual QMenu* IMenuCatalog::findPopup ( const QString title)
pure virtual

Searches for the popup menu specified by title.

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

Implemented in MenuCatalog.

virtual const QMenu* IMenuCatalog::findPopup ( const QString title) const
pure virtual

Searches for the popup menu specified by title.

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

Implemented in MenuCatalog.

virtual QList<QMenu *> IMenuCatalog::menus ( ) const
pure virtual

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

Implemented in MenuCatalog.

virtual void IMenuCatalog::removeMenu ( const QString title)
pure 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().

Implemented in MenuCatalog.

virtual QList<QMenu *> IMenuCatalog::popups ( ) const
pure virtual

Returns all popups menus, registered in the catalog.

Implemented in MenuCatalog.

void IMenuCatalog::menuAdded ( QMenu menu)
signal

This signal is emitted after menu was added to the main menu.

See Also
addMenu.
void IMenuCatalog::menuRemoved ( QMenu menu)
signal

This signal is emitted after menu was removed from the main menu.

See Also
removeMenu.
void IMenuCatalog::subMenuAdded ( QMenu menu)
signal

This signal is emitted after menu was added to the existed menus as submenu.

See Also
QMenu::addMenu(), addPopup.
void IMenuCatalog::subMenuRemoved ( QMenu menu)
signal

This signal is emitted after menu was removed from the existed added menus.

See Also
QWidget::removeAction().