#include <kis_bookmarked_configuration_manager.h>

Inheritance diagram for KisBookmarkedConfigurationManager:

Public Member Functions
QList< QString >	configurations () const

KisSerializableConfigurationSP	defaultConfiguration () const

bool	exists (const QString &configname) const

	KisBookmarkedConfigurationManager (const QString &configEntryGroup, KisSerializableConfigurationFactory *)

KisSerializableConfigurationSP	load (const QString &configname) const

void	remove (const QString &name)

void	save (const QString &configname, const KisSerializableConfigurationSP)

QString	uniqueName (const KLocalizedString &base)

	~KisBookmarkedConfigurationManager ()

Public Member Functions inherited from Private
	Private (KisCanvas2 *c)

Public Attributes
QString	configEntryGroup

KisSerializableConfigurationFactory *	configFactory

Public Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Static Public Attributes
static const char	ConfigDefault [] = "Default"

static const char	ConfigLastUsed [] = "Last Used"

Private Member Functions
QString	configEntryGroup () const

Private Attributes
Private *const	d

Detailed Description

Definition at line 27 of file kis_bookmarked_configuration_manager.cc.

Constructor & Destructor Documentation

◆ KisBookmarkedConfigurationManager()

KisBookmarkedConfigurationManager::KisBookmarkedConfigurationManager	(	const QString &	configEntryGroup,
		KisSerializableConfigurationFactory *	configFactory )

Parameters

configEntryGroup name of the configuration entry with the bookmarked configurations.

Definition at line 34 of file kis_bookmarked_configuration_manager.cc.

    : d(new Private)
{
    d->configEntryGroup = configEntryGroup;
    d->configFactory = configFactory;
}

References configEntryGroup, configFactory, and d.

◆ ~KisBookmarkedConfigurationManager()

KisBookmarkedConfigurationManager::~KisBookmarkedConfigurationManager ( )

Definition at line 41 of file kis_bookmarked_configuration_manager.cc.

{
    delete d->configFactory;
    delete d;
}

References d.

Member Function Documentation

◆ configEntryGroup()

QString KisBookmarkedConfigurationManager::configEntryGroup ( ) const

private

◆ configurations()

QList< QString > KisBookmarkedConfigurationManager::configurations ( ) const

Returns: the list of the names of configurations.

Definition at line 80 of file kis_bookmarked_configuration_manager.cc.

{
    KSharedConfig::Ptr cfg =  KSharedConfig::openConfig();
    QMap< QString, QString > m = cfg->entryMap(configEntryGroup());
    QList<QString> keys = m.keys();
    QList<QString> configsKey;
    Q_FOREACH (const QString & key, keys) {
        if (key != KisBookmarkedConfigurationManager::ConfigDefault && key != KisBookmarkedConfigurationManager::ConfigLastUsed) {
            configsKey << key;
        }
    }
    return configsKey;
}

References ConfigDefault, configEntryGroup, and ConfigLastUsed.

◆ defaultConfiguration()

KisSerializableConfigurationSP KisBookmarkedConfigurationManager::defaultConfiguration ( ) const

Returns: the default configuration

Definition at line 94 of file kis_bookmarked_configuration_manager.cc.

{
    if (exists(KisBookmarkedConfigurationManager::ConfigDefault)) {
        return load(KisBookmarkedConfigurationManager::ConfigDefault);
    }
    if (exists(KisBookmarkedConfigurationManager::ConfigLastUsed)) {
        return load(KisBookmarkedConfigurationManager::ConfigLastUsed);
    }
    return 0;
}

References ConfigDefault, ConfigLastUsed, exists(), and load().

◆ exists()

bool KisBookmarkedConfigurationManager::exists ( const QString & configname ) const

Returns: true if the configuration configname exists

Definition at line 73 of file kis_bookmarked_configuration_manager.cc.

{
    KSharedConfig::Ptr cfg =  KSharedConfig::openConfig();
    QMap< QString, QString > m = cfg->entryMap(configEntryGroup());
    return (m.find(configname) != m.end());
}

References configEntryGroup.

◆ load()

KisSerializableConfigurationSP KisBookmarkedConfigurationManager::load ( const QString & configname ) const

Load the configuration.

Definition at line 47 of file kis_bookmarked_configuration_manager.cc.

{
    if (!exists(configname)) {
        if (configname == KisBookmarkedConfigurationManager::ConfigDefault)
            return d->configFactory->createDefault();
        else
            return 0;
    }
    KConfigGroup cfg =  KSharedConfig::openConfig()->group(configEntryGroup());
 
    QDomDocument doc;
    doc.setContent(cfg.readEntry<QString>(configname, ""));
    QDomElement e = doc.documentElement();
    KisSerializableConfigurationSP config = d->configFactory->create(e);
    dbgImage << config << Qt::endl;
    return config;
}

References ConfigDefault, configEntryGroup, d, dbgImage, and exists().

◆ remove()

void KisBookmarkedConfigurationManager::remove ( const QString & name )

Remove a bookmarked configuration

Definition at line 110 of file kis_bookmarked_configuration_manager.cc.

{
    KSharedConfig::Ptr cfg =  KSharedConfig::openConfig();
    KConfigGroup group = cfg->group(configEntryGroup());
    group.deleteEntry(name);
}

References configEntryGroup.

◆ save()

void KisBookmarkedConfigurationManager::save	(	const QString &	configname,
		const KisSerializableConfigurationSP	config )

Save the configuration.

Definition at line 65 of file kis_bookmarked_configuration_manager.cc.

{
    dbgImage << "Saving configuration " << config << " to " << configname;
    if (!config) return;
    KConfigGroup cfg =  KSharedConfig::openConfig()->group(configEntryGroup());
    cfg.writeEntry(configname, config->toXML());
}

References configEntryGroup, dbgImage, and KisSerializableConfiguration::toXML().

◆ uniqueName()

QString KisBookmarkedConfigurationManager::uniqueName ( const KLocalizedString & base )

Generate an unique name, for instance when the user is creating a new entry.

Parameters

base	the base of the new name, including a "%1" for incrementing the number, for instance : "New Configuration %1", then this function will return the string where %1 will be replaced by the lowest number and be nonexistent in the lists of configuration

Definition at line 117 of file kis_bookmarked_configuration_manager.cc.

{
#ifndef QT_NO_DEBUG
    QString prev;
#endif
    int nb = 1;
    while (true) {
        QString cur = base.subs(nb++).toString();
        if (!exists(cur)) return cur;
#ifndef QT_NO_DEBUG
        Q_ASSERT(prev != cur);
        prev = cur;
#endif
    }
}