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/dialogs/qcolordialog.cpp | 8 ++++---- src/widgets/dialogs/qfiledialog.cpp | 10 +++++----- src/widgets/dialogs/qmessagebox.cpp | 18 +++++++++--------- src/widgets/dialogs/qwizard.cpp | 20 ++++++++++---------- 4 files changed, 28 insertions(+), 28 deletions(-) (limited to 'src/widgets/dialogs') diff --git a/src/widgets/dialogs/qcolordialog.cpp b/src/widgets/dialogs/qcolordialog.cpp index 6a1135920d..547a55f19e 100644 --- a/src/widgets/dialogs/qcolordialog.cpp +++ b/src/widgets/dialogs/qcolordialog.cpp @@ -535,8 +535,8 @@ QColor QColorDialog::customColor(int index) /*! Sets the custom color at \a index to the QColor \a color value. - \note This function does not apply to the Native Color Dialog on the Mac - OS X platform. If you still require this function, use the + \note This function does not apply to the Native Color Dialog on the + \macos platform. If you still require this function, use the QColorDialog::DontUseNativeDialog option. */ void QColorDialog::setCustomColor(int index, QColor color) @@ -557,8 +557,8 @@ QColor QColorDialog::standardColor(int index) /*! Sets the standard color at \a index to the QColor \a color value. - \note This function does not apply to the Native Color Dialog on the Mac - OS X platform. If you still require this function, use the + \note This function does not apply to the Native Color Dialog on the + \macos platform. If you still require this function, use the QColorDialog::DontUseNativeDialog option. */ void QColorDialog::setStandardColor(int index, QColor color) diff --git a/src/widgets/dialogs/qfiledialog.cpp b/src/widgets/dialogs/qfiledialog.cpp index 7d34b6de4a..bc2de899f5 100644 --- a/src/widgets/dialogs/qfiledialog.cpp +++ b/src/widgets/dialogs/qfiledialog.cpp @@ -2076,7 +2076,7 @@ QString QFileDialog::labelText(DialogLabel label) const The dialog's caption is set to \a caption. If \a caption is not specified then a default caption will be used. - On Windows, and OS X, this static function will use the + On Windows, and \macos, this static function will use the native file dialog and not a QFileDialog. On Windows the dialog will spin a blocking modal event loop that will not @@ -2187,7 +2187,7 @@ QUrl QFileDialog::getOpenFileUrl(QWidget *parent, The dialog's caption is set to \a caption. If \a caption is not specified then a default caption will be used. - On Windows, and OS X, this static function will use the + On Windows, and \macos, this static function will use the native file dialog and not a QFileDialog. On Windows the dialog will spin a blocking modal event loop that will not @@ -2310,12 +2310,12 @@ QList QFileDialog::getOpenFileUrls(QWidget *parent, The dialog's caption is set to \a caption. If \a caption is not specified, a default caption will be used. - On Windows, and OS X, this static function will use the + On Windows, and \macos, this static function will use the native file dialog and not a QFileDialog. On Windows the dialog will spin a blocking modal event loop that will not dispatch any QTimers, and if \a parent is not 0 then it will position the - dialog just below the parent's title bar. On OS X, with its native file + dialog just below the parent's title bar. On \macos, with its native file dialog, the filter argument is ignored. On Unix/X11, the normal behavior of the file dialog is to resolve and @@ -2418,7 +2418,7 @@ QUrl QFileDialog::getSaveFileUrl(QWidget *parent, pass. To ensure a native file dialog, \l{QFileDialog::}{ShowDirsOnly} must be set. - On Windows and OS X, this static function will use the + On Windows and \macos, this static function will use the native file dialog and not a QFileDialog. However, the native Windows file dialog does not support displaying files in the directory chooser. You need to pass \l{QFileDialog::}{DontUseNativeDialog} to display files using a diff --git a/src/widgets/dialogs/qmessagebox.cpp b/src/widgets/dialogs/qmessagebox.cpp index f32f7b0417..61a890c064 100644 --- a/src/widgets/dialogs/qmessagebox.cpp +++ b/src/widgets/dialogs/qmessagebox.cpp @@ -580,7 +580,7 @@ void QMessageBoxPrivate::_q_clicked(QPlatformDialogHelper::StandardButton button This is the approach recommended in the \l{http://developer.apple.com/library/mac/documentation/UserExperience/Conceptual/AppleHIGuidelines/Windows/Windows.html#//apple_ref/doc/uid/20000961-BABCAJID} - {OS X Guidelines}. Similar guidelines apply for the other + {\macos Guidelines}. Similar guidelines apply for the other platforms, but note the different ways the \l{QMessageBox::informativeText} {informative text} is handled for different platforms. @@ -795,7 +795,7 @@ void QMessageBoxPrivate::_q_clicked(QPlatformDialogHelper::StandardButton button Constructs a message box with no text and no buttons. \a parent is passed to the QDialog constructor. - On OS X, if you want your message box to appear + On \macos, if you want your message box to appear as a Qt::Sheet of its \a parent, set the message box's \l{setWindowModality()} {window modality} to Qt::WindowModal or use open(). Otherwise, the message box will be a standard dialog. @@ -817,7 +817,7 @@ QMessageBox::QMessageBox(QWidget *parent) The message box is an \l{Qt::ApplicationModal} {application modal} dialog box. - On OS X, if \a parent is not 0 and you want your message box + On \macos, if \a parent is not 0 and you want your message box to appear as a Qt::Sheet of that parent, set the message box's \l{setWindowModality()} {window modality} to Qt::WindowModal (default). Otherwise, the message box will be a standard dialog. @@ -985,7 +985,7 @@ QAbstractButton *QMessageBox::button(StandardButton which) const \list 1 \li If there is only one button, it is made the escape button. \li If there is a \l Cancel button, it is made the escape button. - \li On OS X only, if there is exactly one button with the role + \li On \macos only, if there is exactly one button with the role QMessageBox::RejectRole, it is made the escape button. \endlist @@ -1800,7 +1800,7 @@ QMessageBox::StandardButton QMessageBox::critical(QWidget *parent, const QString \li As a last resort it uses the Information icon. \endlist - The about box has a single button labelled "OK". On OS X, the + The about box has a single button labelled "OK". On \macos, the about box is popped up as a modeless window; on other platforms, it is currently application modal. @@ -1854,7 +1854,7 @@ void QMessageBox::about(QWidget *parent, const QString &title, const QString &te QApplication provides this functionality as a slot. - On OS X, the about box is popped up as a modeless window; on + On \macos, the about box is popped up as a modeless window; on other platforms, it is currently application modal. \sa QApplication::aboutQt() @@ -2619,8 +2619,8 @@ void QMessageBox::setInformativeText(const QString &text) This function shadows QWidget::setWindowTitle(). - Sets the title of the message box to \a title. On OS X, - the window title is ignored (as required by the OS X + Sets the title of the message box to \a title. On \macos, + the window title is ignored (as required by the \macos Guidelines). */ void QMessageBox::setWindowTitle(const QString &title) @@ -2641,7 +2641,7 @@ void QMessageBox::setWindowTitle(const QString &title) Sets the modality of the message box to \a windowModality. - On OS X, if the modality is set to Qt::WindowModal and the message box + On \macos, if the modality is set to Qt::WindowModal and the message box has a parent, then the message box will be a Qt::Sheet, otherwise the message box will be a standard dialog. */ diff --git a/src/widgets/dialogs/qwizard.cpp b/src/widgets/dialogs/qwizard.cpp index b9906f13da..219cfb62b1 100644 --- a/src/widgets/dialogs/qwizard.cpp +++ b/src/widgets/dialogs/qwizard.cpp @@ -1817,7 +1817,7 @@ void QWizardAntiFlickerWidget::paintEvent(QPaintEvent *) \inmodule QtWidgets - A wizard (also called an assistant on OS X) is a special type + A wizard (also called an assistant on \macos) is a special type of input dialog that consists of a sequence of pages. A wizard's purpose is to guide the user through a process step by step. Wizards are useful for complex or infrequent tasks that users may @@ -2115,10 +2115,10 @@ void QWizardAntiFlickerWidget::paintEvent(QPaintEvent *) This enum specifies the buttons in a wizard. - \value BackButton The \uicontrol Back button (\uicontrol {Go Back} on OS X) - \value NextButton The \uicontrol Next button (\uicontrol Continue on OS X) + \value BackButton The \uicontrol Back button (\uicontrol {Go Back} on \macos) + \value NextButton The \uicontrol Next button (\uicontrol Continue on \macos) \value CommitButton The \uicontrol Commit button - \value FinishButton The \uicontrol Finish button (\uicontrol Done on OS X) + \value FinishButton The \uicontrol Finish button (\uicontrol Done on \macos) \value CancelButton The \uicontrol Cancel button (see also NoCancelButton) \value HelpButton The \uicontrol Help button (see also HaveHelpButton) \value CustomButton1 The first user-defined button (see also HaveCustomButton1) @@ -2158,7 +2158,7 @@ void QWizardAntiFlickerWidget::paintEvent(QPaintEvent *) \value ClassicStyle Classic Windows look \value ModernStyle Modern Windows look - \value MacStyle OS X look + \value MacStyle \macos look \value AeroStyle Windows Aero look \omitvalue NStyles @@ -2631,7 +2631,7 @@ bool QWizard::testOption(WizardOption option) const \list \li Windows: HelpButtonOnRight. - \li OS X: NoDefaultButton and NoCancelButton. + \li \macos: NoDefaultButton and NoCancelButton. \li X11 and QWS (Qt for Embedded Linux): none. \endlist @@ -2675,7 +2675,7 @@ QWizard::WizardOptions QWizard::options() const Sets the text on button \a which to be \a text. By default, the text on buttons depends on the wizardStyle. For - example, on OS X, the \uicontrol Next button is called \uicontrol + example, on \macos, the \uicontrol Next button is called \uicontrol Continue. To add extra buttons to the wizard (e.g., a \uicontrol Print button), @@ -2707,7 +2707,7 @@ void QWizard::setButtonText(WizardButton which, const QString &text) If a text has ben set using setButtonText(), this text is returned. By default, the text on buttons depends on the wizardStyle. For - example, on OS X, the \uicontrol Next button is called \uicontrol + example, on \macos, the \uicontrol Next button is called \uicontrol Continue. \sa button(), setButton(), setButtonText(), QWizardPage::buttonText(), @@ -2893,7 +2893,7 @@ void QWizard::setPixmap(WizardPixmap which, const QPixmap &pixmap) Returns the pixmap set for role \a which. By default, the only pixmap that is set is the BackgroundPixmap on - OS X. + \macos. \sa QWizardPage::pixmap(), {Elements of a Wizard Page} */ @@ -3805,7 +3805,7 @@ void QWizardPage::setButtonText(QWizard::WizardButton which, const QString &text this text is returned. By default, the text on buttons depends on the QWizard::wizardStyle. - For example, on OS X, the \uicontrol Next button is called \uicontrol + For example, on \macos, the \uicontrol Next button is called \uicontrol Continue. \sa setButtonText(), QWizard::buttonText(), QWizard::setButtonText() -- cgit v1.2.3