6
6
td.postheader { font-family: sans-serif }
7
7
tr.address { font-family: sans-serif }
8
8
body { background: #ffffff; color: black; }
9
</style></head><body><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr /><td align="left" valign="top" width="32"><img align="left" border="0" height="32" src="images/rb-logo.png" width="32" /></td><td width="1">  </td><td class="postheader" valign="center"><a href="../pyqt4ref.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a></td></table><h1 align="center">QAbstractButton Class Reference<br /><sup><sup>[<a href="qtgui.html">QtGui</a> module]</sup></sup></h1><p>The QAbstractButton class is the abstract base class of button widgets, providing functionality common to buttons. <a href="#details">More...</a></p>
10
<p>Inherits <a href="qwidget.html">QWidget</a>.</p><p>Inherited by <a href="qcheckbox.html">QCheckBox</a>, <a href="qpushbutton.html">QPushButton</a>, <a href="qradiobutton.html">QRadioButton</a> and <a href="qtoolbutton.html">QToolButton</a>.</p><h3>Methods</h3><ul><li><div class="fn" /><b><a href="qabstractbutton.html#QAbstractButton">__init__</a></b> (<i>self</i>, QWidget <i>parent</i> = None)</li><li><div class="fn" /><b><a href="qabstractbutton.html#animateClick">animateClick</a></b> (<i>self</i>, int <i>msecs</i> = 100)</li><li><div class="fn" />bool <b><a href="qabstractbutton.html#autoExclusive">autoExclusive</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qabstractbutton.html#autoRepeat">autoRepeat</a></b> (<i>self</i>)</li><li><div class="fn" />int <b><a href="qabstractbutton.html#autoRepeatDelay">autoRepeatDelay</a></b> (<i>self</i>)</li><li><div class="fn" />int <b><a href="qabstractbutton.html#autoRepeatInterval">autoRepeatInterval</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qabstractbutton.html#changeEvent">changeEvent</a></b> (<i>self</i>, QEvent)</li><li><div class="fn" /><b><a href="qabstractbutton.html#checkStateSet">checkStateSet</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qabstractbutton.html#click">click</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qabstractbutton.html#event">event</a></b> (<i>self</i>, QEvent)</li><li><div class="fn" /><b><a href="qabstractbutton.html#focusInEvent">focusInEvent</a></b> (<i>self</i>, QFocusEvent)</li><li><div class="fn" /><b><a href="qabstractbutton.html#focusOutEvent">focusOutEvent</a></b> (<i>self</i>, QFocusEvent)</li><li><div class="fn" />QButtonGroup <b><a href="qabstractbutton.html#group">group</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qabstractbutton.html#hitButton">hitButton</a></b> (<i>self</i>, QPoint)</li><li><div class="fn" />QIcon <b><a href="qabstractbutton.html#icon">icon</a></b> (<i>self</i>)</li><li><div class="fn" />QSize <b><a href="qabstractbutton.html#iconSize">iconSize</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qabstractbutton.html#isCheckable">isCheckable</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qabstractbutton.html#isChecked">isChecked</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qabstractbutton.html#isDown">isDown</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qabstractbutton.html#keyPressEvent">keyPressEvent</a></b> (<i>self</i>, QKeyEvent)</li><li><div class="fn" /><b><a href="qabstractbutton.html#keyReleaseEvent">keyReleaseEvent</a></b> (<i>self</i>, QKeyEvent)</li><li><div class="fn" /><b><a href="qabstractbutton.html#mouseMoveEvent">mouseMoveEvent</a></b> (<i>self</i>, QMouseEvent)</li><li><div class="fn" /><b><a href="qabstractbutton.html#mousePressEvent">mousePressEvent</a></b> (<i>self</i>, QMouseEvent)</li><li><div class="fn" /><b><a href="qabstractbutton.html#mouseReleaseEvent">mouseReleaseEvent</a></b> (<i>self</i>, QMouseEvent)</li><li><div class="fn" /><b><a href="qabstractbutton.html#nextCheckState">nextCheckState</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qabstractbutton.html#paintEvent">paintEvent</a></b> (<i>self</i>, QPaintEvent)</li><li><div class="fn" /><b><a href="qabstractbutton.html#setAutoExclusive">setAutoExclusive</a></b> (<i>self</i>, bool)</li><li><div class="fn" /><b><a href="qabstractbutton.html#setAutoRepeat">setAutoRepeat</a></b> (<i>self</i>, bool)</li><li><div class="fn" /><b><a href="qabstractbutton.html#setAutoRepeatDelay">setAutoRepeatDelay</a></b> (<i>self</i>, int)</li><li><div class="fn" /><b><a href="qabstractbutton.html#setAutoRepeatInterval">setAutoRepeatInterval</a></b> (<i>self</i>, int)</li><li><div class="fn" /><b><a href="qabstractbutton.html#setCheckable">setCheckable</a></b> (<i>self</i>, bool)</li><li><div class="fn" /><b><a href="qabstractbutton.html#setChecked">setChecked</a></b> (<i>self</i>, bool)</li><li><div class="fn" /><b><a href="qabstractbutton.html#setDown">setDown</a></b> (<i>self</i>, bool)</li><li><div class="fn" /><b><a href="qabstractbutton.html#setIcon">setIcon</a></b> (<i>self</i>, QIcon)</li><li><div class="fn" /><b><a href="qabstractbutton.html#setIconSize">setIconSize</a></b> (<i>self</i>, QSize)</li><li><div class="fn" /><b><a href="qabstractbutton.html#setShortcut">setShortcut</a></b> (<i>self</i>, QKeySequence)</li><li><div class="fn" /><b><a href="qabstractbutton.html#setText">setText</a></b> (<i>self</i>, QString)</li><li><div class="fn" />QKeySequence <b><a href="qabstractbutton.html#shortcut">shortcut</a></b> (<i>self</i>)</li><li><div class="fn" />QString <b><a href="qabstractbutton.html#text">text</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qabstractbutton.html#timerEvent">timerEvent</a></b> (<i>self</i>, QTimerEvent)</li><li><div class="fn" /><b><a href="qabstractbutton.html#toggle">toggle</a></b> (<i>self</i>)</li></ul><h3>Qt Signals</h3><ul><li><div class="fn" />void <b><a href="qabstractbutton.html#clicked">clicked</a></b> (bool = 0)</li><li><div class="fn" />void <b><a href="qabstractbutton.html#pressed">pressed</a></b> ()</li><li><div class="fn" />void <b><a href="qabstractbutton.html#released">released</a></b> ()</li><li><div class="fn" />void <b><a href="qabstractbutton.html#toggled">toggled</a></b> (bool)</li></ul><a name="details" /><hr /><h2>Detailed Description</h2><p>The QAbstractButton class is the abstract base class of button widgets, providing functionality common to buttons.</p>
11
<p>This class implements an <i>abstract</i> button. Subclasses of this class handle user actions, and specify how the button is drawn.</p>
12
<p>QAbstractButton provides support for both push buttons and checkable (toggle) buttons. Checkable buttons are implemented in the <a href="qradiobutton.html">QRadioButton</a> and <a href="qcheckbox.html">QCheckBox</a> classes. Push buttons are implemented in the <a href="qpushbutton.html">QPushButton</a> and <a href="qtoolbutton.html">QToolButton</a> classes; these also provide toggle behavior if required.</p>
13
<p>Any button can display a label containing text and an icon. <a href="qabstractbutton.html#text-prop">setText</a>() sets the text; <a href="qabstractbutton.html#icon-prop">setIcon</a>() sets the icon. If a button is disabled, its label is changed to give the button a "disabled" appearance.</p>
14
<p>If the button is a text button with a string containing an ampersand ('&'), QAbstractButton automatically creates a shortcut key. For example:</p>
15
<pre> QPushButton *button = new QPushButton(tr("Ro&ck && Roll"), this);</pre>
16
<p>The <b>Alt+C</b> shortcut is assigned to the button, i.e., when the user presses <b>Alt+C</b> the button will call <a href="qabstractbutton.html#animateClick">animateClick</a>(). See the <a href="qshortcut.html#mnemonic">QShortcut</a> documentation for details (to display an actual ampersand, use '&&').</p>
17
<p>You can also set a custom shortcut key using the <a href="qabstractbutton.html#shortcut-prop">setShortcut</a>() function. This is useful mostly for buttons that do not have any text, because they have no automatic shortcut.</p>
18
<pre> button->setIcon(QIcon(":/images/print.png"));
19
button->setShortcut(tr("Alt+F7"));</pre>
9
</style></head><body><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr /><td align="left" valign="top" width="32"><img align="left" border="0" height="32" src="images/rb-logo.png" width="32" /></td><td width="1">  </td><td class="postheader" valign="center"><a href="../pyqt4ref.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a></td></table><h1 align="center">QAbstractButton Class Reference<br /><sup><sup>[<a href="qtgui.html">QtGui</a> module]</sup></sup></h1><p>The QAbstractButton class is the abstract base class of button
10
widgets, providing functionality common to buttons. <a href="#details">More...</a></p>
12
<p>Inherits <a href="qwidget.html">QWidget</a>.</p><p>Inherited by <a href="qcheckbox.html">QCheckBox</a>, <a href="qpushbutton.html">QPushButton</a>, <a href="qradiobutton.html">QRadioButton</a> and <a href="qtoolbutton.html">QToolButton</a>.</p><h3>Methods</h3><ul><li><div class="fn" /><b><a href="qabstractbutton.html#QAbstractButton">__init__</a></b> (<i>self</i>, QWidget <i>parent</i> = None)</li><li><div class="fn" /><b><a href="qabstractbutton.html#animateClick">animateClick</a></b> (<i>self</i>, int <i>msecs</i> = 100)</li><li><div class="fn" />bool <b><a href="qabstractbutton.html#autoExclusive">autoExclusive</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qabstractbutton.html#autoRepeat">autoRepeat</a></b> (<i>self</i>)</li><li><div class="fn" />int <b><a href="qabstractbutton.html#autoRepeatDelay">autoRepeatDelay</a></b> (<i>self</i>)</li><li><div class="fn" />int <b><a href="qabstractbutton.html#autoRepeatInterval">autoRepeatInterval</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qabstractbutton.html#changeEvent">changeEvent</a></b> (<i>self</i>, QEvent)</li><li><div class="fn" /><b><a href="qabstractbutton.html#checkStateSet">checkStateSet</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qabstractbutton.html#click">click</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qabstractbutton.html#event">event</a></b> (<i>self</i>, QEvent)</li><li><div class="fn" /><b><a href="qabstractbutton.html#focusInEvent">focusInEvent</a></b> (<i>self</i>, QFocusEvent)</li><li><div class="fn" /><b><a href="qabstractbutton.html#focusOutEvent">focusOutEvent</a></b> (<i>self</i>, QFocusEvent)</li><li><div class="fn" />QButtonGroup <b><a href="qabstractbutton.html#group">group</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qabstractbutton.html#hitButton">hitButton</a></b> (<i>self</i>, QPoint)</li><li><div class="fn" />QIcon <b><a href="qabstractbutton.html#icon">icon</a></b> (<i>self</i>)</li><li><div class="fn" />QSize <b><a href="qabstractbutton.html#iconSize">iconSize</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qabstractbutton.html#isCheckable">isCheckable</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qabstractbutton.html#isChecked">isChecked</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qabstractbutton.html#isDown">isDown</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qabstractbutton.html#keyPressEvent">keyPressEvent</a></b> (<i>self</i>, QKeyEvent)</li><li><div class="fn" /><b><a href="qabstractbutton.html#keyReleaseEvent">keyReleaseEvent</a></b> (<i>self</i>, QKeyEvent)</li><li><div class="fn" /><b><a href="qabstractbutton.html#mouseMoveEvent">mouseMoveEvent</a></b> (<i>self</i>, QMouseEvent)</li><li><div class="fn" /><b><a href="qabstractbutton.html#mousePressEvent">mousePressEvent</a></b> (<i>self</i>, QMouseEvent)</li><li><div class="fn" /><b><a href="qabstractbutton.html#mouseReleaseEvent">mouseReleaseEvent</a></b> (<i>self</i>, QMouseEvent)</li><li><div class="fn" /><b><a href="qabstractbutton.html#nextCheckState">nextCheckState</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qabstractbutton.html#paintEvent">paintEvent</a></b> (<i>self</i>, QPaintEvent)</li><li><div class="fn" /><b><a href="qabstractbutton.html#setAutoExclusive">setAutoExclusive</a></b> (<i>self</i>, bool)</li><li><div class="fn" /><b><a href="qabstractbutton.html#setAutoRepeat">setAutoRepeat</a></b> (<i>self</i>, bool)</li><li><div class="fn" /><b><a href="qabstractbutton.html#setAutoRepeatDelay">setAutoRepeatDelay</a></b> (<i>self</i>, int)</li><li><div class="fn" /><b><a href="qabstractbutton.html#setAutoRepeatInterval">setAutoRepeatInterval</a></b> (<i>self</i>, int)</li><li><div class="fn" /><b><a href="qabstractbutton.html#setCheckable">setCheckable</a></b> (<i>self</i>, bool)</li><li><div class="fn" /><b><a href="qabstractbutton.html#setChecked">setChecked</a></b> (<i>self</i>, bool)</li><li><div class="fn" /><b><a href="qabstractbutton.html#setDown">setDown</a></b> (<i>self</i>, bool)</li><li><div class="fn" /><b><a href="qabstractbutton.html#setIcon">setIcon</a></b> (<i>self</i>, QIcon)</li><li><div class="fn" /><b><a href="qabstractbutton.html#setIconSize">setIconSize</a></b> (<i>self</i>, QSize)</li><li><div class="fn" /><b><a href="qabstractbutton.html#setShortcut">setShortcut</a></b> (<i>self</i>, QKeySequence)</li><li><div class="fn" /><b><a href="qabstractbutton.html#setText">setText</a></b> (<i>self</i>, QString)</li><li><div class="fn" />QKeySequence <b><a href="qabstractbutton.html#shortcut">shortcut</a></b> (<i>self</i>)</li><li><div class="fn" />QString <b><a href="qabstractbutton.html#text">text</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qabstractbutton.html#timerEvent">timerEvent</a></b> (<i>self</i>, QTimerEvent)</li><li><div class="fn" /><b><a href="qabstractbutton.html#toggle">toggle</a></b> (<i>self</i>)</li></ul><h3>Qt Signals</h3><ul><li><div class="fn" />void <b><a href="qabstractbutton.html#clicked">clicked</a></b> (bool = 0)</li><li><div class="fn" />void <b><a href="qabstractbutton.html#pressed">pressed</a></b> ()</li><li><div class="fn" />void <b><a href="qabstractbutton.html#released">released</a></b> ()</li><li><div class="fn" />void <b><a href="qabstractbutton.html#toggled">toggled</a></b> (bool)</li></ul><a name="details" /><hr /><h2>Detailed Description</h2><p>The QAbstractButton class is the abstract base class of button
13
widgets, providing functionality common to buttons.</p>
14
<p>This class implements an <i>abstract</i> button. Subclasses of
15
this class handle user actions, and specify how the button is
17
<p>QAbstractButton provides support for both push buttons and
18
checkable (toggle) buttons. Checkable buttons are implemented in
19
the <a href="qradiobutton.html">QRadioButton</a> and <a href="qcheckbox.html">QCheckBox</a> classes. Push buttons are
20
implemented in the <a href="qpushbutton.html">QPushButton</a> and
21
<a href="qtoolbutton.html">QToolButton</a> classes; these also
22
provide toggle behavior if required.</p>
23
<p>Any button can display a label containing text and an icon.
24
<a href="qabstractbutton.html#text-prop">setText</a>() sets the
25
text; <a href="qabstractbutton.html#icon-prop">setIcon</a>() sets
26
the icon. If a button is disabled, its label is changed to give the
27
button a "disabled" appearance.</p>
28
<p>If the button is a text button with a string containing an
29
ampersand ('&'), QAbstractButton automatically creates a
30
shortcut key. For example:</p>
31
<pre class="highlightedCode brush: cpp">
32
QPushButton *button = new QPushButton(tr("Ro&ck && Roll"), this);
34
<p>The <b>Alt+C</b> shortcut is assigned to the button, i.e., when
35
the user presses <b>Alt+C</b> the button will call <a href="qabstractbutton.html#animateClick">animateClick</a>(). See the
36
<a href="qshortcut.html#mnemonic">QShortcut</a> documentation for
37
details (to display an actual ampersand, use '&&').</p>
38
<p>You can also set a custom shortcut key using the <a href="qabstractbutton.html#shortcut-prop">setShortcut</a>() function.
39
This is useful mostly for buttons that do not have any text,
40
because they have no automatic shortcut.</p>
41
<pre class="highlightedCode brush: cpp">
42
button->setIcon(QIcon(":/images/print.png"));
43
button->setShortcut(tr("Alt+F7"));
20
45
<p>All of the buttons provided by Qt (<a href="qpushbutton.html">QPushButton</a>, <a href="qtoolbutton.html">QToolButton</a>, <a href="qcheckbox.html">QCheckBox</a>, and <a href="qradiobutton.html">QRadioButton</a>) can display both <a href="qabstractbutton.html#text-prop">text</a> and <a href="qabstractbutton.html#icon-prop">icons</a>.</p>
21
<p>A button can be made the default button in a dialog are provided by <a href="qpushbutton.html#default-prop">QPushButton.setDefault</a>() and <a href="qpushbutton.html#autoDefault-prop">QPushButton.setAutoDefault</a>().</p>
22
<p>QAbstractButton provides most of the states used for buttons:</p>
46
<p>A button can be made the default button in a dialog are provided
47
by <a href="qpushbutton.html#default-prop">QPushButton.setDefault</a>() and
48
<a href="qpushbutton.html#autoDefault-prop">QPushButton.setAutoDefault</a>().</p>
49
<p>QAbstractButton provides most of the states used for
24
<li><a href="qabstractbutton.html#down-prop">isDown</a>() indicates whether the button is <i>pressed</i> down.</li>
25
<li><a href="qabstractbutton.html#checked-prop">isChecked</a>() indicates whether the button is <i>checked</i>. Only checkable buttons can be checked and unchecked (see below).</li>
26
<li><a href="qwidget.html#enabled-prop">isEnabled</a>() indicates whether the button can be pressed by the user.</li>
27
<li><a href="qabstractbutton.html#autoRepeat-prop">setAutoRepeat</a>() sets whether the button will auto-repeat if the user holds it down. <a href="qabstractbutton.html#autoRepeatDelay-prop">autoRepeatDelay</a> and <a href="qabstractbutton.html#autoRepeatInterval-prop">autoRepeatInterval</a> define how auto-repetition is done.</li>
28
<li><a href="qabstractbutton.html#checkable-prop">setCheckable</a>() sets whether the button is a toggle button or not.</li>
52
<li><a href="qabstractbutton.html#down-prop">isDown</a>() indicates
53
whether the button is <i>pressed</i> down.</li>
54
<li><a href="qabstractbutton.html#checked-prop">isChecked</a>()
55
indicates whether the button is <i>checked</i>. Only checkable
56
buttons can be checked and unchecked (see below).</li>
57
<li><a href="qwidget.html#enabled-prop">isEnabled</a>() indicates
58
whether the button can be pressed by the user.</li>
59
<li><a href="qabstractbutton.html#autoRepeat-prop">setAutoRepeat</a>() sets
60
whether the button will auto-repeat if the user holds it down.
61
<a href="qabstractbutton.html#autoRepeatDelay-prop">autoRepeatDelay</a> and
62
<a href="qabstractbutton.html#autoRepeatInterval-prop">autoRepeatInterval</a>
63
define how auto-repetition is done.</li>
64
<li><a href="qabstractbutton.html#checkable-prop">setCheckable</a>() sets
65
whether the button is a toggle button or not.</li>
30
<p>The difference between <a href="qabstractbutton.html#down-prop">isDown</a>() and <a href="qabstractbutton.html#checked-prop">isChecked</a>() is as follows. When the user clicks a toggle button to check it, the button is first <i>pressed</i> then released into the <i>checked</i> state. When the user clicks it again (to uncheck it), the button moves first to the <i>pressed</i> state, then to the <i>unchecked</i> state (<a href="qabstractbutton.html#checked-prop">isChecked</a>() and <a href="qabstractbutton.html#down-prop">isDown</a>() are both false).</p>
67
<p>The difference between <a href="qabstractbutton.html#down-prop">isDown</a>() and <a href="qabstractbutton.html#checked-prop">isChecked</a>() is as follows.
68
When the user clicks a toggle button to check it, the button is
69
first <i>pressed</i> then released into the <i>checked</i> state.
70
When the user clicks it again (to uncheck it), the button moves
71
first to the <i>pressed</i> state, then to the <i>unchecked</i>
72
state (<a href="qabstractbutton.html#checked-prop">isChecked</a>()
73
and <a href="qabstractbutton.html#down-prop">isDown</a>() are both
31
75
<p>QAbstractButton provides four signals:</p>
33
<li><a href="qabstractbutton.html#pressed">pressed</a>() is emitted when the left mouse button is pressed while the mouse cursor is inside the button.</li>
34
<li><a href="qabstractbutton.html#released">released</a>() is emitted when the left mouse button is released.</li>
35
<li><a href="qabstractbutton.html#clicked">clicked</a>() is emitted when the button is first pressed and then released, when the shortcut key is typed, or when <a href="qabstractbutton.html#click">click</a>() or <a href="qabstractbutton.html#animateClick">animateClick</a>() is called.</li>
36
<li><a href="qabstractbutton.html#toggled">toggled</a>() is emitted when the state of a toggle button changes.</li>
77
<li><a href="qabstractbutton.html#pressed">pressed</a>() is emitted
78
when the left mouse button is pressed while the mouse cursor is
79
inside the button.</li>
80
<li><a href="qabstractbutton.html#released">released</a>() is
81
emitted when the left mouse button is released.</li>
82
<li><a href="qabstractbutton.html#clicked">clicked</a>() is emitted
83
when the button is first pressed and then released, when the
84
shortcut key is typed, or when <a href="qabstractbutton.html#click">click</a>() or <a href="qabstractbutton.html#animateClick">animateClick</a>() is
86
<li><a href="qabstractbutton.html#toggled">toggled</a>() is emitted
87
when the state of a toggle button changes.</li>
38
<p>To subclass QAbstractButton, you must reimplement at least <a href="qabstractbutton.html#paintEvent">paintEvent</a>() to draw the button's outline and its text or pixmap. It is generally advisable to reimplement <a href="qwidget.html#sizeHint-prop">sizeHint</a>() as well, and sometimes <a href="qabstractbutton.html#hitButton">hitButton</a>() (to determine whether a button press is within the button). For buttons with more than two states (like tri-state buttons), you will also have to reimplement <a href="qabstractbutton.html#checkStateSet">checkStateSet</a>() and <a href="qabstractbutton.html#nextCheckState">nextCheckState</a>().</p>
39
<p>See also <a href="qbuttongroup.html">QButtonGroup</a>.</p>
89
<p>To subclass QAbstractButton, you must reimplement at least
90
<a href="qabstractbutton.html#paintEvent">paintEvent</a>() to draw
91
the button's outline and its text or pixmap. It is generally
92
advisable to reimplement <a href="qwidget.html#sizeHint-prop">sizeHint</a>() as well, and sometimes
93
<a href="qabstractbutton.html#hitButton">hitButton</a>() (to
94
determine whether a button press is within the button). For buttons
95
with more than two states (like tri-state buttons), you will also
96
have to reimplement <a href="qabstractbutton.html#checkStateSet">checkStateSet</a>() and
97
<a href="qabstractbutton.html#nextCheckState">nextCheckState</a>().</p>
40
98
<hr /><h2>Method Documentation</h2><h3 class="fn"><a name="QAbstractButton" />QAbstractButton.__init__ (<i>self</i>, <a href="qwidget.html">QWidget</a> <i>parent</i> = None)</h3><p>The <i>parent</i> argument, if not None, causes <i>self</i> to be owned by Qt instead of PyQt.</p><p>Constructs an abstract button with a <i>parent</i>.</p>
41
<a name="//apple_ref/cpp/instm/QAbstractButton/~QAbstractButton" />
42
<h3 class="fn"><a name="animateClick" />QAbstractButton.animateClick (<i>self</i>, int <i>msecs</i> = 100)</h3><p>This method is also a Qt slot with the C++ signature <tt>void animateClick(int = 100)</tt>.</p><p>Performs an animated click: the button is pressed immediately, and released <i>msec</i> milliseconds later (the default is 100 ms).</p>
43
<p>Calling this function again before the button was released will reset the release timer.</p>
44
<p>All signals associated with a click are emitted as appropriate.</p>
101
<h3 class="fn"><a name="animateClick" />QAbstractButton.animateClick (<i>self</i>, int <i>msecs</i> = 100)</h3><p>This method is also a Qt slot with the C++ signature <tt>void animateClick(int = 100)</tt>.</p><p>Performs an animated click: the button is pressed immediately,
102
and released <i>msec</i> milliseconds later (the default is 100
104
<p>Calling this function again before the button was released will
105
reset the release timer.</p>
106
<p>All signals associated with a click are emitted as
45
108
<p>This function does nothing if the button is <a href="qwidget.html#enabled-prop">disabled.</a></p>
46
109
<p>See also <a href="qabstractbutton.html#click">click</a>().</p>
47
<a name="//apple_ref/cpp/instm/QAbstractButton/changeEvent" />
48
112
<h3 class="fn"><a name="autoExclusive" />bool QAbstractButton.autoExclusive (<i>self</i>)</h3><h3 class="fn"><a name="autoRepeat" />bool QAbstractButton.autoRepeat (<i>self</i>)</h3><h3 class="fn"><a name="autoRepeatDelay" />int QAbstractButton.autoRepeatDelay (<i>self</i>)</h3><h3 class="fn"><a name="autoRepeatInterval" />int QAbstractButton.autoRepeatInterval (<i>self</i>)</h3><h3 class="fn"><a name="changeEvent" />QAbstractButton.changeEvent (<i>self</i>, <a href="qevent.html">QEvent</a>)</h3><p>Reimplemented from <a href="qwidget.html#changeEvent">QWidget.changeEvent</a>().</p>
49
<a name="//apple_ref/cpp/instm/QAbstractButton/checkStateSet" />
50
<h3 class="fn"><a name="checkStateSet" />QAbstractButton.checkStateSet (<i>self</i>)</h3><p>This virtual handler is called when <a href="qabstractbutton.html#checked-prop">setChecked</a>() was called, unless it was called from within <a href="qabstractbutton.html#nextCheckState">nextCheckState</a>(). It allows subclasses to reset their intermediate button states.</p>
115
<h3 class="fn"><a name="checkStateSet" />QAbstractButton.checkStateSet (<i>self</i>)</h3><p>This virtual handler is called when <a href="qabstractbutton.html#checked-prop">setChecked</a>() was called,
116
unless it was called from within <a href="qabstractbutton.html#nextCheckState">nextCheckState</a>(). It
117
allows subclasses to reset their intermediate button states.</p>
51
118
<p>See also <a href="qabstractbutton.html#nextCheckState">nextCheckState</a>().</p>
52
<a name="//apple_ref/cpp/instm/QAbstractButton/click" />
53
121
<h3 class="fn"><a name="click" />QAbstractButton.click (<i>self</i>)</h3><p>This method is also a Qt slot with the C++ signature <tt>void click()</tt>.</p><p>Performs a click.</p>
54
<p>All the usual signals associated with a click are emitted as appropriate. If the button is checkable, the state of the button is toggled.</p>
122
<p>All the usual signals associated with a click are emitted as
123
appropriate. If the button is checkable, the state of the button is
55
125
<p>This function does nothing if the button is <a href="qwidget.html#enabled-prop">disabled.</a></p>
56
126
<p>See also <a href="qabstractbutton.html#animateClick">animateClick</a>().</p>
57
<a name="//apple_ref/cpp/instm/QAbstractButton/clicked" />
58
129
<h3 class="fn"><a name="event" />bool QAbstractButton.event (<i>self</i>, <a href="qevent.html">QEvent</a>)</h3><p>Reimplemented from <a href="qobject.html#event">QObject.event</a>().</p>
59
<a name="//apple_ref/cpp/instm/QAbstractButton/focusInEvent" />
60
132
<h3 class="fn"><a name="focusInEvent" />QAbstractButton.focusInEvent (<i>self</i>, <a href="qfocusevent.html">QFocusEvent</a>)</h3><p>Reimplemented from <a href="qwidget.html#focusInEvent">QWidget.focusInEvent</a>().</p>
61
<a name="//apple_ref/cpp/instm/QAbstractButton/focusOutEvent" />
62
135
<h3 class="fn"><a name="focusOutEvent" />QAbstractButton.focusOutEvent (<i>self</i>, <a href="qfocusevent.html">QFocusEvent</a>)</h3><p>Reimplemented from <a href="qwidget.html#focusOutEvent">QWidget.focusOutEvent</a>().</p>
63
<a name="//apple_ref/cpp/instm/QAbstractButton/group" />
64
138
<h3 class="fn"><a name="group" /><a href="qbuttongroup.html">QButtonGroup</a> QAbstractButton.group (<i>self</i>)</h3><p>Returns the group that this button belongs to.</p>
65
139
<p>If the button is not a member of any <a href="qbuttongroup.html">QButtonGroup</a>, this function returns 0.</p>
66
140
<p>See also <a href="qbuttongroup.html">QButtonGroup</a>.</p>
67
<a name="//apple_ref/cpp/instm/QAbstractButton/hitButton" />
68
<h3 class="fn"><a name="hitButton" />bool QAbstractButton.hitButton (<i>self</i>, <a href="qpoint.html">QPoint</a>)</h3><p>Returns true if <i>pos</i> is inside the clickable button rectangle; otherwise returns false.</p>
69
<p>By default, the clickable area is the entire widget. Subclasses may reimplement this function to provide support for clickable areas of different shapes and sizes.</p>
70
<a name="//apple_ref/cpp/instm/QAbstractButton/keyPressEvent" />
143
<h3 class="fn"><a name="hitButton" />bool QAbstractButton.hitButton (<i>self</i>, <a href="qpoint.html">QPoint</a>)</h3><p>Returns true if <i>pos</i> is inside the clickable button
144
rectangle; otherwise returns false.</p>
145
<p>By default, the clickable area is the entire widget. Subclasses
146
may reimplement this function to provide support for clickable
147
areas of different shapes and sizes.</p>
71
150
<h3 class="fn"><a name="icon" /><a href="qicon.html">QIcon</a> QAbstractButton.icon (<i>self</i>)</h3><h3 class="fn"><a name="iconSize" /><a href="qsize.html">QSize</a> QAbstractButton.iconSize (<i>self</i>)</h3><h3 class="fn"><a name="isCheckable" />bool QAbstractButton.isCheckable (<i>self</i>)</h3><h3 class="fn"><a name="isChecked" />bool QAbstractButton.isChecked (<i>self</i>)</h3><h3 class="fn"><a name="isDown" />bool QAbstractButton.isDown (<i>self</i>)</h3><h3 class="fn"><a name="keyPressEvent" />QAbstractButton.keyPressEvent (<i>self</i>, <a href="qkeyevent.html">QKeyEvent</a>)</h3><p>Reimplemented from <a href="qwidget.html#keyPressEvent">QWidget.keyPressEvent</a>().</p>
72
<a name="//apple_ref/cpp/instm/QAbstractButton/keyReleaseEvent" />
73
153
<h3 class="fn"><a name="keyReleaseEvent" />QAbstractButton.keyReleaseEvent (<i>self</i>, <a href="qkeyevent.html">QKeyEvent</a>)</h3><p>Reimplemented from <a href="qwidget.html#keyReleaseEvent">QWidget.keyReleaseEvent</a>().</p>
74
<a name="//apple_ref/cpp/instm/QAbstractButton/mouseMoveEvent" />
75
156
<h3 class="fn"><a name="mouseMoveEvent" />QAbstractButton.mouseMoveEvent (<i>self</i>, <a href="qmouseevent.html">QMouseEvent</a>)</h3><p>Reimplemented from <a href="qwidget.html#mouseMoveEvent">QWidget.mouseMoveEvent</a>().</p>
76
<a name="//apple_ref/cpp/instm/QAbstractButton/mousePressEvent" />
77
159
<h3 class="fn"><a name="mousePressEvent" />QAbstractButton.mousePressEvent (<i>self</i>, <a href="qmouseevent.html">QMouseEvent</a>)</h3><p>Reimplemented from <a href="qwidget.html#mousePressEvent">QWidget.mousePressEvent</a>().</p>
78
<a name="//apple_ref/cpp/instm/QAbstractButton/mouseReleaseEvent" />
79
162
<h3 class="fn"><a name="mouseReleaseEvent" />QAbstractButton.mouseReleaseEvent (<i>self</i>, <a href="qmouseevent.html">QMouseEvent</a>)</h3><p>Reimplemented from <a href="qwidget.html#mouseReleaseEvent">QWidget.mouseReleaseEvent</a>().</p>
80
<a name="//apple_ref/cpp/instm/QAbstractButton/nextCheckState" />
81
<h3 class="fn"><a name="nextCheckState" />QAbstractButton.nextCheckState (<i>self</i>)</h3><p>This virtual handler is called when a button is clicked. The default implementation calls setChecked(!<a href="qabstractbutton.html#checked-prop">isChecked</a>()) if the button <a href="qabstractbutton.html#checkable-prop">isCheckable</a>(). It allows subclasses to implement intermediate button states.</p>
165
<h3 class="fn"><a name="nextCheckState" />QAbstractButton.nextCheckState (<i>self</i>)</h3><p>This virtual handler is called when a button is clicked. The
166
default implementation calls setChecked(!<a href="qabstractbutton.html#checked-prop">isChecked</a>()) if the button
167
<a href="qabstractbutton.html#checkable-prop">isCheckable</a>(). It
168
allows subclasses to implement intermediate button states.</p>
82
169
<p>See also <a href="qabstractbutton.html#checkStateSet">checkStateSet</a>().</p>
83
<a name="//apple_ref/cpp/instm/QAbstractButton/paintEvent" />
84
172
<h3 class="fn"><a name="paintEvent" />QAbstractButton.paintEvent (<i>self</i>, <a href="qpaintevent.html">QPaintEvent</a>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Reimplemented from <a href="qwidget.html#paintEvent">QWidget.paintEvent</a>().</p>
85
<a name="//apple_ref/cpp/instm/QAbstractButton/pressed" />
86
175
<h3 class="fn"><a name="setAutoExclusive" />QAbstractButton.setAutoExclusive (<i>self</i>, bool)</h3><h3 class="fn"><a name="setAutoRepeat" />QAbstractButton.setAutoRepeat (<i>self</i>, bool)</h3><h3 class="fn"><a name="setAutoRepeatDelay" />QAbstractButton.setAutoRepeatDelay (<i>self</i>, int)</h3><h3 class="fn"><a name="setAutoRepeatInterval" />QAbstractButton.setAutoRepeatInterval (<i>self</i>, int)</h3><h3 class="fn"><a name="setCheckable" />QAbstractButton.setCheckable (<i>self</i>, bool)</h3><h3 class="fn"><a name="setChecked" />QAbstractButton.setChecked (<i>self</i>, bool)</h3><p>This method is also a Qt slot with the C++ signature <tt>void setChecked(bool)</tt>.</p><h3 class="fn"><a name="setDown" />QAbstractButton.setDown (<i>self</i>, bool)</h3><h3 class="fn"><a name="setIcon" />QAbstractButton.setIcon (<i>self</i>, <a href="qicon.html">QIcon</a>)</h3><h3 class="fn"><a name="setIconSize" />QAbstractButton.setIconSize (<i>self</i>, <a href="qsize.html">QSize</a>)</h3><p>This method is also a Qt slot with the C++ signature <tt>void setIconSize(const QSize&)</tt>.</p><h3 class="fn"><a name="setShortcut" />QAbstractButton.setShortcut (<i>self</i>, <a href="qkeysequence.html">QKeySequence</a>)</h3><h3 class="fn"><a name="setText" />QAbstractButton.setText (<i>self</i>, QString)</h3><h3 class="fn"><a name="shortcut" /><a href="qkeysequence.html">QKeySequence</a> QAbstractButton.shortcut (<i>self</i>)</h3><h3 class="fn"><a name="text" />QString QAbstractButton.text (<i>self</i>)</h3><h3 class="fn"><a name="timerEvent" />QAbstractButton.timerEvent (<i>self</i>, <a href="qtimerevent.html">QTimerEvent</a>)</h3><p>Reimplemented from <a href="qobject.html#timerEvent">QObject.timerEvent</a>().</p>
87
<a name="//apple_ref/cpp/instm/QAbstractButton/toggle" />
88
178
<h3 class="fn"><a name="toggle" />QAbstractButton.toggle (<i>self</i>)</h3><p>This method is also a Qt slot with the C++ signature <tt>void toggle()</tt>.</p><p>Toggles the state of a checkable button.</p>
89
179
<p>See also <a href="qabstractbutton.html#checked-prop">checked</a>.</p>
90
<a name="//apple_ref/cpp/instm/QAbstractButton/toggled" />
91
<hr /><h2>Qt Signal Documentation</h2><h3 class="fn"><a name="clicked" />void clicked (bool = 0)</h3><p>This is the default overload of this signal.</p><p>This signal is emitted when the button is activated (i.e. pressed down then released while the mouse cursor is inside the button), when the shortcut key is typed, or when <a href="qabstractbutton.html#click">click</a>() or <a href="qabstractbutton.html#animateClick">animateClick</a>() is called. Notably, this signal is <i>not</i> emitted if you call <a href="qabstractbutton.html#down-prop">setDown</a>(), <a href="qabstractbutton.html#checked-prop">setChecked</a>() or <a href="qabstractbutton.html#toggle">toggle</a>().</p>
92
<p>If the button is checkable, <i>checked</i> is true if the button is checked, or false if the button is unchecked.</p>
93
<p>See also <a href="qabstractbutton.html#pressed">pressed</a>(), <a href="qabstractbutton.html#released">released</a>(), and <a href="qabstractbutton.html#toggled">toggled</a>().</p>
94
<a name="//apple_ref/cpp/instm/QAbstractButton/event" />
182
<hr /><h2>Qt Signal Documentation</h2><h3 class="fn"><a name="clicked" />void clicked (bool = 0)</h3><p>This is the default overload of this signal.</p><p>This signal is emitted when the button is activated (i.e.
183
pressed down then released while the mouse cursor is inside the
184
button), when the shortcut key is typed, or when <a href="qabstractbutton.html#click">click</a>() or <a href="qabstractbutton.html#animateClick">animateClick</a>() is called.
185
Notably, this signal is <i>not</i> emitted if you call <a href="qabstractbutton.html#down-prop">setDown</a>(), <a href="qabstractbutton.html#checked-prop">setChecked</a>() or <a href="qabstractbutton.html#toggle">toggle</a>().</p>
186
<p>If the button is checkable, <i>checked</i> is true if the button
187
is checked, or false if the button is unchecked.</p>
188
<p>See also <a href="qabstractbutton.html#pressed">pressed</a>(),
189
<a href="qabstractbutton.html#released">released</a>(), and
190
<a href="qabstractbutton.html#toggled">toggled</a>().</p>
95
193
<h3 class="fn"><a name="pressed" />void pressed ()</h3><p>This is the default overload of this signal.</p><p>This signal is emitted when the button is pressed down.</p>
96
<p>See also <a href="qabstractbutton.html#released">released</a>() and <a href="qabstractbutton.html#clicked">clicked</a>().</p>
97
<a name="//apple_ref/cpp/instm/QAbstractButton/released" />
194
<p>See also <a href="qabstractbutton.html#released">released</a>()
195
and <a href="qabstractbutton.html#clicked">clicked</a>().</p>
98
198
<h3 class="fn"><a name="released" />void released ()</h3><p>This is the default overload of this signal.</p><p>This signal is emitted when the button is released.</p>
99
<p>See also <a href="qabstractbutton.html#pressed">pressed</a>(), <a href="qabstractbutton.html#clicked">clicked</a>(), and <a href="qabstractbutton.html#toggled">toggled</a>().</p>
100
<a name="//apple_ref/cpp/instm/QAbstractButton/timerEvent" />
101
<h3 class="fn"><a name="toggled" />void toggled (bool)</h3><p>This is the default overload of this signal.</p><p>This signal is emitted whenever a checkable button changes its state. <i>checked</i> is true if the button is checked, or false if the button is unchecked.</p>
102
<p>This may be the result of a user action, <a href="qabstractbutton.html#click">click</a>() slot activation, or because <a href="qabstractbutton.html#checked-prop">setChecked</a>() was called.</p>
103
<p>The states of buttons in exclusive button groups are updated before this signal is emitted. This means that slots can act on either the "off" signal or the "on" signal emitted by the buttons in the group whose states have changed.</p>
104
<p>For example, a slot that reacts to signals emitted by newly checked buttons but which ignores signals from buttons that have been unchecked can be implemented using the following pattern:</p>
105
<pre> void MyWidget.reactToToggle(bool checked)
199
<p>See also <a href="qabstractbutton.html#pressed">pressed</a>(),
200
<a href="qabstractbutton.html#clicked">clicked</a>(), and <a href="qabstractbutton.html#toggled">toggled</a>().</p>
203
<h3 class="fn"><a name="toggled" />void toggled (bool)</h3><p>This is the default overload of this signal.</p><p>This signal is emitted whenever a checkable button changes its
204
state. <i>checked</i> is true if the button is checked, or false if
205
the button is unchecked.</p>
206
<p>This may be the result of a user action, <a href="qabstractbutton.html#click">click</a>() slot activation, or
207
because <a href="qabstractbutton.html#checked-prop">setChecked</a>() was
209
<p>The states of buttons in exclusive button groups are updated
210
before this signal is emitted. This means that slots can act on
211
either the "off" signal or the "on" signal emitted by the buttons
212
in the group whose states have changed.</p>
213
<p>For example, a slot that reacts to signals emitted by newly
214
checked buttons but which ignores signals from buttons that have
215
been unchecked can be implemented using the following pattern:</p>
216
<pre class="highlightedCode brush: cpp">
217
void MyWidget.reactToToggle(bool checked)
108
220
<span class="comment">// Examine the new button states.</span>
112
<p>Button groups can be created using the <a href="qbuttongroup.html">QButtonGroup</a> class, and updates to the button states monitored with the <a href="qbuttongroup.html#buttonClicked">QButtonGroup.buttonClicked</a>() signal.</p>
113
<p>See also <a href="qabstractbutton.html#checked-prop">checked</a> and <a href="qabstractbutton.html#clicked">clicked</a>().</p>
114
<p /><address><hr /><div align="center"><table border="0" cellspacing="0" width="100%"><tr class="address"><td align="left" width="25%">PyQt 4.7.7 for X11</td><td align="center" width="50%">Copyright © <a href="http://www.riverbankcomputing.com">Riverbank Computing Ltd</a> and <a href="http://www.qtsoftware.com">Nokia</a> 2010</td><td align="right" width="25%">Qt 4.6.3</td></tr></table></div></address></body></html>
b'\\ No newline at end of file'
225
<p>Button groups can be created using the <a href="qbuttongroup.html">QButtonGroup</a> class, and updates to the
226
button states monitored with the <a href="qbuttongroup.html#buttonClicked">QButtonGroup.buttonClicked</a>()
228
<p>See also <a href="qabstractbutton.html#checked-prop">checked</a>
229
and <a href="qabstractbutton.html#clicked">clicked</a>().</p>
230
<address><hr /><div align="center"><table border="0" cellspacing="0" width="100%"><tr class="address"><td align="left" width="25%">PyQt 4.8.1 for X11</td><td align="center" width="50%">Copyright © <a href="http://www.riverbankcomputing.com">Riverbank Computing Ltd</a> and <a href="http://www.qtsoftware.com">Nokia</a> 2010</td><td align="right" width="25%">Qt 4.7.0</td></tr></table></div></address></body></html>
b'\\ No newline at end of file'
added
removed
doc/html/qabstractbutton.html
