KInstance Class Reference
#include <kinstance.h>
Inheritance diagram for KInstance:

Detailed Description
Access to KDE global objects for use in shared libraries.In practical terms, this class is used in KDE components. This allows components to store things that normally would be accessed by KGlobal.
- Author:
- Torben Weis
Definition at line 43 of file kinstance.h.
Public Member Functions | |
KInstance (const QCString &instanceName) | |
KInstance (const KAboutData *aboutData) | |
KInstance (KInstance *src) | |
virtual | ~KInstance () |
KStandardDirs * | dirs () const |
KConfig * | config () const |
KSharedConfig * | sharedConfig () const |
KIconLoader * | iconLoader () const |
void | newIconLoader () const |
const KAboutData * | aboutData () const |
QCString | instanceName () const |
KMimeSourceFactory * | mimeSourceFactory () const |
Protected Member Functions | |
KInstance (const KInstance &) | |
void | setConfigName (const QString &name) |
virtual void | virtual_hook (int id, void *data) |
Friends | |
class | KStandardDirs |
Constructor & Destructor Documentation
KInstance::KInstance | ( | const QCString & | instanceName | ) |
Constructor.
- Parameters:
-
instanceName the name of the instance
Definition at line 69 of file kinstance.cpp.
KInstance::KInstance | ( | const KAboutData * | aboutData | ) |
Constructor.
When building a KInstance that is not your KApplication, make sure that the KAboutData and the KInstance have the same life time. You have to destroy both, since the instance doesn't own the about data. Don't build a KAboutData on the stack in this case ! Building a KAboutData on the stack is only ok for usage with KCmdLineArgs and KApplication (not destroyed until the app exits).
- Parameters:
-
aboutData data about this instance (see KAboutData)
Definition at line 87 of file kinstance.cpp.
KInstance::~KInstance | ( | ) | [virtual] |
KInstance::KInstance | ( | const KInstance & | ) | [protected] |
Copy Constructor is not allowed.
Member Function Documentation
const KAboutData * KInstance::aboutData | ( | ) | const |
Returns the about data of this instance Warning, can be 0L.
- Returns:
- the about data of the instance, or 0 if it has not been set yet
Definition at line 255 of file kinstance.cpp.
KConfig * KInstance::config | ( | ) | const |
Returns the general config object ("appnamerc").
- Returns:
- the KConfig object for the instance.
Definition at line 175 of file kinstance.cpp.
KStandardDirs * KInstance::dirs | ( | ) | const |
Returns the application standard dirs object.
- Returns:
- The KStandardDirs of the application.
Definition at line 159 of file kinstance.cpp.
KIconLoader * KInstance::iconLoader | ( | ) | const |
Returns an iconloader object.
- Returns:
- the iconloader object.
Definition at line 237 of file kinstance.cpp.
QCString KInstance::instanceName | ( | ) | const |
Returns the name of the instance.
- Returns:
- the instance name, can be null if the KInstance has been created with a null name
Definition at line 261 of file kinstance.cpp.
KMimeSourceFactory * KInstance::mimeSourceFactory | ( | ) | const |
Returns the KMimeSourceFactory of the instance.
Mainly added for API completeness and future extensibility.
- Returns:
- the KMimeSourceFactory set as default for this application.
Definition at line 267 of file kinstance.cpp.
void KInstance::newIconLoader | ( | ) | const |
void KInstance::setConfigName | ( | const QString & | name | ) | [protected] |
Set name of default config file.
- Parameters:
-
name the name of the default config file
- Since:
- 3.1
Definition at line 231 of file kinstance.cpp.
KSharedConfig * KInstance::sharedConfig | ( | ) | const |
Returns the general config object ("appnamerc").
- Returns:
- the KConfig object for the instance.
Definition at line 222 of file kinstance.cpp.
The documentation for this class was generated from the following files: