/
qabstractbutton.cpp
1329 lines (1137 loc) · 35.5 KB
/
qabstractbutton.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtWidgets module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "private/qabstractbutton_p.h"
#if QT_CONFIG(itemviews)
#include "qabstractitemview.h"
#endif
#if QT_CONFIG(buttongroup)
#include "qbuttongroup.h"
#include "private/qapplication_p.h"
#include "private/qbuttongroup_p.h"
#endif
#include "qabstractbutton_p.h"
#include "qevent.h"
#include "qpainter.h"
#include "qapplication.h"
#include "qstyle.h"
#include "qaction.h"
#ifndef QT_NO_ACCESSIBILITY
#include "qaccessible.h"
#endif
#include <algorithm>
QT_BEGIN_NAMESPACE
#define AUTO_REPEAT_DELAY 300
#define AUTO_REPEAT_INTERVAL 100
Q_WIDGETS_EXPORT extern bool qt_tab_all_widgets();
/*!
\class QAbstractButton
\brief The QAbstractButton class is the abstract base class of
button widgets, providing functionality common to buttons.
\ingroup abstractwidgets
\inmodule QtWidgets
This class implements an \e abstract button.
Subclasses of this class handle user actions, and specify how the button
is drawn.
QAbstractButton provides support for both push buttons and checkable
(toggle) buttons. Checkable buttons are implemented in the QRadioButton
and QCheckBox classes. Push buttons are implemented in the
QPushButton and QToolButton classes; these also provide toggle
behavior if required.
Any button can display a label containing text and an icon. setText()
sets the text; setIcon() sets the icon. If a button is disabled, its label
is changed to give the button a "disabled" appearance.
If the button is a text button with a string containing an
ampersand ('&'), QAbstractButton automatically creates a shortcut
key. For example:
\snippet code/src_gui_widgets_qabstractbutton.cpp 0
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 '&&'.
You can also set a custom shortcut key using the setShortcut()
function. This is useful mostly for buttons that do not have any
text, and therefore can't have any automatic shortcut.
\snippet code/src_gui_widgets_qabstractbutton.cpp 1
All the buttons provided by Qt (QPushButton, QToolButton,
QCheckBox, and QRadioButton) can display both \l text and \l{icon}{icons}.
A button can be made the default button in a dialog by means of
QPushButton::setDefault() and QPushButton::setAutoDefault().
QAbstractButton provides most of the states used for buttons:
\list
\li isDown() indicates whether the button is \e pressed down.
\li isChecked() indicates whether the button is \e checked. Only
checkable buttons can be checked and unchecked (see below).
\li isEnabled() indicates whether the button can be pressed by the
user. \note As opposed to other widgets, buttons derived from
QAbstractButton accept mouse and context menu events
when disabled.
\li setAutoRepeat() sets whether the button will auto-repeat if the
user holds it down. \l autoRepeatDelay and \l autoRepeatInterval
define how auto-repetition is done.
\li setCheckable() sets whether the button is a toggle button or not.
\endlist
The difference between isDown() and isChecked() is as follows.
When the user clicks a toggle button to check it, the button is first
\e pressed then released into the \e checked state. When the user
clicks it again (to uncheck it), the button moves first to the
\e pressed state, then to the \e unchecked state (isChecked() and
isDown() are both false).
QAbstractButton provides four signals:
\list 1
\li pressed() is emitted when the left mouse button is pressed while
the mouse cursor is inside the button.
\li released() is emitted when the left mouse button is released.
\li clicked() is emitted when the button is first pressed and then
released, when the shortcut key is typed, or when click() or
animateClick() is called.
\li toggled() is emitted when the state of a toggle button changes.
\endlist
To subclass QAbstractButton, you must reimplement at least
paintEvent() to draw the button's outline and its text or pixmap. It
is generally advisable to reimplement sizeHint() as well, and
sometimes hitButton() (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 checkStateSet() and
nextCheckState().
\sa QButtonGroup
*/
QAbstractButtonPrivate::QAbstractButtonPrivate(QSizePolicy::ControlType type)
:
#ifndef QT_NO_SHORTCUT
shortcutId(0),
#endif
checkable(false), checked(false), autoRepeat(false), autoExclusive(false),
down(false), blockRefresh(false), pressed(false),
#if QT_CONFIG(buttongroup)
group(nullptr),
#endif
autoRepeatDelay(AUTO_REPEAT_DELAY),
autoRepeatInterval(AUTO_REPEAT_INTERVAL),
controlType(type)
{}
QList<QAbstractButton *>QAbstractButtonPrivate::queryButtonList() const
{
#if QT_CONFIG(buttongroup)
if (group)
return group->d_func()->buttonList;
#endif
QList<QAbstractButton*>candidates = parent->findChildren<QAbstractButton *>();
if (autoExclusive) {
auto isNoMemberOfMyAutoExclusiveGroup = [](QAbstractButton *candidate) {
return !candidate->autoExclusive()
#if QT_CONFIG(buttongroup)
|| candidate->group()
#endif
;
};
candidates.erase(std::remove_if(candidates.begin(), candidates.end(),
isNoMemberOfMyAutoExclusiveGroup),
candidates.end());
}
return candidates;
}
QAbstractButton *QAbstractButtonPrivate::queryCheckedButton() const
{
#if QT_CONFIG(buttongroup)
if (group)
return group->d_func()->checkedButton;
#endif
Q_Q(const QAbstractButton);
QList<QAbstractButton *> buttonList = queryButtonList();
if (!autoExclusive || buttonList.count() == 1) // no group
return nullptr;
for (int i = 0; i < buttonList.count(); ++i) {
QAbstractButton *b = buttonList.at(i);
if (b->d_func()->checked && b != q)
return b;
}
return checked ? const_cast<QAbstractButton *>(q) : nullptr;
}
void QAbstractButtonPrivate::notifyChecked()
{
#if QT_CONFIG(buttongroup)
Q_Q(QAbstractButton);
if (group) {
QAbstractButton *previous = group->d_func()->checkedButton;
group->d_func()->checkedButton = q;
if (group->d_func()->exclusive && previous && previous != q)
previous->nextCheckState();
} else
#endif
if (autoExclusive) {
if (QAbstractButton *b = queryCheckedButton())
b->setChecked(false);
}
}
void QAbstractButtonPrivate::moveFocus(int key)
{
QList<QAbstractButton *> buttonList = queryButtonList();
#if QT_CONFIG(buttongroup)
bool exclusive = group ? group->d_func()->exclusive : autoExclusive;
#else
bool exclusive = autoExclusive;
#endif
QWidget *f = QApplication::focusWidget();
QAbstractButton *fb = qobject_cast<QAbstractButton *>(f);
if (!fb || !buttonList.contains(fb))
return;
QAbstractButton *candidate = nullptr;
int bestScore = -1;
QRect target = f->rect().translated(f->mapToGlobal(QPoint(0,0)));
QPoint goal = target.center();
uint focus_flag = qt_tab_all_widgets() ? Qt::TabFocus : Qt::StrongFocus;
for (int i = 0; i < buttonList.count(); ++i) {
QAbstractButton *button = buttonList.at(i);
if (button != f && button->window() == f->window() && button->isEnabled() && !button->isHidden() &&
(exclusive || (button->focusPolicy() & focus_flag) == focus_flag)) {
QRect buttonRect = button->rect().translated(button->mapToGlobal(QPoint(0,0)));
QPoint p = buttonRect.center();
//Priority to widgets that overlap on the same coordinate.
//In that case, the distance in the direction will be used as significant score,
//take also in account orthogonal distance in case two widget are in the same distance.
int score;
if ((buttonRect.x() < target.right() && target.x() < buttonRect.right())
&& (key == Qt::Key_Up || key == Qt::Key_Down)) {
//one item's is at the vertical of the other
score = (qAbs(p.y() - goal.y()) << 16) + qAbs(p.x() - goal.x());
} else if ((buttonRect.y() < target.bottom() && target.y() < buttonRect.bottom())
&& (key == Qt::Key_Left || key == Qt::Key_Right) ) {
//one item's is at the horizontal of the other
score = (qAbs(p.x() - goal.x()) << 16) + qAbs(p.y() - goal.y());
} else {
score = (1 << 30) + (p.y() - goal.y()) * (p.y() - goal.y()) + (p.x() - goal.x()) * (p.x() - goal.x());
}
if (score > bestScore && candidate)
continue;
switch(key) {
case Qt::Key_Up:
if (p.y() < goal.y()) {
candidate = button;
bestScore = score;
}
break;
case Qt::Key_Down:
if (p.y() > goal.y()) {
candidate = button;
bestScore = score;
}
break;
case Qt::Key_Left:
if (p.x() < goal.x()) {
candidate = button;
bestScore = score;
}
break;
case Qt::Key_Right:
if (p.x() > goal.x()) {
candidate = button;
bestScore = score;
}
break;
}
}
}
if (exclusive
#ifdef QT_KEYPAD_NAVIGATION
&& !QApplicationPrivate::keypadNavigationEnabled()
#endif
&& candidate
&& fb->d_func()->checked
&& candidate->d_func()->checkable)
candidate->click();
if (candidate) {
if (key == Qt::Key_Up || key == Qt::Key_Left)
candidate->setFocus(Qt::BacktabFocusReason);
else
candidate->setFocus(Qt::TabFocusReason);
}
}
void QAbstractButtonPrivate::fixFocusPolicy()
{
Q_Q(QAbstractButton);
#if QT_CONFIG(buttongroup)
if (!group && !autoExclusive)
#else
if (!autoExclusive)
#endif
return;
QList<QAbstractButton *> buttonList = queryButtonList();
for (int i = 0; i < buttonList.count(); ++i) {
QAbstractButton *b = buttonList.at(i);
if (!b->isCheckable())
continue;
b->setFocusPolicy((Qt::FocusPolicy) ((b == q || !q->isCheckable())
? (b->focusPolicy() | Qt::TabFocus)
: (b->focusPolicy() & ~Qt::TabFocus)));
}
}
void QAbstractButtonPrivate::init()
{
Q_Q(QAbstractButton);
q->setFocusPolicy(Qt::FocusPolicy(q->style()->styleHint(QStyle::SH_Button_FocusPolicy)));
q->setSizePolicy(QSizePolicy(QSizePolicy::Minimum, QSizePolicy::Fixed, controlType));
q->setAttribute(Qt::WA_WState_OwnSizePolicy, false);
q->setForegroundRole(QPalette::ButtonText);
q->setBackgroundRole(QPalette::Button);
}
void QAbstractButtonPrivate::refresh()
{
Q_Q(QAbstractButton);
if (blockRefresh)
return;
q->update();
}
void QAbstractButtonPrivate::click()
{
Q_Q(QAbstractButton);
down = false;
blockRefresh = true;
bool changeState = true;
if (checked && queryCheckedButton() == q) {
// the checked button of an exclusive or autoexclusive group cannot be unchecked
#if QT_CONFIG(buttongroup)
if (group ? group->d_func()->exclusive : autoExclusive)
#else
if (autoExclusive)
#endif
changeState = false;
}
QPointer<QAbstractButton> guard(q);
if (changeState) {
q->nextCheckState();
if (!guard)
return;
}
blockRefresh = false;
refresh();
q->repaint();
if (guard)
emitReleased();
if (guard)
emitClicked();
}
void QAbstractButtonPrivate::emitClicked()
{
Q_Q(QAbstractButton);
QPointer<QAbstractButton> guard(q);
emit q->clicked(checked);
#if QT_CONFIG(buttongroup)
if (guard && group) {
const int id = group->id(q);
emit group->idClicked(id);
#if QT_DEPRECATED_SINCE(5, 15)
QT_WARNING_PUSH
QT_WARNING_DISABLE_DEPRECATED
if (guard && group)
emit group->buttonClicked(id);
QT_WARNING_POP
#endif
if (guard && group)
emit group->buttonClicked(q);
}
#endif
}
void QAbstractButtonPrivate::emitPressed()
{
Q_Q(QAbstractButton);
QPointer<QAbstractButton> guard(q);
emit q->pressed();
#if QT_CONFIG(buttongroup)
if (guard && group) {
const int id = group->id(q);
emit group->idPressed(id);
#if QT_DEPRECATED_SINCE(5, 15)
QT_WARNING_PUSH
QT_WARNING_DISABLE_DEPRECATED
if (guard && group)
emit group->buttonPressed(id);
QT_WARNING_POP
#endif
if (guard && group)
emit group->buttonPressed(q);
}
#endif
}
void QAbstractButtonPrivate::emitReleased()
{
Q_Q(QAbstractButton);
QPointer<QAbstractButton> guard(q);
emit q->released();
#if QT_CONFIG(buttongroup)
if (guard && group) {
const int id = group->id(q);
emit group->idReleased(id);
#if QT_DEPRECATED_SINCE(5, 15)
QT_WARNING_PUSH
QT_WARNING_DISABLE_DEPRECATED
if (guard && group)
emit group->buttonReleased(id);
QT_WARNING_POP
#endif
if (guard && group)
emit group->buttonReleased(q);
}
#endif
}
void QAbstractButtonPrivate::emitToggled(bool checked)
{
Q_Q(QAbstractButton);
QPointer<QAbstractButton> guard(q);
emit q->toggled(checked);
#if QT_CONFIG(buttongroup)
if (guard && group) {
const int id = group->id(q);
emit group->idToggled(id, checked);
#if QT_DEPRECATED_SINCE(5, 15)
QT_WARNING_PUSH
QT_WARNING_DISABLE_DEPRECATED
if (guard && group)
emit group->buttonToggled(id, checked);
QT_WARNING_POP
#endif
if (guard && group)
emit group->buttonToggled(q, checked);
}
#endif
}
/*!
Constructs an abstract button with a \a parent.
*/
QAbstractButton::QAbstractButton(QWidget *parent)
: QWidget(*new QAbstractButtonPrivate, parent, { })
{
Q_D(QAbstractButton);
d->init();
}
/*!
Destroys the button.
*/
QAbstractButton::~QAbstractButton()
{
#if QT_CONFIG(buttongroup)
Q_D(QAbstractButton);
if (d->group)
d->group->removeButton(this);
#endif
}
/*! \internal
*/
QAbstractButton::QAbstractButton(QAbstractButtonPrivate &dd, QWidget *parent)
: QWidget(dd, parent, { })
{
Q_D(QAbstractButton);
d->init();
}
/*!
\property QAbstractButton::text
\brief the text shown on the button
If the button has no text, the text() function will return an empty
string.
If the text contains an ampersand character ('&'), a shortcut is
automatically created for it. The character that follows the '&' will
be used as the shortcut key. Any previous shortcut will be
overwritten or cleared if no shortcut is defined by the text. See the
\l {QShortcut#mnemonic}{QShortcut} documentation for details. To
display an actual ampersand, use '&&'.
There is no default text.
*/
void QAbstractButton::setText(const QString &text)
{
Q_D(QAbstractButton);
if (d->text == text)
return;
d->text = text;
#ifndef QT_NO_SHORTCUT
QKeySequence newMnemonic = QKeySequence::mnemonic(text);
setShortcut(newMnemonic);
#endif
d->sizeHint = QSize();
update();
updateGeometry();
#ifndef QT_NO_ACCESSIBILITY
QAccessibleEvent event(this, QAccessible::NameChanged);
QAccessible::updateAccessibility(&event);
#endif
}
QString QAbstractButton::text() const
{
Q_D(const QAbstractButton);
return d->text;
}
/*!
\property QAbstractButton::icon
\brief the icon shown on the button
The icon's default size is defined by the GUI style, but can be
adjusted by setting the \l iconSize property.
*/
void QAbstractButton::setIcon(const QIcon &icon)
{
Q_D(QAbstractButton);
d->icon = icon;
d->sizeHint = QSize();
update();
updateGeometry();
}
QIcon QAbstractButton::icon() const
{
Q_D(const QAbstractButton);
return d->icon;
}
#ifndef QT_NO_SHORTCUT
/*!
\property QAbstractButton::shortcut
\brief the mnemonic associated with the button
*/
void QAbstractButton::setShortcut(const QKeySequence &key)
{
Q_D(QAbstractButton);
if (d->shortcutId != 0)
releaseShortcut(d->shortcutId);
d->shortcut = key;
d->shortcutId = grabShortcut(key);
}
QKeySequence QAbstractButton::shortcut() const
{
Q_D(const QAbstractButton);
return d->shortcut;
}
#endif // QT_NO_SHORTCUT
/*!
\property QAbstractButton::checkable
\brief whether the button is checkable
By default, the button is not checkable.
\sa checked
*/
void QAbstractButton::setCheckable(bool checkable)
{
Q_D(QAbstractButton);
if (d->checkable == checkable)
return;
d->checkable = checkable;
d->checked = false;
}
bool QAbstractButton::isCheckable() const
{
Q_D(const QAbstractButton);
return d->checkable;
}
/*!
\property QAbstractButton::checked
\brief whether the button is checked
Only checkable buttons can be checked. By default, the button is unchecked.
\sa checkable
*/
void QAbstractButton::setChecked(bool checked)
{
Q_D(QAbstractButton);
if (!d->checkable || d->checked == checked) {
if (!d->blockRefresh)
checkStateSet();
return;
}
if (!checked && d->queryCheckedButton() == this) {
// the checked button of an exclusive or autoexclusive group cannot be unchecked
#if QT_CONFIG(buttongroup)
if (d->group ? d->group->d_func()->exclusive : d->autoExclusive)
return;
if (d->group)
d->group->d_func()->detectCheckedButton();
#else
if (d->autoExclusive)
return;
#endif
}
QPointer<QAbstractButton> guard(this);
d->checked = checked;
if (!d->blockRefresh)
checkStateSet();
d->refresh();
if (guard && checked)
d->notifyChecked();
if (guard)
d->emitToggled(checked);
#ifndef QT_NO_ACCESSIBILITY
QAccessible::State s;
s.checked = true;
QAccessibleStateChangeEvent event(this, s);
QAccessible::updateAccessibility(&event);
#endif
}
bool QAbstractButton::isChecked() const
{
Q_D(const QAbstractButton);
return d->checked;
}
/*!
\property QAbstractButton::down
\brief whether the button is pressed down
If this property is \c true, the button is pressed down. The signals
pressed() and clicked() are not emitted if you set this property
to true. The default is false.
*/
void QAbstractButton::setDown(bool down)
{
Q_D(QAbstractButton);
if (d->down == down)
return;
d->down = down;
d->refresh();
if (d->autoRepeat && d->down)
d->repeatTimer.start(d->autoRepeatDelay, this);
else
d->repeatTimer.stop();
}
bool QAbstractButton::isDown() const
{
Q_D(const QAbstractButton);
return d->down;
}
/*!
\property QAbstractButton::autoRepeat
\brief whether autoRepeat is enabled
If autoRepeat is enabled, then the pressed(), released(), and clicked() signals are emitted at
regular intervals when the button is down. autoRepeat is off by default.
The initial delay and the repetition interval are defined in milliseconds by \l
autoRepeatDelay and \l autoRepeatInterval.
Note: If a button is pressed down by a shortcut key, then auto-repeat is enabled and timed by the
system and not by this class. The pressed(), released(), and clicked() signals will be emitted
like in the normal case.
*/
void QAbstractButton::setAutoRepeat(bool autoRepeat)
{
Q_D(QAbstractButton);
if (d->autoRepeat == autoRepeat)
return;
d->autoRepeat = autoRepeat;
if (d->autoRepeat && d->down)
d->repeatTimer.start(d->autoRepeatDelay, this);
else
d->repeatTimer.stop();
}
bool QAbstractButton::autoRepeat() const
{
Q_D(const QAbstractButton);
return d->autoRepeat;
}
/*!
\property QAbstractButton::autoRepeatDelay
\brief the initial delay of auto-repetition
\since 4.2
If \l autoRepeat is enabled, then autoRepeatDelay defines the initial
delay in milliseconds before auto-repetition kicks in.
\sa autoRepeat, autoRepeatInterval
*/
void QAbstractButton::setAutoRepeatDelay(int autoRepeatDelay)
{
Q_D(QAbstractButton);
d->autoRepeatDelay = autoRepeatDelay;
}
int QAbstractButton::autoRepeatDelay() const
{
Q_D(const QAbstractButton);
return d->autoRepeatDelay;
}
/*!
\property QAbstractButton::autoRepeatInterval
\brief the interval of auto-repetition
\since 4.2
If \l autoRepeat is enabled, then autoRepeatInterval defines the
length of the auto-repetition interval in millisecons.
\sa autoRepeat, autoRepeatDelay
*/
void QAbstractButton::setAutoRepeatInterval(int autoRepeatInterval)
{
Q_D(QAbstractButton);
d->autoRepeatInterval = autoRepeatInterval;
}
int QAbstractButton::autoRepeatInterval() const
{
Q_D(const QAbstractButton);
return d->autoRepeatInterval;
}
/*!
\property QAbstractButton::autoExclusive
\brief whether auto-exclusivity is enabled
If auto-exclusivity is enabled, checkable buttons that belong to the
same parent widget behave as if they were part of the same
exclusive button group. In an exclusive button group, only one button
can be checked at any time; checking another button automatically
unchecks the previously checked one.
The property has no effect on buttons that belong to a button
group.
autoExclusive is off by default, except for radio buttons.
\sa QRadioButton
*/
void QAbstractButton::setAutoExclusive(bool autoExclusive)
{
Q_D(QAbstractButton);
d->autoExclusive = autoExclusive;
}
bool QAbstractButton::autoExclusive() const
{
Q_D(const QAbstractButton);
return d->autoExclusive;
}
#if QT_CONFIG(buttongroup)
/*!
Returns the group that this button belongs to.
If the button is not a member of any QButtonGroup, this function
returns \nullptr.
\sa QButtonGroup
*/
QButtonGroup *QAbstractButton::group() const
{
Q_D(const QAbstractButton);
return d->group;
}
#endif // QT_CONFIG(buttongroup)
/*!
Performs an animated click: the button is pressed immediately, and
released \a msec milliseconds later (the default is 100 ms).
Calling this function again before the button is released resets
the release timer.
All signals associated with a click are emitted as appropriate.
This function does nothing if the button is \l{setEnabled()}{disabled.}
\sa click()
*/
void QAbstractButton::animateClick(int msec)
{
if (!isEnabled())
return;
Q_D(QAbstractButton);
if (d->checkable && focusPolicy() & Qt::ClickFocus)
setFocus();
setDown(true);
repaint();
if (!d->animateTimer.isActive())
d->emitPressed();
d->animateTimer.start(msec, this);
}
/*!
Performs a click.
All the usual signals associated with a click are emitted as
appropriate. If the button is checkable, the state of the button is
toggled.
This function does nothing if the button is \l{setEnabled()}{disabled.}
\sa animateClick()
*/
void QAbstractButton::click()
{
if (!isEnabled())
return;
Q_D(QAbstractButton);
QPointer<QAbstractButton> guard(this);
d->down = true;
d->emitPressed();
if (guard) {
d->down = false;
nextCheckState();
if (guard)
d->emitReleased();
if (guard)
d->emitClicked();
}
}
/*! \fn void QAbstractButton::toggle()
Toggles the state of a checkable button.
\sa checked
*/
void QAbstractButton::toggle()
{
Q_D(QAbstractButton);
setChecked(!d->checked);
}
/*! This virtual handler is called when setChecked() is used,
unless it is called from within nextCheckState(). It allows
subclasses to reset their intermediate button states.
\sa nextCheckState()
*/
void QAbstractButton::checkStateSet()
{
}
/*! This virtual handler is called when a button is clicked. The
default implementation calls setChecked(!isChecked()) if the button
isCheckable(). It allows subclasses to implement intermediate button
states.
\sa checkStateSet()
*/
void QAbstractButton::nextCheckState()
{
if (isCheckable())
setChecked(!isChecked());
}
/*!
Returns \c true if \a pos is inside the clickable button rectangle;
otherwise returns \c false.
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.
*/
bool QAbstractButton::hitButton(const QPoint &pos) const
{
return rect().contains(pos);
}
/*! \reimp */
bool QAbstractButton::event(QEvent *e)
{
// as opposed to other widgets, disabled buttons accept mouse
// events. This avoids surprising click-through scenarios
if (!isEnabled()) {
switch(e->type()) {
case QEvent::TabletPress:
case QEvent::TabletRelease:
case QEvent::TabletMove:
case QEvent::MouseButtonPress:
case QEvent::MouseButtonRelease:
case QEvent::MouseButtonDblClick:
case QEvent::MouseMove:
case QEvent::HoverMove:
case QEvent::HoverEnter:
case QEvent::HoverLeave:
case QEvent::ContextMenu:
#if QT_CONFIG(wheelevent)
case QEvent::Wheel:
#endif
return true;
default:
break;
}
}
#ifndef QT_NO_SHORTCUT
if (e->type() == QEvent::Shortcut) {
Q_D(QAbstractButton);
QShortcutEvent *se = static_cast<QShortcutEvent *>(e);
if (d->shortcutId != se->shortcutId())
return false;
if (!se->isAmbiguous()) {
if (!d->animateTimer.isActive())
animateClick();
} else {
if (focusPolicy() != Qt::NoFocus)
setFocus(Qt::ShortcutFocusReason);
window()->setAttribute(Qt::WA_KeyboardFocusChange);
}
return true;
}
#endif