KDE API ReferenceKDECore
Enumerations | |
| enum | CopyCatalogs { DoCopyCatalogs, DontCopyCatalogs } |
Functions | |
| KComponentData | activeComponent () |
| QString | caption () |
| KCharsets * | charsets () |
| KSharedConfigPtr | config () |
| void | deref () |
| KStandardDirs * | dirs () |
| template<typename T > | |
| T | findDirectChild (const QObject *object) |
| QObject * | findDirectChild_helper (const QObject *parent, const QMetaObject &mo) |
| bool | hasLocale () |
| bool | hasMainComponent () |
| void | insertCatalog (const QString &catalog) |
| KLocale * | locale () |
| const KComponentData & | mainComponent () |
| void | newComponentData (const KComponentData &c) |
| void | ref () |
| void | setActiveComponent (const KComponentData &d) |
| void | setAllowQuit (bool allowQuit) |
| void | setLocale (KLocale *, CopyCatalogs copy=DoCopyCatalogs) |
| const QString & | staticQString (const char *str) |
| const QString & | staticQString (const QString &str) |
| mode_t | umask () |
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
Enumeration Type Documentation
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 230 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 292 of file kglobal.cpp.
| KCharsets * KGlobal::charsets | ( | ) |
The global charset manager.
- Returns
- the global charset manager
Definition at line 214 of file kglobal.cpp.
| KSharedConfig::Ptr KGlobal::config | ( | ) |
Returns the general config object.
- Returns
- the global configuration object.
Definition at line 139 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 326 of file kglobal.cpp.
| KStandardDirs* KGlobal::dirs | ( | ) |
Returns the application standard dirs object.
- Returns
- the global standard dir object
Returns the child of the given object that can be cast into type T, or 0 if there is no such object.
Unlike QObject::findChild, the search is NOT performed recursively.
- Since
- 4.4
| QObject * KGlobal::findDirectChild_helper | ( | const QObject * | parent, |
| const QMetaObject & | mo | ||
| ) |
Definition at line 346 of file kglobal.cpp.
| bool KGlobal::hasLocale | ( | ) |
Returns whether KGlobal has a valid KLocale object
Definition at line 205 of file kglobal.cpp.
| bool KGlobal::hasMainComponent | ( | ) |
Returns whether a main KComponentData is available.
Definition at line 151 of file kglobal.cpp.
| void KGlobal::insertCatalog | ( | const QString & | catalog | ) |
Inserts the catalog in the main locale object if it exists.
Otherwise the catalog name is stored and added once the main locale gets created
- Since
- 4.6
Definition at line 160 of file kglobal.cpp.
| KLocale * KGlobal::locale | ( | ) |
Returns the global locale object.
- Returns
- the global locale object
Note: in multi-threaded programs, you should call KGlobal::locale() in the main thread (e.g. in main(), after creating the QCoreApplication and setting the main component), to ensure that the initialization is done in the main thread. However KApplication takes care of this, so this is only needed when not using KApplication.
Definition at line 170 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 145 of file kglobal.cpp.
| void KGlobal::newComponentData | ( | const KComponentData & | c | ) |
Definition at line 246 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), or simply any application with a system tray icon.
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 321 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 237 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.
This is used by KMainWindow to allow quitting after the first mainwindow is created, and is used by special applications like kfmclient, to allow quitting even though no mainwindow was created.
However, don't try to call setAllowQuit(false) in applications, it doesn't make sense. If you find that the application quits too early when closing a window, then consider what is making your application still alive to the user (like a systray icon or a D-Bus object) and use KGlobal::ref() + KGlobal::deref() in that object.
- Since
- 4.1.1
Definition at line 334 of file kglobal.cpp.
| void KGlobal::setLocale | ( | KLocale * | newLocale, |
| CopyCatalogs | copy = DoCopyCatalogs |
||
| ) |
Definition at line 256 of file kglobal.cpp.
| const QString & KGlobal::staticQString | ( | const char * | str | ) |
Creates a static QString.
Create a static QString.
To be used inside functions(!) like:
- Attention
- Do NOT use code such as: 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
To be used inside functions(!) like: static const QString &myString = KGlobal::staticQString("myText");
Definition at line 271 of file kglobal.cpp.
Creates a static QString.
Create a static QString.
To be used inside functions(!) like:
- Attention
- Do NOT use code such as: 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
To be used inside functions(!) like: static const QString &myString = KGlobal::staticQString(i18n("My Text"));
Definition at line 282 of file kglobal.cpp.
| mode_t KGlobal::umask | ( | ) |
Returns the umask of the process.
- Returns
- the umask of the process
Definition at line 224 of file kglobal.cpp.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:22:14 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.
