From a2ae631c04fee752e492f2c0b8fd25f06abffd6b Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Wed, 3 Aug 2016 12:00:41 +0200 Subject: Doc: Change instances of '(Mac) OS X' to 'macOS' As of version 10.12 (Sierra), the name of Apple's desktop operating system will be macOS. Change the occurrences where the Mac platform is discussed to use a macro \macos, which expands to 'macOS'. This helps with adapting to future renaming. Update the instructions on mac-specific Q_OS_* macro usage. Add a \target for the old 'Qt for OS X' topic to keep links working for other documentation modules that try to link with the old name. Change-Id: Id33fb0cd985df702a4ae4efb4c5fd428e77d9b85 Reviewed-by: Leena Miettinen --- src/widgets/kernel/qaction.cpp | 10 +++++----- src/widgets/kernel/qapplication.cpp | 4 ++-- src/widgets/kernel/qdesktopwidget.qdoc | 2 +- src/widgets/kernel/qformlayout.cpp | 4 ++-- src/widgets/kernel/qopenglwidget.cpp | 4 ++-- src/widgets/kernel/qsizepolicy.cpp | 2 +- src/widgets/kernel/qwidget.cpp | 18 +++++++++--------- src/widgets/kernel/qwidgetaction.cpp | 6 +++--- 8 files changed, 25 insertions(+), 25 deletions(-) (limited to 'src/widgets/kernel') diff --git a/src/widgets/kernel/qaction.cpp b/src/widgets/kernel/qaction.cpp index 1ef9e4ef98..2067e7dbcc 100644 --- a/src/widgets/kernel/qaction.cpp +++ b/src/widgets/kernel/qaction.cpp @@ -249,7 +249,7 @@ void QActionPrivate::setShortcutEnabled(bool enable, QShortcutMap &map) /*! \enum QAction::MenuRole - This enum describes how an action should be moved into the application menu on OS X. + This enum describes how an action should be moved into the application menu on \macos. \value NoRole This action should not be put into the application menu \value TextHeuristicRole This action should be put in the application menu based on the action's text @@ -258,7 +258,7 @@ void QActionPrivate::setShortcutEnabled(bool enable, QShortcutMap &map) \value AboutQtRole This action handles the "About Qt" menu item. \value AboutRole This action should be placed where the "About" menu item is in the application menu. The text of the menu item will be set to "About ". The application name is fetched from the - \c{Info.plist} file in the application's bundle (See \l{Qt for OS X - Deployment}). + \c{Info.plist} file in the application's bundle (See \l{Qt for macOS - Deployment}). \value PreferencesRole This action should be placed where the "Preferences..." menu item is in the application menu. \value QuitRole This action should be placed where the Quit menu item is in the application menu. @@ -1230,12 +1230,12 @@ void QAction::activate(ActionEvent event) \brief the action's menu role \since 4.2 - This indicates what role the action serves in the application menu on Mac - OS X. By default all actions have the TextHeuristicRole, which means that + This indicates what role the action serves in the application menu on + \macos. By default all actions have the TextHeuristicRole, which means that the action is added based on its text (see QMenuBar for more information). The menu role can only be changed before the actions are put into the menu - bar in OS X (usually just before the first application window is + bar in \macos (usually just before the first application window is shown). */ void QAction::setMenuRole(MenuRole menuRole) diff --git a/src/widgets/kernel/qapplication.cpp b/src/widgets/kernel/qapplication.cpp index fcc195f601..917273e8cf 100644 --- a/src/widgets/kernel/qapplication.cpp +++ b/src/widgets/kernel/qapplication.cpp @@ -1530,7 +1530,7 @@ void QApplicationPrivate::setPalette_helper(const QPalette &palette, const char* \note Some styles do not use the palette for all drawing, for instance, if they make use of native theme engines. This is the case for the Windows XP, - Windows Vista, and OS X styles. + Windows Vista, and \macos styles. \sa QWidget::setPalette(), palette(), QStyle::polish() */ @@ -4021,7 +4021,7 @@ bool QApplication::keypadNavigationEnabled() Currently this function does nothing on Qt for Embedded Linux. - On OS X, this works more at the application level and will cause the + On \macos, this works more at the application level and will cause the application icon to bounce in the dock. On Windows, this causes the window's taskbar entry to flash for a time. If diff --git a/src/widgets/kernel/qdesktopwidget.qdoc b/src/widgets/kernel/qdesktopwidget.qdoc index abdbd35f5b..00a01bb572 100644 --- a/src/widgets/kernel/qdesktopwidget.qdoc +++ b/src/widgets/kernel/qdesktopwidget.qdoc @@ -149,7 +149,7 @@ Returns the available geometry of the screen with index \a screen. What is available will be subrect of screenGeometry() based on what the platform decides is available (for example excludes the dock and menu bar - on OS X, or the task bar on Windows). The default screen is used if + on \macos, or the task bar on Windows). The default screen is used if \a screen is -1. \sa screenNumber(), screenGeometry() diff --git a/src/widgets/kernel/qformlayout.cpp b/src/widgets/kernel/qformlayout.cpp index 124f6b301c..24bf80f16c 100644 --- a/src/widgets/kernel/qformlayout.cpp +++ b/src/widgets/kernel/qformlayout.cpp @@ -1041,7 +1041,7 @@ QLayoutItem* QFormLayoutPrivate::replaceAt(int index, QLayoutItem *newitem) \li \b{Adherence to the different platform's look and feel guidelines.} For example, the - \l{http://developer.apple.com/library/mac/#documentation/UserExperience/Conceptual/AppleHIGuidelines/Intro/Intro.html}{Mac OS X Aqua} and KDE guidelines specify that the + \l{http://developer.apple.com/library/mac/#documentation/UserExperience/Conceptual/AppleHIGuidelines/Intro/Intro.html}{\macos Aqua} and KDE guidelines specify that the labels should be right-aligned, whereas Windows and GNOME applications normally use left-alignment. @@ -1084,7 +1084,7 @@ QLayoutItem* QFormLayoutPrivate::replaceAt(int index, QLayoutItem *newitem) corresponds to what we would get using a two-column QGridLayout.) \li Style based on the - \l{http://developer.apple.com/library/mac/#documentation/UserExperience/Conceptual/AppleHIGuidelines/Intro/Intro.html}{Mac OS X Aqua} guidelines. Labels are right-aligned, + \l{http://developer.apple.com/library/mac/#documentation/UserExperience/Conceptual/AppleHIGuidelines/Intro/Intro.html}{\macos Aqua} guidelines. Labels are right-aligned, the fields don't grow beyond their size hint, and the form is horizontally centered. \li Recommended style for diff --git a/src/widgets/kernel/qopenglwidget.cpp b/src/widgets/kernel/qopenglwidget.cpp index 1d48be5198..c94c8bd1c6 100644 --- a/src/widgets/kernel/qopenglwidget.cpp +++ b/src/widgets/kernel/qopenglwidget.cpp @@ -106,7 +106,7 @@ QT_BEGIN_NAMESPACE \note Calling QSurfaceFormat::setDefaultFormat() before constructing the QApplication instance is mandatory on some platforms (for example, - OS X) when an OpenGL core profile context is requested. This is to + \macos) when an OpenGL core profile context is requested. This is to ensure that resource sharing between contexts stays functional as all internal contexts are created using the correct version and profile. @@ -461,7 +461,7 @@ QT_BEGIN_NAMESPACE recommended to limit the usage of this approach to cases where there is no other choice. Note that this option is not suitable for most embedded and mobile platforms, and it is known to have issues on - certain desktop platforms (e.g. OS X) too. The stable, + certain desktop platforms (e.g. \macos) too. The stable, cross-platform solution is always QOpenGLWidget. \e{OpenGL is a trademark of Silicon Graphics, Inc. in the United States and other diff --git a/src/widgets/kernel/qsizepolicy.cpp b/src/widgets/kernel/qsizepolicy.cpp index 26d1733d26..b1cdb52c55 100644 --- a/src/widgets/kernel/qsizepolicy.cpp +++ b/src/widgets/kernel/qsizepolicy.cpp @@ -241,7 +241,7 @@ QSizePolicy::ControlType QSizePolicy::controlType() const The control type specifies the type of the widget for which this size policy applies. It is used by some styles, notably QMacStyle, to insert proper spacing between widgets. For example, - the Mac OS X Aqua guidelines specify that push buttons should be + the \macos Aqua guidelines specify that push buttons should be separated by 12 pixels, whereas vertically stacked radio buttons only require 6 pixels. diff --git a/src/widgets/kernel/qwidget.cpp b/src/widgets/kernel/qwidget.cpp index 57148eb811..03f642bd9b 100644 --- a/src/widgets/kernel/qwidget.cpp +++ b/src/widgets/kernel/qwidget.cpp @@ -2505,7 +2505,7 @@ QWidget *QWidget::find(WId id) If a widget is non-native (alien) and winId() is invoked on it, that widget will be provided a native handle. - On OS X, the type returned depends on which framework Qt was linked + On \macos, the type returned depends on which framework Qt was linked against. If Qt is using Carbon, the {WId} is actually an HIViewRef. If Qt is using Cocoa, {WId} is a pointer to an NSView. @@ -2632,7 +2632,7 @@ QWindow *QWidget::windowHandle() const The style sheet contains a textual description of customizations to the widget's style, as described in the \l{Qt Style Sheets} document. - Since Qt 4.5, Qt style sheets fully supports OS X. + Since Qt 4.5, Qt style sheets fully supports \macos. \warning Qt style sheets are currently not supported for custom QStyle subclasses. We plan to address this in some future release. @@ -5111,7 +5111,7 @@ void QWidget::render(QPaintDevice *target, const QPoint &targetOffset, Transformations and settings applied to the \a painter will be used when rendering. - \note The \a painter must be active. On OS X the widget will be + \note The \a painter must be active. On \macos the widget will be rendered into a QPixmap and then drawn by the \a painter. \sa QPainter::device() @@ -6255,7 +6255,7 @@ QString QWidget::windowIconText() const If the window title is set at any point, then the window title takes precedence and will be shown instead of the file path string. - Additionally, on OS X, this has an added benefit that it sets the + Additionally, on \macos, this has an added benefit that it sets the \l{http://developer.apple.com/documentation/UserExperience/Conceptual/OSXHIGuidelines/XHIGWindows/chapter_17_section_3.html}{proxy icon} for the window, assuming that the file path exists. @@ -11294,7 +11294,7 @@ bool QWidget::testAttribute_helper(Qt::WidgetAttribute attribute) const By default the value of this property is 1.0. - This feature is available on Embedded Linux, OS X, Windows, + This feature is available on Embedded Linux, \macos, Windows, and X11 platforms that support the Composite extension. This feature is not available on Windows CE. @@ -11357,7 +11357,7 @@ void QWidgetPrivate::setWindowOpacity_sys(qreal level) A modified window is a window whose content has changed but has not been saved to disk. This flag will have different effects - varied by the platform. On OS X the close button will have a + varied by the platform. On \macos the close button will have a modified look; on other platforms, the window title will have an '*' (asterisk). @@ -12503,7 +12503,7 @@ static void releaseMouseGrabOfWidget(QWidget *widget) \note On Windows, grabMouse() only works when the mouse is inside a window owned by the process. - On OS X, grabMouse() only works when the mouse is inside the frame of that widget. + On \macos, grabMouse() only works when the mouse is inside the frame of that widget. \sa releaseMouse(), grabKeyboard(), releaseKeyboard() */ @@ -12975,7 +12975,7 @@ QDebug operator<<(QDebug debug, const QWidget *widget) This function will return 0 if no painter context can be established, or if the handle could not be created. - \warning This function is only available on OS X. + \warning This function is only available on \macos. */ /*! \fn Qt::HANDLE QWidget::macQDHandle() const \internal @@ -12984,7 +12984,7 @@ QDebug operator<<(QDebug debug, const QWidget *widget) This function will return 0 if QuickDraw is not supported, or if the handle could not be created. - \warning This function is only available on OS X. + \warning This function is only available on \macos. */ /*! \fn const QX11Info &QWidget::x11Info() const \internal diff --git a/src/widgets/kernel/qwidgetaction.cpp b/src/widgets/kernel/qwidgetaction.cpp index 3c0c203fd6..a96ee62996 100644 --- a/src/widgets/kernel/qwidgetaction.cpp +++ b/src/widgets/kernel/qwidgetaction.cpp @@ -79,8 +79,8 @@ QT_BEGIN_NAMESPACE Note that it is up to the widget to activate the action, for example by reimplementing mouse event handlers and calling QAction::trigger(). - \b {OS X}: If you add a widget to a menu in the application's menu - bar on OS X, the widget will be added and it will function but with some + \b {\macos}: If you add a widget to a menu in the application's menu + bar on \macos, the widget will be added and it will function but with some limitations: \list 1 \li The widget is reparented away from the QMenu to the native menu @@ -90,7 +90,7 @@ QT_BEGIN_NAMESPACE \li Due to Apple's design, mouse tracking on the widget currently does not work. \li Connecting the triggered() signal to a slot that opens a modal - dialog will cause a crash in Mac OS X 10.4 (known bug acknowledged + dialog will cause a crash in \macos 10.4 (known bug acknowledged by Apple), a workaround is to use a QueuedConnection instead of a DirectConnection. \endlist -- cgit v1.2.3