savedaction.cpp 13.1 KB
Newer Older
1
2
3
4
/**************************************************************************
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
6
**
hjk's avatar
hjk committed
7
** Contact: Nokia Corporation (info@qt.nokia.com)
8
9
10
11
**
**
** GNU Lesser General Public License Usage
**
hjk's avatar
hjk committed
12
13
14
15
16
17
** 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.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21
22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23
24
25
26
27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
con's avatar
con committed
28
** If you have questions regarding the use of this file, please contact
Tobias Hunger's avatar
Tobias Hunger committed
29
** Nokia at info@qt.nokia.com.
30
31
32
33
34
35
36
37
38
39
40
**
**************************************************************************/

#include <utils/savedaction.h>

#include <utils/qtcassert.h>
#include <utils/pathchooser.h>

#include <QtCore/QDebug>
#include <QtCore/QSettings>

41
#include <QtGui/QAbstractButton>
42
43
44
#include <QtGui/QAction>
#include <QtGui/QActionGroup>
#include <QtGui/QCheckBox>
hjk's avatar
hjk committed
45
#include <QtGui/QGroupBox>
46
#include <QtGui/QLineEdit>
47
48
#include <QtGui/QRadioButton>
#include <QtGui/QSpinBox>
hjk's avatar
hjk committed
49
#include <QtGui/QTextEdit>
50

51
using namespace Utils;
52
53
54
55
56
57
58

//////////////////////////////////////////////////////////////////////////
//
// SavedAction
//
//////////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
59
/*!
60
    \class Utils::SavedAction
61

hjk's avatar
hjk committed
62
63
64
65
    \brief The SavedAction class is a helper class for actions with persistent
    state.
*/

66
67
68
69
70
71
72
SavedAction::SavedAction(QObject *parent)
  : QAction(parent)
{
    m_widget = 0;
    connect(this, SIGNAL(triggered(bool)), this, SLOT(actionTriggered(bool)));
}

hjk's avatar
hjk committed
73
74
75
76
77
78

/*!
    Returns the current value of the object.

    \sa setValue()
*/
79
80
81
82
83
QVariant SavedAction::value() const
{
    return m_value;
}

hjk's avatar
hjk committed
84
85
86
87
88
89
90

/*!
    Sets the current value of the object. If the value changed and
    \a doemit is true, the \c valueChanged() signal will be emitted.

    \sa value()
*/
91
92
93
94
95
96
97
98
99
100
101
void SavedAction::setValue(const QVariant &value, bool doemit)
{
    if (value == m_value)
        return;
    m_value = value;
    if (this->isCheckable())
        this->setChecked(m_value.toBool());
    if (doemit)
        emit valueChanged(m_value);
}

hjk's avatar
hjk committed
102
103
104
105
106
107
108

/*!
    Returns the default value to be used when the item does not exist yet
    in the settings.

    \sa setDefaultValue()
*/
109
110
111
112
113
QVariant SavedAction::defaultValue() const
{
    return m_defaultValue;
}

hjk's avatar
hjk committed
114
115
116
117
118
119
120

/*!
    Sets the default value to be used when the item does not exist yet
    in the settings.

    \sa defaultValue()
*/
121
122
123
124
125
void SavedAction::setDefaultValue(const QVariant &value)
{
    m_defaultValue = value;
}

hjk's avatar
hjk committed
126
127
128
129
130
131

/*!
    Returns the key to be used when accessing the settings.

    \sa settingsKey()
*/
132
133
134
135
136
QString SavedAction::settingsKey() const
{
    return m_settingsKey;
}

hjk's avatar
hjk committed
137
138
139
140
141
142

/*!
    Sets the key to be used when accessing the settings.

    \sa settingsKey()
*/
143
144
145
146
147
void SavedAction::setSettingsKey(const QString &key)
{
    m_settingsKey = key;
}

hjk's avatar
hjk committed
148
149
150
151
152
153

/*!
    Sets the key and group to be used when accessing the settings.

    \sa settingsKey()
*/
154
155
156
157
158
159
void SavedAction::setSettingsKey(const QString &group, const QString &key)
{
    m_settingsKey = key;
    m_settingsGroup = group;
}

hjk's avatar
hjk committed
160
161
162
163
164
165

/*!
    Sets the key to be used when accessing the settings.

    \sa settingsKey()
*/
166
167
168
169
170
QString SavedAction::settingsGroup() const
{
    return m_settingsGroup;
}

hjk's avatar
hjk committed
171
172
173
174
175
/*!
    Sets the group to be used when accessing the settings.

    \sa settingsGroup()
*/
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
void SavedAction::setSettingsGroup(const QString &group)
{
    m_settingsGroup = group;
}

QString SavedAction::textPattern() const
{
    return m_textPattern;
}

void SavedAction::setTextPattern(const QString &value)
{
    m_textPattern = value;
}

QString SavedAction::toString() const
{
hjk's avatar
hjk committed
193
194
195
196
    return QLatin1String("value: ") + m_value.toString()
        + QLatin1String("  defaultvalue: ") + m_defaultValue.toString()
        + QLatin1String("  settingskey: ") + m_settingsGroup
        + '/' + m_settingsKey;
197
198
}

hjk's avatar
hjk committed
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
/*!
    \fn QAction *SavedAction::updatedAction(const QString &text)

    Adjust the \c text() of the underlying action.

    This can be used to update the item shortly before e.g. a menu is shown.

    If the item's \c textPattern() is empty the \a text will be used
    verbatim.

    Otherwise, the behaviour depends on \a text: if it is non-empty,
    \c QString(textPattern()).arg(text), otherwise, \c textPattern()
    with the "%1" placeholder removed will be used.

    \sa textPattern(), setTextPattern()
*/
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
QAction *SavedAction::updatedAction(const QString &text0)
{
    QString text = text0;
    bool enabled = true;
    if (!m_textPattern.isEmpty()) {
        if (text.isEmpty()) {
            text = m_textPattern;
            text.remove("\"%1\"");
            text.remove("%1");
            enabled = false;
        } else {
            text = m_textPattern.arg(text0);
        }
    }
    this->setEnabled(enabled);
    this->setData(text0);
    this->setText(text);
    return this;
}

hjk's avatar
hjk committed
235
/*
236
    Uses \c settingsGroup() and \c settingsKey() to restore the
hjk's avatar
hjk committed
237
238
239
240
    item from \a settings,

    \sa settingsKey(), settingsGroup(), writeSettings()
*/
241
void SavedAction::readSettings(const QSettings *settings)
242
243
244
{
    if (m_settingsGroup.isEmpty() || m_settingsKey.isEmpty())
        return;
245
    QVariant var = settings->value(m_settingsGroup + QLatin1Char('/') + m_settingsKey, m_defaultValue);
246
247
248
249
250
251
    // work around old ini files containing @Invalid() entries
    if (isCheckable() && !var.isValid())
        var = false;
    setValue(var);
    //qDebug() << "READING: " << var.isValid() << m_settingsKey << " -> " << m_value
    //    << " (default: " << m_defaultValue << ")" << var;
252
253
}

hjk's avatar
hjk committed
254
/*
255
    Uses \c settingsGroup() and \c settingsKey() to write the
hjk's avatar
hjk committed
256
257
258
259
    item to \a settings,

    \sa settingsKey(), settingsGroup(), readSettings()
*/
260
261
262
263
264
265
266
267
268
void SavedAction::writeSettings(QSettings *settings)
{
    if (m_settingsGroup.isEmpty() || m_settingsKey.isEmpty())
        return;
    settings->beginGroup(m_settingsGroup);
    settings->setValue(m_settingsKey, m_value);
    //qDebug() << "WRITING: " << m_settingsKey << " -> " << toString();
    settings->endGroup();
}
269

hjk's avatar
hjk committed
270
271
272
273
/*
    A \c SavedAction can be connected to a widget, typically a
    checkbox, radiobutton, or a lineedit in some configuration dialog.

274
    The widget will retrieve its contents from the SavedAction's
hjk's avatar
hjk committed
275
276
277
278
279
280
    value, and - depending on the \a ApplyMode - either write
    changes back immediately, or when \s SavedAction::apply()
    is called explicitly.

    \sa apply(), disconnectWidget()
*/
281
282
283
284
285
286
void SavedAction::connectWidget(QWidget *widget, ApplyMode applyMode)
{
    QTC_ASSERT(!m_widget,
        qDebug() << "ALREADY CONNECTED: " << widget << m_widget << toString(); return);
    m_widget = widget;
    m_applyMode = applyMode;
287

288
289
290
291
292
293
294
295
296
    if (QAbstractButton *button = qobject_cast<QAbstractButton *>(widget)) {
        if (button->isCheckable()) {
            button->setChecked(m_value.toBool());
            connect(button, SIGNAL(clicked(bool)),
                this, SLOT(checkableButtonClicked(bool)));
        } else {
            connect(button, SIGNAL(clicked()),
                this, SLOT(uncheckableButtonClicked()));
        }
297
298
    } else if (QSpinBox *spinBox = qobject_cast<QSpinBox *>(widget)) {
        spinBox->setValue(m_value.toInt());
299
        //qDebug() << "SETTING VALUE" << spinBox->value();
300
301
302
303
        connect(spinBox, SIGNAL(valueChanged(int)),
            this, SLOT(spinBoxValueChanged(int)));
        connect(spinBox, SIGNAL(valueChanged(QString)),
            this, SLOT(spinBoxValueChanged(QString)));
304
305
    } else if (QLineEdit *lineEdit = qobject_cast<QLineEdit *>(widget)) {
        lineEdit->setText(m_value.toString());
306
        //qDebug() << "SETTING TEXT" << lineEdit->text();
307
308
309
310
311
312
313
314
        connect(lineEdit, SIGNAL(editingFinished()),
            this, SLOT(lineEditEditingFinished()));
    } else if (PathChooser *pathChooser = qobject_cast<PathChooser *>(widget)) {
        pathChooser->setPath(m_value.toString());
        connect(pathChooser, SIGNAL(editingFinished()),
            this, SLOT(pathChooserEditingFinished()));
        connect(pathChooser, SIGNAL(browsingFinished()),
            this, SLOT(pathChooserEditingFinished()));
315
    } else if (QGroupBox *groupBox = qobject_cast<QGroupBox *>(widget)) {
316
317
318
319
        if (!groupBox->isCheckable())
            qDebug() << "connectWidget to non-checkable group box" << widget << toString();
        groupBox->setChecked(m_value.toBool());
        connect(groupBox, SIGNAL(toggled(bool)), this, SLOT(groupBoxToggled(bool)));
hjk's avatar
hjk committed
320
321
322
    } else if (QTextEdit *textEdit = qobject_cast<QTextEdit *>(widget)) {
        textEdit->setPlainText(m_value.toString());
        connect(textEdit, SIGNAL(textChanged()), this, SLOT(textEditTextChanged()));
323
324
325
326
327
    } else {
        qDebug() << "Cannot connect widget " << widget << toString();
    }
}

hjk's avatar
hjk committed
328
329
330
331
332
/*
    Disconnects the \c SavedAction from a widget.

    \sa apply(), connectWidget()
*/
333
334
335
336
void SavedAction::disconnectWidget()
{
    m_widget = 0;
}
337

338
339
340
341
342
343
void SavedAction::apply(QSettings *s)
{
    if (QAbstractButton *button = qobject_cast<QAbstractButton *>(m_widget))
        setValue(button->isChecked());
    else if (QLineEdit *lineEdit = qobject_cast<QLineEdit *>(m_widget))
        setValue(lineEdit->text());
344
345
    else if (QSpinBox *spinBox = qobject_cast<QSpinBox *>(m_widget))
        setValue(spinBox->value());
346
347
    else if (PathChooser *pathChooser = qobject_cast<PathChooser *>(m_widget))
        setValue(pathChooser->path());
348
    else if (const QGroupBox *groupBox = qobject_cast<QGroupBox *>(m_widget))
349
        setValue(groupBox->isChecked());
hjk's avatar
hjk committed
350
351
    else if (const QTextEdit *textEdit = qobject_cast<QTextEdit *>(m_widget))
        setValue(textEdit->toPlainText());
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
    if (s)
       writeSettings(s);
}

void SavedAction::uncheckableButtonClicked()
{
    QAbstractButton *button = qobject_cast<QAbstractButton *>(sender());
    QTC_ASSERT(button, return);
    //qDebug() << "UNCHECKABLE BUTTON: " << sender();
    QAction::trigger();
}

void SavedAction::checkableButtonClicked(bool)
{
    QAbstractButton *button = qobject_cast<QAbstractButton *>(sender());
    QTC_ASSERT(button, return);
    //qDebug() << "CHECKABLE BUTTON: " << sender();
    if (m_applyMode == ImmediateApply)
        setValue(button->isChecked());
}

void SavedAction::lineEditEditingFinished()
{
    QLineEdit *lineEdit = qobject_cast<QLineEdit *>(sender());
    QTC_ASSERT(lineEdit, return);
    if (m_applyMode == ImmediateApply)
        setValue(lineEdit->text());
}

381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
void SavedAction::spinBoxValueChanged(int value)
{
    QSpinBox *spinBox = qobject_cast<QSpinBox *>(sender());
    QTC_ASSERT(spinBox, return);
    if (m_applyMode == ImmediateApply)
        setValue(value);
}

void SavedAction::spinBoxValueChanged(QString value)
{
    QSpinBox *spinBox = qobject_cast<QSpinBox *>(sender());
    QTC_ASSERT(spinBox, return);
    if (m_applyMode == ImmediateApply)
        setValue(value);
}

397
398
399
400
401
402
403
404
void SavedAction::pathChooserEditingFinished()
{
    PathChooser *pathChooser = qobject_cast<PathChooser *>(sender());
    QTC_ASSERT(pathChooser, return);
    if (m_applyMode == ImmediateApply)
        setValue(pathChooser->path());
}

hjk's avatar
hjk committed
405
406
407
408
409
410
411
412
void SavedAction::textEditTextChanged()
{
    QTextEdit *textEdit = qobject_cast<QTextEdit *>(sender());
    QTC_ASSERT(textEdit, return);
    if (m_applyMode == ImmediateApply)
        setValue(textEdit->toPlainText());
}

413
414
415
416
417
418
void SavedAction::groupBoxToggled(bool checked)
{
    if (m_applyMode == ImmediateApply)
        setValue(QVariant(checked));
}

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
void SavedAction::actionTriggered(bool)
{
    if (isCheckable())
        setValue(isChecked());
    if (actionGroup() && actionGroup()->isExclusive()) {
        // FIXME: should be taken care of more directly
        foreach (QAction *act, actionGroup()->actions())
            if (SavedAction *dact = qobject_cast<SavedAction *>(act))
                dact->setValue(bool(act == this));
    }
}

void SavedAction::trigger(const QVariant &data)
{
    setData(data);
    QAction::trigger();
}

//////////////////////////////////////////////////////////////////////////
//
// SavedActionSet
//
//////////////////////////////////////////////////////////////////////////

void SavedActionSet::insert(SavedAction *action, QWidget *widget)
{
    m_list.append(action);
446
447
    if (widget)
        action->connectWidget(widget);
448
449
450
451
452
453
454
455
456
457
458
459
460
461
}

void SavedActionSet::apply(QSettings *settings)
{
    foreach (SavedAction *action, m_list)
        action->apply(settings);
}

void SavedActionSet::finish()
{
    foreach (SavedAction *action, m_list)
        action->disconnectWidget();
}

462
463
464
465
466
467
468
469
470
471
472
473
474
QString SavedActionSet::searchKeyWords() const
{
    const QChar blank = QLatin1Char(' ');
    QString rc;
    foreach (SavedAction *action, m_list) {
        if (!rc.isEmpty())
            rc += blank;
        rc += action->text();
    }
    rc.remove(QLatin1Char('&'));
    return rc;
}