statesavingobject.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digikam project
 * https://www.digikam.org
 *
 * Date        : 2009-20-12
 * Description : Interface class for objects that can store their state.
 *
 * Copyright (C) 2009 by Johannes Wienke <languitar at semipol dot de>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_STATE_SAVING_OBJECT_H
#define DIGIKAM_STATE_SAVING_OBJECT_H
 
// Qt includes
 
#include <QObject>
 
// Local includes
 
#include "digikam_export.h"
 
class KConfigGroup;
 
namespace Digikam
{
 
class DIGIKAM_EXPORT StateSavingObject
{
public:
 
    enum StateSavingDepth
    {
        INSTANCE,
 
        DIRECT_CHILDREN,
 
        RECURSIVE
    };
 
    explicit StateSavingObject(QObject* const host);
 
    virtual ~StateSavingObject();
 
    StateSavingDepth getStateSavingDepth()  const;
 
    void setStateSavingDepth(const StateSavingDepth depth);
 
    virtual void setConfigGroup(const KConfigGroup& group);
 
    virtual void setEntryPrefix(const QString& prefix);
 
    void loadState();
 
    void saveState();
 
protected:
 
    virtual void doLoadState() = 0;
 
    virtual void doSaveState() = 0;
 
    KConfigGroup getConfigGroup()           const;
 
    QString entryName(const QString& base)  const;
 
private:
 
    // Disable
    StateSavingObject(const StateSavingObject&)            = delete;
    StateSavingObject& operator=(const StateSavingObject&) = delete;
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_STATE_SAVING_OBJECT_H