• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kdecore
 

kdecore

Classes | Public Types | Static Public Member Functions | Friends
KGlobalSettings Class Reference

#include <kglobalsettings.h>

List of all members.

Classes

struct  KMouseSettings
 Describes the mouse settings. More...

Public Types

enum  TearOffHandle { Disable = 0, ApplicationLevel, Enable }
enum  Completion {
  CompletionNone = 1, CompletionAuto, CompletionMan, CompletionShell,
  CompletionPopup, CompletionPopupAuto
}

Static Public Member Functions

static int dndEventDelay ()
static bool singleClick ()
static bool iconUseRoundedRect ()
static TearOffHandle insertTearOffHandle ()
static bool changeCursorOverIcon ()
static bool visualActivate ()
static unsigned int visualActivateSpeed ()
static int autoSelectDelay ()
static int contextMenuKey ()
static bool showContextMenusOnPress ()
static Completion completionMode ()
static KMouseSettings & mouseSettings ()
static TQString autostartPath ()
static TQString trashPath ()
static TQString desktopPath ()
static TQString documentPath ()
static TQString downloadPath ()
static TQString musicPath ()
static TQString picturesPath ()
static TQString publicSharePath ()
static TQString templatesPath ()
static TQString videosPath ()
static TQColor toolBarHighlightColor ()
static TQColor inactiveTitleColor ()
static TQColor inactiveTextColor ()
static TQColor activeTitleColor ()
static TQColor activeTextColor ()
static int contrast ()
static TQColor buttonBackground ()
static TQColor buttonTextColor ()
static TQColor baseColor ()
static TQColor textColor ()
static TQColor linkColor ()
static TQColor visitedLinkColor ()
static TQColor highlightedTextColor ()
static TQColor highlightColor ()
static TQColor alternateBackgroundColor ()
static TQColor calculateAlternateBackgroundColor (const TQColor &base)
static bool shadeSortColumn ()
static TQFont generalFont ()
static TQFont fixedFont ()
static TQFont toolBarFont ()
static TQFont menuFont ()
static TQFont windowTitleFont ()
static TQFont taskbarFont ()
static TQFont largeFont (const TQString &text=TQString::null)
static bool isMultiHead ()
static bool wheelMouseZooms ()
static TQRect splashScreenDesktopGeometry ()
static TQRect desktopGeometry (const TQPoint &point)
static TQRect desktopGeometry (TQWidget *w)
static bool showIconsOnPushButtons ()
static bool showFilePreview (const KURL &)
static bool showKonqIconActivationEffect ()
static bool opaqueResize ()
static int buttonLayout ()

Friends

class KApplication

Detailed Description

Access the KDE global configuration.

Author:
David Faure <faure@kde.org>

Definition at line 48 of file kglobalsettings.h.


Member Enumeration Documentation

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 178 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 KPopupMenu.

Since:
3.1
Enumerator:
Disable 

disable tear-off handles

ApplicationLevel 

enable on application level

Enable 

enable tear-off handles

Definition at line 117 of file kglobalsettings.h.


Member Function Documentation

TQColor KGlobalSettings::activeTextColor ( ) [static]

The default color to use for active texts.

Returns:
the active text color

Definition at line 353 of file kglobalsettings.cpp.

TQColor KGlobalSettings::activeTitleColor ( ) [static]

The default color to use for active titles.

Returns:
the active title color

Definition at line 340 of file kglobalsettings.cpp.

TQColor KGlobalSettings::alternateBackgroundColor ( ) [static]

Returns the alternate background color used by KListView with KListViewItem.

Any other list that uses alternating background colors should use this too, to obey to the user's preferences. Returns an invalid color if the user doesn't want alternating backgrounds.

Returns:
the alternate background color
See also:
calculateAlternateBackgroundColor

Definition at line 422 of file kglobalsettings.cpp.

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 277 of file kglobalsettings.cpp.

static TQString KGlobalSettings::autostartPath ( ) [inline, static]

The path to the autostart directory of the current user.

Returns:
the path of the autostart directory

Definition at line 233 of file kglobalsettings.h.

TQColor KGlobalSettings::baseColor ( ) [static]

Returns the default base (background) color.

Returns:
the default base (background) color
See also:
TQColorGroup::base()

Definition at line 386 of file kglobalsettings.cpp.

TQColor KGlobalSettings::buttonBackground ( ) [static]

Returns the button background color.

Returns:
the button background color
Since:
3.4

Definition at line 369 of file kglobalsettings.cpp.

int KGlobalSettings::buttonLayout ( ) [static]

The layout scheme to use for dialog buttons.

Returns:
Returns the number of the scheme to use.
See also:
KDialogBase::setButtonStyle()
Since:
3.3

Definition at line 945 of file kglobalsettings.cpp.

TQColor KGlobalSettings::buttonTextColor ( ) [static]

Returns the button text color.

Returns:
the button text color
Since:
3.4

Definition at line 377 of file kglobalsettings.cpp.

TQColor KGlobalSettings::calculateAlternateBackgroundColor ( const TQColor &  base) [static]

Calculates a color based on base to be used as alternating color for e.g.

listviews.

Parameters:
basethe base for the calculation
Returns:
the calculated color
See also:
alternateBackgroundColor

Definition at line 430 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 253 of file kglobalsettings.cpp.

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

Returns the preferred completion mode setting.

Returns:
Completion. Default is CompletionPopup.

Definition at line 283 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.

Definition at line 302 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 363 of file kglobalsettings.cpp.

TQRect KGlobalSettings::desktopGeometry ( const TQPoint &  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:
pointa 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).
Since:
3.2

Definition at line 880 of file kglobalsettings.cpp.

TQRect KGlobalSettings::desktopGeometry ( TQWidget *  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:
wthe 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).
Since:
3.2

Definition at line 897 of file kglobalsettings.cpp.

static TQString KGlobalSettings::desktopPath ( ) [inline, static]

The path to the desktop directory of the current user.

Returns:
the user's desktop directory

Definition at line 248 of file kglobalsettings.h.

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 TQWidget::mousePressEvent(). When the position of the mouse (newPos) in a TQWidget::mouseMoveEvent() exceeds this threshold you may start a drag which should originate from oldPos.

Example code:

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

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

    int delay = KGlobalSettings::dndEventDelay();
    TQPoint 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 225 of file kglobalsettings.cpp.

static TQString KGlobalSettings::documentPath ( ) [inline, static]

The path where documents are stored of the current user.

Returns:
the path of the document directory

Definition at line 254 of file kglobalsettings.h.

static TQString KGlobalSettings::downloadPath ( ) [inline, static]

The path where documents are stored of the current user.

Returns:
the path of the downloads directory

Definition at line 260 of file kglobalsettings.h.

TQFont KGlobalSettings::fixedFont ( ) [static]

Returns the default fixed font.

Returns:
the default fixed font.

Definition at line 486 of file kglobalsettings.cpp.

TQFont KGlobalSettings::generalFont ( ) [static]

Returns the default general font.

Returns:
the default general font.

Definition at line 470 of file kglobalsettings.cpp.

TQColor KGlobalSettings::highlightColor ( ) [static]

Returns the default color for text highlights.

Returns:
the default color for text highlights
See also:
TQColorGroup::hightlight()

Definition at line 413 of file kglobalsettings.cpp.

TQColor KGlobalSettings::highlightedTextColor ( ) [static]

Returns the default color for highlighted text.

Returns:
the default color for highlighted text
See also:
TQColorGroup::hightlightedText()

Definition at line 404 of file kglobalsettings.cpp.

bool KGlobalSettings::iconUseRoundedRect ( ) [static]

Returns whether icon text is drawn in a rounded style.

Returns:
true if rounded, or false if rectangular.

Definition at line 237 of file kglobalsettings.cpp.

TQColor KGlobalSettings::inactiveTextColor ( ) [static]

The default color to use for inactive texts.

Returns:
the inactive text color

Definition at line 328 of file kglobalsettings.cpp.

TQColor KGlobalSettings::inactiveTitleColor ( ) [static]

The default color to use for inactive titles.

Returns:
the inactive title color

Definition at line 316 of file kglobalsettings.cpp.

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

Returns whether tear-off handles are inserted in KPopupMenus.

Returns:
whether tear-off handles are inserted in KPopupMenus.
Since:
3.1

Definition at line 243 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 842 of file kglobalsettings.cpp.

TQFont KGlobalSettings::largeFont ( const TQString &  text = TQString::null) [static]

Returns a font of approx.

48 pt. capable of showing text.

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

Definition at line 567 of file kglobalsettings.cpp.

TQColor KGlobalSettings::linkColor ( ) [static]

Returns the default link color.

Returns:
the default link color

Definition at line 453 of file kglobalsettings.cpp.

TQFont KGlobalSettings::menuFont ( ) [static]

Returns the default menu font.

Returns:
the default menu font.

Definition at line 518 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 784 of file kglobalsettings.cpp.

static TQString KGlobalSettings::musicPath ( ) [inline, static]

The path where documents are stored of the current user.

Returns:
the path of the music directory

Definition at line 266 of file kglobalsettings.h.

bool KGlobalSettings::opaqueResize ( ) [static]

Whether the user wishes to use opaque resizing.

Primarily intended for TQSplitter::setOpaqueResize()

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

Definition at line 938 of file kglobalsettings.cpp.

static TQString KGlobalSettings::picturesPath ( ) [inline, static]

The path where documents are stored of the current user.

Returns:
the path of the pictures directory

Definition at line 272 of file kglobalsettings.h.

static TQString KGlobalSettings::publicSharePath ( ) [inline, static]

The path of the public share of the current user.

Returns:
the path of the public share directory

Definition at line 278 of file kglobalsettings.h.

bool KGlobalSettings::shadeSortColumn ( void  ) [static]

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

Returns:
true if the sorted column shall be shaded
Since:
3.4

Definition at line 447 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 296 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.
Since:
3.2

Definition at line 923 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.
Since:
3.2

Definition at line 916 of file kglobalsettings.cpp.

bool KGlobalSettings::showKonqIconActivationEffect ( ) [static]

This function determines if the user wishes to see icon activation effects in Konqueror or KDesktop.

Returns:
Returns true if user wants to show activation effects.
Since:
3.5.12

Definition at line 931 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 231 of file kglobalsettings.cpp.

TQRect 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).
Since:
3.2

Definition at line 861 of file kglobalsettings.cpp.

TQFont KGlobalSettings::taskbarFont ( ) [static]

Returns the default taskbar font.

Returns:
the default taskbar font.

Definition at line 550 of file kglobalsettings.cpp.

static TQString KGlobalSettings::templatesPath ( ) [inline, static]

The path where templates are stored of the current user.

Returns:
the path of the templates directory

Definition at line 284 of file kglobalsettings.h.

TQColor KGlobalSettings::textColor ( ) [static]

Returns the default text color.

Returns:
the default text color
See also:
TQColorGroup::text()

Definition at line 395 of file kglobalsettings.cpp.

TQFont KGlobalSettings::toolBarFont ( ) [static]

Returns the default toolbar font.

Returns:
the default toolbar font.

Definition at line 502 of file kglobalsettings.cpp.

TQColor KGlobalSettings::toolBarHighlightColor ( ) [static]

The default color to use when highlighting toolbar buttons.

Returns:
the toolbar highlight color

Definition at line 309 of file kglobalsettings.cpp.

static TQString KGlobalSettings::trashPath ( ) [inline, static]

DEPRECATED (starting from kde-3.4).

This isn't where the trash contents is, anymore. Use KIO::trash() to trash files, "trash:/" to list the trash contents.

Definition at line 240 of file kglobalsettings.h.

static TQString KGlobalSettings::videosPath ( ) [inline, static]

The path where documents are stored of the current user.

Returns:
the path of the videos directory

Definition at line 290 of file kglobalsettings.h.

TQColor KGlobalSettings::visitedLinkColor ( ) [static]

Returns the default color for visited links.

Returns:
the default color for visited links

Definition at line 462 of file kglobalsettings.cpp.

bool KGlobalSettings::visualActivate ( ) [static]

Checks whether to show feedback when in item (specifically an icon) is activated.

Returns:
whether to show some feedback when an item is activated.

Definition at line 259 of file kglobalsettings.cpp.

unsigned int KGlobalSettings::visualActivateSpeed ( ) [static]

Returns the speed of the visual activation feedback.

Returns:
the speed of the visual activation feedback, between 0 for minimum and 100 for maximum speed

Definition at line 265 of file kglobalsettings.cpp.

bool KGlobalSettings::wheelMouseZooms ( ) [static]

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

But TQTextEdit 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
Since:
3.1

Definition at line 855 of file kglobalsettings.cpp.

TQFont KGlobalSettings::windowTitleFont ( ) [static]

Returns the default window title font.

Returns:
the default window title font.

Definition at line 534 of file kglobalsettings.cpp.


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

kdecore

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

kdecore

Skip menu "kdecore"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kdecore by doxygen 1.7.6.1
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |