command.cpp 13.4 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2
3
4
**
** This file is part of Qt Creator
**
5
** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
9
** Commercial Usage
10
**
11
12
13
14
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
15
**
16
** GNU Lesser General Public License Usage
17
**
18
19
20
21
22
23
** 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.
24
**
25
** If you are unsure which license is appropriate for your use, please
26
** contact the sales department at http://www.qtsoftware.com/contact.
con's avatar
con committed
27
**
28
**************************************************************************/
hjk's avatar
hjk committed
29

con's avatar
con committed
30
31
32
33
#include <QtCore/QDebug>
#include <QtGui/QAction>
#include <QtGui/QShortcut>

con's avatar
con committed
34
#include "command_p.h"
con's avatar
con committed
35
36

/*!
con's avatar
con committed
37
    \class Core::Command
con's avatar
con committed
38
39
    \mainclass

40
    \brief The class Command represents an action like a menu item, tool button, or shortcut.
con's avatar
con committed
41
42
43
44
    You don't create Command objects directly, instead use \l{ActionManager::registerAction()}
    to register an action and retrieve a Command. The Command object represents the user visible
    action and its properties. If multiple actions are registered with the same ID (but
    different contexts) the returned Command is the shared one between these actions.
con's avatar
con committed
45

con's avatar
con committed
46
47
48
49
50
51
52
53
54
55
56
57
58
59
    A Command has two basic properties: A default shortcut and a default text. The default
    shortcut is a key sequence that the user can use to trigger the active action that
    the Command represents. The default text is e.g. used for representing the Command
    in the keyboard shortcut preference pane. If the default text is empty, the text
    of the visible action is used.

    The user visible action is updated to represent the state of the active action (if any).
    For performance reasons only the enabled and visible state are considered by default though.
    You can tell a Command to also update the actions icon and text by setting the
    corresponding \l{Command::CommandAttribute}{attribute}.

    If there is no active action, the default behavior of the visible action is to be disabled.
    You can change that behavior to make the visible action hide instead via the Command's
    \l{Command::CommandAttribute}{attributes}.
con's avatar
con committed
60
61
62
*/

/*!
con's avatar
con committed
63
    \enum Command::CommandAttribute
con's avatar
con committed
64
65
66
67
68
69
70
71
72
73
74
75
76
77
    Defines how the user visible action is updated when the active action changes.
    The default is to update the enabled and visible state, and to disable the
    user visible action when there is no active action.
    \omitvalue CA_Mask
    \value CA_UpdateText
        Also update the actions text.
    \value CA_UpdateIcon
        Also update the actions icon.
    \value CA_Hide
        When there is no active action, hide the user "visible" action, instead of just
        disabling it.
    \value CA_NonConfigureable
        Flag to indicate that the keyboard shortcut of this Command should not be
        configurable by the user.
con's avatar
con committed
78
79
80
*/

/*!
con's avatar
con committed
81
82
83
84
    \fn void Command::setDefaultKeySequence(const QKeySequence &key)
    Set the default keyboard shortcut that can be used to activate this command to \a key.
    This is used if the user didn't customize the shortcut, or resets the shortcut
    to the default one.
con's avatar
con committed
85
86
87
*/

/*!
con's avatar
con committed
88
89
90
    \fn void Command::defaultKeySequence() const
    Returns the default keyboard shortcut that can be used to activate this command.
    \sa setDefaultKeySequence()
con's avatar
con committed
91
92
93
*/

/*!
con's avatar
con committed
94
95
96
    \fn void Command::keySequenceChanged()
    Sent when the keyboard shortcut assigned to this Command changes, e.g.
    when the user sets it in the keyboard shortcut settings dialog.
con's avatar
con committed
97
98
99
*/

/*!
con's avatar
con committed
100
101
102
    \fn QKeySequence Command::keySequence() const
    Returns the current keyboard shortcut assigned to this Command.
    \sa defaultKeySequence()
con's avatar
con committed
103
104
105
*/

/*!
con's avatar
con committed
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
    \fn void Command::setKeySequence(const QKeySequence &key)
    \internal
*/

/*!
    \fn void Command::setDefaultText(const QString &text)
    Set the \a text that is used to represent the Command in the
    keyboard shortcut settings dialog. If you don't set this,
    the current text from the user visible action is taken (which
    is ok in many cases).
*/

/*!
    \fn QString Command::defaultText() const
    Returns the text that is used to present this Command to the user.
    \sa setDefaultText()
*/

/*!
    \fn int Command::id() const
    \internal
*/

/*!
    \fn QString Command::stringWithAppendedShortcut(const QString &string) const
    Returns the \a string with an appended representation of the keyboard shortcut
    that is currently assigned to this Command.
*/

/*!
    \fn QAction *Command::action() const
    Returns the user visible action for this Command.
    If the Command represents a shortcut, it returns null.
    Use this action to put it on e.g. tool buttons. The action
    automatically forwards trigger and toggle signals to the
    action that is currently active for this Command.
    It also shows the current keyboard shortcut in its
    tool tip (in addition to the tool tip of the active action)
    and gets disabled/hidden when there is
    no active action for the current context.
con's avatar
con committed
146
147
148
*/

/*!
con's avatar
con committed
149
150
151
    \fn QShortcut *Command::shortcut() const
    Returns the shortcut for this Command.
    If the Command represents an action, it returns null.
con's avatar
con committed
152
153
154
*/

/*!
con's avatar
con committed
155
156
157
158
159
    \fn void Command::setAttribute(CommandAttribute attribute)
    Add the \a attribute to the attributes of this Command.
    \sa CommandAttribute
    \sa removeAttribute()
    \sa hasAttribute()
con's avatar
con committed
160
161
162
*/

/*!
con's avatar
con committed
163
164
165
166
    \fn void Command::removeAttribute(CommandAttribute attribute)
    Remove the \a attribute from the attributes of this Command.
    \sa CommandAttribute
    \sa setAttribute()
con's avatar
con committed
167
168
169
*/

/*!
con's avatar
con committed
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
    \fn bool Command::hasAttribute(CommandAttribute attribute) const
    Returns if the Command has the \a attribute set.
    \sa CommandAttribute
    \sa removeAttribute()
    \sa setAttribute()
*/

/*!
    \fn bool Command::isActive() const
    Returns if the Command has an active action/shortcut for the current
    context.
*/

/*!
    \fn Command::~Command()
    \internal
con's avatar
con committed
186
187
188
189
190
*/

using namespace Core::Internal;

/*!
con's avatar
con committed
191
192
    \class CommandPrivate
    \internal
con's avatar
con committed
193
194
*/

con's avatar
con committed
195
196
CommandPrivate::CommandPrivate(int id)
    : m_attributes(0), m_id(id)
con's avatar
con committed
197
198
199
{
}

con's avatar
con committed
200
void CommandPrivate::setDefaultKeySequence(const QKeySequence &key)
con's avatar
con committed
201
202
203
204
{
    m_defaultKey = key;
}

con's avatar
con committed
205
QKeySequence CommandPrivate::defaultKeySequence() const
con's avatar
con committed
206
207
208
209
{
    return m_defaultKey;
}

con's avatar
con committed
210
void CommandPrivate::setDefaultText(const QString &text)
con's avatar
con committed
211
212
213
214
{
    m_defaultText = text;
}

con's avatar
con committed
215
QString CommandPrivate::defaultText() const
con's avatar
con committed
216
217
218
219
{
    return m_defaultText;
}

con's avatar
con committed
220
int CommandPrivate::id() const
con's avatar
con committed
221
222
223
224
{
    return m_id;
}

con's avatar
con committed
225
QAction *CommandPrivate::action() const
con's avatar
con committed
226
227
228
229
{
    return 0;
}

con's avatar
con committed
230
QShortcut *CommandPrivate::shortcut() const
con's avatar
con committed
231
232
233
234
{
    return 0;
}

con's avatar
con committed
235
void CommandPrivate::setAttribute(CommandAttribute attr)
con's avatar
con committed
236
{
con's avatar
con committed
237
    m_attributes |= attr;
con's avatar
con committed
238
239
}

con's avatar
con committed
240
void CommandPrivate::removeAttribute(CommandAttribute attr)
con's avatar
con committed
241
{
con's avatar
con committed
242
    m_attributes &= ~attr;
con's avatar
con committed
243
244
}

con's avatar
con committed
245
bool CommandPrivate::hasAttribute(CommandAttribute attr) const
con's avatar
con committed
246
{
con's avatar
con committed
247
    return (m_attributes & attr);
con's avatar
con committed
248
249
}

con's avatar
con committed
250
QString CommandPrivate::stringWithAppendedShortcut(const QString &str) const
con's avatar
con committed
251
252
253
254
255
256
257
258
259
{
    return QString("%1 <span style=\"color: gray; font-size: small\">%2</span>").arg(str).arg(
            keySequence().toString(QKeySequence::NativeText));
}

// ---------- Shortcut ------------

/*!
    \class Shortcut
con's avatar
con committed
260
    \internal
con's avatar
con committed
261
262
263
*/

Shortcut::Shortcut(int id)
con's avatar
con committed
264
    : CommandPrivate(id), m_shortcut(0)
con's avatar
con committed
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
{

}

QString Shortcut::name() const
{
    if (!m_shortcut)
        return QString();

    return m_shortcut->whatsThis();
}

void Shortcut::setShortcut(QShortcut *shortcut)
{
    m_shortcut = shortcut;
}

QShortcut *Shortcut::shortcut() const
{
    return m_shortcut;
}

void Shortcut::setContext(const QList<int> &context)
{
    m_context = context;
}

QList<int> Shortcut::context() const
{
    return m_context;
}

void Shortcut::setDefaultKeySequence(const QKeySequence &key)
{
299
300
    if (m_shortcut->key().isEmpty())
        setKeySequence(key);
con's avatar
con committed
301
    CommandPrivate::setDefaultKeySequence(key);
con's avatar
con committed
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
}

void Shortcut::setKeySequence(const QKeySequence &key)
{
    m_shortcut->setKey(key);
    emit keySequenceChanged();
}

QKeySequence Shortcut::keySequence() const
{
    return m_shortcut->key();
}

void Shortcut::setDefaultText(const QString &text)
{
    m_defaultText = text;
}

QString Shortcut::defaultText() const
{
    return m_defaultText;
}

bool Shortcut::setCurrentContext(const QList<int> &context)
{
    foreach (int ctxt, m_context) {
        if (context.contains(ctxt)) {
            m_shortcut->setEnabled(true);
            return true;
        }
    }
    m_shortcut->setEnabled(false);
    return false;
}

bool Shortcut::isActive() const
{
    return m_shortcut->isEnabled();
}

// ---------- Action ------------

/*!
con's avatar
con committed
345
346
  \class Action
  \internal
con's avatar
con committed
347
*/
con's avatar
con committed
348
349
Action::Action(int id)
    : CommandPrivate(id), m_action(0)
con's avatar
con committed
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
{

}

QString Action::name() const
{
    if (!m_action)
        return QString();

    return m_action->text();
}

void Action::setAction(QAction *action)
{
    m_action = action;
    if (m_action) {
        m_action->setParent(this);
        m_toolTip = m_action->toolTip();
    }
}

QAction *Action::action() const
{
    return m_action;
}

void Action::setLocations(const QList<CommandLocation> &locations)
{
    m_locations = locations;
}

QList<CommandLocation> Action::locations() const
{
    return m_locations;
}

void Action::setDefaultKeySequence(const QKeySequence &key)
{
388
    if (m_action->shortcut().isEmpty())
389
        setKeySequence(key);
con's avatar
con committed
390
    CommandPrivate::setDefaultKeySequence(key);
con's avatar
con committed
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
}

void Action::setKeySequence(const QKeySequence &key)
{
    m_action->setShortcut(key);
    updateToolTipWithKeySequence();
    emit keySequenceChanged();
}

void Action::updateToolTipWithKeySequence()
{
    if (m_action->shortcut().isEmpty())
        m_action->setToolTip(m_toolTip);
    else
        m_action->setToolTip(stringWithAppendedShortcut(m_toolTip));
}

QKeySequence Action::keySequence() const
{
    return m_action->shortcut();
}

// ---------- OverrideableAction ------------

/*!
    \class OverrideableAction
con's avatar
con committed
417
    \internal
con's avatar
con committed
418
419
420
*/

OverrideableAction::OverrideableAction(int id)
con's avatar
con committed
421
    : Action(id), m_currentAction(0), m_active(false),
con's avatar
con committed
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
    m_contextInitialized(false)
{
}

void OverrideableAction::setAction(QAction *action)
{
    Action::setAction(action);
}

bool OverrideableAction::setCurrentContext(const QList<int> &context)
{
    m_context = context;

    QAction *oldAction = m_currentAction;
    m_currentAction = 0;
    for (int i = 0; i < m_context.size(); ++i) {
        if (QAction *a = m_contextActionMap.value(m_context.at(i), 0)) {
            m_currentAction = a;
            break;
        }
    }

    if (m_currentAction == oldAction && m_contextInitialized)
        return true;
    m_contextInitialized = true;

    if (oldAction) {
        disconnect(oldAction, SIGNAL(changed()), this, SLOT(actionChanged()));
        disconnect(m_action, SIGNAL(triggered(bool)), oldAction, SIGNAL(triggered(bool)));
        disconnect(m_action, SIGNAL(toggled(bool)), oldAction, SLOT(setChecked(bool)));
    }
    if (m_currentAction) {
        connect(m_currentAction, SIGNAL(changed()), this, SLOT(actionChanged()));
        // we want to avoid the toggling semantic on slot trigger(), so we just connect the signals
        connect(m_action, SIGNAL(triggered(bool)), m_currentAction, SIGNAL(triggered(bool)));
        // we need to update the checked state, so we connect to setChecked slot, which also fires a toggled signal
        connect(m_action, SIGNAL(toggled(bool)), m_currentAction, SLOT(setChecked(bool)));
        actionChanged();
        m_active = true;
        return true;
    }
    if (hasAttribute(CA_Hide))
        m_action->setVisible(false);
    m_action->setEnabled(false);
    m_active = false;
    return false;
}

void OverrideableAction::addOverrideAction(QAction *action, const QList<int> &context)
{
    if (context.isEmpty()) {
        m_contextActionMap.insert(0, action);
    } else {
        for (int i=0; i<context.size(); ++i) {
            int k = context.at(i);
            if (m_contextActionMap.contains(k))
                qWarning() << QString("addOverrideAction: action already registered for context when registering '%1'").arg(action->text());
            m_contextActionMap.insert(k, action);
        }
    }
}

void OverrideableAction::actionChanged()
{
    if (hasAttribute(CA_UpdateIcon)) {
        m_action->setIcon(m_currentAction->icon());
        m_action->setIconText(m_currentAction->iconText());
    }
    if (hasAttribute(CA_UpdateText)) {
        m_action->setText(m_currentAction->text());
        m_toolTip = m_currentAction->toolTip();
        updateToolTipWithKeySequence();
        m_action->setStatusTip(m_currentAction->statusTip());
        m_action->setWhatsThis(m_currentAction->whatsThis());
    }

con's avatar
con committed
498
    m_action->setCheckable(m_currentAction->isCheckable());
con's avatar
con committed
499
500
501
502
503
504
505
506
507
508
509
510
    bool block = m_action->blockSignals(true);
    m_action->setChecked(m_currentAction->isChecked());
    m_action->blockSignals(block);

    m_action->setEnabled(m_currentAction->isEnabled());
    m_action->setVisible(m_currentAction->isVisible());
}

bool OverrideableAction::isActive() const
{
    return m_active;
}