• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDEUI

KGlobalSettings Class Reference

Access the KDE global configuration. More...

#include <kglobalsettings.h>

Inheritance diagram for KGlobalSettings:
QObject

List of all members.

Classes

struct  KMouseSettings
 Describes the mouse settings. More...

Public Types

enum  ChangeType {
  PaletteChanged = 0, FontChanged, StyleChanged, SettingsChanged,
  IconChanged, CursorChanged, ToolbarStyleChanged, ClipboardConfigChanged,
  BlockShortcuts
}
enum  Completion {
  CompletionNone = 1, CompletionAuto, CompletionMan, CompletionShell,
  CompletionPopup, CompletionPopupAuto
}
enum  GraphicEffect { NoEffects = 0x0000, GradientEffects = 0x0001, SimpleAnimationEffects = 0x0002, ComplexAnimationEffects = 0x0006 }
enum  SettingsCategory {
  SETTINGS_MOUSE, SETTINGS_COMPLETION, SETTINGS_PATHS, SETTINGS_POPUPMENU,
  SETTINGS_QT, SETTINGS_SHORTCUTS
}
enum  TearOffHandle { Disable = 0, ApplicationLevel, Enable }

Signals

void appearanceChanged ()
void blockShortcuts (int data)
void cursorChanged ()
void iconChanged (int group)
void kdisplayFontChanged ()
void kdisplayPaletteChanged ()
void kdisplayStyleChanged ()
void settingsChanged (int category)
void toolbarAppearanceChanged (int)

Public Member Functions

void activate ()
 ~KGlobalSettings ()

Static Public Member Functions

static QColor activeTextColor ()
static QColor activeTitleColor ()
static bool allowDefaultBackgroundImages ()
static int autoSelectDelay ()
static QString autostartPath ()
static int buttonLayout ()
static bool changeCursorOverIcon ()
static Completion completionMode ()
static KDE_DEPRECATED int contextMenuKey ()
static int contrast ()
static qreal contrastF (const KSharedConfigPtr &config=KSharedConfigPtr())
static QPalette createApplicationPalette (const KSharedConfigPtr &config=KSharedConfigPtr())
static QRect desktopGeometry (const QWidget *w)
static QRect desktopGeometry (const QPoint &point)
static QString desktopPath ()
static int dndEventDelay ()
static QString documentPath ()
static QString downloadPath ()
static void emitChange (ChangeType changeType, int arg=0)
static QFont fixedFont ()
static QFont generalFont ()
static GraphicEffects graphicEffectsLevel ()
static GraphicEffects graphicEffectsLevelDefault ()
static QColor inactiveTextColor ()
static QColor inactiveTitleColor ()
static TearOffHandle insertTearOffHandle ()
static bool isMultiHead ()
static QFont largeFont (const QString &text=QString())
static QFont menuFont ()
static KMouseSettings & mouseSettings ()
static QString musicPath ()
static bool opaqueResize ()
static QString picturesPath ()
static KGlobalSettings * self ()
static bool shadeSortColumn ()
static bool showContextMenusOnPress ()
static bool showFilePreview (const KUrl &)
static bool showIconsOnPushButtons ()
static bool singleClick ()
static QFont smallestReadableFont ()
static bool smoothScroll ()
static QRect splashScreenDesktopGeometry ()
static QFont taskbarFont ()
static QFont toolBarFont ()
static QString videosPath ()
static bool wheelMouseZooms ()
static QFont windowTitleFont ()

Detailed Description

Access the KDE global configuration.

Author:
David Faure <faure@kde.org>

Definition at line 53 of file kglobalsettings.h.


Member Enumeration Documentation

enum KGlobalSettings::ChangeType

An identifier for change signals.

See also:
emitChange
Enumerator:
PaletteChanged 
FontChanged 
StyleChanged 
SettingsChanged 
IconChanged 
CursorChanged 
ToolbarStyleChanged 
ClipboardConfigChanged 
BlockShortcuts 

Definition at line 505 of file kglobalsettings.h.

enum KGlobalSettings::Completion

This enum describes the completion mode used for by the KCompletion class.

See the styleguide.

Enumerator:
CompletionNone 

No completion is used.

CompletionAuto 

Text is automatically filled in whenever possible.

CompletionMan 

Same as automatic except shortest match is used for completion.

CompletionShell 

Complete text much in the same way as a typical *nix shell would.

CompletionPopup 

Lists all possible matches in a popup list-box to choose from.

CompletionPopupAuto 

Lists all possible matches in a popup list-box to choose from, and automatically fill the result whenever possible.

Definition at line 172 of file kglobalsettings.h.

enum KGlobalSettings::GraphicEffect
Enumerator:
NoEffects 

GUI with no effects at all.

GradientEffects 

GUI with only gradients enabled.

SimpleAnimationEffects 

GUI with simple animations enabled.

ComplexAnimationEffects 

GUI with complex animations enabled.

Note that ComplexAnimationsEffects implies SimpleAnimationEffects.

Definition at line 441 of file kglobalsettings.h.

enum KGlobalSettings::SettingsCategory

Valid values for the settingsChanged signal.

Enumerator:
SETTINGS_MOUSE 
SETTINGS_COMPLETION 
SETTINGS_PATHS 
SETTINGS_POPUPMENU 
SETTINGS_QT 
SETTINGS_SHORTCUTS 

Definition at line 537 of file kglobalsettings.h.

enum KGlobalSettings::TearOffHandle

This enum describes the return type for insertTearOffHandle() whether to insert a handle or not.

Applications who independently want to use handles in their popup menus should test for Application level before calling the appropriate function in KMenu.

Enumerator:
Disable 

disable tear-off handles

ApplicationLevel 

enable on application level

Enable 

enable tear-off handles

Definition at line 125 of file kglobalsettings.h.


Constructor & Destructor Documentation

KGlobalSettings::~KGlobalSettings (  ) 

Definition at line 198 of file kglobalsettings.cpp.


Member Function Documentation

void KGlobalSettings::activate (  ) 

Makes all globally applicable settings take effect and starts listening for changes to these settings.

This is usually called only by the KApplication constructor.

Since:
4.3.3

Definition at line 203 of file kglobalsettings.cpp.

QColor KGlobalSettings::activeTextColor (  )  [static]

The default color to use for active texts.

Returns:
the active text color

Definition at line 335 of file kglobalsettings.cpp.

QColor KGlobalSettings::activeTitleColor (  )  [static]

The default color to use for active titles.

Returns:
the active title color

Definition at line 324 of file kglobalsettings.cpp.

bool KGlobalSettings::allowDefaultBackgroundImages (  )  [static]

Returns if default background images are allowed by the color scheme.

A "default" background image is just that, i.e. the user has not actively selected a background image to use.

Returns:
true if default background images may be used

Definition at line 366 of file kglobalsettings.cpp.

void KGlobalSettings::appearanceChanged (  )  [signal]

Emitted when the application has changed either its GUI style, its font or its palette in response to a kdisplay request.

Normally, widgets will update their styles automatically, but you should connect to this to program special behavior.

int KGlobalSettings::autoSelectDelay (  )  [static]

Returns the KDE setting for the auto-select option.

Returns:
the auto-select delay or -1 if auto-select is disabled.

Definition at line 248 of file kglobalsettings.cpp.

QString KGlobalSettings::autostartPath (  )  [static]

The path to the autostart directory of the current user.

Returns:
the path of the autostart directory

Definition at line 608 of file kglobalsettings.cpp.

void KGlobalSettings::blockShortcuts ( int  data  )  [signal]

Emitted by BlockShortcuts.

int KGlobalSettings::buttonLayout (  )  [static]

The layout scheme to use for dialog buttons.

Returns:
Returns the number of the scheme to use.

Definition at line 782 of file kglobalsettings.cpp.

bool KGlobalSettings::changeCursorOverIcon (  )  [static]

Checks whether the cursor changes over icons.

Returns:
the KDE setting for "change cursor over icon"

Definition at line 242 of file kglobalsettings.cpp.

KGlobalSettings::Completion KGlobalSettings::completionMode (  )  [static]

Returns the preferred completion mode setting.

Returns:
Completion. Default is CompletionPopup.

Definition at line 254 of file kglobalsettings.cpp.

int KGlobalSettings::contextMenuKey (  )  [static]

Returns the KDE setting for the shortcut key to open context menus.

Returns:
the key that pops up context menus.
Deprecated:
Simply reimplement QWidget::contextMenuEvent() instead.

Definition at line 273 of file kglobalsettings.cpp.

int KGlobalSettings::contrast (  )  [static]

Returns the contrast for borders.

Returns:
the contrast (between 0 for minimum and 10 for maximum contrast)

Definition at line 345 of file kglobalsettings.cpp.

qreal KGlobalSettings::contrastF ( const KSharedConfigPtr &  config = KSharedConfigPtr()  )  [static]

Returns the contrast for borders as a floating point value.

Parameters:
config pointer to the config from which to read the contrast setting (the default is to use KGlobal::config())
Returns:
the contrast (between 0.0 for minimum and 1.0 for maximum contrast)

Definition at line 351 of file kglobalsettings.cpp.

QPalette KGlobalSettings::createApplicationPalette ( const KSharedConfigPtr &  config = KSharedConfigPtr()  )  [static]

Used to obtain the QPalette that will be used to set the application palette.

This is only useful for configuration modules such as krdb and should not be used in normal circumstances.

Parameters:
config KConfig from which to load the colors (passed as-is to KColorScheme).
Returns:
the QPalette

Definition at line 911 of file kglobalsettings.cpp.

void KGlobalSettings::cursorChanged (  )  [signal]

Emitted when the cursor theme has been changed.

QRect KGlobalSettings::desktopGeometry ( const QWidget *  w  )  [static]

This function returns the desktop geometry for an application that needs to set the geometry of a widget on the screen manually.

It takes into account the user's display settings (number of screens, Xinerama, etc), and the user's preferences (if KDE should be Xinerama aware).

Parameters:
w the widget in question. This is used to determine which screen to use in Xinerama or multi-head mode.
Returns:
the geometry to use for the desktop. Note that it might not start at (0,0).

Definition at line 719 of file kglobalsettings.cpp.

QRect KGlobalSettings::desktopGeometry ( const QPoint &  point  )  [static]

This function returns the desktop geometry for an application that needs to set the geometry of a widget on the screen manually.

It takes into account the user's display settings (number of screens, Xinerama, etc), and the user's preferences (if KDE should be Xinerama aware).

Note that this can break in multi-head (not Xinerama) mode because this point could be on multiple screens. Use with care.

Parameters:
point a reference point for the widget, for instance one that the widget should be adjacent or on top of.
Returns:
the geometry to use for the desktop. Note that it might not start at (0,0).

Definition at line 702 of file kglobalsettings.cpp.

QString KGlobalSettings::desktopPath (  )  [static]

The path to the desktop directory of the current user.

Returns:
the user's desktop directory

Definition at line 601 of file kglobalsettings.cpp.

int KGlobalSettings::dndEventDelay (  )  [static]

Returns a threshold in pixels for drag & drop operations.

As long as the mouse movement has not exceeded this number of pixels in either X or Y direction no drag operation may be started. This prevents spurious drags when the user intended to click on something but moved the mouse a bit while doing so.

For this to work you must save the position of the mouse (oldPos) in the QWidget::mousePressEvent(). When the position of the mouse (newPos) in a QWidget::mouseMoveEvent() exceeds this threshold you may start a drag which should originate from oldPos.

Example code:

 void KColorCells::mousePressEvent( QMouseEvent *e )
 {
    mOldPos = e->pos();
 }

 void KColorCells::mouseMoveEvent( QMouseEvent *e )
 {
    if( !(e->state() && LeftButton)) return;

    int delay = KGlobalSettings::dndEventDelay();
    QPoint newPos = e->pos();
    if(newPos.x() > mOldPos.x()+delay || newPos.x() < mOldPos.x()-delay ||
       newPos.y() > mOldPos.y()+delay || newPos.y() < mOldPos.y()-delay)
    {
       // Drag color object
       int cell = posToCell(mOldPos); // Find color at mOldPos
       if ((cell != -1) && colors[cell].isValid())
       {
          KColorDrag *d = KColorDrag::makeDrag( colors[cell], this);
          d->dragCopy();
       }
    }
 }
Returns:
the threshold for drag & drop in pixels

Definition at line 214 of file kglobalsettings.cpp.

QString KGlobalSettings::documentPath (  )  [static]

The path where documents are stored of the current user.

Returns:
the path of the document directory

Definition at line 621 of file kglobalsettings.cpp.

QString KGlobalSettings::downloadPath (  )  [static]

The path where download are stored of the current user.

Returns:
the path of the download directory

Definition at line 627 of file kglobalsettings.cpp.

void KGlobalSettings::emitChange ( ChangeType  changeType,
int  arg = 0 
) [static]

Notifies all KDE applications on the current display of a change.

This is typically called by kcontrol modules after changing the corresponding config file. Do not call this from a normal KDE application.

Definition at line 788 of file kglobalsettings.cpp.

QFont KGlobalSettings::fixedFont (  )  [static]

Returns the default fixed font.

Returns:
the default fixed font.

Definition at line 430 of file kglobalsettings.cpp.

QFont KGlobalSettings::generalFont (  )  [static]

Returns the default general font.

Returns:
the default general font.

Definition at line 426 of file kglobalsettings.cpp.

KGlobalSettings::GraphicEffects KGlobalSettings::graphicEffectsLevel (  )  [static]

This function determines the desired level of effects on the GUI.

Since:
4.1

Definition at line 745 of file kglobalsettings.cpp.

KGlobalSettings::GraphicEffects KGlobalSettings::graphicEffectsLevelDefault (  )  [static]

This function determines the default level of effects on the GUI depending on the system capabilities.

Since:
4.1

Definition at line 760 of file kglobalsettings.cpp.

void KGlobalSettings::iconChanged ( int  group  )  [signal]

Emitted when the global icon settings have been changed.

Parameters:
group the new group
QColor KGlobalSettings::inactiveTextColor (  )  [static]

The default color to use for inactive texts.

Returns:
the inactive text color

Definition at line 313 of file kglobalsettings.cpp.

QColor KGlobalSettings::inactiveTitleColor (  )  [static]

The default color to use for inactive titles.

Returns:
the inactive title color

Definition at line 302 of file kglobalsettings.cpp.

KGlobalSettings::TearOffHandle KGlobalSettings::insertTearOffHandle (  )  [static]

Returns whether tear-off handles are inserted in KMenus.

Returns:
whether tear-off handles are inserted in KMenus.

Definition at line 232 of file kglobalsettings.cpp.

bool KGlobalSettings::isMultiHead (  )  [static]

Returns if the user specified multihead.

In case the display has multiple screens, the return value of this function specifies if the user wants KDE to run on all of them or just on the primary On Windows, settings are retrieved from the system.

Returns:
true if the user chose multi head

Definition at line 664 of file kglobalsettings.cpp.

void KGlobalSettings::kdisplayFontChanged (  )  [signal]

Emitted when the application has changed its font in response to a KControl request.

Normally widgets will update their fonts automatically, but you should connect to this to monitor global font changes, especially if you are using explicit fonts.

Note: If you derive from a QWidget-based class, a faster method is to reimplement QWidget::changeEvent() and catch QEvent::FontChange. This is the preferred way to get informed about font updates.

void KGlobalSettings::kdisplayPaletteChanged (  )  [signal]

Emitted when the application has changed its palette due to a KControl request.

Normally, widgets will update their palette automatically, but you should connect to this to program special behavior.

Note: If you derive from a QWidget-based class, a faster method is to reimplement QWidget::changeEvent() and catch QEvent::PaletteChange. This is the preferred way to get informed about palette updates.

void KGlobalSettings::kdisplayStyleChanged (  )  [signal]

Emitted when the application has changed its GUI style in response to a KControl request.

Normally, widgets will update their styles automatically (as they would respond to an explicit setGUIStyle() call), but you should connect to this to program special behavior.

Note: If you derive from a QWidget-based class, a faster method is to reimplement QWidget::changeEvent() and catch QEvent::StyleChange. This is the preferred way to get informed about style updates.

QFont KGlobalSettings::largeFont ( const QString &  text = QString()  )  [static]

Returns a font of approx.

48 pt. capable of showing text.

Parameters:
text the text to test
Returns:
the font that is capable to show the text with 48 pt

Definition at line 520 of file kglobalsettings.cpp.

QFont KGlobalSettings::menuFont (  )  [static]

Returns the default menu font.

Returns:
the default menu font.

Definition at line 438 of file kglobalsettings.cpp.

KGlobalSettings::KMouseSettings & KGlobalSettings::mouseSettings (  )  [static]

This returns the current mouse settings.

On Windows, settings are retrieved from the system.

Returns:
the current mouse settings

Definition at line 588 of file kglobalsettings.cpp.

QString KGlobalSettings::musicPath (  )  [static]

The path where music are stored of the current user.

Returns:
the path of the music directory

Definition at line 658 of file kglobalsettings.cpp.

bool KGlobalSettings::opaqueResize (  )  [static]

Whether the user wishes to use opaque resizing.

Primarily intended for QSplitter::setOpaqueResize()

Returns:
Returns true if user wants to use opaque resizing.

Definition at line 776 of file kglobalsettings.cpp.

QString KGlobalSettings::picturesPath (  )  [static]

The path where pictures are stored of the current user.

Returns:
the path of the pictures directory

Definition at line 652 of file kglobalsettings.cpp.

KGlobalSettings * KGlobalSettings::self (  )  [static]

Return the KGlobalSettings singleton.

This is used to connect to its signals, to be notified of changes.

Definition at line 185 of file kglobalsettings.cpp.

void KGlobalSettings::settingsChanged ( int  category  )  [signal]

Emitted when the global settings have been changed.

KGlobalSettings takes care of calling reparseConfiguration on KGlobal::config() so that applications/classes using this only have to re-read the configuration

Parameters:
category the category among the SettingsCategory enum.
bool KGlobalSettings::shadeSortColumn (  )  [static]

Returns if the sorted column in a K3ListView shall be drawn with a shaded background color.

Returns:
true if the sorted column shall be shaded

Definition at line 360 of file kglobalsettings.cpp.

bool KGlobalSettings::showContextMenusOnPress (  )  [static]

Returns the KDE setting for context menus.

Returns:
whether context menus should be shown on button press or button release (click).

Definition at line 267 of file kglobalsettings.cpp.

bool KGlobalSettings::showFilePreview ( const KUrl &  url  )  [static]

This function determines if the user wishes to see previews for the selected url.

Returns:
Returns true if user wants to show previews.

Definition at line 768 of file kglobalsettings.cpp.

bool KGlobalSettings::showIconsOnPushButtons (  )  [static]

This function determines if the user wishes to see icons on the push buttons.

Returns:
Returns true if user wants to show icons.

Definition at line 738 of file kglobalsettings.cpp.

bool KGlobalSettings::singleClick (  )  [static]

Returns whether KDE runs in single (default) or double click mode.

see http://developer.kde.org/documentation/standards/kde/style/mouse/index.html

Returns:
true if single click mode, or false if double click mode.

Definition at line 220 of file kglobalsettings.cpp.

QFont KGlobalSettings::smallestReadableFont (  )  [static]

Returns the smallest readable font.

This can be used in dockers, rulers and other places where space is at a premium.

Definition at line 450 of file kglobalsettings.cpp.

bool KGlobalSettings::smoothScroll (  )  [static]

Returns if item views should force smooth scrolling.

Returns:
true if smooth scrolling is enabled for item view, false otherwise.
Since:
4.2

Definition at line 226 of file kglobalsettings.cpp.

QRect KGlobalSettings::splashScreenDesktopGeometry (  )  [static]

This function returns the desktop geometry for an application's splash screen.

It takes into account the user's display settings (number of screens, Xinerama, etc), and the user's preferences (if KDE should be Xinerama aware).

Returns:
the geometry to use for the desktop. Note that it might not start at (0,0).

Definition at line 683 of file kglobalsettings.cpp.

QFont KGlobalSettings::taskbarFont (  )  [static]

Returns the default taskbar font.

Returns:
the default taskbar font.

Definition at line 446 of file kglobalsettings.cpp.

void KGlobalSettings::toolbarAppearanceChanged ( int   )  [signal]

Emitted when the settings for toolbars have been changed.

KToolBar will know what to do.

QFont KGlobalSettings::toolBarFont (  )  [static]

Returns the default toolbar font.

Returns:
the default toolbar font.

Definition at line 434 of file kglobalsettings.cpp.

QString KGlobalSettings::videosPath (  )  [static]

The path where videos are stored of the current user.

Returns:
the path of the video directory

Definition at line 646 of file kglobalsettings.cpp.

bool KGlobalSettings::wheelMouseZooms (  )  [static]

Typically, QScrollView derived classes can be scrolled fast by holding down the Ctrl-button during wheel-scrolling.

But QTextEdit and derived classes perform zooming instead of fast scrolling.

This value determines whether the user wants to zoom or scroll fast with Ctrl-wheelscroll.

Returns:
true if the user wishes to zoom with the mouse wheel, false for scrolling

Definition at line 677 of file kglobalsettings.cpp.

QFont KGlobalSettings::windowTitleFont (  )  [static]

Returns the default window title font.

Returns:
the default window title font.

Definition at line 442 of file kglobalsettings.cpp.


The documentation for this class was generated from the following files:
  • kglobalsettings.h
  • kglobalsettings.cpp

KDEUI

Skip menu "KDEUI"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal