KPluginName

#include <kpluginloader.h>

Public Member Functions

 KPluginName (const QString &name)
 
QString errorString () const
 
bool isValid () const
 
QString name () const
 

Static Public Member Functions

static KPluginName fromErrorString (const QString &errorString)
 

Detailed Description

Represents the name of a plugin intended for KPluginLoader.

This exists only so that classes such as KService can provide a cast operator to allow them to be used as arguments to KPluginLoader. Unless you are implementing such a cast operator, you should never need to use this class directly.

Definition at line 384 of file kpluginloader.h.

Constructor & Destructor Documentation

KPluginName::KPluginName ( const QString name)
inlineexplicit

Construct a (valid) plugin name from a string.

If there was an error and the name could not be determined, fromErrorString() should be used instead to construct an appropriate error message.

Parameters
nameThe name of the plugin; this should not be empty.

Definition at line 442 of file kpluginloader.h.

Member Function Documentation

QString KPluginName::errorString ( ) const
inline

The error string if no name could be determined.

Returns
The string passed to fromErrorString() if isValid() is false, QString() otherwise.

Definition at line 456 of file kpluginloader.h.

KPluginName KPluginName::fromErrorString ( const QString errorString)
inlinestatic

Construct an invalid plugin name with an error message.

When this object is passed to KPluginLoader, errorString will be used for KPluginLoader::errorString().

Parameters
errorStringThe (translated) error string.

Definition at line 460 of file kpluginloader.h.

bool KPluginName::isValid ( ) const
inline

Whether the name is valid.

Note that this only determines how the KPluginName was constructed, not anything about the value of the string.

Returns
true if the KPluginName(const QString&) constructor was used, false if fromErrorString() was used.

Definition at line 452 of file kpluginloader.h.

QString KPluginName::name ( ) const
inline

The name of the plugin.

Returns
The string passed to the constructor if isValid() is true, QString() otherwise.

Definition at line 448 of file kpluginloader.h.


The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed May 27 2020 23:06:03 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.