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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
|
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtGui module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the either Technology Preview License Agreement or the
** Beta Release License Agreement.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain
** additional rights. These rights are described in the Nokia Qt LGPL
** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
** package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://www.qtsoftware.com/contact.
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qaction.h"
#include "qactiongroup.h"
#ifndef QT_NO_ACTION
#include "qaction_p.h"
#include "qapplication.h"
#include "qevent.h"
#include "qlist.h"
#include "qdebug.h"
#include <private/qshortcutmap_p.h>
#include <private/qapplication_p.h>
#include <private/qmenu_p.h>
#define QAPP_CHECK(functionName) \
if (!qApp) { \
qWarning("QAction: Initialize QApplication before calling '" functionName "'."); \
return; \
}
QT_BEGIN_NAMESPACE
/*
internal: guesses a descriptive text from a text suited for a menu entry
*/
static QString qt_strippedText(QString s)
{
s.remove( QString::fromLatin1("...") );
int i = 0;
while (i < s.size()) {
++i;
if (s.at(i-1) != QLatin1Char('&'))
continue;
if (i < s.size() && s.at(i) == QLatin1Char('&'))
++i;
s.remove(i-1,1);
}
return s.trimmed();
}
QActionPrivate::QActionPrivate() : group(0), enabled(1), forceDisabled(0),
visible(1), forceInvisible(0), checkable(0), checked(0), separator(0), fontSet(false),
menuRole(QAction::TextHeuristicRole), iconVisibleInMenu(-1)
{
#ifdef QT3_SUPPORT
static int qt_static_action_id = -1;
param = id = --qt_static_action_id;
act_signal = 0;
#endif
#ifndef QT_NO_SHORTCUT
shortcutId = 0;
shortcutContext = Qt::WindowShortcut;
autorepeat = true;
#endif
}
QActionPrivate::~QActionPrivate()
{
}
void QActionPrivate::sendDataChanged()
{
Q_Q(QAction);
QActionEvent e(QEvent::ActionChanged, q);
for (int i = 0; i < widgets.size(); ++i) {
QWidget *w = widgets.at(i);
QApplication::sendEvent(w, &e);
}
#ifndef QT_NO_GRAPHICSVIEW
for (int i = 0; i < graphicsWidgets.size(); ++i) {
QGraphicsWidget *w = graphicsWidgets.at(i);
QApplication::sendEvent(w, &e);
}
#endif
QApplication::sendEvent(q, &e);
emit q->changed();
}
#ifndef QT_NO_SHORTCUT
void QActionPrivate::redoGrab(QShortcutMap &map)
{
Q_Q(QAction);
if (shortcutId)
map.removeShortcut(shortcutId, q);
if (shortcut.isEmpty())
return;
shortcutId = map.addShortcut(q, shortcut, shortcutContext);
if (!enabled)
map.setShortcutEnabled(false, shortcutId, q);
if (!autorepeat)
map.setShortcutAutoRepeat(false, shortcutId, q);
}
void QActionPrivate::redoGrabAlternate(QShortcutMap &map)
{
Q_Q(QAction);
for(int i = 0; i < alternateShortcutIds.count(); ++i) {
if (const int id = alternateShortcutIds.at(i))
map.removeShortcut(id, q);
}
alternateShortcutIds.clear();
if (alternateShortcuts.isEmpty())
return;
for(int i = 0; i < alternateShortcuts.count(); ++i) {
const QKeySequence& alternate = alternateShortcuts.at(i);
if (!alternate.isEmpty())
alternateShortcutIds.append(map.addShortcut(q, alternate, shortcutContext));
else
alternateShortcutIds.append(0);
}
if (!enabled) {
for(int i = 0; i < alternateShortcutIds.count(); ++i) {
const int id = alternateShortcutIds.at(i);
map.setShortcutEnabled(false, id, q);
}
}
if (!autorepeat) {
for(int i = 0; i < alternateShortcutIds.count(); ++i) {
const int id = alternateShortcutIds.at(i);
map.setShortcutAutoRepeat(false, id, q);
}
}
}
void QActionPrivate::setShortcutEnabled(bool enable, QShortcutMap &map)
{
Q_Q(QAction);
if (shortcutId)
map.setShortcutEnabled(enable, shortcutId, q);
for(int i = 0; i < alternateShortcutIds.count(); ++i) {
if (const int id = alternateShortcutIds.at(i))
map.setShortcutEnabled(enable, id, q);
}
}
#endif // QT_NO_SHORTCUT
/*!
\class QAction
\brief The QAction class provides an abstract user interface
action that can be inserted into widgets.
\ingroup application
\mainclass
\omit
* parent and widget are different
* parent does not define context
\endomit
In applications many common commands can be invoked via menus,
toolbar buttons, and keyboard shortcuts. Since the user expects
each command to be performed in the same way, regardless of the
user interface used, it is useful to represent each command as
an \e action.
Actions can be added to menus and toolbars, and will
automatically keep them in sync. For example, in a word processor,
if the user presses a Bold toolbar button, the Bold menu item
will automatically be checked.
Actions can be created as independent objects, but they may
also be created during the construction of menus; the QMenu class
contains convenience functions for creating actions suitable for
use as menu items.
A QAction may contain an icon, menu text, a shortcut, status text,
"What's This?" text, and a tooltip. Most of these can be set in
the constructor. They can also be set independently with
setIcon(), setText(), setIconText(), setShortcut(),
setStatusTip(), setWhatsThis(), and setToolTip(). For menu items,
it is possible to set an individual font with setFont().
Actions are added to widgets using QWidget::addAction() or
QGraphicsWidget::addAction(). Note that an action must be added to a
widget before it can be used; this is also true when the shortcut should
be global (i.e., Qt::ApplicationShortcut as Qt::ShortcutContext).
Once a QAction has been created it should be added to the relevant
menu and toolbar, then connected to the slot which will perform
the action. For example:
\snippet examples/mainwindows/application/mainwindow.cpp 19
\codeline
\snippet examples/mainwindows/application/mainwindow.cpp 28
\snippet examples/mainwindows/application/mainwindow.cpp 31
We recommend that actions are created as children of the window
they are used in. In most cases actions will be children of
the application's main window.
\sa QMenu, QToolBar, {Application Example}
*/
/*!
\fn void QAction::trigger()
This is a convenience slot that calls activate(Trigger).
*/
/*!
\fn void QAction::hover()
This is a convenience slot that calls activate(Hover).
*/
/*!
\enum QAction::MenuRole
This enum describes how an action should be moved into the application menu on Mac OS X.
\value NoRole This action should not be put into the application menu
\value TextHeuristicRole This action should be put in the application menu based on the action's text
as described in the QMenuBar documentation.
\value ApplicationSpecificRole This action should be put in the application menu with an application specific role
\value AboutQtRole This action matches handles the "About Qt" menu item.
\value AboutRole This action should be placed where the "About" menu item is in the application menu.
\value PreferencesRole This action should be placed where the "Preferences..." menu item is in the application menu.
\value QuitRole This action should be placed where the Quit menu item is in the application menu.
*/
/*!
Constructs an action with \a parent. If \a parent is an action
group the action will be automatically inserted into the group.
*/
QAction::QAction(QObject* parent)
: QObject(*(new QActionPrivate), parent)
{
Q_D(QAction);
d->group = qobject_cast<QActionGroup *>(parent);
if (d->group)
d->group->addAction(this);
}
/*!
Constructs an action with some \a text and \a parent. If \a
parent is an action group the action will be automatically
inserted into the group.
The action uses a stripped version of \a text (e.g. "\&Menu
Option..." becomes "Menu Option") as descriptive text for
tool buttons. You can override this by setting a specific
description with setText(). The same text will be used for
tooltips unless you specify a different text using
setToolTip().
*/
QAction::QAction(const QString &text, QObject* parent)
: QObject(*(new QActionPrivate), parent)
{
Q_D(QAction);
d->text = text;
d->group = qobject_cast<QActionGroup *>(parent);
if (d->group)
d->group->addAction(this);
}
/*!
Constructs an action with an \a icon and some \a text and \a
parent. If \a parent is an action group the action will be
automatically inserted into the group.
The action uses a stripped version of \a text (e.g. "\&Menu
Option..." becomes "Menu Option") as descriptive text for
tool buttons. You can override this by setting a specific
description with setText(). The same text will be used for
tooltips unless you specify a different text using
setToolTip().
*/
QAction::QAction(const QIcon &icon, const QString &text, QObject* parent)
: QObject(*(new QActionPrivate), parent)
{
Q_D(QAction);
d->icon = icon;
d->text = text;
d->group = qobject_cast<QActionGroup *>(parent);
if (d->group)
d->group->addAction(this);
}
/*!
\internal
*/
QAction::QAction(QActionPrivate &dd, QObject *parent)
: QObject(dd, parent)
{
Q_D(QAction);
d->group = qobject_cast<QActionGroup *>(parent);
if (d->group)
d->group->addAction(this);
}
/*!
Returns the parent widget.
*/
QWidget *QAction::parentWidget() const
{
QObject *ret = parent();
while (ret && !ret->isWidgetType())
ret = ret->parent();
return (QWidget*)ret;
}
/*!
\since 4.2
Returns a list of widgets this action has been added to.
\sa QWidget::addAction(), associatedGraphicsWidgets()
*/
QList<QWidget *> QAction::associatedWidgets() const
{
Q_D(const QAction);
return d->widgets;
}
#ifndef QT_NO_GRAPHICSVIEW
/*!
\since 4.5
Returns a list of widgets this action has been added to.
\sa QWidget::addAction(), associatedWidgets()
*/
QList<QGraphicsWidget *> QAction::associatedGraphicsWidgets() const
{
Q_D(const QAction);
return d->graphicsWidgets;
}
#endif
#ifndef QT_NO_SHORTCUT
/*!
\property QAction::shortcut
\brief the action's primary shortcut key
Valid keycodes for this property can be found in \l Qt::Key and
\l Qt::Modifier. There is no default shortcut key.
*/
void QAction::setShortcut(const QKeySequence &shortcut)
{
QAPP_CHECK("setShortcut");
Q_D(QAction);
if (d->shortcut == shortcut)
return;
d->shortcut = shortcut;
d->redoGrab(qApp->d_func()->shortcutMap);
d->sendDataChanged();
}
/*!
\since 4.2
Sets \a shortcuts as the list of shortcuts that trigger the
action. The first element of the list is the primary shortcut.
\sa shortcut
*/
void QAction::setShortcuts(const QList<QKeySequence> &shortcuts)
{
Q_D(QAction);
QList <QKeySequence> listCopy = shortcuts;
QKeySequence primary;
if (!listCopy.isEmpty())
primary = listCopy.takeFirst();
if (d->shortcut == primary && d->alternateShortcuts == listCopy)
return;
QAPP_CHECK("setShortcuts");
d->shortcut = primary;
d->alternateShortcuts = listCopy;
d->redoGrab(qApp->d_func()->shortcutMap);
d->redoGrabAlternate(qApp->d_func()->shortcutMap);
d->sendDataChanged();
}
/*!
\since 4.2
Sets a platform dependent list of shortcuts based on the \a key.
The result of calling this function will depend on the currently running platform.
Note that more than one shortcut can assigned by this action.
If only the primary shortcut is required, use setShortcut instead.
\sa QKeySequence::keyBindings()
*/
void QAction::setShortcuts(QKeySequence::StandardKey key)
{
QList <QKeySequence> list = QKeySequence::keyBindings(key);
setShortcuts(list);
}
/*!
Returns the primary shortcut.
\sa setShortcuts()
*/
QKeySequence QAction::shortcut() const
{
Q_D(const QAction);
return d->shortcut;
}
/*!
\since 4.2
Returns the list of shortcuts, with the primary shortcut as
the first element of the list.
\sa setShortcuts()
*/
QList<QKeySequence> QAction::shortcuts() const
{
Q_D(const QAction);
QList <QKeySequence> shortcuts;
if (!d->shortcut.isEmpty())
shortcuts << d->shortcut;
if (!d->alternateShortcuts.isEmpty())
shortcuts << d->alternateShortcuts;
return shortcuts;
}
/*!
\property QAction::shortcutContext
\brief the context for the action's shortcut
Valid values for this property can be found in \l Qt::ShortcutContext.
The default value is Qt::WindowShortcut.
*/
void QAction::setShortcutContext(Qt::ShortcutContext context)
{
Q_D(QAction);
if (d->shortcutContext == context)
return;
QAPP_CHECK("setShortcutContext");
d->shortcutContext = context;
d->redoGrab(qApp->d_func()->shortcutMap);
d->redoGrabAlternate(qApp->d_func()->shortcutMap);
d->sendDataChanged();
}
Qt::ShortcutContext QAction::shortcutContext() const
{
Q_D(const QAction);
return d->shortcutContext;
}
/*!
\property QAction::autoRepeat
\brief whether the action can auto repeat
\since 4.2
If true, the action will auto repeat when the keyboard shortcut
combination is held down, provided that keyboard auto repeat is
enabled on the system.
The default value is true.
*/
void QAction::setAutoRepeat(bool on)
{
Q_D(QAction);
if (d->autorepeat == on)
return;
QAPP_CHECK("setAutoRepeat");
d->autorepeat = on;
d->redoGrab(qApp->d_func()->shortcutMap);
d->redoGrabAlternate(qApp->d_func()->shortcutMap);
d->sendDataChanged();
}
bool QAction::autoRepeat() const
{
Q_D(const QAction);
return d->autorepeat;
}
#endif // QT_NO_SHORTCUT
/*!
\property QAction::font
\brief the action's font
The font property is used to render the text set on the
QAction. The font will can be considered a hint as it will not be
consulted in all cases based upon application and style.
By default, this property contains the application's default font.
\sa QAction::setText() QStyle
*/
void QAction::setFont(const QFont &font)
{
Q_D(QAction);
if (d->font == font)
return;
d->fontSet = true;
d->font = font;
d->sendDataChanged();
}
QFont QAction::font() const
{
Q_D(const QAction);
return d->font;
}
#ifdef QT3_SUPPORT
/*!
Use one of the QAction constructors that doesn't take a \a name
argument and call setObjectName() instead.
*/
QAction::QAction(QObject* parent, const char* name)
: QObject(*(new QActionPrivate), parent)
{
Q_D(QAction);
setObjectName(QString::fromAscii(name));
d->group = qobject_cast<QActionGroup *>(parent);
if (d->group)
d->group->addAction(this);
}
/*!
Use one of the QAction constructors that doesn't take a \a name
argument and call setObjectName() instead.
*/
QAction::QAction(const QString &text, const QKeySequence &shortcut, QObject* parent, const char* name)
: QObject(*(new QActionPrivate), parent)
{
Q_D(QAction);
setObjectName(QString::fromAscii(name));
d->text = text;
setShortcut(shortcut);
d->group = qobject_cast<QActionGroup *>(parent);
if (d->group)
d->group->addAction(this);
}
/*!
Use one of the QAction constructors that doesn't take a \a name
argument and call setObjectName() instead.
*/
QAction::QAction(const QIcon &icon, const QString &text, const QKeySequence &shortcut,
QObject* parent, const char* name)
: QObject(*(new QActionPrivate), parent)
{
Q_D(QAction);
setObjectName(QString::fromAscii(name));
d->text = text;
setShortcut(shortcut);
d->icon = icon;
d->group = qobject_cast<QActionGroup *>(parent);
if (d->group)
d->group->addAction(this);
}
#endif
/*!
Destroys the object and frees allocated resources.
*/
QAction::~QAction()
{
Q_D(QAction);
for (int i = d->widgets.size()-1; i >= 0; --i) {
QWidget *w = d->widgets.at(i);
w->removeAction(this);
}
#ifndef QT_NO_GRAPHICSVIEW
for (int i = d->graphicsWidgets.size()-1; i >= 0; --i) {
QGraphicsWidget *w = d->graphicsWidgets.at(i);
w->removeAction(this);
}
#endif
if (d->group)
d->group->removeAction(this);
#ifndef QT_NO_SHORTCUT
if (d->shortcutId && qApp) {
qApp->d_func()->shortcutMap.removeShortcut(d->shortcutId, this);
for(int i = 0; i < d->alternateShortcutIds.count(); ++i) {
const int id = d->alternateShortcutIds.at(i);
qApp->d_func()->shortcutMap.removeShortcut(id, this);
}
}
#endif
}
/*!
Sets this action group to \a group. The action will be automatically
added to the group's list of actions.
Actions within the group will be mutually exclusive.
\sa QActionGroup, QAction::actionGroup()
*/
void QAction::setActionGroup(QActionGroup *group)
{
Q_D(QAction);
if(group == d->group)
return;
if(d->group)
d->group->removeAction(this);
d->group = group;
if(group)
group->addAction(this);
}
/*!
Returns the action group for this action. If no action group manages
this action then 0 will be returned.
\sa QActionGroup, QAction::setActionGroup()
*/
QActionGroup *QAction::actionGroup() const
{
Q_D(const QAction);
return d->group;
}
/*!
\property QAction::icon
\brief the action's icon
In toolbars, the icon is used as the tool button icon; in menus,
it is displayed to the left of the menu text. There is no default
icon.
If a null icon (QIcon::isNull() is passed into this function,
the icon of the action is cleared.
*/
void QAction::setIcon(const QIcon &icon)
{
Q_D(QAction);
d->icon = icon;
d->sendDataChanged();
}
QIcon QAction::icon() const
{
Q_D(const QAction);
return d->icon;
}
#ifndef QT_NO_MENU
/*!
Returns the menu contained by this action. Actions that contain
menus can be used to create menu items with submenus, or inserted
into toolbars to create buttons with popup menus.
\sa QMenu::addAction()
*/
QMenu *QAction::menu() const
{
Q_D(const QAction);
return d->menu;
}
/*!
Sets the menu contained by this action to the specified \a menu.
*/
void QAction::setMenu(QMenu *menu)
{
Q_D(QAction);
if (d->menu)
d->menu->d_func()->setOverrideMenuAction(0); //we reset the default action of any previous menu
d->menu = menu;
if (menu)
menu->d_func()->setOverrideMenuAction(this);
d->sendDataChanged();
}
#endif // QT_NO_MENU
/*!
If \a b is true then this action will be considered a separator.
How a separator is represented depends on the widget it is inserted
into. Under most circumstances the text, submenu, and icon will be
ignored for separator actions.
\sa QAction::isSeparator()
*/
void QAction::setSeparator(bool b)
{
Q_D(QAction);
if (d->separator == b)
return;
d->separator = b;
d->sendDataChanged();
}
/*!
Returns true if this action is a separator action; otherwise it
returns false.
\sa QAction::setSeparator()
*/
bool QAction::isSeparator() const
{
Q_D(const QAction);
return d->separator;
}
/*!
\property QAction::text
\brief the action's descriptive text
If the action is added to a menu, the menu option will consist of
the icon (if there is one), the text, and the shortcut (if there
is one). If the text is not explicitly set in the constructor, or
by using setText(), the action's description icon text will be
used as text. There is no default text.
\sa iconText
*/
void QAction::setText(const QString &text)
{
Q_D(QAction);
if (d->text == text)
return;
d->text = text;
d->sendDataChanged();
}
QString QAction::text() const
{
Q_D(const QAction);
QString s = d->text;
if(s.isEmpty()) {
s = d->iconText;
s.replace(QLatin1Char('&'), QLatin1String("&&"));
}
return s;
}
/*!
\property QAction::iconText
\brief the action's descriptive icon text
If QToolBar::toolButtonStyle is set to a value that permits text to
be displayed, the text defined held in this property appears as a
label in the relevant tool button.
It also serves as the default text in menus and tooltips if the action
has not been defined with setText() or setToolTip(), and will
also be used in toolbar buttons if no icon has been defined using setIcon().
If the icon text is not explicitly set, the action's normal text will be
used for the icon text.
By default, this property contains an empty string.
\sa setToolTip(), setStatusTip()
*/
void QAction::setIconText(const QString &text)
{
Q_D(QAction);
if (d->iconText == text)
return;
d->iconText = text;
d->sendDataChanged();
}
QString QAction::iconText() const
{
Q_D(const QAction);
if (d->iconText.isEmpty())
return qt_strippedText(d->text);
return d->iconText;
}
/*!
\property QAction::toolTip
\brief the action's tooltip
This text is used for the tooltip. If no tooltip is specified,
the action's text is used.
By default, this property contains the action's text.
\sa setStatusTip() setShortcut()
*/
void QAction::setToolTip(const QString &tooltip)
{
Q_D(QAction);
if (d->tooltip == tooltip)
return;
d->tooltip = tooltip;
d->sendDataChanged();
}
QString QAction::toolTip() const
{
Q_D(const QAction);
if (d->tooltip.isEmpty()) {
if (!d->text.isEmpty())
return qt_strippedText(d->text);
return qt_strippedText(d->iconText);
}
return d->tooltip;
}
/*!
\property QAction::statusTip
\brief the action's status tip
The status tip is displayed on all status bars provided by the
action's top-level parent widget.
By default, this property contains an empty string.
\sa setToolTip() showStatusText()
*/
void QAction::setStatusTip(const QString &statustip)
{
Q_D(QAction);
if (d->statustip == statustip)
return;
d->statustip = statustip;
d->sendDataChanged();
}
QString QAction::statusTip() const
{
Q_D(const QAction);
return d->statustip;
}
/*!
\property QAction::whatsThis
\brief the action's "What's This?" help text
The "What's This?" text is used to provide a brief description of
the action. The text may contain rich text. There is no default
"What's This?" text.
\sa QWhatsThis Q3StyleSheet
*/
void QAction::setWhatsThis(const QString &whatsthis)
{
Q_D(QAction);
if (d->whatsthis == whatsthis)
return;
d->whatsthis = whatsthis;
d->sendDataChanged();
}
QString QAction::whatsThis() const
{
Q_D(const QAction);
return d->whatsthis;
}
/*!
\property QAction::checkable
\brief whether the action is a checkable action
A checkable action is one which has an on/off state. For example,
in a word processor, a Bold toolbar button may be either on or
off. An action which is not a toggle action is a command action;
a command action is simply executed, e.g. file save.
By default, this property is false.
In some situations, the state of one toggle action should depend
on the state of others. For example, "Left Align", "Center" and
"Right Align" toggle actions are mutually exclusive. To achieve
exclusive toggling, add the relevant toggle actions to a
QActionGroup with the QActionGroup::exclusive property set to
true.
\sa QAction::setChecked()
*/
void QAction::setCheckable(bool b)
{
Q_D(QAction);
if (d->checkable == b)
return;
d->checkable = b;
d->checked = false;
d->sendDataChanged();
}
bool QAction::isCheckable() const
{
Q_D(const QAction);
return d->checkable;
}
/*!
\fn void QAction::toggle()
This is a convenience function for the \l checked property.
Connect to it to change the checked state to its opposite state.
*/
void QAction::toggle()
{
Q_D(QAction);
setChecked(!d->checked);
}
/*!
\property QAction::checked
\brief whether the action is checked.
Only checkable actions can be checked. By default, this is false
(the action is unchecked).
\sa checkable
*/
void QAction::setChecked(bool b)
{
Q_D(QAction);
if (!d->checkable || d->checked == b)
return;
QPointer<QAction> guard(this);
d->checked = b;
d->sendDataChanged();
if (guard)
emit toggled(b);
}
bool QAction::isChecked() const
{
Q_D(const QAction);
return d->checked;
}
/*!
\fn void QAction::setDisabled(bool b)
This is a convenience function for the \l enabled property, that
is useful for signals--slots connections. If \a b is true the
action is disabled; otherwise it is enabled.
*/
/*!
\property QAction::enabled
\brief whether the action is enabled
Disabled actions cannot be chosen by the user. They do not
disappear from menus or toolbars, but they are displayed in a way
which indicates that they are unavailable. For example, they might
be displayed using only shades of gray.
\gui{What's This?} help on disabled actions is still available, provided
that the QAction::whatsThis property is set.
An action will be disabled when all widgets to which it is added
(with QWidget::addAction()) are disabled or not visible. When an
action is disabled, it is not possible to trigger it through its
shortcut.
By default, this property is true (actions are enabled).
\sa text
*/
void QAction::setEnabled(bool b)
{
Q_D(QAction);
if (b == d->enabled && b != d->forceDisabled)
return;
d->forceDisabled = !b;
if (b && (!d->visible || (d->group && !d->group->isEnabled())))
return;
QAPP_CHECK("setEnabled");
d->enabled = b;
#ifndef QT_NO_SHORTCUT
d->setShortcutEnabled(b, qApp->d_func()->shortcutMap);
#endif
d->sendDataChanged();
}
bool QAction::isEnabled() const
{
Q_D(const QAction);
return d->enabled;
}
/*!
\property QAction::visible
\brief whether the action can be seen (e.g. in menus and toolbars)
If \e visible is true the action can be seen (e.g. in menus and
toolbars) and chosen by the user; if \e visible is false the
action cannot be seen or chosen by the user.
Actions which are not visible are \e not grayed out; they do not
appear at all.
By default, this property is true (actions are visible).
*/
void QAction::setVisible(bool b)
{
Q_D(QAction);
if (b == d->visible && b != d->forceInvisible)
return;
QAPP_CHECK("setVisible");
d->forceInvisible = !b;
d->visible = b;
d->enabled = b && !d->forceDisabled && (!d->group || d->group->isEnabled()) ;
#ifndef QT_NO_SHORTCUT
d->setShortcutEnabled(d->enabled, qApp->d_func()->shortcutMap);
#endif
d->sendDataChanged();
}
bool QAction::isVisible() const
{
Q_D(const QAction);
return d->visible;
}
/*!
\reimp
*/
bool
QAction::event(QEvent *e)
{
#ifndef QT_NO_SHORTCUT
if (e->type() == QEvent::Shortcut) {
QShortcutEvent *se = static_cast<QShortcutEvent *>(e);
Q_ASSERT_X(se->key() == d_func()->shortcut || d_func()->alternateShortcuts.contains(se->key()),
"QAction::event",
"Received shortcut event from incorrect shortcut");
if (se->isAmbiguous())
qWarning("QAction::eventFilter: Ambiguous shortcut overload: %s", QString(se->key()).toLatin1().constData());
else
activate(Trigger);
return true;
}
#endif
return QObject::event(e);
}
/*!
Returns the user data as set in QAction::setData.
\sa setData()
*/
QVariant
QAction::data() const
{
Q_D(const QAction);
return d->userData;
}
/*!
\fn void QAction::setData(const QVariant &userData)
Sets the action's internal data to the given \a userData.
\sa data()
*/
void
QAction::setData(const QVariant &data)
{
Q_D(QAction);
d->userData = data;
d->sendDataChanged();
}
/*!
Updates the relevant status bar for the \a widget specified by sending a
QStatusTipEvent to its parent widget. Returns true if an event was sent;
otherwise returns false.
If a null widget is specified, the event is sent to the action's parent.
\sa statusTip
*/
bool
QAction::showStatusText(QWidget *widget)
{
#ifdef QT_NO_STATUSTIP
Q_UNUSED(widget);
#else
if(QObject *object = widget ? widget : parent()) {
QStatusTipEvent tip(statusTip());
QApplication::sendEvent(object, &tip);
return true;
}
#endif
return false;
}
/*!
Sends the relevant signals for ActionEvent \a event.
Action based widgets use this API to cause the QAction
to emit signals as well as emitting their own.
*/
void QAction::activate(ActionEvent event)
{
Q_D(QAction);
if(event == Trigger) {
QObject *guard = this;
QMetaObject::addGuard(&guard);
if(d->checkable) {
// the checked action of an exclusive group cannot be unchecked
if (d->checked && (d->group && d->group->isExclusive()
&& d->group->checkedAction() == this)) {
if (guard)
emit triggered(true);
QMetaObject::removeGuard(&guard);
return;
}
setChecked(!d->checked);
}
if (guard)
emit triggered(d->checked);
#ifdef QT3_SUPPORT
if (guard)
emit activated(d->param);
#endif
QMetaObject::removeGuard(&guard);
} else if(event == Hover) {
emit hovered();
}
}
/*!
\fn void QAction::triggered(bool checked)
This signal is emitted when an action is activated by the user;
for example, when the user clicks a menu option, toolbar button,
or presses an action's shortcut key combination, or when trigger()
was called. Notably, it is \e not emitted when setChecked() or
toggle() is called.
If the action is checkable, \a checked is true if the action is
checked, or false if the action is unchecked.
\sa QAction::activate(), QAction::toggled(), checked
*/
/*!
\fn void QAction::toggled(bool checked)
This signal is emitted whenever a checkable action changes its
isChecked() status. This can be the result of a user interaction,
or because setChecked() was called.
\a checked is true if the action is checked, or false if the
action is unchecked.
\sa QAction::activate(), QAction::triggered(), checked
*/
/*!
\fn void QAction::hovered()
This signal is emitted when an action is highlighted by the user;
for example, when the user pauses with the cursor over a menu option,
toolbar button, or presses an action's shortcut key combination.
\sa QAction::activate()
*/
/*!
\fn void QAction::changed()
This signal is emitted when an action has changed. If you
are only interested in actions in a given widget, you can
watch for QWidget::actionEvent() sent with an
QEvent::ActionChanged.
\sa QWidget::actionEvent()
*/
/*!
\enum QAction::ActionEvent
This enum type is used when calling QAction::activate()
\value Trigger this will cause the QAction::triggered() signal to be emitted.
\value Hover this will cause the QAction::hovered() signal to be emitted.
*/
/*!
\fn void QAction::setMenuText(const QString &text)
Use setText() instead.
*/
/*!
\fn QString QAction::menuText() const
Use text() instead.
*/
/*!
\fn bool QAction::isOn() const
Use isChecked() instead.
*/
/*!
\fn void QAction::setOn(bool b)
Use setChecked() instead.
*/
/*!
\fn bool QAction::isToggleAction() const
Use isCheckable() instead.
*/
/*!
\fn void QAction::setToggleAction(bool b)
Use setCheckable() instead.
*/
/*!
\fn void QAction::setIconSet(const QIcon &i)
Use setIcon() instead.
*/
/*!
\fn bool QAction::addTo(QWidget *w)
Use QWidget::addAction() instead.
\oldcode
action->addTo(widget);
\newcode
widget->addAction(action);
\endcode
*/
/*!
\fn bool QAction::removeFrom(QWidget *w)
Use QWidget::removeAction() instead.
\oldcode
action->removeFrom(widget);
\newcode
widget->removeAction(action);
\endcode
*/
/*!
\fn void QAction::setAccel(const QKeySequence &shortcut)
Use setShortcut() instead.
*/
/*!
\fn QIcon QAction::iconSet() const
Use icon() instead.
*/
/*!
\fn QKeySequence QAction::accel() const
Use shortcut() instead.
*/
/*!
\fn void QAction::activated(int i);
Use triggered() instead.
*/
/*!
\property QAction::menuRole
\brief the action's menu role
\since 4.2
This indicates what role the action serves in the application menu on Mac
OS X. By default all action have the TextHeuristicRole, which means that
the action is added based on its text (see QMenuBar for more information).
The menu role can only be changed before the actions are put into the menu
bar in Mac OS X (usually just before the first application window is
shown).
*/
void QAction::setMenuRole(MenuRole menuRole)
{
Q_D(QAction);
if (d->menuRole == menuRole)
return;
d->menuRole = menuRole;
d->sendDataChanged();
}
QAction::MenuRole QAction::menuRole() const
{
Q_D(const QAction);
return d->menuRole;
}
/*!
\property QAction::iconVisibleInMenu
\brief Whether or not an action should show an icon in a menu
\since 4.4
In some applications, it may make sense to have actions with icons in the
toolbar, but not in menus. If true, the icon (if valid) is shown in the menu, when it
is false, it is not shown.
The default is to follow whether the Qt::AA_DontShowIconsInMenus attribute
is set for the application. Explicitly settings this property overrides
the presence (or abscence) of the attribute.
For example:
\snippet doc/src/snippets/code/src_gui_kernel_qaction.cpp 0
\sa QAction::icon QApplication::setAttribute()
*/
void QAction::setIconVisibleInMenu(bool visible)
{
Q_D(QAction);
if (d->iconVisibleInMenu == -1 || visible != bool(d->iconVisibleInMenu)) {
int oldValue = d->iconVisibleInMenu;
d->iconVisibleInMenu = visible;
// Only send data changed if we really need to.
if (oldValue != -1
|| (oldValue == -1
&& visible == !QApplication::instance()->testAttribute(Qt::AA_DontShowIconsInMenus))) {
d->sendDataChanged();
}
}
}
bool QAction::isIconVisibleInMenu() const
{
Q_D(const QAction);
if (d->iconVisibleInMenu == -1) {
return !QApplication::instance()->testAttribute(Qt::AA_DontShowIconsInMenus);
}
return d->iconVisibleInMenu;
}
QT_END_NAMESPACE
#include "moc_qaction.cpp"
#endif // QT_NO_ACTION
|