.TH "KInstance" 3 "28 Jan 2004" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KInstance \- Access to \fBKDE\fP global objects for use in shared libraries.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kinstance.h>\fP
.PP
Inherited by \fBKApplication\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKInstance\fP (const  \fBQCString\fP &instanceName)"
.br
.RI "\fIConstructor. \fP"
.ti -1c
.RI "\fBKInstance\fP (const  \fBKAboutData\fP *aboutData)"
.br
.RI "\fIConstructor. \fP"
.ti -1c
.RI "\fBKInstance\fP (\fBKInstance\fP *src)"
.br
.ti -1c
.RI "virtual \fB~KInstance\fP ()"
.br
.RI "\fIDestructor. \fP"
.ti -1c
.RI "\fBKStandardDirs\fP * \fBdirs\fP () const "
.br
.RI "\fIReturns the application standard dirs object. \fP"
.ti -1c
.RI "\fBKConfig\fP * \fBconfig\fP () const "
.br
.RI "\fIReturns the general config object ('appnamerc'). \fP"
.ti -1c
.RI "\fBKIconLoader\fP * \fBiconLoader\fP () const "
.br
.RI "\fIReturns an iconloader object. \fP"
.ti -1c
.RI "void \fBnewIconLoader\fP () const "
.br
.RI "\fIRe-allocate the global iconloader. \fP"
.ti -1c
.RI "\fBKCharsets\fP * \fBcharsets\fP () const "
.br
.ti -1c
.RI "const  \fBKAboutData\fP * \fBaboutData\fP () const "
.br
.RI "\fIReturns the about data of this instance Warning, can be 0L. \fP"
.ti -1c
.RI "\fBQCString\fP \fBinstanceName\fP () const "
.br
.RI "\fIReturns the name of the instance. \fP"
.ti -1c
.RI "\fBKMimeSourceFactory\fP * \fBmimeSourceFactory\fP () const "
.br
.RI "\fIReturns the \fBKMimeSourceFactory\fP of the instance. \fP"
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBKInstance\fP (const  \fBKInstance\fP &)"
.br
.RI "\fICopy Constructor is not allowed. \fP"
.ti -1c
.RI "void \fBsetConfigName\fP (const  \fBQString\fP &name)"
.br
.RI "\fISet name of default config file. \fP"
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBKStandardDirs\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Access to \fBKDE\fP global objects for use in shared libraries. 

In practical terms, this class is used in \fBKDE\fP components. This allows components to store things that normally would be accessed by \fBKGlobal\fP.
.PP
\fBAuthor:\fP
.RS 4
Torben Weis 
.RE
.PP
\fBVersion:\fP
.RS 4
\fBId\fP.RS 4
\fBkinstance.h\fP,v 1.26 2002/09/28 12:28:47 tjansen Exp 
.RE
.PP
.RE
.PP

.PP
Definition at line 42 of file kinstance.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KInstance::KInstance (const \fBQCString\fP & instanceName)"
.PP
Constructor. \fBParameters:\fP
.RS 4
\fIinstanceName\fP the name of the instance 
.RE
.PP
Definition at line 50 of file kinstance.cpp.
.PP
References KStdAction::name(), and KGlobal::setActiveInstance().
.SS "KInstance::KInstance (const \fBKAboutData\fP * aboutData)"
.PP
Constructor. When building a KInstance that is not your \fBKApplication\fP, make sure that the \fBKAboutData\fP 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 \fBKAboutData\fP on the stack in this case ! Building a \fBKAboutData\fP on the stack is only ok for usage with \fBKCmdLineArgs\fP and \fBKApplication\fP (not destroyed until the app exits). 
.PP
\fBParameters:\fP
.RS 4
\fIaboutData\fP data about this instance (see \fBKAboutData\fP) 
.RE
.PP
Definition at line 67 of file kinstance.cpp.
.PP
References QCString::isEmpty(), and KGlobal::setActiveInstance().
.SS "KInstance::~\fBKInstance\fP ()\fC [virtual]\fP"
.PP
Destructor. Definition at line 109 of file kinstance.cpp.
.PP
References KGlobal::setActiveInstance().
.SS "KInstance::KInstance (const \fBKInstance\fP &)\fC [protected]\fP"
.PP
Copy Constructor is not allowed. 
.SH "Member Function Documentation"
.PP 
.SS "\fBKStandardDirs\fP * KInstance::dirs () const"
.PP
Returns the application standard dirs object. \fBReturns:\fP
.RS 4
The \fBKStandardDirs\fP of the application. 
.RE
.PP
Definition at line 132 of file kinstance.cpp.
.PP
References KStandardDirs::addCustomized(), and KConfig::reparseConfiguration().
.PP
Referenced by KGlobal::dirs(), KLibLoader::findLibrary(), iconLoader(), KStandardDirs::locate(), KStandardDirs::locateLocal(), and newIconLoader().
.SS "\fBKConfig\fP * KInstance::config () const"
.PP
Returns the general config object ('appnamerc'). \fBReturns:\fP
.RS 4
the \fBKConfig\fP object for the instance. 
.RE
.PP
Definition at line 144 of file kinstance.cpp.
.PP
References KStandardDirs::addCustomized(), QCString::isEmpty(), KConfigBase::readBoolEntry(), KConfig::reparseConfiguration(), and KConfigBase::setGroup().
.PP
Referenced by KGlobal::config(), KCmdLineArgs::enable_i18n(), KNotifyClient::Instance::Instance(), KApplication::invokeMailer(), and KLocale::KLocale().
.SS "\fBKIconLoader\fP * KInstance::iconLoader () const"
.PP
Returns an iconloader object. \fBReturns:\fP
.RS 4
the iconloader object. 
.RE
.PP
Definition at line 184 of file kinstance.cpp.
.PP
References dirs(), and KIconLoader::enableDelayedIconSetLoading().
.PP
Referenced by KWin::icon(), KGlobal::iconLoader(), and mimeSourceFactory().
.SS "void KInstance::newIconLoader () const"
.PP
Re-allocate the global iconloader. Definition at line 194 of file kinstance.cpp.
.PP
References dirs(), KIconLoader::reconfigure(), and KIconTheme::reconfigure().
.SS "const  \fBKAboutData\fP * KInstance::aboutData () const"
.PP
Returns the about data of this instance Warning, can be 0L. \fBReturns:\fP
.RS 4
the about data of the instance, or 0 if it has not been set yet 
.RE
.PP
Definition at line 200 of file kinstance.cpp.
.PP
Referenced by KApplication::caption(), and KCrash::defaultCrashHandler().
.SS "\fBQCString\fP KInstance::instanceName () const"
.PP
Returns the name of the instance. \fBReturns:\fP
.RS 4
the instance name, can be null if the KInstance has been created with a null name 
.RE
.PP
Definition at line 205 of file kinstance.cpp.
.PP
Referenced by KApplication::icon(), KApplication::iconName(), KApplication::KApplication(), KApplication::miniIcon(), and KApplication::miniIconName().
.SS "\fBKMimeSourceFactory\fP * KInstance::mimeSourceFactory () const"
.PP
Returns the \fBKMimeSourceFactory\fP of the instance. Mainly added for API completeness and future extensibility. 
.PP
\fBReturns:\fP
.RS 4
the \fBKMimeSourceFactory\fP set as default for this application. 
.RE
.PP
Definition at line 210 of file kinstance.cpp.
.PP
References iconLoader().
.SS "void KInstance::setConfigName (const \fBQString\fP & name)\fC [protected]\fP"
.PP
Set name of default config file. \fBParameters:\fP
.RS 4
\fIname\fP the name of the default config file 
.RE
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP
Definition at line 179 of file kinstance.cpp.

.SH "Author"
.PP 
Generated automatically by Doxygen for kdecore Library from the source code.
