qsettingslayout.h

#ifndef QSETTINGSLAYOUT_H
#define QSETTINGSLAYOUT_H

#include "qsettingsdialog_global.h"
#include "exceptions.h"
#include <QObject>
#include <QList>
#include <QIcon>
#include <QSharedPointer>
class QSettingsDialog;
class QSettingsContainer;

class QSettingsLayoutPrivate;
class QSETTINGSDIALOGSHARED_EXPORT QSettingsLayout
{
    friend class SettingsEntryLayout;
    friend class SettingsGroupLayout;
    friend class SettingsSectionLayout;
    friend class SettingsCategoryLayout;
    friend class SettingsRootLayout;

public:
    enum LayoutType {
        DialogLayout, 
        CategoryLayout, 
        SectionLayout, 
        GroupLayout, 
        EntryLayout 
    };

    explicit QSettingsLayout(QSettingsDialog *settingsDialog, bool fromCurrentContainer = false);
    explicit QSettingsLayout(QSettingsDialog *settingsDialog, const QString &containerPath, int entryId = -1);
    explicit QSettingsLayout(QSettingsContainer *container);

    QString id() const;
    LayoutType layoutType() const;
    bool isNull() const;

    QSettingsDialog *dialog() const;
    QString containerPath() const;

    QSettingsLayout parentContainer() const;

    int displayId() const;
    void setDisplayId(int displayId);
    QString name() const;
    void setName(const QString &name);
    QIcon icon() const;
    void setIcon(const QIcon &icon);
    QString tooltip() const;
    void setTooltip(const QString &tooltip);
    bool isOptional() const;
    void setOptional(bool optional);

    QSettingsLayout defaultElement(bool allowCreateNew = false) const;
    bool removeDefaultElement();

    int elementCount() const;
    QSettingsLayout elementAt(int index) const;
    int indexOfElement(const QSettingsLayout &element) const;
    int indexOfElement(const QString &elementName) const;
    QSettingsLayout createElement(int index,
                                  const QString &id,
                                  const QString &name = QString(),
                                  const QIcon &icon = QIcon(),
                                  const QString &tooltip = QString());  
    QSettingsLayout createGroupElement(int index,
                                       const QString &id,
                                       int displayId = 0,
                                       const QString &name = QString(),
                                       bool optional = false,
                                       const QString &tooltip = QString());
    void removeElement(int index);
    void moveElement(int indexFrom, int indexTo);

    void transferElement(int indexFrom, QSettingsLayout targetLayout, int indexTo);

private:
    QSharedPointer<QSettingsLayoutPrivate> d_ptr;

    QSettingsLayout(QSettingsLayoutPrivate *d_ptr);
};

#endif // QSETTINGSLAYOUT_H