QPopupMenu Class Reference

The QPopupMenu class provides a popup menu widget. More...

#include <qpopupmenu.h>

Inherits QFrame and QMenuData.

List of all member functions.

Public Members

• QPopupMenu ( QWidget * parent=0, const char * name=0 ) 
• ~QPopupMenu () 
• void popup ( const QPoint & pos, int indexAtPoint = 0 ) 
• virtual void updateItem ( int id ) 
• virtual void setCheckable ( bool ) 
• bool isCheckable () const
• virtual void setFont ( const QFont & ) 
• virtual void show () 
• virtual void hide () 
• int exec () 
• int exec ( const QPoint & pos, int indexAtPoint = 0 ) 
• virtual void setActiveItem ( int ) 
• virtual QSize sizeHint () const
• int idAt ( int index ) const
• int idAt ( const QPoint & pos ) const
• virtual bool customWhatsThis () const

Signals

• void activated ( int itemId ) 
• void highlighted ( int itemId ) 
• void activatedRedirect ( int itemId ) 
• void highlightedRedirect ( int itemId ) 
• void aboutToShow () 

Protected Members

• int itemHeight ( int ) const
• int itemHeight ( QMenuItem * mi ) const
• void drawItem ( QPainter * p, int tab, QMenuItem * mi, bool act, int x, int y, int w, int h ) 
• virtual void drawContents ( QPainter * ) 
• virtual void closeEvent ( QCloseEvent * e ) 
• virtual void paintEvent ( QPaintEvent * ) 
• virtual void mousePressEvent ( QMouseEvent * ) 
• virtual void mouseReleaseEvent ( QMouseEvent * ) 
• virtual void mouseMoveEvent ( QMouseEvent * ) 
• virtual void keyPressEvent ( QKeyEvent * ) 
• virtual void timerEvent ( QTimerEvent * ) 
• virtual void styleChange ( QStyle & ) 

Detailed Description

menu/menu.cpp is a typical example of QMenuBar and QPopupMenu use.

See also: QMenuBar and GUI Design Handbook: Menu, Drop-Down and Pop-Up

Examples: qtimage/qtimage.cpp grapher/grapher.cpp mainlyQt/editor.cpp layout/layout.cpp menu/menu.cpp progress/progress.cpp scrollview/scrollview.cpp

Member Function Documentation

QPopupMenu::QPopupMenu ( QWidget * parent=0, const char * name=0 )

Constructs a popup menu with a parent and a widget name.

Although a popup menu is always a top level widget, if a parent is passed, the popup menu will be deleted on destruction of that parent (as with any other QObject).

QPopupMenu::~QPopupMenu ()

Destroys the popup menu.

void QPopupMenu::aboutToShow () [signal]

This signal is emitted just before the popup menu is displayed. You can connect it to any slot that sets up the menu contents (e.g. to ensure that the right items are enabled).

See also: setItemEnabled(), setItemChecked(), insertItem() and removeItem().

void QPopupMenu::activated ( int id ) [signal]

This signal is emitted when a menu item is selected; id is the id of the selected item.

Normally, you will connect each menu item to a single slot using QMenuData::insertItem(), but sometimes you will want to connect several items to a single slot (most often if the user selects from an array). This signal is handy in such cases.

See also: highlighted() and QMenuData::insertItem().

void QPopupMenu::activatedRedirect ( int id ) [signal]

For internal use only.

void QPopupMenu::closeEvent ( QCloseEvent * e ) [virtual protected]

Handles close events for the popup menu.

Reimplemented from QWidget.

bool QPopupMenu::customWhatsThis () const [virtual]

Reimplemented for internal reasons; the API is not affected.

Reimplemented from QWidget.

int QPopupMenu::exec ()

Execute this popup synchronously.

Similar to the above function, but the position of the popup is not set, so you must choose an appropriate position. The function move the popup if it is partially off-screen.

More common usage is to position the popup at the current mouse position:

      exec(QCursor::pos());

or aligned to a widget:

      exec(somewidget.mapToGlobal(QPoint(0,0)));

int QPopupMenu::exec ( const QPoint & pos, int indexAtPoint = 0 )

Execute this popup synchronously.

Opens the popup menu so that the item number indexAtPoint will be at the specified global position pos. To translate a widget's local coordinates into global coordinates, use QWidget::mapToGlobal().

The return code is the ID of the selected item in either the popup menu or one of its submenus, or -1 if no item is selected (normally because the user presses Escape).

Note that all signals are emitted as usual. If you connect a menu item to a slot and call the menu's exec(), you get the result both via the signal-slot connection and in the return value of exec().

Common usage is to position the popup at the current mouse position:

      exec(QCursor::pos());

or aligned to a widget:

      exec(somewidget.mapToGlobal(QPoint(0,0)));

When positioning a popup with exec() or popup(), keep in mind that you cannot rely on the popup menu's current size(). For performance reasons, the popup adapts its size only when actually needed. So in many cases, the size before and after the show is different. Instead, use sizeHint(). It calculates the proper size depending on the menu's current contents.

See also: popup() and sizeHint().

void QPopupMenu::hide () [virtual]

Reimplements QWidget::hide() for internal purposes.

Reimplemented from QWidget.

void QPopupMenu::highlighted ( int id ) [signal]

This signal is emitted when a menu item is highlighted; id is the id of the highlighted item.

Normally, you will connect each menu item to a single slot using QMenuData::insertItem(), but sometimes you will want to connect several items to a single slot (most often if the user selects from an array). This signal is handy in such cases.

See also: activated() and QMenuData::insertItem().

void QPopupMenu::highlightedRedirect ( int id ) [signal]

For internal use only.

int QPopupMenu::idAt ( const QPoint & pos ) const

Return the id of the item at pos, or -1 if there is no item there, or if it is a separator item.

int QPopupMenu::idAt ( int index ) const

Returns the identifier of the menu item at position index in the internal list, or -1 if index is out of range.

See also: QMenuData::setId() and QMenuData::indexOf().

Examples: scrollview/scrollview.cpp

bool QPopupMenu::isCheckable () const

Returns whether display of check marks by the menu items is enabled.

See also: setCheckable() and QMenuData::setItemChecked().

int QPopupMenu::itemHeight ( QMenuItem * mi ) const [protected]

Calculates the height in pixels of the item mi.

int QPopupMenu::itemHeight ( int row ) const [protected]

Calculates the height in pixels of the item in row row.

void QPopupMenu::keyPressEvent ( QKeyEvent * e ) [virtual protected]

Handles key press events for the popup menu.

Reimplemented from QWidget.

void QPopupMenu::mouseMoveEvent ( QMouseEvent * e ) [virtual protected]

Handles mouse move events for the popup menu.

Reimplemented from QWidget.

void QPopupMenu::mousePressEvent ( QMouseEvent * e ) [virtual protected]

Handles mouse press events for the popup menu.

Reimplemented from QWidget.

void QPopupMenu::mouseReleaseEvent ( QMouseEvent * e ) [virtual protected]

Handles mouse release events for the popup menu.

Reimplemented from QWidget.

void QPopupMenu::paintEvent ( QPaintEvent * e ) [virtual protected]

Handles paint events for the popup menu.

Reimplemented from QWidget.

void QPopupMenu::popup ( const QPoint & pos, int indexAtPoint = 0 )

Opens the popup menu so that the item number indexAtPoint will be at the specified global position pos. To translate a widget's local coordinates into global coordinates, use QWidget::mapToGlobal().

When positioning a popup with exec() or popup(), keep in mind that you cannot rely on the popup menu's current size(). For performance reasons, the popup adapts its size only when actually needed. So in many cases, the size before and after the show is different. Instead, use sizeHint(). It calculates the proper size depending on the menu's current contents.

Examples: qtimage/qtimage.cpp

void QPopupMenu::setActiveItem ( int i ) [virtual]

Sets the currently active item to i and repaints as necessary.

void QPopupMenu::setCheckable ( bool enable ) [virtual]

Enables or disables display of check marks by the menu items.

Notice that checking is always enabled when in windows-style.

See also: isCheckable() and QMenuData::setItemChecked().

Examples: grapher/grapher.cpp menu/menu.cpp progress/progress.cpp scrollview/scrollview.cpp

void QPopupMenu::setFont ( const QFont & font ) [virtual]

Reimplements QWidget::setFont() to be able to refresh the popup menu when its font changes.

Reimplemented from QWidget.

void QPopupMenu::show () [virtual]

Reimplements QWidget::show() for internal purposes.

Reimplemented from QWidget.

QSize QPopupMenu::sizeHint () const [virtual]

Returns the size the popupmenu would use shall it become visible now. (##### is that english??)

Note that this size may be different from the popup's actual size. It changes all the time a new item is added or an existing one is modified. For performance reasons, QPopupMenu doesn't change its physical size each time this happens but only once before it is shown.

See also: exec() and show().

Reimplemented from QWidget.

void QPopupMenu::styleChange ( QStyle & old ) [virtual protected]

Reimplemented for internal purposes.

Reimplemented from QWidget.

void QPopupMenu::timerEvent ( QTimerEvent * e ) [virtual protected]

Handles timer events for the popup menu.

Reimplemented from QObject.

Search the documentation, FAQ, qt-interest archive and more (uses www.troll.no):

This file is part of the Qt toolkit, copyright © 1995-99 Troll Tech, all rights reserved.