QtBase
v6.3.1
|
The QPushButton widget provides a command button. More...
#include <qpushbutton.h>
Properties | |
bool | autoDefault |
whether the push button is an auto default button More... | |
bool | default |
whether the push button is the default button More... | |
bool | flat |
whether the button border is raised More... | |
Properties inherited from QAbstractButton | |
QString | text |
the text shown on the button More... | |
QIcon | icon |
the icon shown on the button More... | |
QSize | iconSize |
the icon size used for this button. More... | |
QKeySequence | shortcut |
the mnemonic associated with the button More... | |
bool | checkable |
whether the button is checkable More... | |
bool | checked |
whether the button is checked More... | |
bool | autoRepeat |
whether autoRepeat is enabled More... | |
bool | autoExclusive |
whether auto-exclusivity is enabled More... | |
int | autoRepeatDelay |
the initial delay of auto-repetition More... | |
int | autoRepeatInterval |
the interval of auto-repetition More... | |
bool | down |
whether the button is pressed down More... | |
Properties inherited from QWidget | |
bool | modal |
whether the widget is a modal widget More... | |
Qt::WindowModality | windowModality |
which windows are blocked by the modal widget More... | |
bool | enabled |
whether the widget is enabled More... | |
QRect | geometry |
the geometry of the widget relative to its parent and excluding the window frame More... | |
QRect | frameGeometry |
geometry of the widget relative to its parent including any window frame More... | |
QRect | normalGeometry |
the geometry of the widget as it will appear when shown as a normal (not maximized or full screen) top-level widget More... | |
int | x |
the x coordinate of the widget relative to its parent including any window frame More... | |
int | y |
the y coordinate of the widget relative to its parent and including any window frame More... | |
QPoint | pos |
the position of the widget within its parent widget More... | |
QSize | frameSize |
the size of the widget including any window frame More... | |
QSize | size |
the size of the widget excluding any window frame More... | |
int | width |
the width of the widget excluding any window frame More... | |
int | height |
the height of the widget excluding any window frame More... | |
QRect | rect |
the internal geometry of the widget excluding any window frame More... | |
QRect | childrenRect |
the bounding rectangle of the widget's children More... | |
QRegion | childrenRegion |
the combined region occupied by the widget's children More... | |
QSizePolicy | sizePolicy |
the default layout behavior of the widget More... | |
QSize | minimumSize |
the widget's minimum size More... | |
QSize | maximumSize |
the widget's maximum size in pixels More... | |
int | minimumWidth |
the widget's minimum width in pixels More... | |
int | minimumHeight |
the widget's minimum height in pixels More... | |
int | maximumWidth |
the widget's maximum width in pixels More... | |
int | maximumHeight |
the widget's maximum height in pixels More... | |
QSize | sizeIncrement |
the size increment of the widget More... | |
QSize | baseSize |
the base size of the widget More... | |
QPalette | palette |
the widget's palette More... | |
QFont | font |
the font currently set for the widget More... | |
QCursor | cursor |
the cursor shape for this widget More... | |
bool | mouseTracking |
whether mouse tracking is enabled for the widget More... | |
bool | tabletTracking |
whether tablet tracking is enabled for the widget More... | |
bool | isActiveWindow |
whether this widget's window is the active window More... | |
Qt::FocusPolicy | focusPolicy |
the way the widget accepts keyboard focus More... | |
bool | focus |
whether this widget (or its focus proxy) has the keyboard input focus More... | |
Qt::ContextMenuPolicy | contextMenuPolicy |
how the widget shows a context menu More... | |
bool | updatesEnabled |
whether updates are enabled More... | |
bool | visible |
whether the widget is visible More... | |
bool | minimized |
whether this widget is minimized (iconified) More... | |
bool | maximized |
whether this widget is maximized More... | |
bool | fullScreen |
whether the widget is shown in full screen mode More... | |
QSize | sizeHint |
the recommended size for the widget More... | |
QSize | minimumSizeHint |
the recommended minimum size for the widget More... | |
bool | acceptDrops |
whether drop events are enabled for this widget More... | |
QString | windowTitle |
the window title (caption) More... | |
QIcon | windowIcon |
the widget's icon More... | |
QString | windowIconText |
the text to be displayed on the icon of a minimized window More... | |
double | windowOpacity |
The level of opacity for the window. More... | |
bool | windowModified |
whether the document shown in the window has unsaved changes More... | |
QString | accessibleName |
the widget's name as seen by assistive technologies More... | |
QString | accessibleDescription |
the widget's description as seen by assistive technologies More... | |
Qt::LayoutDirection | layoutDirection |
the layout direction for this widget. More... | |
bool | autoFillBackground |
whether the widget background is filled automatically More... | |
QString | styleSheet |
the widget's style sheet More... | |
QLocale | locale |
the widget's locale More... | |
QString | windowFilePath |
the file path associated with a widget More... | |
Qt::InputMethodHints | inputMethodHints |
What input method specific hints the widget has. More... | |
Properties inherited from QObject | |
QString | objectName |
the name of this object More... | |
The QPushButton widget provides a command button.
\inmodule QtWidgets
The push button, or command button, is perhaps the most commonly used widget in any graphical user interface. Push (click) a button to command the computer to perform some action, or to answer a question. Typical buttons are OK, Apply, Cancel, Close, Yes, No and Help.
A command button is rectangular and typically displays a text label describing its action. A shortcut key can be specified by preceding the preferred character with an ampersand in the text. For example:
In this example the shortcut is {Alt+D}. See the \l {QShortcut::mnemonic}{QShortcut} documentation for details (to display an actual ampersand, use '&&').
Push buttons display a textual label, and optionally a small icon. These can be set using the constructors and changed later using setText() and setIcon(). If the button is disabled, the appearance of the text and icon will be manipulated with respect to the GUI style to make the button look "disabled".
A push button emits the signal clicked() when it is activated by the mouse, the Spacebar or by a keyboard shortcut. Connect to this signal to perform the button's action. Push buttons also provide less commonly used signals, for example pressed() and released().
Command buttons in dialogs are by default auto-default buttons, i.e., they become the default push button automatically when they receive the keyboard input focus. A default button is a push button that is activated when the user presses the Enter or Return key in a dialog. You can change this with setAutoDefault(). Note that auto-default buttons reserve a little extra space which is necessary to draw a default-button indicator. If you do not want this space around your buttons, call setAutoDefault(false).
Being so central, the button widget has grown to accommodate a great many variations in the past decade. The Microsoft style guide now shows about ten different states of Windows push buttons and the text implies that there are dozens more when all the combinations of features are taken into consideration.
The most important modes or states are: \list
As a general rule, use a push button when the application or dialog window performs an action when the user clicks on it (such as Apply, Cancel, Close and Help) and when the widget is supposed to have a wide, rectangular shape with a text label. Small, typically square buttons that change the state of the window rather than performing an action (such as the buttons in the top-right corner of the QFileDialog) are not command buttons, but tool buttons. Qt provides a special class (QToolButton) for these buttons.
If you need toggle behavior (see setCheckable()) or a button that auto-repeats the activation signal when being pushed down like the arrows in a scroll bar (see setAutoRepeat()), a command button is probably not what you want. When in doubt, use a tool button.
A variation of a command button is a menu button. These provide not just one command, but several, since when they are clicked they pop up a menu of options. Use the method setMenu() to associate a popup menu with a push button.
Other classes of buttons are option buttons (see QRadioButton) and check boxes (see QCheckBox).
In Qt, the QAbstractButton base class provides most of the modes and other API, and QPushButton provides GUI logic. See QAbstractButton for more information about the API.
Definition at line 55 of file qpushbutton.h.
Constructs a push button with no text and a parent.
Definition at line 239 of file qpushbutton.cpp.
Constructs a push button with the parent parent and the text text.
Definition at line 251 of file qpushbutton.cpp.
Constructs a push button with an icon and a text, and a parent.
Note that you can also pass a QPixmap object as an icon (thanks to the implicit type conversion provided by C++).
Definition at line 265 of file qpushbutton.cpp.
QPushButton::~QPushButton | ( | ) |
Destroys the push button.
Definition at line 284 of file qpushbutton.cpp.
|
protected |
Definition at line 274 of file qpushbutton.cpp.
bool QPushButton::autoDefault | ( | ) | const |
Definition at line 352 of file qpushbutton.cpp.
|
overrideprotectedvirtual |
\reimp
Reimplemented from QAbstractButton.
Definition at line 702 of file qpushbutton.cpp.
|
overrideprotectedvirtual |
\reimp
Reimplemented from QAbstractButton.
Definition at line 474 of file qpushbutton.cpp.
|
overrideprotectedvirtual |
\reimp
Reimplemented from QAbstractButton.
Definition at line 491 of file qpushbutton.cpp.
\reimp
Reimplemented from QAbstractButton.
Reimplemented in TestPushButton, TestButton, and TestPushButton.
Definition at line 535 of file qpushbutton.cpp.
|
protectedvirtual |
Initialize option with the values from this QPushButton. This method is useful for subclasses when they need a QStyleOptionButton, but don't want to fill in all the information themselves.
Reimplemented in QCommandLinkButton.
Definition at line 309 of file qpushbutton.cpp.
bool QPushButton::isDefault | ( | ) | const |
bool QPushButton::isFlat | ( | ) | const |
Definition at line 695 of file qpushbutton.cpp.
\reimp
Reimplemented from QAbstractButton.
Definition at line 455 of file qpushbutton.cpp.
|
overridevirtual |
\reimp
Reimplemented from QWidget.
Definition at line 437 of file qpushbutton.cpp.
|
overrideprotectedvirtual |
\reimp
Reimplemented from QAbstractButton.
Definition at line 514 of file qpushbutton.cpp.
|
overrideprotectedvirtual |
\reimp
Implements QAbstractButton.
Definition at line 445 of file qpushbutton.cpp.
void QPushButton::setAutoDefault | ( | bool | enable | ) |
Definition at line 340 of file qpushbutton.cpp.
void QPushButton::setDefault | ( | bool | enable | ) |
Definition at line 360 of file qpushbutton.cpp.
void QPushButton::setFlat | ( | bool | flat | ) |
Definition at line 683 of file qpushbutton.cpp.
|
overridevirtual |
\reimp
Reimplemented from QWidget.
Definition at line 390 of file qpushbutton.cpp.
|
readwrite |
whether the push button is an auto default button
If this property is set to true then the push button is an auto default button.
In some GUI styles a default button is drawn with an extra frame around it, up to 3 pixels or more. Qt automatically keeps this space free around auto-default buttons, i.e., auto-default buttons may have a slightly larger size hint.
This property's default is true for buttons that have a QDialog parent; otherwise it defaults to false.
See the \l default property for details of how \l default and auto-default interact.
Definition at line 111 of file qpushbutton.h.
|
readwrite |
whether the push button is the default button
Default and autodefault buttons decide what happens when the user presses enter in a dialog.
A button with this property set to true (i.e., the dialog's default button,) will automatically be pressed when the user presses enter, with one exception: if an autoDefault button currently has focus, the autoDefault button is pressed. When the dialog has \l autoDefault buttons but no default button, pressing enter will press either the \l autoDefault button that currently has focus, or if no button has focus, the next \l autoDefault button in the focus chain.
In a dialog, only one push button at a time can be the default button. This button is then displayed with an additional frame (depending on the GUI style).
The default button behavior is provided only in dialogs. Buttons can always be clicked from the keyboard by pressing Spacebar when the button has focus.
If the default property is set to false on the current default button while the dialog is visible, a new default will automatically be assigned the next time a push button in the dialog receives focus.
This property's default is false.
Definition at line 111 of file qpushbutton.h.
|
readwrite |
whether the button border is raised
This property's default is false. If this property is set, most styles will not paint the button background unless the button is being pressed. setAutoFillBackground() can be used to ensure that the background is filled using the QPalette::Button brush.
Definition at line 111 of file qpushbutton.h.