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/gui/kernel/qevent.cpp | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) (limited to 'src/gui/kernel/qevent.cpp') diff --git a/src/gui/kernel/qevent.cpp b/src/gui/kernel/qevent.cpp index 43da81e8a6..a3d39f13b2 100644 --- a/src/gui/kernel/qevent.cpp +++ b/src/gui/kernel/qevent.cpp @@ -653,7 +653,7 @@ QHoverEvent::~QHoverEvent() wheel event delta: angleDelta() returns the delta in wheel degrees. This value is always provided. pixelDelta() returns the delta in screen pixels and is available on platforms that - have high-resolution trackpads, such as OS X. If that is the + have high-resolution trackpads, such as \macos. If that is the case, source() will return Qt::MouseEventSynthesizedBySystem. The functions pos() and globalPos() return the mouse cursor's @@ -883,7 +883,7 @@ QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos, Returns the scrolling distance in pixels on screen. This value is provided on platforms that support high-resolution pixel-based - delta values, such as OS X. The value should be used directly + delta values, such as \macos. The value should be used directly to scroll content on screen. Example: @@ -1024,7 +1024,7 @@ QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos, Returns the scrolling phase of this wheel event. \note The Qt::ScrollBegin and Qt::ScrollEnd phases are currently - supported only on OS X. + supported only on \macos. */ @@ -1642,7 +1642,7 @@ QCloseEvent::~QCloseEvent() \ingroup events Icon drag events are sent to widgets when the main icon of a window - has been dragged away. On OS X, this happens when the proxy + has been dragged away. On \macos, this happens when the proxy icon of a window is dragged off the title bar. It is normal to begin using drag and drop in response to this @@ -2653,15 +2653,15 @@ Qt::MouseButtons QTabletEvent::buttons() const \row \li Qt::ZoomNativeGesture \li Magnification delta in percent. - \li OS X: Two-finger pinch. + \li \macos: Two-finger pinch. \row \li Qt::SmartZoomNativeGesture \li Boolean magnification state. - \li OS X: Two-finger douple tap (trackpad) / One-finger douple tap (magic mouse). + \li \macos: Two-finger douple tap (trackpad) / One-finger douple tap (magic mouse). \row \li Qt::RotateNativeGesture \li Rotation delta in degrees. - \li OS X: Two-finger rotate. + \li \macos: Two-finger rotate. \endtable @@ -2684,7 +2684,7 @@ Qt::MouseButtons QTabletEvent::buttons() const gesture position relative to the receiving widget or item, window, and screen, respectively. - \a realValue is the OS X event parameter, \a sequenceId and \a intValue are the Windows event parameters. + \a realValue is the \macos event parameter, \a sequenceId and \a intValue are the Windows event parameters. */ QNativeGestureEvent::QNativeGestureEvent(Qt::NativeGestureType type, const QPointF &localPos, const QPointF &windowPos, const QPointF &screenPos, qreal realValue, ulong sequenceId, quint64 intValue) @@ -3421,16 +3421,16 @@ QShowEvent::~QShowEvent() when the operating system requests that a file or URL should be opened. This is a high-level event that can be caused by different user actions depending on the user's desktop environment; for example, double - clicking on an file icon in the Finder on OS X. + clicking on an file icon in the Finder on \macos. This event is only used to notify the application of a request. It may be safely ignored. - \note This class is currently supported for OS X only. + \note This class is currently supported for \macos only. - \section1 OS X Example + \section1 \macos Example - In order to trigger the event on OS X, the application must be configured + In order to trigger the event on \macos, the application must be configured to let the OS know what kind of file(s) it should react on. For example, the following \c Info.plist file declares that the application @@ -3507,13 +3507,13 @@ bool QFileOpenEvent::openFile(QFile &file, QIODevice::OpenMode flags) const \internal \class QToolBarChangeEvent \brief The QToolBarChangeEvent class provides an event that is - sent whenever a the toolbar button is clicked on OS X. + sent whenever a the toolbar button is clicked on \macos. \ingroup events \inmodule QtGui - The QToolBarChangeEvent is sent when the toolbar button is clicked. On Mac - OS X, this is the long oblong button on the right side of the window + The QToolBarChangeEvent is sent when the toolbar button is clicked. On + \macos, this is the long oblong button on the right side of the window title bar. The default implementation is to toggle the appearance (hidden or shown) of the associated toolbars for the window. */ -- cgit v1.2.3