ioptionspage.cpp 4.39 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
3
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
con's avatar
con committed
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
con's avatar
con committed
7
**
hjk's avatar
hjk committed
8 9 10 11 12 13 14
** 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 Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
con's avatar
con committed
15 16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22 23 24 25
** 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, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
con's avatar
con committed
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
con's avatar
con committed
29 30 31

#include "ioptionspage.h"

32 33 34 35 36
#include <QCheckBox>
#include <QGroupBox>
#include <QLabel>
#include <QPushButton>

con's avatar
con committed
37 38 39
/*!
  \class Core::IOptionsPage
  \mainclass
40 41
  \brief The IOptionsPage class is an interface for providing pages for the
  \gui Options dialog (called \gui Preferences on Mac OS).
con's avatar
con committed
42

43 44
  You need to subclass this interface and put an instance of your subclass
  into the plugin manager object pool (e.g. ExtensionSystem::PluginManager::addObject).
con's avatar
con committed
45 46
  Guidelines for implementing:
  \list
Leena Miettinen's avatar
Leena Miettinen committed
47 48 49 50
  \li \c id() is a unique identifier for referencing this page
  \li \c displayName() is the (translated) name for display
  \li \c category() is the unique id for the category that the page should be displayed in
  \li \c displayCategory() is the translated name of the category
51 52 53 54
  \li \c widget() is called to retrieve the widget to show in the
        \gui Options dialog. You should create a widget lazily here, and delete it again in the
        finish() method. This method can be called multiple times, so you should only create a new
        widget if the old one was deleted.
Leena Miettinen's avatar
Leena Miettinen committed
55
  \li \c apply() is called to store the settings. It should detect if any changes have been
56
         made and store those
57 58 59 60 61 62
  \li \c finish() is called directly before the \gui Options dialog closes. Here you should delete
         the widget that was created in widget() to free resources.
  \li \c matches() is used for the \gui Options dialog search filter. The default implementation
         takes the widget() and searches for all labels, buttons, checkboxes and group boxes,
         and matches on their texts/titles. You can implement your own matching algorithm, but
         usually the default implementation will work fine.
con's avatar
con committed
63 64
  \endlist
*/
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


Core::IOptionsPage::IOptionsPage(QObject *parent)
    : QObject(parent),
      m_keywordsInitialized(false)
{

}

Core::IOptionsPage::~IOptionsPage()
{
}

bool Core::IOptionsPage::matches(const QString &searchKeyWord) const
{
    if (!m_keywordsInitialized) {
        IOptionsPage *that = const_cast<IOptionsPage *>(this);
        QWidget *widget = that->widget();
        if (!widget)
            return false;
        // find common subwidgets
        foreach (const QLabel *label, widget->findChildren<QLabel *>())
            m_keywords << label->text();
        foreach (const QCheckBox *checkbox, widget->findChildren<QCheckBox *>())
            m_keywords << checkbox->text();
        foreach (const QPushButton *pushButton, widget->findChildren<QPushButton *>())
            m_keywords << pushButton->text();
        foreach (const QGroupBox *groupBox, widget->findChildren<QGroupBox *>())
            m_keywords << groupBox->title();

        // clean up accelerators
        QMutableStringListIterator it(m_keywords);
        while (it.hasNext())
            it.next().remove(QLatin1Char('&'));
        m_keywordsInitialized = true;
    }
    foreach (const QString &keyword, m_keywords)
        if (keyword.contains(searchKeyWord, Qt::CaseInsensitive))
            return true;
    return false;
}