TDEInstance Class Reference

#include <kinstance.h>

Inheritance diagram for TDEInstance:

Public Member Functions
	TDEInstance (const TQCString &instanceName)
	TDEInstance (const TDEAboutData *aboutData)
	TDEInstance (TDEInstance *src)
virtual	~TDEInstance ()
TDEStandardDirs *	dirs () const
TDEConfig *	config () const
TDESharedConfig *	sharedConfig () const
void	setConfigReadOnly (bool ro)
TDEIconLoader *	iconLoader () const
void	newIconLoader () const
const TDEAboutData *	aboutData () const
TQCString	instanceName () const
KMimeSourceFactory *	mimeSourceFactory () const

Protected Member Functions
	TDEInstance (const TDEInstance &)
void	setConfigName (const TQString &name)
virtual void	virtual_hook (int id, void *data)

Friends
class	TDEStandardDirs

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 TDEGlobal.

Author

Torben Weis

Definition at line 47 of file kinstance.h.

Constructor & Destructor Documentation

TDEInstance() [1/3]

TDEInstance::TDEInstance

(

const TQCString &

instanceName

)

Constructor.

Parameters

instanceName

the name of the instance

Definition at line 75 of file kinstance.cpp.

TDEInstance() [2/3]

TDEInstance::TDEInstance

(

const TDEAboutData *

aboutData

)

Constructor.

When building a TDEInstance that is not your TDEApplication, make sure that the TDEAboutData and the TDEInstance have the same life time. You have to destroy both, since the instance doesn't own the about data. Don't build a TDEAboutData on the stack in this case ! Building a TDEAboutData on the stack is only ok for usage with TDECmdLineArgs and TDEApplication (not destroyed until the app exits).

Parameters

aboutData

data about this instance (see TDEAboutData)

Definition at line 97 of file kinstance.cpp.

~TDEInstance()

TDEInstance::~TDEInstance ( )

virtual

Destructor.

Definition at line 154 of file kinstance.cpp.

TDEInstance() [3/3]

TDEInstance::TDEInstance ( const TDEInstance &  )

protected

Copy Constructor is not allowed.

Member Function Documentation

aboutData()

const TDEAboutData * TDEInstance::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 336 of file kinstance.cpp.

config()

TDEConfig * TDEInstance::config

(

)

const

Returns the general config object ("appnamerc").

Returns

the TDEConfig object for the instance.

Definition at line 212 of file kinstance.cpp.

dirs()

TDEStandardDirs * TDEInstance::dirs

(

)

const

Returns the application standard dirs object.

Returns

The TDEStandardDirs of the application.

Definition at line 189 of file kinstance.cpp.

iconLoader()

TDEIconLoader * TDEInstance::iconLoader

(

)

const

Returns an iconloader object.

Returns

the iconloader object.

Definition at line 276 of file kinstance.cpp.

instanceName()

TQCString TDEInstance::instanceName

(

)

const

Returns the name of the instance.

Returns

the instance name, can be null if the TDEInstance has been created with a null name

Definition at line 342 of file kinstance.cpp.

mimeSourceFactory()

KMimeSourceFactory * TDEInstance::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 348 of file kinstance.cpp.

newIconLoader()

void TDEInstance::newIconLoader

(

)

const

Re-allocate the global iconloader.

Definition at line 329 of file kinstance.cpp.

setConfigName()

void TDEInstance::setConfigName ( const TQString &  name )

protected

Set name of default config file.

Parameters

name	the name of the default config file

Since

3.1

Definition at line 270 of file kinstance.cpp.

setConfigReadOnly()

void TDEInstance::setConfigReadOnly

(

bool

ro

)

Set a read-only flag on the configuration files This must be called before config() or dirs() to have any effect Defaults to FALSE.

Parameters

ro	read only if TRUE

Definition at line 207 of file kinstance.cpp.

sharedConfig()

TDESharedConfig * TDEInstance::sharedConfig

(

)

const

Returns the general config object ("appnamerc").

Returns

the TDEConfig object for the instance.

Definition at line 261 of file kinstance.cpp.

---

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

• kinstance.h
• kinstance.cpp