kglobalsettings.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright (C) 2000,2006 David Faure <faure@kde.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/
#ifndef _KGLOBALSETTINGS_H
#define _KGLOBALSETTINGS_H

#include <kdeui_export.h>
#include <ksharedconfig.h>
#include <QtCore/QObject>
#include <QtCore/QString>
#include <QtGui/QPalette>

#define KDE_DEFAULT_SINGLECLICK true
#define KDE_DEFAULT_SMOOTHSCROLL true
#define KDE_DEFAULT_INSERTTEAROFFHANDLES 0
#define KDE_DEFAULT_AUTOSELECTDELAY -1
#define KDE_DEFAULT_CHANGECURSOR true
#define KDE_DEFAULT_LARGE_CURSOR false
#define KDE_DEFAULT_WHEEL_ZOOM false
#ifdef Q_WS_MAEMO_5
#define KDE_DEFAULT_ICON_ON_PUSHBUTTON false
#else
#define KDE_DEFAULT_ICON_ON_PUSHBUTTON true
#endif
#define KDE_DEFAULT_OPAQUE_RESIZE true
#define KDE_DEFAULT_BUTTON_LAYOUT 0
#define KDE_DEFAULT_SHADE_SORT_COLUMN true
#define KDE_DEFAULT_ALLOW_DEFAULT_BACKGROUND_IMAGES true
#define KDE_DEFAULT_NATURAL_SORTING true

class KUrl;

class QColor;
class QFont;
class QPoint;
class QRect;
class QWidget;

class KDEUI_EXPORT KGlobalSettings : public QObject
{
    Q_OBJECT

public:
    ~KGlobalSettings();

    static int dndEventDelay();

    static bool singleClick();

    static bool smoothScroll();

    enum TearOffHandle {
        Disable = 0, 
        ApplicationLevel, 
        Enable 
    };

    static TearOffHandle insertTearOffHandle();

    static bool changeCursorOverIcon();

    static int autoSelectDelay();

#ifndef KDE_NO_DEPRECATED
    static KDE_DEPRECATED int contextMenuKey ();
#endif

    static bool showContextMenusOnPress ();

    enum Completion {
        CompletionNone=1,
        CompletionAuto,
        CompletionMan,
        CompletionShell,
        CompletionPopup,
        CompletionPopupAuto
    };

    static Completion completionMode();

    struct KMouseSettings
    {
        enum { RightHanded = 0, LeftHanded = 1 };
        int handed; // left or right
    };

    static KMouseSettings & mouseSettings();

    static QString desktopPath();

    static QString autostartPath();

    static QString documentPath();

    static QString musicPath();

    static QString videosPath();

    static QString downloadPath();

    static QString picturesPath();

    static QColor inactiveTitleColor();

    static QColor inactiveTextColor();

    static QColor activeTitleColor();

    static QColor activeTextColor();

    static int contrast();

    static qreal contrastF(const KSharedConfigPtr &config = KSharedConfigPtr());

    static bool shadeSortColumn();

    static bool allowDefaultBackgroundImages();

    static QFont generalFont();

    static QFont fixedFont();

    static QFont toolBarFont();

    static QFont menuFont();

    static QFont windowTitleFont();

    static QFont taskbarFont();

    static QFont largeFont(const QString &text = QString());

    static QFont smallestReadableFont();

    static bool isMultiHead();

    static bool wheelMouseZooms();

    static QRect splashScreenDesktopGeometry();

    static QRect desktopGeometry(const QPoint& point);

    static QRect desktopGeometry(const QWidget* w);

    static bool showIconsOnPushButtons();

    static bool naturalSorting();

    enum GraphicEffect {
        NoEffects               = 0x0000, 
        GradientEffects         = 0x0001, 
        SimpleAnimationEffects  = 0x0002, 
        ComplexAnimationEffects = 0x0006  
    };

    Q_DECLARE_FLAGS(GraphicEffects, GraphicEffect)

    
    static GraphicEffects graphicEffectsLevel();

    static GraphicEffects graphicEffectsLevelDefault();

    static bool showFilePreview(const KUrl &);

    static bool opaqueResize();

    static int buttonLayout();

    static QPalette createApplicationPalette(const KSharedConfigPtr &config = KSharedConfigPtr());

    static QPalette createNewApplicationPalette(const KSharedConfigPtr &config = KSharedConfigPtr());

    enum ChangeType { PaletteChanged = 0, FontChanged, StyleChanged,
                      SettingsChanged, IconChanged, CursorChanged,
                      ToolbarStyleChanged, ClipboardConfigChanged,
                      BlockShortcuts, NaturalSortingChanged };

    static void emitChange(ChangeType changeType, int arg = 0);

    static KGlobalSettings* self();

    enum ActivateOption {
        ApplySettings = 0x1, 
        ListenForChanges = 0x2 
    };
    Q_DECLARE_FLAGS(ActivateOptions, ActivateOption)

    
    void activate(); //KDE5: Merge with the overloaded method below

    void activate(ActivateOptions options);

    enum SettingsCategory { SETTINGS_MOUSE, SETTINGS_COMPLETION, SETTINGS_PATHS,
                            SETTINGS_POPUPMENU, SETTINGS_QT, SETTINGS_SHORTCUTS,
                            SETTINGS_LOCALE, SETTINGS_STYLE };

Q_SIGNALS:
    void kdisplayPaletteChanged();

    void kdisplayStyleChanged();

    void kdisplayFontChanged();

    void appearanceChanged();

    void toolbarAppearanceChanged(int);

    void settingsChanged(int category);

    void iconChanged(int group);

    void cursorChanged();

    void blockShortcuts(int data);

    void naturalSortingChanged();

private:
    friend class KApplication;

    KGlobalSettings();

    class Private;
    Private* const d;

    Q_PRIVATE_SLOT(d, void _k_slotNotifyChange(int, int))
};

Q_DECLARE_OPERATORS_FOR_FLAGS(KGlobalSettings::GraphicEffects)
Q_DECLARE_OPERATORS_FOR_FLAGS(KGlobalSettings::ActivateOptions)

#endif