Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KGlobalSettings Class Reference

#include <kglobalsettings.h>

List of all members.

Public Types

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

Static Public Methods

int dndEventDelay ()
bool singleClick ()
TearOffHandle insertTearOffHandle ()
bool changeCursorOverIcon ()
bool visualActivate ()
unsigned int visualActivateSpeed ()
int autoSelectDelay ()
int contextMenuKey ()
bool showContextMenusOnPress ()
Completion completionMode ()
KMouseSettings & mouseSettings ()
QString desktopPath ()
QString autostartPath ()
QString trashPath ()
QString documentPath ()
QColor toolBarHighlightColor ()
QColor inactiveTitleColor ()
QColor inactiveTextColor ()
QColor activeTitleColor ()
QColor activeTextColor ()
int contrast ()
QColor baseColor ()
QColor textColor ()
QColor linkColor ()
QColor visitedLinkColor ()
QColor highlightedTextColor ()
QColor highlightColor ()
QColor alternateBackgroundColor ()
QColor calculateAlternateBackgroundColor (const QColor &base)
QFont generalFont ()
QFont fixedFont ()
QFont toolBarFont ()
QFont menuFont ()
QFont windowTitleFont ()
QFont taskbarFont ()
QFont largeFont (const QString &text=QString::null)
bool isMultiHead ()
bool wheelMouseZooms ()

Detailed Description

Access the KDE global configuration.

Author:
David Faure <faure@kde.org>
Version:
Id:
kglobalsettings.h,v 1.42 2002/09/28 12:28:47 tjansen Exp

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

Enumeration values:
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 164 of file kglobalsettings.h.

Referenced by KCompletionBase::completionMode(), and KCompletion::completionMode().

enum KGlobalSettings::TearOffHandle
 

This enum describes the return type for insertTearOffHandle() wether 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
Enumeration values:
Disable  disable tear-off handles
ApplicationLevel  enable on application level
Enable  enable tear-off handles

Definition at line 103 of file kglobalsettings.h.

Member Function Documentation

QColor KGlobalSettings::activeTextColor (    )  [static]
 

The default color to use for active texts.

Returns:
the active text color

QColor KGlobalSettings::activeTitleColor (    )  [static]
 

The default color to use for active titles.

Returns:
the active title color

QColor 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

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.

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

The path to the autostart directory of the current user.

Returns:
the path of the autostart directory

Definition at line 224 of file kglobalsettings.h.

QColor KGlobalSettings::baseColor (    )  [static]
 

Returns the default base (background) color.

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

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

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

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

bool KGlobalSettings::changeCursorOverIcon (    )  [static]
 

Checks whether the cursor changes over icons.

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

Completion KGlobalSettings::completionMode (    )  [static]
 

Returns the preferred completion mode setting.

Returns:
Completion. Default is CompletionPopup.

int KGlobalSettings::contextMenuKey (    )  [static]
 

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

Returns:
the key that pops up context menus.

int KGlobalSettings::contrast (    )  [static]
 

Returns the contrast for borders.

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

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

The path to the desktop directory of the current user.

Returns:
the user's desktop directory

Definition at line 218 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 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

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

The path where documents are stored of the current user.

Returns:
the path of the document directory

Definition at line 236 of file kglobalsettings.h.

QFont KGlobalSettings::fixedFont (    )  [static]
 

Returns the default fixed font.

Returns:
the default fixed font.

QFont KGlobalSettings::generalFont (    )  [static]
 

Returns the default general font.

Returns:
the default general font.

QColor KGlobalSettings::highlightColor (    )  [static]
 

Returns the default color for text highlights.

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

QColor KGlobalSettings::highlightedTextColor (    )  [static]
 

Returns the default color for highlighted text.

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

QColor KGlobalSettings::inactiveTextColor (    )  [static]
 

The default color to use for inactive texts.

Returns:
the inactive text color

QColor KGlobalSettings::inactiveTitleColor (    )  [static]
 

The default color to use for inactive titles.

Returns:
the inactive title color

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

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

Returns:
true if the user chose multi head

QFont KGlobalSettings::largeFont (  const QString &    text = QString::null )  [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
Since:
3.1

QColor KGlobalSettings::linkColor (    )  [static]
 

Returns the default link color.

Returns:
the default link color

QFont KGlobalSettings::menuFont (    )  [static]
 

Returns the default menu font.

Returns:
the default menu font.

KMouseSettings& KGlobalSettings::mouseSettings (    )  [static]
 

This returns the current mouse settings.

Returns:
the current mouse settings

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).

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.

QFont KGlobalSettings::taskbarFont (    )  [static]
 

Returns the default taskbar font.

Returns:
the default taskbar font.

QColor KGlobalSettings::textColor (    )  [static]
 

Returns the default text color.

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

QFont KGlobalSettings::toolBarFont (    )  [static]
 

Returns the default toolbar font.

Returns:
the default toolbar font.

QColor KGlobalSettings::toolBarHighlightColor (    )  [static]
 

The default color to use when highlighting toolbar buttons.

Returns:
the toolbar highlight color

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

The path to the trash directory of the current user.

Returns:
the path of the trash directory

Definition at line 230 of file kglobalsettings.h.

QColor KGlobalSettings::visitedLinkColor (    )  [static]
 

Returns the default color for visited links.

Returns:
the default color for visited links

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.

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

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

QFont KGlobalSettings::windowTitleFont (    )  [static]
 

Returns the default window title font.

Returns:
the default window title font.

The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:14 2003 for kdelibs by doxygen1.2.18