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 exportedfunctions.html 30 \title Platform-Specific Functions 31 \ingroup funclists 32 33 \brief Exported functions for fine tuning Qt applications. 34 35 Qt provides a few low-level global functions for fine-tuning 36 applications. Most of these perform very specific tasks and are 37 platform-specific. In general, we recommend that you try using 38 Qt's public API before resorting to using any functions mentioned 39 here. 40 41 These functions are exported by \l QtCore and \l QtGui, but most 42 of them aren't declared in Qt's header files. To use them in your 43 application, you must declare them before calling them. For 44 example: 45 46 \snippet doc/src/snippets/code/doc_src_exportedfunctions.qdoc 0 47 48 These functions will remain as part of Qt for the lifetime of Qt 49 4. 50 51 Functions: 52 53 \tableofcontents 54 55 \section1 void qt_set_library_config_file(const QString &\e{fileName}) 56 57 Specifies the location of the Qt configuration file. You must 58 call this function before constructing a QApplication or 59 QCoreApplication object. If no location is specified, Qt 60 automatically finds an appropriate location. 61 62 \section1 void qt_set_sequence_auto_mnemonic(bool \e{enable}) 63 64 Specifies whether mnemonics for menu items, labels, etc., should 65 be honored or not. On Windows and X11, this feature is 66 on by default; on Mac OS X, it is off. When this feature is off, 67 the QKeySequence::mnemonic() function always returns an empty 68 string. This feature is also enabled on embedded Linux. 69 70 \section1 void qt_x11_wait_for_window_manager(QWidget *\e{widget}) 71 72 Blocks until the X11 window manager has shown the widget after a 73 call to QWidget::show(). 74 75 \section1 void qt_mac_secure_keyboard(bool \e{enable}) 76 77 Turns the Mac OS X secure keyboard feature on or off. QLineEdit 78 uses this when the echo mode is QLineEdit::Password or 79 QLineEdit::NoEcho to guard the editor against keyboard sniffing. 80 If you implement your own password editor, you might want to turn 81 on this feature in your editor's 82 \l{QWidget::focusInEvent()}{focusInEvent()} and turn it off in 83 \l{QWidget::focusOutEvent()}{focusOutEvent()}. 84 85 \section1 void qt_mac_set_dock_menu(QMenu *\e{menu}) 86 87 Sets the menu to display in the Mac OS X Dock for the 88 application. This menu is shown when the user attempts a 89 press-and-hold operation on the application's dock icon or 90 \key{Ctrl}-clicks on it while the application is running. 91 92 The menu will be turned into a Mac menu and the items added to the default 93 Dock menu. There is no merging of the Qt menu items with the items that are 94 in the Dock menu (i.e., it is not recommended to include actions that 95 duplicate functionality of items already in the Dock menu). 96 97 \section1 void qt_mac_set_menubar_icons(bool \e{enable}) 98 99 Specifies whether icons associated to menu items for the 100 application's menu bar should be shown on Mac OS X. By default, 101 icons are shown on Mac OS X just like on the other platforms. 102 103 In Qt 4.4, this is equivalent to 104 \c { QApplication::instance()->setAttribute(Qt::AA_DontShowIconsInMenus); }. 105 106 \section1 void qt_mac_set_menubar_merge(bool \e{enable}) 107 108 Specifies whether Qt should attempt to relocate standard menu 109 items (such as \gui Quit, \gui Preferences, and \gui About) to 110 the application menu on Mac OS X. This feature is on by default. 111 See \l{Qt for Mac OS X - Specific Issues} for the list of menu items for 112 which this applies. 113 114 \section1 void qt_mac_set_native_menubar(bool \e{enable}) 115 116 Specifies whether the application should use the native menu bar 117 on Mac OS X or be part of the main window. This feature is on by 118 default. 119 120 In Qt 4.6, this is equivalent to 121 \c { QApplication::instance()->setAttribute(Qt::AA_DontUseNativeMenuBar); }. 122 123 \section1 void qt_mac_set_press_and_hold_context(bool \e{enable}) 124 125 Turns emulation of the right mouse button by clicking and holding 126 the left mouse button on or off. This feature is off by default. 127*/ 128