source: trunk/doc/src/examples/menus.qdoc@ 1168

Last change on this file since 1168 was 846, checked in by Dmitry A. Kuminov, 14 years ago

trunk: Merged in qt 4.7.2 sources from branches/vendor/nokia/qt.

File size: 9.4 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4** All rights reserved.
5** Contact: Nokia Corporation ([email protected])
6**
7** This file is part of the documentation of the Qt Toolkit.
8**
9** $QT_BEGIN_LICENSE:FDL$
10** Commercial Usage
11** Licensees holding valid Qt Commercial licenses may use this file in
12** accordance with the Qt Commercial License Agreement provided with the
13** Software or, alternatively, in accordance with the terms contained in a
14** written agreement between you and Nokia.
15**
16** GNU Free Documentation License
17** Alternatively, this file may be used under the terms of the GNU Free
18** Documentation License version 1.3 as published by the Free Software
19** Foundation and appearing in the file included in the packaging of this
20** file.
21**
22** If you have questions regarding the use of this file, please contact
23** Nokia at [email protected].
24** $QT_END_LICENSE$
25**
26****************************************************************************/
27
28/*!
29 \example mainwindows/menus
30 \title Menus Example
31
32 The Menus example demonstrates how menus can be used in a main
33 window application.
34
35 A menu widget can be either a pull-down menu in a menu bar or a
36 standalone context menu. Pull-down menus are shown by the menu bar
37 when the user clicks on the respective item or presses the
38 specified shortcut key. Context menus are usually invoked by some
39 special keyboard key or by right-clicking.
40
41 \image menus-example.png
42
43 A menu consists of a list of \e action items. In applications,
44 many common commands can be invoked via menus, toolbar buttons as
45 well as keyboard shortcuts. Since the user expects the commands to
46 be performed in the same way, regardless of the user interface
47 used, it is useful to represent each command as an action.
48
49 The Menus example consists of one single class, \c MainWindow, derived
50 from the QMainWindow class. When choosing one of the
51 action items in our application, it will display the item's path
52 in its central widget.
53
54 \section1 MainWindow Class Definition
55