From a68577e7e07cce40cac142f6e2b386a76f3ecbd1 Mon Sep 17 00:00:00 2001 From: Jeremy Katz Date: Wed, 1 Aug 2012 14:36:13 +0200 Subject: replace \key and \gui qdoc commands with \uicontrol Change-Id: I0753305d4fe1ea20417f451766101da1247dfeeb Reviewed-by: Casper van Donderen --- src/gui/kernel/qevent.cpp | 8 ++--- src/gui/util/qdesktopservices.cpp | 2 +- src/printsupport/dialogs/qabstractprintdialog.cpp | 2 +- src/printsupport/doc/src/printing.qdoc | 2 +- src/widgets/dialogs/qmessagebox.cpp | 42 +++++++++++----------- src/widgets/doc/src/addressbook-fr.qdoc | 10 +++--- src/widgets/doc/src/addressbook.qdoc | 22 ++++++------ src/widgets/doc/src/model-view-programming.qdoc | 2 +- src/widgets/doc/src/widgets-and-layouts/focus.qdoc | 40 ++++++++++----------- .../doc/src/widgets-and-layouts/stylesheet.qdoc | 6 ++-- src/widgets/doc/src/widgets-tutorial.qdoc | 6 ++-- src/widgets/itemviews/qlistwidget.cpp | 2 +- src/widgets/itemviews/qtreewidget.cpp | 2 +- src/widgets/kernel/qwidget.cpp | 10 +++--- src/widgets/widgets/qabstractbutton.cpp | 4 +-- src/widgets/widgets/qdial.cpp | 8 ++--- src/widgets/widgets/qgroupbox.cpp | 2 +- src/widgets/widgets/qscrollbar.cpp | 2 +- 18 files changed, 86 insertions(+), 86 deletions(-) (limited to 'src') diff --git a/src/gui/kernel/qevent.cpp b/src/gui/kernel/qevent.cpp index 0c2dc0aae1..a0ea261034 100644 --- a/src/gui/kernel/qevent.cpp +++ b/src/gui/kernel/qevent.cpp @@ -843,7 +843,7 @@ QKeyEvent::~QKeyEvent() after the event occurred. \warning This function cannot always be trusted. The user can - confuse it by pressing both \key{Shift} keys simultaneously and + confuse it by pressing both \uicontrol{Shift} keys simultaneously and releasing one of them, for example. \sa QApplication::keyboardModifiers() @@ -952,7 +952,7 @@ bool QKeyEvent::matches(QKeySequence::StandardKey matchKey) const Focus events are sent to widgets when the keyboard input focus changes. Focus events occur due to mouse actions, key presses - (such as \gui{Tab} or \gui{Backtab}), the window system, popup + (such as \uicontrol{Tab} or \uicontrol{Backtab}), the window system, popup menus, keyboard shortcuts, or other application-specific reasons. The reason for a particular focus event is returned by reason() in the appropriate event handler. @@ -1198,7 +1198,7 @@ QResizeEvent::~QResizeEvent() Close events are sent to widgets that the user wants to close, usually by choosing "Close" from the window menu, or by clicking - the \gui{X} title bar button. They are also sent when you call + the \uicontrol{X} title bar button. They are also sent when you call QWidget::close() to close a widget programmatically. Close events contain a flag that indicates whether the receiver @@ -1880,7 +1880,7 @@ QVariant QInputMethodQueryEvent::value(Qt::InputMethodQuery query) const x and y axes respectively. \a keyState specifies which keyboard modifiers are pressed (e.g., - \key{Ctrl}). + \uicontrol{Ctrl}). The \a uniqueID parameter contains the unique ID for the current device. diff --git a/src/gui/util/qdesktopservices.cpp b/src/gui/util/qdesktopservices.cpp index 623cd893f9..b98337fa4d 100644 --- a/src/gui/util/qdesktopservices.cpp +++ b/src/gui/util/qdesktopservices.cpp @@ -132,7 +132,7 @@ void QOpenUrlHandlerRegistry::handlerDestroyed(QObject *handler) scheme to the default behavior. This system makes it easy to implement a help system, for example. Help could be - provided in labels and text browsers using \gui{help://myapplication/mytopic} + provided in labels and text browsers using \uicontrol{help://myapplication/mytopic} URLs, and by registering a handler it becomes possible to display the help text inside the application: diff --git a/src/printsupport/dialogs/qabstractprintdialog.cpp b/src/printsupport/dialogs/qabstractprintdialog.cpp index 841a9e688e..055a73c775 100644 --- a/src/printsupport/dialogs/qabstractprintdialog.cpp +++ b/src/printsupport/dialogs/qabstractprintdialog.cpp @@ -393,7 +393,7 @@ void QAbstractPrintDialogPrivate::setPrinter(QPrinter *newPrinter) The printer dialog (shown above in Plastique style) enables access to common printing properties. On X11 platforms that use the CUPS printing system, the settings for each available printer can be modified via the dialog's - \gui{Properties} push button. + \uicontrol{Properties} push button. On Windows and Mac OS X, the native print dialog is used, which means that some QWidget and QDialog properties set on the dialog won't be respected. diff --git a/src/printsupport/doc/src/printing.qdoc b/src/printsupport/doc/src/printing.qdoc index 69f3cd5019..aff04206e6 100644 --- a/src/printsupport/doc/src/printing.qdoc +++ b/src/printsupport/doc/src/printing.qdoc @@ -67,7 +67,7 @@ Although QPrinter objects can be constructed and set up without requiring user input, printing is often performed as a result of a request by the user; - for example, when the user selects the \gui{File|Print...} menu item in a GUI + for example, when the user selects the \uicontrol{File|Print...} menu item in a GUI application. In such cases, a newly-constructed QPrinter object is supplied to a QPrintDialog, allowing the user to specify the printer to use, paper size, and other printing properties. diff --git a/src/widgets/dialogs/qmessagebox.cpp b/src/widgets/dialogs/qmessagebox.cpp index 1064ac4a74..ba70d4dd60 100644 --- a/src/widgets/dialogs/qmessagebox.cpp +++ b/src/widgets/dialogs/qmessagebox.cpp @@ -649,33 +649,33 @@ void QMessageBoxPrivate::_q_buttonClicked(QAbstractButton *button) \section1 Default and Escape Keys - The default button (i.e., the button activated when \key Enter is + The default button (i.e., the button activated when \uicontrol Enter is pressed) can be specified using setDefaultButton(). If a default button is not specified, QMessageBox tries to find one based on the \l{ButtonRole} {button roles} of the buttons used in the message box. - The escape button (the button activated when \key Esc is pressed) + The escape button (the button activated when \uicontrol Esc is pressed) can be specified using setEscapeButton(). If an escape button is not specified, QMessageBox tries to find one using these rules: \list 1 \li If there is only one button, it is the button activated when - \key Esc is pressed. + \uicontrol Esc is pressed. \li If there is a \l Cancel button, it is the button activated when - \key Esc is pressed. + \uicontrol Esc is pressed. \li If there is exactly one button having either \l{QMessageBox::RejectRole} {the Reject role} or the \l{QMessageBox::NoRole} {the No role}, it is the button - activated when \key Esc is pressed. + activated when \uicontrol Esc is pressed. \endlist When an escape button can't be determined using these rules, - pressing \key Esc has no effect. + pressing \uicontrol Esc has no effect. \sa QDialogButtonBox, {fowler}{GUI Design Handbook: Message Box}, {Standard Dialogs Example}, {Application Example} */ @@ -932,7 +932,7 @@ QAbstractButton *QMessageBox::button(StandardButton which) const \endlist When an escape button could not be automatically detected, pressing - \key Esc has no effect. + \uicontrol Esc has no effect. \sa addButton() */ @@ -945,7 +945,7 @@ QAbstractButton *QMessageBox::escapeButton() const /*! \since 4.2 - Sets the button that gets activated when the \key Escape key is + Sets the button that gets activated when the \uicontrol Escape key is pressed to \a button. \sa addButton(), clickedButton() @@ -960,7 +960,7 @@ void QMessageBox::setEscapeButton(QAbstractButton *button) /*! \since 4.3 - Sets the buttons that gets activated when the \key Escape key is + Sets the buttons that gets activated when the \uicontrol Escape key is pressed to \a button. \sa addButton(), clickedButton() @@ -1019,7 +1019,7 @@ void QMessageBoxPrivate::detectEscapeButton() \since 4.2 Returns the button that was clicked by the user, - or 0 if the user hit the \key Esc key and + or 0 if the user hit the \uicontrol Esc key and no \l{setEscapeButton()}{escape button} was set. If exec() hasn't been called yet, returns 0. @@ -1518,13 +1518,13 @@ static QMessageBox::StandardButton showNewMessageBox(QWidget *parent, \a text in front of the specified \a parent widget. The standard \a buttons are added to the message box. - \a defaultButton specifies the button used when \key Enter is pressed. + \a defaultButton specifies the button used when \uicontrol Enter is pressed. \a defaultButton must refer to a button that was given in \a buttons. If \a defaultButton is QMessageBox::NoButton, QMessageBox chooses a suitable default automatically. Returns the identity of the standard button that was clicked. If - \key Esc was pressed instead, the \l{Default and Escape Keys} + \uicontrol Esc was pressed instead, the \l{Default and Escape Keys} {escape button} is returned. The message box is an \l{Qt::ApplicationModal}{application modal} @@ -1552,13 +1552,13 @@ QMessageBox::StandardButton QMessageBox::information(QWidget *parent, const QStr text in front of the specified \a parent widget. The standard \a buttons are added to the message box. \a - defaultButton specifies the button used when \key Enter is + defaultButton specifies the button used when \uicontrol Enter is pressed. \a defaultButton must refer to a button that was given in \a buttons. If \a defaultButton is QMessageBox::NoButton, QMessageBox chooses a suitable default automatically. Returns the identity of the standard button that was clicked. If - \key Esc was pressed instead, the \l{Default and Escape Keys} + \uicontrol Esc was pressed instead, the \l{Default and Escape Keys} {escape button} is returned. The message box is an \l{Qt::ApplicationModal} {application modal} @@ -1584,13 +1584,13 @@ QMessageBox::StandardButton QMessageBox::question(QWidget *parent, const QString text in front of the specified \a parent widget. The standard \a buttons are added to the message box. \a - defaultButton specifies the button used when \key Enter is + defaultButton specifies the button used when \uicontrol Enter is pressed. \a defaultButton must refer to a button that was given in \a buttons. If \a defaultButton is QMessageBox::NoButton, QMessageBox chooses a suitable default automatically. Returns the identity of the standard button that was clicked. If - \key Esc was pressed instead, the \l{Default and Escape Keys} + \uicontrol Esc was pressed instead, the \l{Default and Escape Keys} {escape button} is returned. The message box is an \l{Qt::ApplicationModal} {application modal} @@ -1616,13 +1616,13 @@ QMessageBox::StandardButton QMessageBox::warning(QWidget *parent, const QString text in front of the specified \a parent widget. The standard \a buttons are added to the message box. \a - defaultButton specifies the button used when \key Enter is + defaultButton specifies the button used when \uicontrol Enter is pressed. \a defaultButton must refer to a button that was given in \a buttons. If \a defaultButton is QMessageBox::NoButton, QMessageBox chooses a suitable default automatically. Returns the identity of the standard button that was clicked. If - \key Esc was pressed instead, the \l{Default and Escape Keys} + \uicontrol Esc was pressed instead, the \l{Default and Escape Keys} {escape button} is returned. The message box is an \l{Qt::ApplicationModal} {application modal} @@ -1958,7 +1958,7 @@ void QMessageBoxPrivate::retranslateStrings() pressed). One of the buttons can be OR-ed with the QMessageBox::Escape flag - to make it the cancel or close button (clicked when \key Esc is + to make it the cancel or close button (clicked when \uicontrol Esc is pressed). \snippet dialogs/dialogs.cpp 2 @@ -2045,8 +2045,8 @@ int QMessageBox::information(QWidget *parent, const QString &title, const QStrin default button; pressing Return or Enter is the same as clicking the default button. It defaults to 0 (the first button). \a escapeButtonNumber is the index of the escape button; pressing - \key Esc is the same as clicking this button. It defaults to -1; - supply 0, 1 or 2 to make pressing \key Esc equivalent to clicking + \uicontrol Esc is the same as clicking this button. It defaults to -1; + supply 0, 1 or 2 to make pressing \uicontrol Esc equivalent to clicking the relevant button. The message box is an \l{Qt::ApplicationModal} {application modal} diff --git a/src/widgets/doc/src/addressbook-fr.qdoc b/src/widgets/doc/src/addressbook-fr.qdoc index edd53239d0..06bbca0b6a 100644 --- a/src/widgets/doc/src/addressbook-fr.qdoc +++ b/src/widgets/doc/src/addressbook-fr.qdoc @@ -704,11 +704,11 @@ par les classes qui instancient \c FindDialog, ce qui leur permet d'obtenir le texte entré par l'utilisateur. Un slot public, \c findClicked(), est défini pour prendre en charge le texte lorsque l'utilisateur clique sur - le bouton \gui Find. + le bouton \uicontrol Find. Finalement, nous définissons les variables privées \c findButton, \c lineEdit et \c findText, qui correspondent respectivement au bouton - \gui Find, au champ de texte dans lequel l'utilisateur tape le texte + \uicontrol Find, au champ de texte dans lequel l'utilisateur tape le texte à rechercher, et à une variable interne stockant le texte pour une utilisation ultérieure. @@ -733,7 +733,7 @@ \image addressbook-tutorial-part5-signals-and-slots.png Dans \c findClicked(), nous validons le champ de texte pour nous - assurer que l'utilisateur n'a pas cliqué sur le bouton \gui Find sans + assurer que l'utilisateur n'a pas cliqué sur le bouton \uicontrol Find sans avoir entré un nom de contact. Ensuite, nous stockons le texte du champ d'entrée \c lineEdit dans \c findText. Et finalement nous vidons le contenu de \c lineEdit et cachons la boîte de dialogue. @@ -759,7 +759,7 @@ Jusqu'ici, toutes les fonctionnalités du carnet d'adresses ont un QPushButton et un slot correspondant. De la même façon, pour la - fonctionnalité \gui Find, nous avons \c findButton et \c findContact(). + fonctionnalité \uicontrol Find, nous avons \c findButton et \c findContact(). Le \c findButton est déclaré comme une variable privée et la méthode \c findContact() est déclarée comme un slot public. @@ -856,7 +856,7 @@ Idéalement, l'interface serait plus conviviale avec des boutons affichant "Load contacts from a file" et "Save contacts to a file". Mais compte tenu de la dimension des autres boutons, on initialise les labels - des boutons à \gui{Load...} et \gui{Save...}. Heureusement, Qt offre une + des boutons à \uicontrol{Load...} et \uicontrol{Save...}. Heureusement, Qt offre une façon simple d'ajouter des info-bulles avec \l{QWidget::setToolTip()}{setToolTip()}, et nous l'exploitons de la façon suivante pour nos boutons: diff --git a/src/widgets/doc/src/addressbook.qdoc b/src/widgets/doc/src/addressbook.qdoc index 27bdb0fac4..ca0531c13c 100644 --- a/src/widgets/doc/src/addressbook.qdoc +++ b/src/widgets/doc/src/addressbook.qdoc @@ -276,8 +276,8 @@ We also declare two private QString objects, \c oldName and \c oldAddress. These objects are needed to hold the name and address of the contact that - was last displayed, before the user clicked \gui Add. So, when the user clicks - \gui Cancel, we can revert to displaying the details of the last contact. + was last displayed, before the user clicked \uicontrol Add. So, when the user clicks + \uicontrol Cancel, we can revert to displaying the details of the last contact. \section1 Implementing the AddressBook Class @@ -298,7 +298,7 @@ The \c addButton is displayed by invoking the \l{QPushButton::show()} {show()} function, while the \c submitButton and \c cancelButton are hidden by invoking \l{QPushButton::hide()}{hide()}. These two push - buttons will only be displayed when the user clicks \gui Add and this is + buttons will only be displayed when the user clicks \uicontrol Add and this is handled by the \c addContact() function discussed below. \snippet tutorials/addressbook/part2/addressbook.cpp connecting signals and slots @@ -342,7 +342,7 @@ \list 1 \li We extract the contact's details from \c nameLine and \c addressText and store them in QString objects. We also validate to make sure that the - user did not click \gui Submit with empty input fields; otherwise, a + user did not click \uicontrol Submit with empty input fields; otherwise, a QMessageBox is displayed to remind the user for a name and address. \snippet tutorials/addressbook/part2/addressbook.cpp submitContact part1 @@ -377,7 +377,7 @@ \snippet tutorials/addressbook/part2/addressbook.cpp cancel The general idea behind adding a contact is to give the user the - flexibility to click \gui Submit or \gui Cancel at any time. The flowchart below + flexibility to click \uicontrol Submit or \uicontrol Cancel at any time. The flowchart below further explains this concept: \image addressbook-tutorial-part2-add-flowchart.png @@ -673,11 +673,11 @@ We define a public function, \c getFindText(), to be used by classes that instantiate \c FindDialog. This function allows these classes to obtain the search string entered by the user. A public slot, \c findClicked(), is also - defined to handle the search string when the user clicks the \gui Find + defined to handle the search string when the user clicks the \uicontrol Find button. Lastly, we define the private variables, \c findButton, \c lineEdit - and \c findText, corresponding to the \gui Find button, the line edit + and \c findText, corresponding to the \uicontrol Find button, the line edit into which the user types the search string, and an internal string used to store the search string for later use. @@ -702,7 +702,7 @@ \image addressbook-tutorial-part5-signals-and-slots.png In \c findClicked(), we validate \c lineEdit to ensure that the user - did not click the \gui Find button without entering a contact's name. Then, we set + did not click the \uicontrol Find button without entering a contact's name. Then, we set \c findText to the search string, extracted from \c lineEdit. After that, we clear the contents of \c lineEdit and hide the dialog. @@ -726,7 +726,7 @@ \snippet tutorials/addressbook/part5/addressbook.h include finddialog's header So far, all our address book features have a QPushButton and a - corresponding slot. Similarly, for the \gui Find feature we have + corresponding slot. Similarly, for the \uicontrol Find feature we have \c findButton and \c findContact(). The \c findButton is declared as a private variable and the @@ -821,8 +821,8 @@ In our constructor, we instantiate \c loadButton and \c saveButton. Ideally, it would be more user-friendly to set the push buttons' labels to "Load contacts from a file" and "Save contacts to a file". However, due - to the size of our other push buttons, we set the labels to \gui{Load...} - and \gui{Save...}. Fortunately, Qt provides a simple way to set tooltips with + to the size of our other push buttons, we set the labels to \uicontrol{Load...} + and \uicontrol{Save...}. Fortunately, Qt provides a simple way to set tooltips with \l{QWidget::setToolTip()}{setToolTip()} and we use it in the following way for our push buttons: diff --git a/src/widgets/doc/src/model-view-programming.qdoc b/src/widgets/doc/src/model-view-programming.qdoc index 0e48efbff8..f3b94e31aa 100644 --- a/src/widgets/doc/src/model-view-programming.qdoc +++ b/src/widgets/doc/src/model-view-programming.qdoc @@ -851,7 +851,7 @@ The behavior of the spin box could be adjusted to make it more user friendly. In the default event filter supplied by QItemDelegate, if - the user hits \key Return to confirm their choice in the spin box, + the user hits \uicontrol Return to confirm their choice in the spin box, the delegate commits the value to the model and closes the spin box. We can change this behavior by installing our own event filter on the spin box, and provide editing hints that suit our needs; for example, diff --git a/src/widgets/doc/src/widgets-and-layouts/focus.qdoc b/src/widgets/doc/src/widgets-and-layouts/focus.qdoc index 60f05948b4..7417f34eaf 100644 --- a/src/widgets/doc/src/widgets-and-layouts/focus.qdoc +++ b/src/widgets/doc/src/widgets-and-layouts/focus.qdoc @@ -51,7 +51,7 @@ \list 1 - \li The user presses \key Tab (or \key Shift+Tab). + \li The user presses \uicontrol Tab (or \uicontrol Shift+Tab). \li The user clicks a widget. \li The user presses a keyboard shortcut. \li The user uses the mouse wheel. @@ -65,36 +65,36 @@ \section2 Tab or Shift+Tab - Pressing \key Tab is by far the most common way to move focus + Pressing \uicontrol Tab is by far the most common way to move focus using the keyboard. (Sometimes in data-entry applications Enter - does the same as \key{Tab}; this can easily be achieved in Qt by + does the same as \uicontrol{Tab}; this can easily be achieved in Qt by implementing an \l{The Event System}{event filter}.) - Pressing \key Tab, in all window systems in common use today, + Pressing \uicontrol Tab, in all window systems in common use today, moves the keyboard focus to the next widget in a circular - per-window list. \key Tab moves focus along the circular list in - one direction, \key Shift+Tab in the other. The order in which - \key Tab presses move from widget to widget is called the tab order. + per-window list. \uicontrol Tab moves focus along the circular list in + one direction, \uicontrol Shift+Tab in the other. The order in which + \uicontrol Tab presses move from widget to widget is called the tab order. You can customize the tab order using QWidget::setTabOrder(). (If - you don't, \key Tab generally moves focus in the order of widget + you don't, \uicontrol Tab generally moves focus in the order of widget construction.) \l{Qt Designer} provides a means of visually changing the tab order. - Since pressing \key Tab is so common, most widgets that can have focus + Since pressing \uicontrol Tab is so common, most widgets that can have focus should support tab focus. The major exception is widgets that are rarely used, and where there is some keyboard accelerator or error handler that moves the focus. For example, in a data entry dialog, there might be a field that is only necessary in one per cent of all cases. In such a dialog, - \key Tab could skip this field, and the dialog could use one of + \uicontrol Tab could skip this field, and the dialog could use one of these mechanisms: \list 1 \li If the program can determine whether the field is needed, it can - move focus there when the user finishes entry and presses \gui OK, or when + move focus there when the user finishes entry and presses \uicontrol OK, or when the user presses Enter after finishing the other fields. Alternately, include the field in the tab order but disable it. Enable it if it becomes appropriate in view of what the user has set in the other @@ -105,22 +105,22 @@ \endlist - Another exception to \key Tab support is text-entry widgets that + Another exception to \uicontrol Tab support is text-entry widgets that must support the insertion of tabs; almost all text editors fall - into this class. Qt treats \key Ctrl+Tab as \key Tab and \key - Ctrl+Shift+Tab as \key Shift+Tab, and such widgets can + into this class. Qt treats \uicontrol Ctrl+Tab as \uicontrol Tab and \uicontrol + Ctrl+Shift+Tab as \uicontrol Shift+Tab, and such widgets can reimplement QWidget::event() and handle Tab before calling QWidget::event() to get normal processing of all other keys. - However, since some systems use \key Ctrl+Tab for other purposes, - and many users aren't aware of \key Ctrl+Tab anyway, this isn't a + However, since some systems use \uicontrol Ctrl+Tab for other purposes, + and many users aren't aware of \uicontrol Ctrl+Tab anyway, this isn't a complete solution. \section2 The User Clicks a Widget - This is perhaps even more common than pressing \key Tab on + This is perhaps even more common than pressing \uicontrol Tab on computers with a mouse or other pointing device. - Clicking to move the focus is slightly more powerful than \key + Clicking to move the focus is slightly more powerful than \uicontrol Tab. While it moves the focus \e to a widget, for editor widgets it also moves the text cursor (the widget's internal focus) to the spot where the mouse is clicked. @@ -152,10 +152,10 @@ We advise supporting shortcut focus for all widgets that the user may want to jump to. For example, a tab dialog can have keyboard - shortcuts for each of its pages, so the user can press e.g. \key + shortcuts for each of its pages, so the user can press e.g. \uicontrol Alt+P to step to the \underline{P}rinting page. It is easy to overdo this: there are only a few keys, and it's also important - to provide keyboard shortcuts for commands. \key Alt+P is also + to provide keyboard shortcuts for commands. \uicontrol Alt+P is also used for Paste, Play, Print, and Print Here in the \l{Standard Accelerator Keys} list, for example. diff --git a/src/widgets/doc/src/widgets-and-layouts/stylesheet.qdoc b/src/widgets/doc/src/widgets-and-layouts/stylesheet.qdoc index 75835f0038..31d6d34517 100644 --- a/src/widgets/doc/src/widgets-and-layouts/stylesheet.qdoc +++ b/src/widgets/doc/src/widgets-and-layouts/stylesheet.qdoc @@ -550,18 +550,18 @@ \l{Qt Designer}{Qt Designer} is an excellent tool to preview style sheets. You can right-click on any widget in Designer - and select \gui{Change styleSheet...} to set the style sheet. + and select \uicontrol{Change styleSheet...} to set the style sheet. \image designer-stylesheet-options.png In Qt 4.2 and later, \l{Qt Designer}{Qt Designer} also includes a style sheet syntax highlighter and validator. The validator indicates - if the syntax is valid or invalid, at the bottom left of the \gui{Edit + if the syntax is valid or invalid, at the bottom left of the \uicontrol{Edit Style Sheet} dialog. \image designer-validator-highlighter.png - When you click \gui{OK} or \gui{Apply}, \QD will automatically display + When you click \uicontrol{OK} or \uicontrol{Apply}, \QD will automatically display the widget with its new stylesheet. \image designer-stylesheet-usage.png diff --git a/src/widgets/doc/src/widgets-tutorial.qdoc b/src/widgets/doc/src/widgets-tutorial.qdoc index 37f095d500..10eabd1368 100644 --- a/src/widgets/doc/src/widgets-tutorial.qdoc +++ b/src/widgets/doc/src/widgets-tutorial.qdoc @@ -106,13 +106,13 @@ \li From a command prompt, enter the directory containing the example you have modified. - \li Type \c qmake and press \key{Return}. If this doesn't work, + \li Type \c qmake and press \uicontrol{Return}. If this doesn't work, make sure that the executable is on your path, or enter its full location. \li On Linux/Unix and Mac OS X, type \c make and press - \key{Return}; on Windows with Visual Studio, type \c nmake and - press \key{Return}. + \uicontrol{Return}; on Windows with Visual Studio, type \c nmake and + press \uicontrol{Return}. \endlist diff --git a/src/widgets/itemviews/qlistwidget.cpp b/src/widgets/itemviews/qlistwidget.cpp index 23b7989634..39889a6b29 100644 --- a/src/widgets/itemviews/qlistwidget.cpp +++ b/src/widgets/itemviews/qlistwidget.cpp @@ -1259,7 +1259,7 @@ void QListWidgetPrivate::_q_dataChanged(const QModelIndex &topLeft, activated when the user clicks or double clicks on it, depending on the system configuration. It is also activated when the user presses the activation key (on Windows and X11 this is the \uicontrol Return key, on Mac OS - X it is \key{Ctrl+0}). + X it is \uicontrol{Ctrl+0}). */ /*! diff --git a/src/widgets/itemviews/qtreewidget.cpp b/src/widgets/itemviews/qtreewidget.cpp index 653a17d2d2..aa614e8191 100644 --- a/src/widgets/itemviews/qtreewidget.cpp +++ b/src/widgets/itemviews/qtreewidget.cpp @@ -2402,7 +2402,7 @@ void QTreeWidgetPrivate::_q_dataChanged(const QModelIndex &topLeft, This signal is emitted when the user activates an item by single- or double-clicking (depending on the platform, i.e. on the QStyle::SH_ItemView_ActivateItemOnSingleClick style hint) or - pressing a special key (e.g., \key Enter). + pressing a special key (e.g., \uicontrol Enter). The specified \a item is the item that was clicked, or 0 if no item was clicked. The \a column is the item's column that was diff --git a/src/widgets/kernel/qwidget.cpp b/src/widgets/kernel/qwidget.cpp index 747d0a049a..ac2c5f20a3 100644 --- a/src/widgets/kernel/qwidget.cpp +++ b/src/widgets/kernel/qwidget.cpp @@ -629,7 +629,7 @@ void QWidget::setAutoFillBackground(bool enabled) \list \li keyPressEvent() is called whenever a key is pressed, and again when a key has been held down long enough for it to auto-repeat. The - \key Tab and \key Shift+Tab keys are only passed to the widget if + \uicontrol Tab and \uicontrol Shift+Tab keys are only passed to the widget if they are not used by the focus-change mechanisms. To force those keys to be processed by your widget, you must reimplement QWidget::event(). @@ -652,7 +652,7 @@ void QWidget::setAutoFillBackground(bool enabled) \li keyReleaseEvent() is called whenever a key is released and while it is held down (if the key is auto-repeating). In that case, the widget will receive a pair of key release and key press event for - every repeat. The \key Tab and \key Shift+Tab keys are only passed + every repeat. The \uicontrol Tab and \uicontrol Shift+Tab keys are only passed to the widget if they are not used by the focus-change mechanisms. To force those keys to be processed by your widget, you must reimplement QWidget::event(). @@ -674,7 +674,7 @@ void QWidget::setAutoFillBackground(bool enabled) for QEvent::Type. To handle these events, you need to reimplement event() directly. - The default implementation of event() handles \key Tab and \key Shift+Tab + The default implementation of event() handles \uicontrol Tab and \uicontrol Shift+Tab (to move the keyboard focus), and passes on most of the other events to one of the more specialized handlers above. @@ -6079,7 +6079,7 @@ void QWidget::clearFocus() \fn bool QWidget::focusNextChild() Finds a new widget to give the keyboard focus to, as appropriate - for \key Tab, and returns true if it can find a new widget, or + for \uicontrol Tab, and returns true if it can find a new widget, or false if it can't. \sa focusPreviousChild() @@ -6089,7 +6089,7 @@ void QWidget::clearFocus() \fn bool QWidget::focusPreviousChild() Finds a new widget to give the keyboard focus to, as appropriate - for \key Shift+Tab, and returns true if it can find a new widget, + for \uicontrol Shift+Tab, and returns true if it can find a new widget, or false if it can't. \sa focusNextChild() diff --git a/src/widgets/widgets/qabstractbutton.cpp b/src/widgets/widgets/qabstractbutton.cpp index c263e5c239..1514fd0fa4 100644 --- a/src/widgets/widgets/qabstractbutton.cpp +++ b/src/widgets/widgets/qabstractbutton.cpp @@ -88,8 +88,8 @@ Q_WIDGETS_EXPORT extern bool qt_tab_all_widgets; \snippet code/src_gui_widgets_qabstractbutton.cpp 0 - The \key Alt+C shortcut is assigned to the button, i.e., when the - user presses \key Alt+C the button will call animateClick(). See + The \uicontrol Alt+C shortcut is assigned to the button, i.e., when the + user presses \uicontrol Alt+C the button will call animateClick(). See the \l {QShortcut#mnemonic}{QShortcut} documentation for details (to display an actual ampersand, use '&&'). diff --git a/src/widgets/widgets/qdial.cpp b/src/widgets/widgets/qdial.cpp index e3fe390f2a..38e3d3a655 100644 --- a/src/widgets/widgets/qdial.cpp +++ b/src/widgets/widgets/qdial.cpp @@ -215,11 +215,11 @@ int QDialPrivate::valueFromPoint(const QPoint &p) const subtractPage() available as slots. The dial's keyboard interface is fairly simple: The - \key{left}/\key{up} and \key{right}/\key{down} arrow keys adjust + \uicontrol{left}/\uicontrol{up} and \uicontrol{right}/\uicontrol{down} arrow keys adjust the dial's \l {QAbstractSlider::value} {value} by the defined - \l {QAbstractSlider::singleStep} {singleStep}, \key{Page Up} and - \key{Page Down} by the defined \l {QAbstractSlider::pageStep} - {pageStep}, and the \key Home and \key End keys set the value to + \l {QAbstractSlider::singleStep} {singleStep}, \uicontrol{Page Up} and + \uicontrol{Page Down} by the defined \l {QAbstractSlider::pageStep} + {pageStep}, and the \uicontrol Home and \uicontrol End keys set the value to the defined \l {QAbstractSlider::minimum} {minimum} and \l {QAbstractSlider::maximum} {maximum} values. diff --git a/src/widgets/widgets/qgroupbox.cpp b/src/widgets/widgets/qgroupbox.cpp index 343fc85bc9..64875074a3 100644 --- a/src/widgets/widgets/qgroupbox.cpp +++ b/src/widgets/widgets/qgroupbox.cpp @@ -263,7 +263,7 @@ void QGroupBox::setTitle(const QString &title) \snippet code/src_gui_widgets_qgroupbox.cpp 0 - In the example above, \key Alt+U moves the keyboard focus to the + In the example above, \uicontrol Alt+U moves the keyboard focus to the group box. See the \l {QShortcut#mnemonic}{QShortcut} documentation for details (to display an actual ampersand, use '&&'). diff --git a/src/widgets/widgets/qscrollbar.cpp b/src/widgets/widgets/qscrollbar.cpp index 6ac5473f2e..e896173884 100644 --- a/src/widgets/widgets/qscrollbar.cpp +++ b/src/widgets/widgets/qscrollbar.cpp @@ -118,7 +118,7 @@ QT_BEGIN_NAMESPACE The length of the slider is usually related to the value of the page step, and typically represents the proportion of the document area shown in a scrolling view. The page step is the amount that the value changes by - when the user presses the \key{Page Up} and \key{Page Down} keys, and is + when the user presses the \uicontrol{Page Up} and \uicontrol{Page Down} keys, and is set with setPageStep(). Smaller changes to the value defined by the line step are made using the cursor keys, and this quantity is set with \l{QAbstractSlider::}{setSingleStep()}. -- cgit v1.2.3