1 /****************************************************************************
3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
7 ** This file is part of the documentation of the Qt Toolkit.
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
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.
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.
28 ** If you have questions regarding the use of this file, please contact
29 ** Nokia at qt-info@nokia.com.
40 ****************************************************************************/
43 \page exportedfunctions.html
44 \title Special-Purpose Global Functions Exported by Qt
47 Qt provides a few low-level global functions for fine-tuning
48 applications. Most of these perform very specific tasks and are
49 platform-specific. In general, we recommend that you try using
50 Qt's public API before resorting to using any functions mentioned
53 These functions are exported by \l QtCore and \l QtGui, but most
54 of them aren't declared in Qt's header files. To use them in your
55 application, you must declare them before calling them. For
58 \snippet doc/src/snippets/code/doc_src_exportedfunctions.qdoc 0
60 These functions will remain as part of Qt for the lifetime of Qt
67 \section1 void qt_set_library_config_file(const QString &\e{fileName})
69 Specifies the location of the Qt configuration file. You must
70 call this function before constructing a QApplication or
71 QCoreApplication object. If no location is specified, Qt
72 automatically finds an appropriate location.
74 \section1 void qt_set_sequence_auto_mnemonic(bool \e{enable})
76 Specifies whether mnemonics for menu items, labels, etc., should
77 be honored or not. On Windows and X11, this feature is
78 on by default; on Mac OS X, it is off. When this feature is off,
79 the QKeySequence::mnemonic() function always returns an empty
80 string. This feature is also enabled on embedded Linux.
82 \section1 void qt_x11_wait_for_window_manager(QWidget *\e{widget})
84 Blocks until the X11 window manager has shown the widget after a
85 call to QWidget::show().
87 \section1 void qt_mac_secure_keyboard(bool \e{enable})
89 Turns the Mac OS X secure keyboard feature on or off. QLineEdit
90 uses this when the echo mode is QLineEdit::Password or
91 QLineEdit::NoEcho to guard the editor against keyboard sniffing.
92 If you implement your own password editor, you might want to turn
93 on this feature in your editor's
94 \l{QWidget::focusInEvent()}{focusInEvent()} and turn it off in
95 \l{QWidget::focusOutEvent()}{focusOutEvent()}.
97 \section1 void qt_mac_set_dock_menu(QMenu *\e{menu})
99 Sets the menu to display in the Mac OS X Dock for the
100 application. This menu is shown when the user attempts a
101 press-and-hold operation on the application's dock icon or
102 \key{Ctrl}-clicks on it while the application is running.
104 The menu will be turned into a Mac menu and the items added to the default
105 Dock menu. There is no merging of the Qt menu items with the items that are
106 in the Dock menu (i.e., it is not recommended to include actions that
107 duplicate functionality of items already in the Dock menu).
109 \section1 void qt_mac_set_menubar_icons(bool \e{enable})
111 Specifies whether icons associated to menu items for the
112 application's menu bar should be shown on Mac OS X. By default,
113 icons are shown on Mac OS X just like on the other platforms.
115 In Qt 4.4, this is equivalent to
116 \c { QApplication::instance()->setAttribute(Qt::AA_DontShowIconsInMenus); }.
118 \section1 void qt_mac_set_menubar_merge(bool \e{enable})
120 Specifies whether Qt should attempt to relocate standard menu
121 items (such as \gui Quit, \gui Preferences, and \gui About) to
122 the application menu on Mac OS X. This feature is on by default.
123 See \l{Qt for Mac OS X - Specific Issues} for the list of menu items for
126 \section1 void qt_mac_set_native_menubar(bool \e{enable})
128 Specifies whether the application should use the native menu bar
129 on Mac OS X or be part of the main window. This feature is on by
132 \section1 void qt_mac_set_press_and_hold_context(bool \e{enable})
134 Turns emulation of the right mouse button by clicking and holding
135 the left mouse button on or off. This feature is off by default.