KoDockRegistry Class Reference

#include <KoDockRegistry.h>

Inheritance diagram for KoDockRegistry:

Public Member Functions
	KoDockRegistry ()
QList< KoDockFactoryBase * >	sortedDockWidgetFactories ()
	~KoDockRegistry () override
Public Member Functions inherited from KoGenericRegistry< KoDockFactoryBase * >
void	add (const QString &id, KoDockFactoryBase * item)
void	add (KoDockFactoryBase * item)
void	addAlias (const QString &alias, const QString &id)
QHash< QString, KoDockFactoryBase * >::const_iterator	constBegin () const
QHash< QString, KoDockFactoryBase * >::const_iterator	constEnd () const
bool	contains (const QString &id) const
int	count () const
QList< KoDockFactoryBase * >	doubleEntries () const
KoDockFactoryBase *	get (const QString &id) const
QList< QString >	keys () const
	KoGenericRegistry ()
void	remove (const QString &id)
void	removeAlias (const QString &alias)
const KoDockFactoryBase *	value (const QString &id) const
QList< KoDockFactoryBase * >	values () const
virtual	~KoGenericRegistry ()

Static Public Member Functions
static KoDockRegistry *	instance ()

Private Member Functions
void	init ()
	KoDockRegistry (const KoDockRegistry &)
KoDockRegistry	operator= (const KoDockRegistry &)

Private Attributes
Private *const	d

Detailed Description

This singleton class keeps a register of all available dockers, or rather, of the factories that can create the QDockWidget instances for the mainwindows. Note that adding your KoDockFactoryBase to this registry will mean it will automatically be added to an application, no extra code is required for that.

See also

KoCanvasObserverBase

Definition at line 25 of file KoDockRegistry.h.

Constructor & Destructor Documentation

KoDockRegistry() [1/2]

KoDockRegistry::KoDockRegistry

(

)

Definition at line 38 of file KoDockRegistry.cpp.

    : d(0)
{
}

~KoDockRegistry()

KoDockRegistry::~KoDockRegistry ( )

override

Definition at line 52 of file KoDockRegistry.cpp.

{
    Q_FOREACH(const KoDockFactoryBase *a, values()) {
        delete a;
    }
}

References KoGenericRegistry< KoDockFactoryBase * >::values().

KoDockRegistry() [2/2]

KoDockRegistry::KoDockRegistry ( const KoDockRegistry & )

private

Member Function Documentation

init()

void KoDockRegistry::init ( )

private

Definition at line 43 of file KoDockRegistry.cpp.

{
    KoPluginLoader::PluginsConfig config;
    config.blacklist = "DockerPluginsDisabled";
    config.group = "krita";
    KoPluginLoader::instance()->load(QString::fromLatin1("Krita/Dock"),
                                     config);
}

References KoPluginLoader::PluginsConfig::blacklist, KoPluginLoader::PluginsConfig::group, KoPluginLoader::instance(), and KoPluginLoader::load().

instance()

KoDockRegistry * KoDockRegistry::instance ( )

static

Return an instance of the KoDockRegistry Create a new instance on first call and return the singleton.

Definition at line 77 of file KoDockRegistry.cpp.

{
 
    if (!s_instance.exists()) {
        s_instance->init();
    }
    return s_instance;
}

References init().

operator=()

KoDockRegistry KoDockRegistry::operator= ( const KoDockRegistry & )

private

sortedDockWidgetFactories()

QList< KoDockFactoryBase * > KoDockRegistry::sortedDockWidgetFactories

(

)

Returns the registered docks in a predictable order: first sorted by priority, then sorted case-insensitively by their id.

Definition at line 59 of file KoDockRegistry.cpp.

{
    QList<SortableDockFactoryBase> sortables;
    sortables.reserve(count());
    for (const QString &id : keys()) {
        KoDockFactoryBase *factory = value(id);
        sortables.append({id, factory, factory->priority()});
    }
    std::sort(sortables.begin(), sortables.end());
 
    QList<KoDockFactoryBase *> factories;
    factories.reserve(sortables.size());
    for (const SortableDockFactoryBase &s : sortables) {
        factories.append(s.factory);
    }
    return factories;
}

References KoGenericRegistry< KoDockFactoryBase * >::count(), KoGenericRegistry< KoDockFactoryBase * >::keys(), KoDockFactoryBase::priority(), and KoGenericRegistry< KoDockFactoryBase * >::value().

Member Data Documentation

d

Private* const KoDockRegistry::d

private

Definition at line 50 of file KoDockRegistry.h.

---

The documentation for this class was generated from the following files:

• libs/flake/KoDockRegistry.h
• libs/flake/KoDockRegistry.cpp