kwin/libkdecorations/kdecoration.cpp

/*****************************************************************
This file is part of the KDE project.

Copyright (C) 2003 Lubos Lunak <l.lunak@kde.org>

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
******************************************************************/

#include "kdecoration.h"
#include "kdecoration_p.h"

#include <kdebug.h>
#include <QApplication>
#include <QMenu>
#include <kglobal.h>
#include <assert.h>
#include <X11/Xlib.h>
#include <fixx11h.h>
#include <QX11Info>

#include "kdecorationfactory.h"
#include "kdecorationbridge.h"


/*

Extending KDecoration:
======================

If KDecoration will ever need to be extended in a way that'd break binary compatibility
(i.e. adding new virtual methods most probably), new class KDecoration2 should be
inherited from KDecoration and those methods added there. Code that would depend
on the new functionality could then dynamic_cast<> to KDecoration2 to check whether
it is available and use it.

KCommonDecoration would have to be extended the same way, adding KCommonDecoration2
inheriting KCommonDecoration and adding the new API matching KDecoration2.

*/

class KDecorationPrivate
{
public:
    KDecorationPrivate()
        : alphaEnabled(false)
    {
    }
    bool alphaEnabled;
};

KDecorationOptions* KDecoration::options_;

KDecoration::KDecoration(KDecorationBridge* bridge, KDecorationFactory* factory)
    :   bridge_(bridge),
        w_(NULL),
        factory_(factory),
        d(new KDecorationPrivate())
{
    factory->addDecoration(this);
}

KDecoration::~KDecoration()
{
    factory()->removeDecoration(this);
    delete w_;
    delete d;
}

const KDecorationOptions* KDecoration::options()
{
    return options_;
}

void KDecoration::createMainWidget(Qt::WFlags flags)
{
    // FRAME check flags?
    QWidget *w = new QWidget(initialParentWidget(), initialWFlags() | flags);
    w->setObjectName(QLatin1String("decoration widget"));
    w->setAttribute(Qt::WA_PaintOnScreen);
    if (options()->showTooltips())
        w->setAttribute(Qt::WA_AlwaysShowToolTips);
    setMainWidget(w);
}

void KDecoration::setMainWidget(QWidget* w)
{
    assert(w_ == NULL);
    w_ = w;
    w->setMouseTracking(true);
    widget()->resize(geometry().size());
}

QWidget* KDecoration::initialParentWidget() const
{
    return bridge_->initialParentWidget();
}

Qt::WFlags KDecoration::initialWFlags() const
{
    return bridge_->initialWFlags();
}

bool KDecoration::isActive() const
{
    return bridge_->isActive();
}

bool KDecoration::isCloseable() const
{
    return bridge_->isCloseable();
}

bool KDecoration::isMaximizable() const
{
    return bridge_->isMaximizable();
}

KDecoration::MaximizeMode KDecoration::maximizeMode() const
{
    return bridge_->maximizeMode();
}

KDecoration::QuickTileMode KDecoration::quickTileMode() const
{
    return bridge_->quickTileMode();
}

bool KDecoration::isMinimizable() const
{
    return bridge_->isMinimizable();
}

bool KDecoration::providesContextHelp() const
{
    return bridge_->providesContextHelp();
}

int KDecoration::desktop() const
{
    return bridge_->desktop();
}

bool KDecoration::isModal() const
{
    return bridge_->isModal();
}

bool KDecoration::isShadeable() const
{
    return bridge_->isShadeable();
}

bool KDecoration::isShade() const
{
    return bridge_->isShade();
}

bool KDecoration::isSetShade() const
{
    return bridge_->isSetShade();
}

bool KDecoration::keepAbove() const
{
    return bridge_->keepAbove();
}

bool KDecoration::keepBelow() const
{
    return bridge_->keepBelow();
}

bool KDecoration::isMovable() const
{
    return bridge_->isMovable();
}

bool KDecoration::isResizable() const
{
    return bridge_->isResizable();
}

NET::WindowType KDecoration::windowType(unsigned long supported_types) const
{
    // this one is also duplicated in KDecorationFactory
    return bridge_->windowType(supported_types);
}

QIcon KDecoration::icon() const
{
    return bridge_->icon();
}

QString KDecoration::caption() const
{
    return bridge_->caption();
}

void KDecoration::processMousePressEvent(QMouseEvent* e)
{
    return bridge_->processMousePressEvent(e);
}

void KDecoration::showWindowMenu(const QRect &pos)
{
    bridge_->showWindowMenu(pos);
}

void KDecoration::showWindowMenu(QPoint pos)
{
    bridge_->showWindowMenu(pos);
}

void KDecoration::showApplicationMenu(const QPoint &p)
{
    bridge_->showApplicationMenu(p);
}

bool KDecoration::menuAvailable() const
{
    return bridge_->menuAvailable();
}

void KDecoration::performWindowOperation(WindowOperation op)
{
    bridge_->performWindowOperation(op);
}

void KDecoration::setMask(const QRegion& reg, int mode)
{
    bridge_->setMask(reg, mode);
}

void KDecoration::clearMask()
{
    bridge_->setMask(QRegion(), 0);
}

bool KDecoration::isPreview() const
{
    return bridge_->isPreview();
}

QRect KDecoration::geometry() const
{
    return bridge_->geometry();
}

QRect KDecoration::iconGeometry() const
{
    return bridge_->iconGeometry();
}

QRegion KDecoration::unobscuredRegion(const QRegion& r) const
{
    return bridge_->unobscuredRegion(r);
}

WId KDecoration::windowId() const
{
    return bridge_->windowId();
}

void KDecoration::closeWindow()
{
    bridge_->closeWindow();
}

void KDecoration::maximize(Qt::MouseButtons button)
{
    performWindowOperation(options()->operationMaxButtonClick(button));
}

void KDecoration::maximize(MaximizeMode mode)
{
    bridge_->maximize(mode);
}

void KDecoration::minimize()
{
    bridge_->minimize();
}

void KDecoration::showContextHelp()
{
    bridge_->showContextHelp();
}

void KDecoration::setDesktop(int desktop)
{
    bridge_->setDesktop(desktop);
}

void KDecoration::toggleOnAllDesktops()
{
    if (isOnAllDesktops())
        setDesktop(bridge_->currentDesktop());
    else
        setDesktop(NET::OnAllDesktops);
}

void KDecoration::titlebarDblClickOperation()
{
    bridge_->titlebarDblClickOperation();
}

void KDecoration::titlebarMouseWheelOperation(int delta)
{
    bridge_->titlebarMouseWheelOperation(delta);
}

void KDecoration::setShade(bool set)
{
    bridge_->setShade(set);
}

void KDecoration::setKeepAbove(bool set)
{
    bridge_->setKeepAbove(set);
}

void KDecoration::setKeepBelow(bool set)
{
    bridge_->setKeepBelow(set);
}

void KDecoration::emitKeepAboveChanged(bool above)
{
    keepAboveChanged(above);
}

void KDecoration::emitKeepBelowChanged(bool below)
{
    keepBelowChanged(below);
}

bool KDecoration::drawbound(const QRect&, bool)
{
    return false;
}

bool KDecoration::windowDocked(Position)
{
    return false;
}

void KDecoration::reset(unsigned long)
{
}

void KDecoration::grabXServer()
{
    bridge_->grabXServer(true);
}

void KDecoration::ungrabXServer()
{
    bridge_->grabXServer(false);
}

KDecoration::Position KDecoration::mousePosition(const QPoint& p) const
{
    const int range = 16;
    int bleft, bright, btop, bbottom;
    borders(bleft, bright, btop, bbottom);
    btop = qMin(btop, 4);   // otherwise whole titlebar would have resize cursor

    Position m = PositionCenter;

    if ((p.x() > bleft && p.x() < widget()->width() - bright)
            && (p.y() > btop && p.y() < widget()->height() - bbottom))
        return PositionCenter;

    if (p.y() <= qMax(range, btop) && p.x() <= qMax(range, bleft))
        m = PositionTopLeft;
    else if (p.y() >= widget()->height() - qMax(range, bbottom)
            && p.x() >= widget()->width() - qMax(range, bright))
        m = PositionBottomRight;
    else if (p.y() >= widget()->height() - qMax(range, bbottom) && p.x() <= qMax(range, bleft))
        m = PositionBottomLeft;
    else if (p.y() <= qMax(range, btop) && p.x() >= widget()->width() - qMax(range, bright))
        m = PositionTopRight;
    else if (p.y() <= btop)
        m = PositionTop;
    else if (p.y() >= widget()->height() - bbottom)
        m = PositionBottom;
    else if (p.x() <= bleft)
        m = PositionLeft;
    else if (p.x() >= widget()->width() - bright)
        m = PositionRight;
    else
        m = PositionCenter;
    return m;
}

QRect KDecoration::transparentRect() const
{
    if (KDecorationBridgeUnstable *bridge2 = dynamic_cast<KDecorationBridgeUnstable*>(bridge_))
        return bridge2->transparentRect();
    else
        return QRect();
}

void KDecoration::setAlphaEnabled(bool enabled)
{
    if (d->alphaEnabled == enabled) {
        return;
    }
    d->alphaEnabled = enabled;
    emit alphaEnabledChanged(enabled);
}

bool KDecoration::isAlphaEnabled() const
{
    return d->alphaEnabled;
}

KDecorationUnstable::KDecorationUnstable(KDecorationBridge* bridge, KDecorationFactory* factory)
    : KDecoration(bridge, factory)
{
    Q_ASSERT(dynamic_cast< KDecorationBridgeUnstable* >(bridge));
}

KDecorationUnstable::~KDecorationUnstable()
{
}

bool KDecorationUnstable::compositingActive() const
{
    return static_cast< KDecorationBridgeUnstable* >(bridge_)->compositingActive();
}

void KDecorationUnstable::padding(int &left, int &right, int &top, int &bottom) const
{
    left = right = top = bottom = 0;
}

//BEGIN Window tabbing

int KDecorationUnstable::tabCount() const
{
    return static_cast< KDecorationBridgeUnstable* >(bridge_)->tabCount();
}

long KDecorationUnstable::tabId(int idx) const
{
    return static_cast< KDecorationBridgeUnstable* >(bridge_)->tabId(idx);
}

QString KDecorationUnstable::caption(int idx) const
{
    return static_cast< KDecorationBridgeUnstable* >(bridge_)->caption(idx);
}

QIcon KDecorationUnstable::icon(int idx) const
{
    return static_cast< KDecorationBridgeUnstable* >(bridge_)->icon(idx);
}

long KDecorationUnstable::currentTabId() const
{
    return static_cast< KDecorationBridgeUnstable* >(bridge_)->currentTabId();
}

void KDecorationUnstable::setCurrentTab(long id)
{
    static_cast< KDecorationBridgeUnstable* >(bridge_)->setCurrentTab(id);
}

void KDecorationUnstable::tab_A_before_B(long A, long B)
{
    static_cast< KDecorationBridgeUnstable* >(bridge_)->tab_A_before_B(A, B);
}

void KDecorationUnstable::tab_A_behind_B(long A, long B)
{
    static_cast< KDecorationBridgeUnstable* >(bridge_)->tab_A_behind_B(A, B);
}

void KDecorationUnstable::untab(long id, const QRect& newGeom)
{
    static_cast< KDecorationBridgeUnstable* >(bridge_)->untab(id, newGeom);
}

void KDecorationUnstable::closeTab(long id)
{
    static_cast< KDecorationBridgeUnstable* >(bridge_)->closeTab(id);
}

void KDecorationUnstable::closeTabGroup()
{
    static_cast< KDecorationBridgeUnstable* >(bridge_)->closeTabGroup();
}

void KDecorationUnstable::showWindowMenu(const QPoint &pos, long id)
{
    static_cast< KDecorationBridgeUnstable* >(bridge_)->showWindowMenu(pos, id);
}

//END tabbing

KDecoration::WindowOperation KDecorationUnstable::buttonToWindowOperation(Qt::MouseButtons button)
{
    return static_cast< KDecorationBridgeUnstable* >(bridge_)->buttonToWindowOperation(button);
}

QRegion KDecoration::region(KDecorationDefines::Region)
{
    return QRegion();
}

KDecorationDefines::Position KDecoration::titlebarPosition()
{
    return PositionTop;
}

QString KDecorationDefines::tabDragMimeType()
{
    return QStringLiteral("text/ClientGroupItem");
}

KDecorationOptions::KDecorationOptions()
    : d(new KDecorationOptionsPrivate)
{
    assert(KDecoration::options_ == NULL);
    KDecoration::options_ = this;
}

KDecorationOptions::~KDecorationOptions()
{
    assert(KDecoration::options_ == this);
    KDecoration::options_ = NULL;
    delete d;
}

QColor KDecorationOptions::color(ColorType type, bool active) const
{
    return(d->colors[type + (active ? 0 : NUM_COLORS)]);
}

QFont KDecorationOptions::font(bool active, bool small) const
{
    if (small)
        return(active ? d->activeFontSmall : d->inactiveFontSmall);
    else
        return(active ? d->activeFont : d->inactiveFont);
}

QPalette KDecorationOptions::palette(ColorType type, bool active) const
{
    int idx = type + (active ? 0 : NUM_COLORS);
    if (d->pal[idx])
        return(*d->pal[idx]);
    // TODO: Why construct the palette this way? Is it worth porting to Qt4?
    //d->pal[idx] = new QPalette(Qt::black, d->colors[idx], d->colors[idx].light(150),
    //                           d->colors[idx].dark(), d->colors[idx].dark(120),
    //                           Qt::black, QApplication::palette().active().
    //                           base());
    d->pal[idx] = new QPalette(d->colors[idx]);
    return(*d->pal[idx]);
}

unsigned long KDecorationOptions::updateSettings(KConfig* config)
{
    return d->updateSettings(config);
}

bool KDecorationOptions::customButtonPositions() const
{
    return d->custom_button_positions;
}

QString KDecorationOptions::titleButtonsLeft() const
{
    return d->title_buttons_left;
}

QString KDecorationOptions::defaultTitleButtonsLeft()
{
    return QStringLiteral("MS");
}

QString KDecorationOptions::titleButtonsRight() const
{
    return d->title_buttons_right;
}

QString KDecorationOptions::defaultTitleButtonsRight()
{
    return QStringLiteral("HIAX");
}

bool KDecorationOptions::showTooltips() const
{
    return d->show_tooltips;
}

KDecorationOptions::BorderSize KDecorationOptions::preferredBorderSize(KDecorationFactory* factory) const
{
    assert(factory != NULL);
    if (d->cached_border_size == BordersCount)   // invalid
        d->cached_border_size = d->findPreferredBorderSize(d->border_size,
                                factory->borderSizes());
    return d->cached_border_size;
}

bool KDecorationOptions::moveResizeMaximizedWindows() const
{
    // TODO KF5: remove function with API break
    return false;
}

KDecorationDefines::WindowOperation KDecorationOptions::operationMaxButtonClick(Qt::MouseButtons button) const
{
    return button == Qt::RightButton ? d->opMaxButtonRightClick :
           button == Qt::MidButton ?   d->opMaxButtonMiddleClick :
           d->opMaxButtonLeftClick;
}

void KDecorationOptions::setOpMaxButtonLeftClick(WindowOperation op)
{
    d->opMaxButtonLeftClick = op;
}

void KDecorationOptions::setOpMaxButtonRightClick(WindowOperation op)
{
    d->opMaxButtonRightClick = op;
}

void KDecorationOptions::setOpMaxButtonMiddleClick(WindowOperation op)
{
    d->opMaxButtonMiddleClick = op;
}

void KDecorationOptions::setBorderSize(BorderSize bs)
{
    d->border_size = bs;
    d->cached_border_size = BordersCount; // invalid
}

void KDecorationOptions::setCustomButtonPositions(bool b)
{
    d->custom_button_positions = b;
}

void KDecorationOptions::setTitleButtonsLeft(const QString& b)
{
    d->title_buttons_left = b;
}

void KDecorationOptions::setTitleButtonsRight(const QString& b)
{
    d->title_buttons_right = b;
}

extern "C" {

int decoration_bridge_version()
{
    return KWIN_DECORATION_BRIDGE_API_VERSION;
}

}

#include "kdecoration.moc"