summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSze Howe Koh <szehowe.koh@gmail.com>2015-10-10 10:52:19 +0800
committerTopi Reiniƶ <topi.reinio@digia.com>2015-11-02 09:10:40 +0000
commitd81e3b7ac7e629b148a5c51518bbc60b02792c95 (patch)
treeb181e1b38a3f5b40805d06a6d023688610d01b9c
parenta982d7501ec377045f1cf4bcf7eef9891605be54 (diff)
downloadqtdoc-d81e3b7ac7e629b148a5c51518bbc60b02792c95.tar.gz
Doc: Remove docs for old, deleted, platform-specific functions
Most of these functions were removed prior to the release of Qt 5.0. Three of them remain in the code base though: 1. qt_set_sequence_auto_mnemonic() 2. qt_mac_set_dock_menu() 3. qt_mac_secure_keyboard() (1) is currently referenced by the QShortcut class ref, so I'm transferring its documentation to QKeySequence. (2) is already documented under QMenu. (3) is not mentioned anywhere else in the Qt docs, so I'll just leave it undocumented and let it be quietly replaced with a better function. Change-Id: I27ecc79de7967593781c5cb641e7ec14752b9a3b Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
-rw-r--r--doc/src/classes/exportedfunctions.qdoc127
-rw-r--r--doc/src/snippets/code/doc_src_exportedfunctions.qdoc57
2 files changed, 0 insertions, 184 deletions
diff --git a/doc/src/classes/exportedfunctions.qdoc b/doc/src/classes/exportedfunctions.qdoc
deleted file mode 100644
index 33b18f7e..00000000
--- a/doc/src/classes/exportedfunctions.qdoc
+++ /dev/null
@@ -1,127 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2015 The Qt Company Ltd.
-** Contact: http://www.qt.io/licensing/
-**
-** This file is part of the documentation of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:FDL$
-** Commercial License Usage
-** Licensees holding valid commercial Qt licenses may use this file in
-** accordance with the commercial license agreement provided with the
-** Software or, alternatively, in accordance with the terms contained in
-** a written agreement between you and The Qt Company. For licensing terms
-** and conditions see http://www.qt.io/terms-conditions. For further
-** information use the contact form at http://www.qt.io/contact-us.
-**
-** GNU Free Documentation License Usage
-** Alternatively, this file may be used under the terms of the GNU Free
-** Documentation License version 1.3 as published by the Free Software
-** Foundation and appearing in the file included in the packaging of
-** this file. Please review the following information to ensure
-** the GNU Free Documentation License version 1.3 requirements
-** will be met: http://www.gnu.org/copyleft/fdl.html.
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-/*!
- \page exportedfunctions.html
- \title Platform-Specific Functions
- \ingroup funclists
-
- \brief Exported functions for fine tuning Qt applications.
-
- Qt provides a few low-level global functions for fine-tuning
- applications. Most of these perform very specific tasks and are
- platform-specific. In general, we recommend that you try using
- Qt's public API before resorting to using any functions mentioned
- here.
-
- These functions are exported by \l QtCore and \l QtGui, but most
- of them aren't declared in Qt's header files. To use them in your
- application, you must declare them before calling them. For
- example:
-
- \snippet snippets/code/doc_src_exportedfunctions.qdoc 0
-
- These functions will remain as part of Qt for the lifetime of Qt
- 4.
-
- Functions:
-
- \tableofcontents
-
- \section1 void qt_set_library_config_file(const QString &\e{fileName})
-
- Specifies the location of the Qt configuration file. You must
- call this function before constructing a QApplication or
- QCoreApplication object. If no location is specified, Qt
- automatically finds an appropriate location.
-
- \section1 void qt_set_sequence_auto_mnemonic(bool \e{enable})
-
- Specifies whether mnemonics for menu items, labels, etc., should
- be honored or not. On Windows and X11, this feature is
- on by default; on OS X, it is off. When this feature is off,
- the QKeySequence::mnemonic() function always returns an empty
- string. This feature is also enabled on embedded Linux.
-
- \section1 void qt_x11_wait_for_window_manager(QWidget *\e{widget})
-
- Blocks until the X11 window manager has shown the widget after a
- call to QWidget::show().
-
- \section1 void qt_mac_secure_keyboard(bool \e{enable})
-
- Turns the OS X secure keyboard feature on or off. QLineEdit
- uses this when the echo mode is QLineEdit::Password or
- QLineEdit::NoEcho to guard the editor against keyboard sniffing.
- If you implement your own password editor, you might want to turn
- on this feature in your editor's
- \l{QWidget::focusInEvent()}{focusInEvent()} and turn it off in
- \l{QWidget::focusOutEvent()}{focusOutEvent()}.
-
- \section1 void qt_mac_set_dock_menu(QMenu *\e{menu})
-
- Sets the menu to display in the OS X Dock for the
- application. This menu is shown when the user attempts a
- press-and-hold operation on the application's dock icon or
- \key{Ctrl}-clicks on it while the application is running.
-
- The menu will be turned into a Mac menu and the items added to the default
- Dock menu. There is no merging of the Qt menu items with the items that are
- in the Dock menu (i.e., it is not recommended to include actions that
- duplicate functionality of items already in the Dock menu).
-
- \section1 void qt_mac_set_menubar_icons(bool \e{enable})
-
- Specifies whether icons associated to menu items for the
- application's menu bar should be shown on OS X. By default,
- icons are shown on OS X just like on the other platforms.
-
- In Qt 4.4, this is equivalent to
- \c { QApplication::instance()->setAttribute(Qt::AA_DontShowIconsInMenus); }.
-
- \section1 void qt_mac_set_menubar_merge(bool \e{enable})
-
- Specifies whether Qt should attempt to relocate standard menu
- items (such as \gui Quit, \gui Preferences, and \gui About) to
- the application menu on OS X. This feature is on by default.
- See \l{Qt for OS X - Specific Issues} for the list of menu items for
- which this applies.
-
- \section1 void qt_mac_set_native_menubar(bool \e{enable})
-
- Specifies whether the application should use the native menu bar
- on OS X or be part of the main window. This feature is on by
- default.
-
- In Qt 4.6, this is equivalent to
- \c { QApplication::instance()->setAttribute(Qt::AA_DontUseNativeMenuBar); }.
-
- \section1 void qt_mac_set_press_and_hold_context(bool \e{enable})
-
- Turns emulation of the right mouse button by clicking and holding
- the left mouse button on or off. This feature is off by default.
-*/
diff --git a/doc/src/snippets/code/doc_src_exportedfunctions.qdoc b/doc/src/snippets/code/doc_src_exportedfunctions.qdoc
deleted file mode 100644
index 6456a8bb..00000000
--- a/doc/src/snippets/code/doc_src_exportedfunctions.qdoc
+++ /dev/null
@@ -1,57 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2015 The Qt Company Ltd.
-** Contact: http://www.qt.io/licensing/
-**
-** This file is part of the documentation of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:BSD$
-** You may use this file under the terms of the BSD license as follows:
-**
-** "Redistribution and use in source and binary forms, with or without
-** modification, are permitted provided that the following conditions are
-** met:
-** * Redistributions of source code must retain the above copyright
-** notice, this list of conditions and the following disclaimer.
-** * Redistributions in binary form must reproduce the above copyright
-** notice, this list of conditions and the following disclaimer in
-** the documentation and/or other materials provided with the
-** distribution.
-** * Neither the name of The Qt Company Ltd nor the names of its
-** contributors may be used to endorse or promote products derived
-** from this software without specific prior written permission.
-**
-**
-** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
-**
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-//! [0]
-#ifdef Q_WS_X11
-void qt_x11_wait_for_window_manager(QWidget *widget);
-#endif
-
-int main(int argc, char *argv[])
-{
- QApplication app(argc, argv);
- ...
- window.show();
-#ifdef Q_WS_X11
- qt_x11_wait_for_window_manager(&window);
-#endif
- ...
- return app.exec();
-}
-//! [0]