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/corelib/global/qglobal.cpp | 54 +++++++++++++++++++------------------- src/corelib/global/qnamespace.qdoc | 50 +++++++++++++++++------------------ 2 files changed, 52 insertions(+), 52 deletions(-) (limited to 'src/corelib/global') diff --git a/src/corelib/global/qglobal.cpp b/src/corelib/global/qglobal.cpp index 8b6d8745f8..eff94f5361 100644 --- a/src/corelib/global/qglobal.cpp +++ b/src/corelib/global/qglobal.cpp @@ -1001,8 +1001,8 @@ bool qSharedBuild() Q_DECL_NOTHROW \endlist Some constants are defined only on certain platforms. You can use - the preprocessor symbols Q_OS_WIN and Q_OS_OSX to test that - the application is compiled under Windows or OS X. + the preprocessor symbols Q_OS_WIN and Q_OS_MACOS to test that + the application is compiled under Windows or \macos. \sa QLibraryInfo */ @@ -1041,7 +1041,7 @@ bool qSharedBuild() Q_DECL_NOTHROW /*! \fn QSysInfo::MacVersion QSysInfo::macVersion() - Returns the version of Darwin (OS X or iOS) on which the + Returns the version of Darwin (\macos or iOS) on which the application is run, or MV_None if the operating system is not a version of Darwin. */ @@ -1117,24 +1117,24 @@ bool qSharedBuild() Q_DECL_NOTHROW \enum QSysInfo::MacVersion This enum provides symbolic names for the various versions of the - Darwin operating system, covering both OS X and iOS. The + Darwin operating system, covering both \macos and iOS. The QSysInfo::MacintoshVersion variable gives the version of the system on which the application is run. - \value MV_9 Mac OS 9 - \value MV_10_0 Mac OS X 10.0 - \value MV_10_1 Mac OS X 10.1 - \value MV_10_2 Mac OS X 10.2 - \value MV_10_3 Mac OS X 10.3 - \value MV_10_4 Mac OS X 10.4 - \value MV_10_5 Mac OS X 10.5 - \value MV_10_6 Mac OS X 10.6 - \value MV_10_7 Mac OS X 10.7 - \value MV_10_8 OS X 10.8 - \value MV_10_9 OS X 10.9 - \value MV_10_10 OS X 10.10 - \value MV_10_11 OS X 10.11 - \value MV_10_12 macOS 10.12 + \value MV_9 \macos 9 + \value MV_10_0 \macos 10.0 + \value MV_10_1 \macos 10.1 + \value MV_10_2 \macos 10.2 + \value MV_10_3 \macos 10.3 + \value MV_10_4 \macos 10.4 + \value MV_10_5 \macos 10.5 + \value MV_10_6 \macos 10.6 + \value MV_10_7 \macos 10.7 + \value MV_10_8 \macos 10.8 + \value MV_10_9 \macos 10.9 + \value MV_10_10 \macos 10.10 + \value MV_10_11 \macos 10.11 + \value MV_10_12 \macos 10.12 \value MV_Unknown An unknown and currently unsupported platform \value MV_CHEETAH Apple codename for MV_10_0 @@ -1179,7 +1179,7 @@ bool qSharedBuild() Q_DECL_NOTHROW \macro Q_OS_DARWIN \relates - Defined on Darwin-based operating systems such as OS X and iOS. + Defined on Darwin-based operating systems such as \macos and iOS. */ /*! @@ -1200,7 +1200,7 @@ bool qSharedBuild() Q_DECL_NOTHROW \macro Q_OS_MACOS \relates - Defined on macOS. + Defined on \macos. */ /*! @@ -2515,7 +2515,7 @@ static QString unknownText() Note that this function may return surprising values: it returns "linux" for all operating systems running Linux (including Android), "qnx" for all operating systems running QNX (including BlackBerry 10), "freebsd" for - Debian/kFreeBSD, and "darwin" for OS X and iOS. For information on the type + Debian/kFreeBSD, and "darwin" for \macos and iOS. For information on the type of product the application is running on, see productType(). \sa QFileSelector, kernelVersion(), productType(), productVersion(), prettyProductName() @@ -2539,7 +2539,7 @@ QString QSysInfo::kernelType() Returns the release version of the operating system kernel. On Windows, it returns the version of the NT or CE kernel. On Unix systems, including - Android, BlackBerry and OS X, it returns the same as the \c{uname -r} + Android, BlackBerry and \macos, it returns the same as the \c{uname -r} command would return. If the version could not be determined, this function may return an empty @@ -2584,11 +2584,11 @@ QString QSysInfo::kernelVersion() running the BlackBerry userspace, but "qnx" for all other QNX-based systems. - \b{Darwin, OS X and iOS note}: this function returns "macos" for macOS + \b{Darwin, \macos and iOS note}: this function returns "macos" for \macos systems, "ios" for iOS systems and "darwin" in case the system could not be determined. - \b{OS X note}: this function returns "osx" for versions of macOS prior to 10.12. + \b{OS X note}: this function returns "osx" for versions of \macos prior to 10.12. \b{FreeBSD note}: this function returns "debian" for Debian/kFreeBSD and "unknown" otherwise. @@ -2646,8 +2646,8 @@ QString QSysInfo::productType() Returns the product version of the operating system in string form. If the version could not be determined, this function returns "unknown". - It will return the Android, BlackBerry, iOS, OS X, Windows full-product - versions on those systems. In particular, on OS X, iOS and Windows, the + It will return the Android, BlackBerry, iOS, \macos, Windows full-product + versions on those systems. In particular, on \macos, iOS and Windows, the returned string is similar to the macVersion() or windowsVersion() enums. On Linux systems, it will try to determine the distribution version and will @@ -2657,7 +2657,7 @@ QString QSysInfo::productType() In all other Unix-type systems, this function always returns "unknown". \note The version string returned from this function is only guaranteed to - be orderable on Android, BlackBerry, OS X and iOS. On Windows, some Windows + be orderable on Android, BlackBerry, \macos and iOS. On Windows, some Windows versions are text ("XP" and "Vista", for example). On Linux, the version of the distribution may jump unexpectedly, please refer to the distribution's documentation for versioning practices. diff --git a/src/corelib/global/qnamespace.qdoc b/src/corelib/global/qnamespace.qdoc index 527bded3c2..23eeb01640 100644 --- a/src/corelib/global/qnamespace.qdoc +++ b/src/corelib/global/qnamespace.qdoc @@ -111,7 +111,7 @@ shown in any menus unless specifically set by the QAction::iconVisibleInMenu property. Menus that are currently open or menus already created in the native - OS X menubar \e{may not} pick up a change in this attribute. Changes + \macos menubar \e{may not} pick up a change in this attribute. Changes in the QAction::iconVisibleInMenu property will always be picked up. \value AA_NativeWindows Ensures that widgets have native windows. @@ -129,9 +129,9 @@ \value AA_DontUseNativeMenuBar All menubars created while this attribute is set to true won't be used as a native menubar (e.g, the menubar at - the top of the main screen on OS X or at the bottom in Windows CE). + the top of the main screen on \macos or at the bottom in Windows CE). - \value AA_MacDontSwapCtrlAndMeta On OS X by default, Qt swaps the + \value AA_MacDontSwapCtrlAndMeta On \macos by default, Qt swaps the Control and Meta (Command) keys (i.e., whenever Control is pressed, Qt sends Meta, and whenever Meta is pressed Control is sent). When this attribute is true, Qt will not do the flip. \l QKeySequence::StandardKey @@ -315,7 +315,7 @@ \omitvalue KeyboardModifierMask - \note On OS X, the \c ControlModifier value corresponds to + \note On \macos, the \c ControlModifier value corresponds to the Command keys on the Macintosh keyboard, and the \c MetaModifier value corresponds to the Control keys. The \c KeypadModifier value will also be set when an arrow key is pressed as the arrow keys are considered part of the @@ -333,7 +333,7 @@ This enum provides shorter names for the keyboard modifier keys supported by Qt. - \note On OS X, the \c CTRL value corresponds to + \note On \macos, the \c CTRL value corresponds to the Command keys on the Macintosh keyboard, and the \c META value corresponds to the Control keys. @@ -934,34 +934,34 @@ \value WA_MacOpaqueSizeGrip Indicates that the native Carbon size grip should be opaque instead of transparent (the default). This attribute - is only applicable to OS X and is set by the widget's author. + is only applicable to \macos and is set by the widget's author. \value WA_MacShowFocusRect Indicates that this widget should get a QFocusFrame around it. Some widgets draw their own focus halo regardless of this attribute. Not that the QWidget::focusPolicy also plays the main role in whether something is given focus or not, this only controls whether or not this gets the focus - frame. This attribute is only applicable to OS X. + frame. This attribute is only applicable to \macos. \value WA_MacNormalSize Indicates the widget should have the - normal size for widgets in OS X. This attribute is only - applicable to OS X. + normal size for widgets in \macos. This attribute is only + applicable to \macos. \value WA_MacSmallSize Indicates the widget should have the small - size for widgets in OS X. This attribute is only applicable to - OS X. + size for widgets in \macos. This attribute is only applicable to + \macos. \value WA_MacMiniSize Indicates the widget should have the mini - size for widgets in OS X. This attribute is only applicable to - OS X. + size for widgets in \macos. This attribute is only applicable to + \macos. \value WA_MacVariableSize Indicates the widget can choose between alternative sizes for widgets to avoid clipping. - This attribute is only applicable to OS X. + This attribute is only applicable to \macos. \value WA_MacBrushedMetal Indicates the widget should be drawn in the brushed metal style as supported by the windowing system. This - attribute is only applicable to OS X. + attribute is only applicable to \macos. \omitvalue WA_MacMetalStyle @@ -1111,14 +1111,14 @@ \b Warning: This flag must \e never be set or cleared by the widget's author. \value WA_WindowModified Indicates that the window is marked as modified. - On some platforms this flag will do nothing, on others (including OS X + On some platforms this flag will do nothing, on others (including \macos and Windows) the window will take a modified appearance. This flag is set or cleared by QWidget::setWindowModified(). \value WA_WindowPropagation Makes a toplevel window inherit font and palette from its parent. - \value WA_MacAlwaysShowToolWindow On OS X, show the tool window even + \value WA_MacAlwaysShowToolWindow On \macos, show the tool window even when the application is not active. By default, all tool windows are hidden when the application is inactive. @@ -1301,8 +1301,8 @@ \value Key_PageUp \value Key_PageDown \value Key_Shift - \value Key_Control On OS X, this corresponds to the Command keys. - \value Key_Meta On OS X, this corresponds to the Control keys. + \value Key_Control On \macos, this corresponds to the Command keys. + \value Key_Meta On \macos, this corresponds to the Control keys. On Windows keyboards, this key is mapped to the Windows key. \value Key_Alt @@ -1962,7 +1962,7 @@ \value TabFocus the widget accepts focus by tabbing. \value ClickFocus the widget accepts focus by clicking. \value StrongFocus the widget accepts focus by both tabbing - and clicking. On OS X this will also + and clicking. On \macos this will also be indicate that the widget accepts tab focus when in 'Text/List focus mode'. \value WheelFocus like Qt::StrongFocus plus the widget accepts @@ -2068,7 +2068,7 @@ system supports it, a tool window can be decorated with a somewhat lighter frame. It can also be combined with Qt::FramelessWindowHint. - On OS X, tool windows correspond to the + On \macos, tool windows correspond to the \l{http://developer.apple.com/documentation/Carbon/Conceptual/HandlingWindowsControls/hitb-wind_cont_concept/chapter_2_section_2.html}{Floating} class of windows. This means that the window lives on a level above normal windows; it impossible to put a normal @@ -2157,10 +2157,10 @@ \value WindowContextHelpButtonHint Adds a context help button to dialogs. On some platforms this implies Qt::WindowSystemMenuHint for it to work. - \value MacWindowToolBarButtonHint On OS X adds a tool bar button (i.e., + \value MacWindowToolBarButtonHint On \macos adds a tool bar button (i.e., the oblong button that is on the top right of windows that have toolbars). - \value WindowFullscreenButtonHint On OS X adds a fullscreen button. + \value WindowFullscreenButtonHint On \macos adds a fullscreen button. \value BypassGraphicsProxyWidget Prevents the window and its children from automatically embedding themselves into a QGraphicsProxyWidget if the @@ -2184,7 +2184,7 @@ that support _NET_WM_STATE_BELOW atom. If a window always on the bottom has a parent, the parent will also be left on the bottom. This window hint is currently not implemented - for OS X. + for \macos. \value WindowOkButtonHint Adds an OK button to the window decoration of a dialog. Only supported for Windows CE. @@ -3049,7 +3049,7 @@ \value CoarseTimer Coarse timers try to keep accuracy within 5% of the desired interval \value VeryCoarseTimer Very coarse timers only keep full second accuracy - On UNIX (including Linux, OS X, and iOS), Qt will keep millisecond accuracy + On UNIX (including Linux, \macos, and iOS), Qt will keep millisecond accuracy for Qt::PreciseTimer. For Qt::CoarseTimer, the interval will be adjusted up to 5% to align the timer with other timers that are expected to fire at or around the same time. The objective is to make most timers wake up at the -- cgit v1.2.3