ioptionspage.cpp 2.54 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
3
** Copyright (C) 2013 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 32 33 34

#include "ioptionspage.h"

/*!
  \class Core::IOptionsPage
  \mainclass
35 36
  \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
37

38 39
  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
40 41
  Guidelines for implementing:
  \list
Leena Miettinen's avatar
Leena Miettinen committed
42 43 44 45 46 47
  \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
  \li \c createPage() is called to retrieve the widget to show in the
        \gui Options dialog
48
     The widget will be destroyed by the widget hierarchy when the dialog closes
Leena Miettinen's avatar
Leena Miettinen committed
49
  \li \c apply() is called to store the settings. It should detect if any changes have been
50
         made and store those
Leena Miettinen's avatar
Leena Miettinen committed
51 52
  \li \c finish() is called directly before the \gui Options dialog closes
  \li \c matches() is used for the \gui Options dialog search filter
con's avatar
con committed
53 54
  \endlist
*/