Unix/Linux Go Back    


CentOS 7.0 - man page for qmenubar (centos section 3qt)

Linux & Unix Commands - Search Man Pages
Man Page or Keyword Search:   man
Select Man Page Set:       apropos Keyword Search (sections above)


QMenuBar(3qt)									    QMenuBar(3qt)

NAME
       QMenuBar - Horizontal menu bar

SYNOPSIS
       #include <qmenubar.h>

       Inherits QFrame and QMenuData.

   Public Members
       QMenuBar ( QWidget * parent = 0, const char * name = 0 )
       ~QMenuBar ()
       virtual void show ()
       virtual void hide ()
       virtual int heightForWidth ( int max_width ) const
       enum Separator { Never = 0, InWindowsStyle = 1 }
       Separator separator () const  (obsolete)
       virtual void setSeparator ( Separator when )  (obsolete)
       void setDefaultUp ( bool )
       bool isDefaultUp () const

   Signals
       void activated ( int id )
       void highlighted ( int id )

   Important Inherited Members
       int insertItem ( const QString & text, const QObject * receiver, const char * member,
	   const QKeySequence & accel = 0, int id = -1, int index = -1 )
       int insertItem ( const QIconSet & icon, const QString & text, const QObject * receiver,
	   const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )
       int insertItem ( const QPixmap & pixmap, const QObject * receiver, const char * member,
	   const QKeySequence & accel = 0, int id = -1, int index = -1 )
       int insertItem ( const QIconSet & icon, const QPixmap & pixmap, const QObject * receiver,
	   const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )
       int insertItem ( const QString & text, int id = -1, int index = -1 )
       int insertItem ( const QIconSet & icon, const QString & text, int id = -1, int index = -1
	   )
       int insertItem ( const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )
       int insertItem ( const QIconSet & icon, const QString & text, QPopupMenu * popup, int id =
	   -1, int index = -1 )
       int insertItem ( const QPixmap & pixmap, int id = -1, int index = -1 )
       int insertItem ( const QIconSet & icon, const QPixmap & pixmap, int id = -1, int index =
	   -1 )
       int insertItem ( const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )
       int insertItem ( const QIconSet & icon, const QPixmap & pixmap, QPopupMenu * popup, int id
	   = -1, int index = -1 )
       int insertItem ( QWidget * widget, int id = -1, int index = -1 )
       int insertItem ( const QIconSet & icon, QCustomMenuItem * custom, int id = -1, int index =
	   -1 )
       int insertItem ( QCustomMenuItem * custom, int id = -1, int index = -1 )
       int insertSeparator ( int index = -1 )
       void removeItem ( int id )
       void clear ()
       bool isItemEnabled ( int id ) const
       void setItemEnabled ( int id, bool enable )
       bool isItemVisible ( int id ) const
       void setItemVisible ( int id, bool visible )

   Properties
       bool defaultUp - the popup orientation
       Separator separator - in which cases a menubar sparator is drawn  (obsolete)

   Protected Members
       virtual void drawContents ( QPainter * p )
       virtual void menuContentsChanged ()
       virtual void menuStateChanged ()

DESCRIPTION
       The QMenuBar class provides a horizontal menu bar.

       A menu bar consists of a list of pull-down menu items. You add menu items with
       insertItem(). For example, asuming that menubar is a pointer to a QMenuBar and filemenu is
       a pointer to a QPopupMenu, the following statement inserts the menu into the menu bar:

	   menubar->insertItem( "&File", filemenu );
       The ampersand in the menu item's text sets Alt+F as a shortcut for this menu. (You can use
       "&&" to get a real ampersand in the menu bar.)

       Items are either enabled or disabled. You toggle their state with setItemEnabled().

       There is no need to lay out a menu bar. It automatically sets its own geometry to the top
       of the parent widget and changes it appropriately whenever the parent is resized.

       Example of creating a menu bar with menu items (from menu/menu.cpp):

	       QPopupMenu *file = new QPopupMenu( this );

	       file->insertItem( p1, "&Open",  this, SLOT(open()), CTRL+Key_O );
	       file->insertItem( p2, "&New", this, SLOT(news()), CTRL+Key_N );

	       menu = new QMenuBar( this );

	       menu->insertItem( "&File", file );

       In most main window style applications you would use the menuBar() provided in
       QMainWindow, adding QPopupMenus to the menu bar and adding QActions to the popup menus.

       Example (from action/application.cpp):

	       QPopupMenu * file = new QPopupMenu( this );
	       menuBar()->insertItem( "&File", file );
	       fileNewAction->addTo( file );

       Menu items can have text and pixmaps (or iconsets), see the various insertItem()
       overloads, as well as separators, see insertSeparator(). You can also add custom menu
       items that are derived from QCustomMenuItem.

       Menu items may be removed with removeItem() and enabled or disabled with setItemEnabled().

					    [Image Omitted]

					    [Image Omitted]

QMenuBar on Qt/Mac
       QMenuBar on Qt/Mac is a wrapper for using the system-wide menubar. If you have multiple
       menubars in one dialog the outermost menubar (normally inside a widget with widget flag
       WType_TopLevel) will be used for the system-wide menubar.

       Note that arbitrary Qt widgets cannot be inserted into a QMenuBar on the Mac because Qt
       uses Mac's native menus which don't support this functionality. This limitation does not
       apply to stand-alone QPopupMenus.

       Qt/Mac also provides a menubar merging feature to make QMenuBar conform more closely to
       accepted Mac OS X menubar layout. The merging functionality is based on string matching
       the title of a QPopupMenu entry. These strings are translated (using QObject::tr()) in the
       "QMenuBar" context. If an entry is moved its slots will still fire as if it was in the
       original place. The table below outlines the strings looked for and where the entry is
       placed if matched:

       <center>.nf

       </center>

       menu/menu.cpp is an example of QMenuBar and QPopupMenu use.

       See also QPopupMenu, QAccel, QAction, Aqua Style Guidelines, GUI Design Handbook: Menu
       Bar, and Main Window and Related Classes.

   Member Type Documentation
QMenuBar::Separator
       This enum type is used to decide whether QMenuBar should draw a separator line at its
       bottom.

       QMenuBar::Never - In many applications there is already a separator, and having two looks
       wrong.

       QMenuBar::InWindowsStyle - In some other applications a separator looks good in Windows
       style, but nowhere else.

MEMBER FUNCTION DOCUMENTATION
QMenuBar::QMenuBar ( QWidget * parent = 0, const char * name = 0 )
       Constructs a menu bar called name with parent parent.

QMenuBar::~QMenuBar ()
       Destroys the menu bar.

void QMenuBar::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 useful in such cases.

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

       Example: progress/progress.cpp.

void QMenuData::clear ()
       Removes all menu items.

       See also removeItem() and removeItemAt().

       Examples:

void QMenuBar::drawContents ( QPainter * p ) [virtual protected]
       Called from QFrame::paintEvent(). Draws the menu bar contents using painter p.

       Reimplemented from QFrame.

int QMenuBar::heightForWidth ( int max_width ) const [virtual]
       Returns the height that the menu would resize itself to if its parent (and hence itself)
       resized to the given max_width. This can be useful for simple layout tasks in which the
       height of the menu bar is needed after items have been inserted. See showimg/showimg.cpp
       for an example of the usage.

       Example: showimg/showimg.cpp.

       Reimplemented from QWidget.

void QMenuBar::hide () [virtual]
       Reimplements QWidget::hide() in order to deselect any selected item, and calls
       setUpLayout() for the main window.

       Example: grapher/grapher.cpp.

       Reimplemented from QWidget.

void QMenuBar::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 useful in such cases.

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

int QMenuData::insertItem ( const QString & text, const QObject * receiver, const char * member,
       const QKeySequence & accel = 0, int id = -1, int index = -1 )
       The family of insertItem() functions inserts menu items into a popup menu or a menu bar.

       A menu item is usually either a text string or a pixmap, both with an optional icon or
       keyboard accelerator. For special cases it is also possible to insert custom items (see
       QCustomMenuItem) or even widgets into popup menus.

       Some insertItem() members take a popup menu as an additional argument. Use this to insert
       submenus into existing menus or pulldown menus into a menu bar.

       The number of insert functions may look confusing, but they are actually quite simple to
       use.

       This default version inserts a menu item with the text text, the accelerator key accel, an
       id and an optional index and connects it to the slot member in the object receiver.

       Example:

	       QMenuBar   *mainMenu = new QMenuBar;
	       QPopupMenu *fileMenu = new QPopupMenu;
	       fileMenu->insertItem( "New",  myView, SLOT(newFile()), CTRL+Key_N );
	       fileMenu->insertItem( "Open", myView, SLOT(open()),    CTRL+Key_O );
	       mainMenu->insertItem( "File", fileMenu );

       Not all insert functions take an object/slot parameter or an accelerator key. Use
       connectItem() and setAccel() on those items.

       If you need to translate accelerators, use tr() with the text and accelerator. (For
       translations use a string key sequence.):

	       fileMenu->insertItem( tr("Open"), myView, SLOT(open()),
				     tr("Ctrl+O") );

       In the example above, pressing Ctrl+O or selecting "Open" from the menu activates the
       myView->open() function.

       Some insert functions take a QIconSet parameter to specify the little menu item icon. Note
       that you can always pass a QPixmap object instead.

       The id specifies the identification number associated with the menu item. Note that only
       positive values are valid, as a negative value will make Qt select a unique id for the
       item.

       The index specifies the position in the menu. The menu item is appended at the end of the
       list if index is negative.

       Note that keyboard accelerators in Qt are not application-global, instead they are bound
       to a certain top-level window. For example, accelerators in QPopupMenu items only work for
       menus that are associated with a certain window. This is true for popup menus that live in
       a menu bar since their accelerators will then be installed in the menu bar itself. This
       also applies to stand-alone popup menus that have a top-level widget in their
       parentWidget() chain. The menu will then install its accelerator object on that top-level
       widget. For all other cases use an independent QAccel object.

       Warning: Be careful when passing a literal 0 to insertItem() because some C++ compilers
       choose the wrong overloaded function. Cast the 0 to what you mean, e.g. (QObject*)0.

       Warning: On Mac OS X, items that connect to a slot that are inserted into a menubar will
       not function as we use the native menubar that knows nothing about signals or slots.
       Instead insert the items into a popup menu and insert the popup menu into the menubar.
       This may be fixed in a future Qt version.

       Returns the allocated menu identifier number (id if id >= 0).

       See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and qnamespace.h.

       Examples:

int QMenuData::insertItem ( const QIconSet & icon, const QString & text, const QObject *
       receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1
       )
       This is an overloaded member function, provided for convenience. It behaves essentially
       like the above function.

       Inserts a menu item with icon icon, text text, accelerator accel, optional id id, and
       optional index position. The menu item is connected it to the receiver's member slot. The
       icon will be displayed to the left of the text in the item.

       Returns the allocated menu identifier number (id if id >= 0).

       See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and qnamespace.h.

int QMenuData::insertItem ( const QPixmap & pixmap, const QObject * receiver, const char *
       member, const QKeySequence & accel = 0, int id = -1, int index = -1 )
       This is an overloaded member function, provided for convenience. It behaves essentially
       like the above function.

       Inserts a menu item with pixmap pixmap, accelerator accel, optional id id, and optional
       index position. The menu item is connected it to the receiver's member slot. The icon will
       be displayed to the left of the text in the item.

       To look best when being highlighted as a menu item, the pixmap should provide a mask (see
       QPixmap::mask()).

       Returns the allocated menu identifier number (id if id >= 0).

       See also removeItem(), changeItem(), setAccel(), and connectItem().

int QMenuData::insertItem ( const QIconSet & icon, const QPixmap & pixmap, const QObject *
       receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1
       )
       This is an overloaded member function, provided for convenience. It behaves essentially
       like the above function.

       Inserts a menu item with icon icon, pixmap pixmap, accelerator accel, optional id id, and
       optional index position. The icon will be displayed to the left of the pixmap in the item.
       The item is connected to the member slot in the receiver object.

       To look best when being highlighted as a menu item, the pixmap should provide a mask (see
       QPixmap::mask()).

       Returns the allocated menu identifier number (id if id >= 0).

       See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and qnamespace.h.

int QMenuData::insertItem ( const QString & text, int id = -1, int index = -1 )
       This is an overloaded member function, provided for convenience. It behaves essentially
       like the above function.

       Inserts a menu item with text text, optional id id, and optional index position.

       Returns the allocated menu identifier number (id if id >= 0).

       See also removeItem(), changeItem(), setAccel(), and connectItem().

int QMenuData::insertItem ( const QIconSet & icon, const QString & text, int id = -1, int index =
       -1 )
       This is an overloaded member function, provided for convenience. It behaves essentially
       like the above function.

       Inserts a menu item with icon icon, text text, optional id id, and optional index
       position. The icon will be displayed to the left of the text in the item.

       Returns the allocated menu identifier number (id if id >= 0).

       See also removeItem(), changeItem(), setAccel(), and connectItem().

int QMenuData::insertItem ( const QString & text, QPopupMenu * popup, int id = -1, int index = -1
       )
       This is an overloaded member function, provided for convenience. It behaves essentially
       like the above function.

       Inserts a menu item with text text, submenu popup, optional id id, and optional index
       position.

       The popup must be deleted by the programmer or by its parent widget. It is not deleted
       when this menu item is removed or when the menu is deleted.

       Returns the allocated menu identifier number (id if id >= 0).

       See also removeItem(), changeItem(), setAccel(), and connectItem().

int QMenuData::insertItem ( const QIconSet & icon, const QString & text, QPopupMenu * popup, int
       id = -1, int index = -1 )
       This is an overloaded member function, provided for convenience. It behaves essentially
       like the above function.

       Inserts a menu item with icon icon, text text, submenu popup, optional id id, and optional
       index position. The icon will be displayed to the left of the text in the item.

       The popup must be deleted by the programmer or by its parent widget. It is not deleted
       when this menu item is removed or when the menu is deleted.

       Returns the allocated menu identifier number (id if id >= 0).

       See also removeItem(), changeItem(), setAccel(), and connectItem().

int QMenuData::insertItem ( const QPixmap & pixmap, int id = -1, int index = -1 )
       This is an overloaded member function, provided for convenience. It behaves essentially
       like the above function.

       Inserts a menu item with pixmap pixmap, optional id id, and optional index position.

       To look best when being highlighted as a menu item, the pixmap should provide a mask (see
       QPixmap::mask()).

       Returns the allocated menu identifier number (id if id >= 0).

       See also removeItem(), changeItem(), setAccel(), and connectItem().

int QMenuData::insertItem ( const QIconSet & icon, const QPixmap & pixmap, int id = -1, int index
       = -1 )
       This is an overloaded member function, provided for convenience. It behaves essentially
       like the above function.

       Inserts a menu item with icon icon, pixmap pixmap, optional id id, and optional index
       position. The icon will be displayed to the left of the pixmap in the item.

       Returns the allocated menu identifier number (id if id >= 0).

       See also removeItem(), changeItem(), setAccel(), and connectItem().

int QMenuData::insertItem ( const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index =
       -1 )
       This is an overloaded member function, provided for convenience. It behaves essentially
       like the above function.

       Inserts a menu item with pixmap pixmap, submenu popup, optional id id, and optional index
       position.

       The popup must be deleted by the programmer or by its parent widget. It is not deleted
       when this menu item is removed or when the menu is deleted.

       Returns the allocated menu identifier number (id if id >= 0).

       See also removeItem(), changeItem(), setAccel(), and connectItem().

int QMenuData::insertItem ( const QIconSet & icon, const QPixmap & pixmap, QPopupMenu * popup,
       int id = -1, int index = -1 )
       This is an overloaded member function, provided for convenience. It behaves essentially
       like the above function.

       Inserts a menu item with icon icon, pixmap pixmap submenu popup, optional id id, and
       optional index position. The icon will be displayed to the left of the pixmap in the item.

       The popup must be deleted by the programmer or by its parent widget. It is not deleted
       when this menu item is removed or when the menu is deleted.

       Returns the allocated menu identifier number (id if id >= 0).

       See also removeItem(), changeItem(), setAccel(), and connectItem().

int QMenuData::insertItem ( QWidget * widget, int id = -1, int index = -1 )
       This is an overloaded member function, provided for convenience. It behaves essentially
       like the above function.

       Inserts a menu item that consists of the widget widget with optional id id, and optional
       index position.

       Ownership of widget is transferred to the popup menu or to the menu bar.

       Theoretically, any widget can be inserted into a popup menu. In practice, this only makes
       sense with certain widgets.

       If a widget is not focus-enabled (see QWidget::isFocusEnabled()), the menu treats it as a
       separator; this means that the item is not selectable and will never get focus. In this
       way you can, for example, simply insert a QLabel if you need a popup menu with a title.

       If the widget is focus-enabled it will get focus when the user traverses the popup menu
       with the arrow keys. If the widget does not accept ArrowUp and ArrowDown in its key event
       handler, the focus will move back to the menu when the respective arrow key is hit one
       more time. This works with a QLineEdit, for example. If the widget accepts the arrow key
       itself, it must also provide the possibility to put the focus back on the menu again by
       calling QWidget::focusNextPrevChild(). Futhermore, if the embedded widget closes the menu
       when the user made a selection, this can be done safely by calling:

	       if ( isVisible() &&
		    parentWidget() &&
		    parentWidget()->inherits("QPopupMenu") )
		   parentWidget()->close();

       Returns the allocated menu identifier number (id if id >= 0).

       See also removeItem().

int QMenuData::insertItem ( const QIconSet & icon, QCustomMenuItem * custom, int id = -1, int
       index = -1 )
       This is an overloaded member function, provided for convenience. It behaves essentially
       like the above function.

       Inserts a custom menu item custom with an icon and with optional id id, and optional index
       position.

       This only works with popup menus. It is not supported for menu bars. Ownership of custom
       is transferred to the popup menu.

       If you want to connect a custom item to a slot, use connectItem().

       Returns the allocated menu identifier number (id if id >= 0).

       See also connectItem(), removeItem(), and QCustomMenuItem.

int QMenuData::insertItem ( QCustomMenuItem * custom, int id = -1, int index = -1 )
       This is an overloaded member function, provided for convenience. It behaves essentially
       like the above function.

       Inserts a custom menu item custom with optional id id, and optional index position.

       This only works with popup menus. It is not supported for menu bars. Ownership of custom
       is transferred to the popup menu.

       If you want to connect a custom item to a slot, use connectItem().

       Returns the allocated menu identifier number (id if id >= 0).

       See also connectItem(), removeItem(), and QCustomMenuItem.

int QMenuData::insertSeparator ( int index = -1 )
       Inserts a separator at position index, and returns the menu identifier number allocated to
       it. The separator becomes the last menu item if index is negative.

       In a popup menu a separator is rendered as a horizontal line. In a Motif menu bar a
       separator is spacing, so the rest of the items (normally just "Help") are drawn right-
       justified. In a Windows menu bar separators are ignored (to comply with the Windows style
       guidelines).

       Examples:

bool QMenuBar::isDefaultUp () const
       Returns the popup orientation. See the "defaultUp" property for details.

bool QMenuData::isItemEnabled ( int id ) const
       Returns TRUE if the item with identifier id is enabled; otherwise returns FALSE

       See also setItemEnabled() and isItemVisible().

bool QMenuData::isItemVisible ( int id ) const
       Returns TRUE if the menu item with the id id is visible; otherwise returns FALSE.

       See also setItemVisible().

void QMenuBar::menuContentsChanged () [virtual protected]
       Recomputes the menu bar's display data according to the new contents.

       You should never need to call this; it is called automatically by QMenuData whenever it
       needs to be called.

       Reimplemented from QMenuData.

void QMenuBar::menuStateChanged () [virtual protected]
       Recomputes the menu bar's display data according to the new state.

       You should never need to call this; it is called automatically by QMenuData whenever it
       needs to be called.

       Reimplemented from QMenuData.

void QMenuData::removeItem ( int id )
       Removes the menu item that has the identifier id.

       See also removeItemAt() and clear().

       Example: chart/chartform.cpp.

Separator QMenuBar::separator () const
       Returns in which cases a menubar sparator is drawn. See the "separator" property for
       details.

void QMenuBar::setDefaultUp ( bool )
       Sets the popup orientation. See the "defaultUp" property for details.

void QMenuData::setItemEnabled ( int id, bool enable )
       If enable is TRUE, enables the menu item with identifier id; otherwise disables the menu
       item with identifier id.

       See also isItemEnabled().

       Examples:

void QMenuData::setItemVisible ( int id, bool visible )
       If visible is TRUE, shows the menu item with id id; otherwise hides the menu item with id
       id.

       See also isItemVisible() and isItemEnabled().

void QMenuBar::setSeparator ( Separator when ) [virtual]
       Sets in which cases a menubar sparator is drawn to when. See the "separator" property for
       details.

void QMenuBar::show () [virtual]
       Reimplements QWidget::show() in order to set up the correct keyboard accelerators and to
       raise itself to the top of the widget stack.

       Example: grapher/grapher.cpp.

       Reimplemented from QWidget.

   Property Documentation
bool defaultUp
       This property holds the popup orientation.

       The default popup orientation. By default, menus pop "down" the screen. By setting the
       property to TRUE, the menu will pop "up". You might call this for menus that are below the
       document to which they refer.

       If the menu would not fit on the screen, the other direction is used automatically.

       Set this property's value with setDefaultUp() and get this property's value with
       isDefaultUp().

Separator separator
       This property holds in which cases a menubar sparator is drawn.

       This property is obsolete. It is provided to keep old source working. We strongly advise
       against using it in new code.

       Set this property's value with setSeparator() and get this property's value with
       separator().

SEE ALSO
       http://doc.trolltech.com/qmenubar.html http://www.trolltech.com/faq/tech.html

COPYRIGHT
       Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com.  See the license file
       included in the distribution for a complete license statement.

AUTHOR
       Generated automatically from the source code.

BUGS
       If you find a bug in Qt, please report it as described in
       http://doc.trolltech.com/bughowto.html.	Good bug reports help us to help you. Thank you.

       The definitive Qt documentation is provided in HTML format; it is located at
       $QTDIR/doc/html and can be read using Qt Assistant or with a web browser. This man page is
       provided as a convenience for those users who prefer man pages, although this format is
       not officially supported by Trolltech.

       If you find errors in this manual page, please report them to qt-bugs@trolltech.com.
       Please include the name of the manual page (qmenubar.3qt) and the Qt version (3.3.8).

Trolltech AS				 2 February 2007			    QMenuBar(3qt)
Unix & Linux Commands & Man Pages : ©2000 - 2018 Unix and Linux Forums


All times are GMT -4. The time now is 11:19 AM.