Update copyright headers
[qt:qt.git] / doc / src / howtos / accelerators.qdoc
1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the documentation of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:FDL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/contact-us.
16 **
17 ** GNU Free Documentation License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Free
19 ** Documentation License version 1.3 as published by the Free Software
20 ** Foundation and appearing in the file included in the packaging of
21 ** this file.  Please review the following information to ensure
22 ** the GNU Free Documentation License version 1.3 requirements
23 ** will be met: http://www.gnu.org/copyleft/fdl.html.
24 ** $QT_END_LICENSE$
25 **
26 ****************************************************************************/
27
28 /*!
29     \page accelerators.html
30     \title Standard Accelerator Keys
31     \brief Recommended accelerator keys.
32
33     \ingroup best-practices
34
35     Applications invariably need to define accelerator keys for actions.
36     Qt fully supports accelerators, for example with \l Q3Accel::shortcutKey().
37
38     Here are Microsoft's recommendations for accelerator keys, with
39     comments about the Open Group's recommendations where they exist
40     and differ. For most commands, the Open Group either has no advice or
41     agrees with Microsoft.
42
43     The emboldened letter plus Alt is Microsoft's recommended choice, and
44     we recommend supporting it. For an Apply button, for example, we
45     recommend QAbstractButton::setText(\link QWidget::tr() tr \endlink("&Apply"));
46
47     If you have conflicting commands (e.g. About and Apply buttons in the
48     same dialog), you must decide for yourself.
49
50     \list
51     \i \bold{\underline{A}}bout
52     \i Always on \bold{\underline{T}}op
53     \i \bold{\underline{A}}pply
54     \i \bold{\underline{B}}ack
55     \i \bold{\underline{B}}rowse
56     \i \bold{\underline{C}}lose (CDE: Alt+F4; Alt+F4 is "close window" in Windows)
57     \i \bold{\underline{C}}opy (CDE: Ctrl+C, Ctrl+Insert)
58     \i \bold{\underline{C}}opy Here
59     \i Create \bold{\underline{S}}hortcut
60     \i Create \bold{\underline{S}}hortcut Here
61     \i Cu\bold{\underline{t}}
62     \i \bold{\underline{D}}elete
63     \i \bold{\underline{E}}dit
64     \i \bold{\underline{E}}xit (CDE: E\bold{\underline{x}}it)
65     \i \bold{\underline{E}}xplore
66     \i \bold{\underline{F}}ile
67     \i \bold{\underline{F}}ind
68     \i \bold{\underline{H}}elp
69     \i Help \bold{\underline{T}}opics
70     \i \bold{\underline{H}}ide
71     \i \bold{\underline{I}}nsert
72     \i Insert \bold{\underline{O}}bject
73     \i \bold{\underline{L}}ink Here
74     \i Ma\bold{\underline{x}}imize
75     \i Mi\bold{\underline{n}}imize
76     \i \bold{\underline{M}}ove
77     \i \bold{\underline{M}}ove Here
78     \i \bold{\underline{N}}ew
79     \i \bold{\underline{N}}ext
80     \i \bold{\underline{N}}o
81     \i \bold{\underline{O}}pen
82     \i Open \bold{\underline{W}}ith
83     \i Page Set\bold{\underline{u}}p
84     \i \bold{\underline{P}}aste
85     \i Paste \bold{\underline{L}}ink
86     \i Paste \bold{\underline{S}}hortcut
87     \i Paste \bold{\underline{S}}pecial
88     \i \bold{\underline{P}}ause
89     \i \bold{\underline{P}}lay
90     \i \bold{\underline{P}}rint
91     \i \bold{\underline{P}}rint Here
92     \i P\bold{\underline{r}}operties
93     \i \bold{\underline{Q}}uick View
94     \i \bold{\underline{R}}edo (CDE: Ctrl+Y, Shift+Alt+Backspace)
95     \i \bold{\underline{R}}epeat
96     \i \bold{\underline{R}}estore
97     \i \bold{\underline{R}}esume
98     \i \bold{\underline{R}}etry
99     \i \bold{\underline{R}}un
100     \i \bold{\underline{S}}ave
101     \i Save \bold{\underline{A}}s
102     \i Select \bold{\underline{A}}ll
103     \i Se\bold{\underline{n}}d To
104     \i \bold{\underline{S}}how
105     \i \bold{\underline{S}}ize
106     \i S\bold{\underline{p}}lit
107     \i \bold{\underline{S}}top
108     \i \bold{\underline{U}}ndo (CDE: Ctrl+Z or Alt+Backspace)
109     \i \bold{\underline{V}}iew
110     \i \bold{\underline{W}}hat's This?
111     \i \bold{\underline{W}}indow
112     \i \bold{\underline{Y}}es
113     \endlist
114
115     There are also a lot of other keys and actions (that use other
116     modifier keys than Alt). See the Microsoft and The Open Group
117     documentation for details.
118
119     The
120     \l{http://www.amazon.com/exec/obidos/ASIN/0735605661/trolltech/t}{Microsoft book}
121     has ISBN 0735605661. The corresponding Open Group
122     book is very hard to find, rather expensive and we cannot recommend
123     it. However, if you really want it, ogpubs@opengroup.org might be able
124     to help. Ask them for ISBN 1859121047.
125 */