KGlobal Namespace Reference

---

Detailed Description

Access to the KDE global objects.

KGlobal provides you with pointers of many central objects that exist only once in the process. It is also responsible for managing instances of KStaticDeleterBase.

See also:

KStaticDeleterBase

Author:

Sirtaj Singh Kang (taj@kde.org)

Enumerations
enum	CopyCatalogs { DoCopyCatalogs, DontCopyCatalogs }
Functions
KComponentData	activeComponent ()
QString	caption ()
KCharsets *	charsets ()
KSharedConfig::Ptr	config ()
void	deref ()
KStandardDirs *	dirs ()
bool	hasLocale ()
bool	hasMainComponent ()
KLocale *	locale ()
const KComponentData &	mainComponent ()
void	newComponentData (const KComponentData &c)
void	ref ()
void	setActiveComponent (const KComponentData &d)
void	setAllowQuit (bool allowQuit)
void	setLocale (KLocale *locale, CopyCatalogs copy)
const QString &	staticQString (const QString &str)
const QString &	staticQString (const char *str)
mode_t	umask ()

---

Enumeration Type Documentation

enum KGlobal::CopyCatalogs

For setLocale.

Enumerator:

DoCopyCatalogs
DontCopyCatalogs

Definition at line 470 of file kglobal.h.

---

Function Documentation

KComponentData KGlobal::activeComponent

(

)

The component currently active (useful in a multi-component application, such as a KParts application).

Don't use this - it's mainly for KAboutDialog and KBugReport.

Definition at line 172 of file kglobal.cpp.

QString KGlobal::caption

(

)

Returns a text for the window caption.

This may be set by "-caption", otherwise it will be equivalent to the name of the executable.

Returns:

the text for the window caption

Definition at line 234 of file kglobal.cpp.

KCharsets * KGlobal::charsets

(

)

The global charset manager.

Returns:

the global charset manager

Definition at line 156 of file kglobal.cpp.

KSharedConfigPtr KGlobal::config

(

)

Returns the general config object.

Returns:

the global configuration object.

Definition at line 109 of file kglobal.cpp.

void KGlobal::deref

(

)

Tells KGlobal that one operation such as those described in ref() just finished.

This call makes the QApplication quit if the counter is back to 0.

Definition at line 269 of file kglobal.cpp.

KStandardDirs * KGlobal::dirs

(

)

Returns the application standard dirs object.

Returns:

the global standard dir object

Definition at line 102 of file kglobal.cpp.

bool KGlobal::hasLocale

(

)

Definition at line 147 of file kglobal.cpp.

bool KGlobal::hasMainComponent

(

)

Definition at line 123 of file kglobal.cpp.

KLocale * KGlobal::locale

(

)

Returns the global locale object.

Returns:

the global locale object

Definition at line 132 of file kglobal.cpp.

const KComponentData & KGlobal::mainComponent

(

)

Returns the global component data.

There is always at least one instance of a component in one application (in most cases the application itself).

Returns:

the global component data

Definition at line 116 of file kglobal.cpp.

void KGlobal::newComponentData

(

const KComponentData &

c

)

Definition at line 188 of file kglobal.cpp.

void KGlobal::ref

(

)

Tells KGlobal about one more operations that should be finished before the application exits.

The standard behavior is to exit on the "last window closed" event, but some events should outlive the last window closed (e.g. a file copy for a file manager, or 'compacting folders on exit' for a mail client).

We have some use cases that we want to take care of (the format is "action refcount"):

• open window -> setAllowQuit(true) 1 ; close window 0 => EXIT
• job start 1; job end 0 [don't exit yet]; open window -> setAllowQuit(true) 1 ; close window 0 => EXIT
• job start 1; open window -> setAllowQuit(true) 2; close window 1; job end 0 => EXIT
• job start 1; open window -> setAllowQuit(true) 2; job end 1; close window 0 => EXIT
• open dialog 0; close dialog 0; => DO NOT EXIT
• job start 1; job end 0; create two main objects 2; delete both main objects 0 => EXIT
• open window -> setAllowQuit(true) 1; add systray icon 2; close window 1 => DO NOT EXIT
• open window -> setAllowQuit(true) 1; add systray icon 2; remove systray icon 1; close window 0 => EXIT
• unit test which opens and closes many windows: should call ref() to avoid subevent-loops quitting too early.

Note that for this to happen you must call qApp->setQuitOnLastWindowClosed(false), in main() for instance.

Definition at line 263 of file kglobal.cpp.

void KGlobal::setActiveComponent

(

const KComponentData &

d

)

Set the active component for use by KAboutDialog and KBugReport.

To be used only by a multi-component (KParts) application.

See also:

activeComponent()

Definition at line 179 of file kglobal.cpp.

void KGlobal::setAllowQuit

(

bool

allowQuit

)

If refcounting reaches 0 (or less), and allowQuit is true, the instance of the application will automatically be exited.

Otherwise, the application will not exit automatically.

Since:

4.1.1

Definition at line 278 of file kglobal.cpp.

void KGlobal::setLocale	(	KLocale *	locale,
		CopyCatalogs	copy
	)

Definition at line 198 of file kglobal.cpp.

const QString & KGlobal::staticQString

(

const QString &

str

)

Create a static QString.

Creates a static QString.

To be used inside functions(!) like: static const QString &myString = KGlobal::staticQString(i18n("My Text"));

To be used inside functions(!) like:

 static const QString &myString = KGlobal::staticQString(i18n("My Text"));

Attention:

Do NOT use code such as:

 static QString myString = KGlobal::staticQString(i18n("myText"));

This creates a static object (instead of a static reference) and as you know static objects are EVIL.

Parameters:

str

the string to create

Returns:

the static string

Definition at line 224 of file kglobal.cpp.

const QString & KGlobal::staticQString

(

const char *

str

)

Create a static QString.

Creates a static QString.

To be used inside functions(!) like: static const QString &myString = KGlobal::staticQString("myText");

To be used inside functions(!) like:

 static const QString &myString = KGlobal::staticQString("myText");

Attention:

Do NOT use code such as:

 static QString myString = KGlobal::staticQString("myText");

This creates a static object (instead of a static reference) and as you know static objects are EVIL.

Parameters:

str

the string to create

Returns:

the static string

Definition at line 213 of file kglobal.cpp.

mode_t KGlobal::umask

(

)

Returns the umask of the process.

Returns:

the umask of the process

Definition at line 166 of file kglobal.cpp.