|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
4 ** All rights reserved. |
|
5 ** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 ** |
|
7 ** This file is part of the documentation of the Qt Toolkit. |
|
8 ** |
|
9 ** $QT_BEGIN_LICENSE:LGPL$ |
|
10 ** No Commercial Usage |
|
11 ** This file contains pre-release code and may not be distributed. |
|
12 ** You may use this file in accordance with the terms and conditions |
|
13 ** contained in the Technology Preview License Agreement accompanying |
|
14 ** this package. |
|
15 ** |
|
16 ** GNU Lesser General Public License Usage |
|
17 ** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 ** General Public License version 2.1 as published by the Free Software |
|
19 ** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 ** packaging of this file. Please review the following information to |
|
21 ** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 ** |
|
24 ** In addition, as a special exception, Nokia gives you certain additional |
|
25 ** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 ** |
|
28 ** If you have questions regarding the use of this file, please contact |
|
29 ** Nokia at qt-info@nokia.com. |
|
30 ** |
|
31 ** |
|
32 ** |
|
33 ** |
|
34 ** |
|
35 ** |
|
36 ** |
|
37 ** |
|
38 ** $QT_END_LICENSE$ |
|
39 ** |
|
40 ****************************************************************************/ |
|
41 |
|
42 /*! |
|
43 \page exportedfunctions.html |
|
44 \title Platform-Specific Functions |
|
45 \ingroup funclists |
|
46 |
|
47 \brief Exported functions for fine tuning Qt applications. |
|
48 |
|
49 Qt provides a few low-level global functions for fine-tuning |
|
50 applications. Most of these perform very specific tasks and are |
|
51 platform-specific. In general, we recommend that you try using |
|
52 Qt's public API before resorting to using any functions mentioned |
|
53 here. |
|
54 |
|
55 These functions are exported by \l QtCore and \l QtGui, but most |
|
56 of them aren't declared in Qt's header files. To use them in your |
|
57 application, you must declare them before calling them. For |
|
58 example: |
|
59 |
|
60 \snippet doc/src/snippets/code/doc_src_exportedfunctions.qdoc 0 |
|
61 |
|
62 These functions will remain as part of Qt for the lifetime of Qt |
|
63 4. |
|
64 |
|
65 Functions: |
|
66 |
|
67 \tableofcontents |
|
68 |
|
69 \section1 void qt_set_library_config_file(const QString &\e{fileName}) |
|
70 |
|
71 Specifies the location of the Qt configuration file. You must |
|
72 call this function before constructing a QApplication or |
|
73 QCoreApplication object. If no location is specified, Qt |
|
74 automatically finds an appropriate location. |
|
75 |
|
76 \section1 void qt_set_sequence_auto_mnemonic(bool \e{enable}) |
|
77 |
|
78 Specifies whether mnemonics for menu items, labels, etc., should |
|
79 be honored or not. On Windows and X11, this feature is |
|
80 on by default; on Mac OS X, it is off. When this feature is off, |
|
81 the QKeySequence::mnemonic() function always returns an empty |
|
82 string. This feature is also enabled on embedded Linux. |
|
83 |
|
84 \section1 void qt_x11_wait_for_window_manager(QWidget *\e{widget}) |
|
85 |
|
86 Blocks until the X11 window manager has shown the widget after a |
|
87 call to QWidget::show(). |
|
88 |
|
89 \section1 void qt_mac_secure_keyboard(bool \e{enable}) |
|
90 |
|
91 Turns the Mac OS X secure keyboard feature on or off. QLineEdit |
|
92 uses this when the echo mode is QLineEdit::Password or |
|
93 QLineEdit::NoEcho to guard the editor against keyboard sniffing. |
|
94 If you implement your own password editor, you might want to turn |
|
95 on this feature in your editor's |
|
96 \l{QWidget::focusInEvent()}{focusInEvent()} and turn it off in |
|
97 \l{QWidget::focusOutEvent()}{focusOutEvent()}. |
|
98 |
|
99 \section1 void qt_mac_set_dock_menu(QMenu *\e{menu}) |
|
100 |
|
101 Sets the menu to display in the Mac OS X Dock for the |
|
102 application. This menu is shown when the user attempts a |
|
103 press-and-hold operation on the application's dock icon or |
|
104 \key{Ctrl}-clicks on it while the application is running. |
|
105 |
|
106 The menu will be turned into a Mac menu and the items added to the default |
|
107 Dock menu. There is no merging of the Qt menu items with the items that are |
|
108 in the Dock menu (i.e., it is not recommended to include actions that |
|
109 duplicate functionality of items already in the Dock menu). |
|
110 |
|
111 \section1 void qt_mac_set_menubar_icons(bool \e{enable}) |
|
112 |
|
113 Specifies whether icons associated to menu items for the |
|
114 application's menu bar should be shown on Mac OS X. By default, |
|
115 icons are shown on Mac OS X just like on the other platforms. |
|
116 |
|
117 In Qt 4.4, this is equivalent to |
|
118 \c { QApplication::instance()->setAttribute(Qt::AA_DontShowIconsInMenus); }. |
|
119 |
|
120 \section1 void qt_mac_set_menubar_merge(bool \e{enable}) |
|
121 |
|
122 Specifies whether Qt should attempt to relocate standard menu |
|
123 items (such as \gui Quit, \gui Preferences, and \gui About) to |
|
124 the application menu on Mac OS X. This feature is on by default. |
|
125 See \l{Qt for Mac OS X - Specific Issues} for the list of menu items for |
|
126 which this applies. |
|
127 |
|
128 \section1 void qt_mac_set_native_menubar(bool \e{enable}) |
|
129 |
|
130 Specifies whether the application should use the native menu bar |
|
131 on Mac OS X or be part of the main window. This feature is on by |
|
132 default. |
|
133 |
|
134 In Qt 4.6, this is equivalent to |
|
135 \c { QApplication::instance()->setAttribute(Qt::AA_DontUseNativeMenuBar); }. |
|
136 |
|
137 \section1 void qt_mac_set_press_and_hold_context(bool \e{enable}) |
|
138 |
|
139 Turns emulation of the right mouse button by clicking and holding |
|
140 the left mouse button on or off. This feature is off by default. |
|
141 */ |