Designer: Add documentation for new interfaces.

\internal.

3 files changed, 127 insertions, 3 deletions

diff --git a/src/designer/src/lib/sdk/abstractoptionspage.qdoc b/src/designer/src/lib/sdk/abstractoptionspage.qdoc
new file mode 100644
index 000000000..1009cc35f
--- /dev/null
+++ b/src/designer/src/lib/sdk/abstractoptionspage.qdoc
@@ -0,0 +1,80 @@
+/****************************************************************************
+**
+** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** 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 Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of this
+** file.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \class QDesignerOptionsPageInterface
+
+    \brief The QDesignerOptionsPageInterface provides an interface for integrating \QD's
+           options pages into IDE option dialogs.
+
+    Plugin-based IDE's typically have options dialogs for which the plugins can provide
+    widgets to be shown for example in a tab-widget. The widgets are created on
+    demand when the user activates a page.
+
+    In order to do this for \QD, a list of QDesignerOptionsPageInterface objects
+    can be obtained from QDesignerFormEditorInterface and registered with the option
+    dialog. When the respective tab is activated, createPage() is invoked to
+    create the widget. To apply the modified settings, apply() is called.
+    finish() is called when the dialog closes.
+
+    \sa QDesignerFormEditorInterface::optionsPages(), QDesignerFormEditorInterface::setOptionsPages()
+
+    \internal
+    \inmodule QtDesigner
+    \since 5.0
+*/
+
+/*!
+    \fn QDesignerOptionsPageInterface::~QDesignerOptionsPageInterface()
+
+    Destroys the QDesignerOptionsPageInterface object.
+*/
+
+/*!
+    \fn QString QDesignerOptionsPageInterface::name() const
+
+    Returns the name of the page, which can for example be used as a tab title.
+*/
+
+/*!
+    \fn QWidget *QDesignerOptionsPageInterface::createPage(QWidget *parent)
+
+    Creates the widget of the page parented on \a parent.
+*/
+
+/*!
+    \fn QDesignerOptionsPageInterface::apply()
+
+    This function should be called when the user clicks \gui{OK} or \gui{Apply} to
+    apply the modified settings.
+*/
+
+/*!
+    \fn QDesignerOptionsPageInterface::finish()
+
+    This function should be called when the option dialog is closed.
+*/
diff --git a/src/designer/src/lib/sdk/abstractsettings.h b/src/designer/src/lib/sdk/abstractsettings.h
index 652be5fd7..c3784d05a 100644
--- a/src/designer/src/lib/sdk/abstractsettings.h
+++ b/src/designer/src/lib/sdk/abstractsettings.h
@@ -52,9 +52,6 @@ QT_BEGIN_NAMESPACE
 
 class QString;
 
-/*!
- To be implemented by IDEs that want to control the way designer retrieves/stores its settings.
- */
 class QDESIGNER_SDK_EXPORT QDesignerSettingsInterface
 {
 public:
diff --git a/src/designer/src/lib/sdk/abstractsettings.qdoc b/src/designer/src/lib/sdk/abstractsettings.qdoc
new file mode 100644
index 000000000..6b0089d79
--- /dev/null
+++ b/src/designer/src/lib/sdk/abstractsettings.qdoc
@@ -0,0 +1,47 @@
+/****************************************************************************
+**
+** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** 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 Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of this
+** file.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \class QDesignerSettingsInterface
+
+    \brief The QDesignerSettingsInterface provides an abstraction of QSettings to be used in \QD.
+
+    \QD uses the QDesignerSettingsInterface to save and retrieve its settings.
+    The default implementation in \QD is based on QSettings, using a file in .ini-format.
+    IDE integrations can provide their own implementations that for
+    example store the settings in a database instead of a file.
+
+    The virtual functions are equivalent to the functions of the same name in the
+    QSettings class.
+
+    \sa QDesignerFormEditorInterface::setSettingsManager(), QDesignerFormEditorInterface::settingsManager()
+    \sa QSettings
+
+    \internal
+    \inmodule QtDesigner
+    \since 5.0
+*/