highlightwindow.cpp 11.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
/********************************************************************
 KWin - the KDE window manager
 This file is part of the KDE project.

Copyright (C) 2009 Lucas Murray <lmurray@undefinedfire.com>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program 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 General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*********************************************************************/

#include "highlightwindow.h"

23
#include <QDebug>
24 25 26 27

namespace KWin
{

28
KWIN_EFFECT(highlightwindow, HighlightWindowEffect)
29 30

HighlightWindowEffect::HighlightWindowEffect()
31
    : m_finishing(false)
32
    , m_fadeDuration(float(animationTime(150)))
33 34
    , m_monitorWindow(NULL)
{
35
    m_atom = effects->announceSupportProperty("_KDE_WINDOW_HIGHLIGHT", this);
36 37 38 39
    connect(effects, SIGNAL(windowAdded(KWin::EffectWindow*)), this, SLOT(slotWindowAdded(KWin::EffectWindow*)));
    connect(effects, SIGNAL(windowClosed(KWin::EffectWindow*)), this, SLOT(slotWindowClosed(KWin::EffectWindow*)));
    connect(effects, SIGNAL(windowDeleted(KWin::EffectWindow*)), this, SLOT(slotWindowDeleted(KWin::EffectWindow*)));
    connect(effects, SIGNAL(propertyNotify(KWin::EffectWindow*,long)), this, SLOT(slotPropertyNotify(KWin::EffectWindow*,long)));
40
}
41 42

HighlightWindowEffect::~HighlightWindowEffect()
43 44
{
}
45

46 47 48
static bool isInitiallyHidden(EffectWindow* w)
{
    // Is the window initially hidden until it is highlighted?
Thomas Lübking's avatar
Thomas Lübking committed
49
    return w->isMinimized() || !w->isCurrentTab() || !w->isOnCurrentDesktop();
50
}
51

52 53
void HighlightWindowEffect::prePaintWindow(EffectWindow* w, WindowPrePaintData& data, int time)
{
54
    // Calculate window opacities
55
    QHash<EffectWindow*, float>::iterator opacity = m_windowOpacity.find(w);
56 57
    if (!m_highlightedWindows.isEmpty()) {
        // Initial fade out and changing highlight animation
58 59 60
        if (opacity == m_windowOpacity.end())
            opacity = m_windowOpacity.insertMulti(w, 0.0f);
        float oldOpacity = *opacity;
61
        if (m_highlightedWindows.contains(w))
62
            *opacity = qMin(1.0f, oldOpacity + time / m_fadeDuration);
63
        else if (w->isNormalWindow() || w->isDialog())   // Only fade out windows
64
            *opacity = qMax(isInitiallyHidden(w) ? 0.0f : 0.15f, oldOpacity - time / m_fadeDuration);
65

66
        if (*opacity < 0.98f)
67
            data.setTranslucent();
68 69
        if (oldOpacity != *opacity)
            effects->addRepaint(w->geometry().adjusted(-16,-16,16,32)); // add some padding. w->addRepaintFull() is wrong for at least isInitiallyHidden ...
70 71
    } else if (m_finishing && m_windowOpacity.contains(w)) {
        // Final fading back in animation
72 73 74
        if (opacity == m_windowOpacity.end())
            opacity = m_windowOpacity.insert(w, 0.0f);
        float oldOpacity = *opacity;
75
        if (isInitiallyHidden(w))
76
            *opacity = qMax(0.0f, oldOpacity - time / m_fadeDuration);
77
        else
78
            *opacity = qMin(1.0f, oldOpacity + time / m_fadeDuration);
79

80
        if (*opacity < 0.98f)
81
            data.setTranslucent();
82 83
        if (oldOpacity != *opacity)
            effects->addRepaint(w->geometry().adjusted(-16,-16,16,32)); // ... see above ... because the window is pot. gone in the last pass
84

85
        if (*opacity > 0.98f || *opacity < 0.02f)
86 87
            m_windowOpacity.remove(w);   // We default to 1.0
    }
88

89
    // Show tabbed windows and windows on other desktops if highlighted
90 91 92
    if (opacity != m_windowOpacity.end() && *opacity > 0.01) {
        if (w->isMinimized())
            w->enablePainting(EffectWindow::PAINT_DISABLED_BY_MINIMIZE);
Thomas Lübking's avatar
Thomas Lübking committed
93 94
        if (!w->isCurrentTab())
            w->enablePainting(EffectWindow::PAINT_DISABLED_BY_TAB_GROUP);
95 96
        if (!w->isOnCurrentDesktop())
            w->enablePainting(EffectWindow::PAINT_DISABLED_BY_DESKTOP);
97 98
    }

99 100 101 102 103
    effects->prePaintWindow(w, data, time);
}

void HighlightWindowEffect::paintWindow(EffectWindow* w, int mask, QRegion region, WindowPaintData& data)
{
104
    data.multiplyOpacity(m_windowOpacity.value(w, 1.0f));
105 106
    effects->paintWindow(w, mask, region, data);
}
107

108
void HighlightWindowEffect::slotWindowAdded(EffectWindow* w)
109 110 111
{
    if (!m_highlightedWindows.isEmpty()) {
        // The effect is activated thus we need to add it to the opacity hash
112 113 114 115 116 117 118
        foreach (const WId id, m_highlightedIds) {
            if (w == effects->findWindow(id)) {
                m_windowOpacity[w] = 1.0; // this window was demanded to be highlighted before it appeared
                return;
            }
        }
        m_windowOpacity[w] = 0.15; // this window is not currently highlighted
119
    }
120
    slotPropertyNotify(w, m_atom, w);   // Check initial value
121
}
122

123
void HighlightWindowEffect::slotWindowClosed(EffectWindow* w)
124 125
{
    if (m_monitorWindow == w)   // The monitoring window was destroyed
126
        finishHighlighting();
127
}
128

129
void HighlightWindowEffect::slotWindowDeleted(EffectWindow* w)
130 131 132
{
    m_windowOpacity.remove(w);
}
133

134
void HighlightWindowEffect::slotPropertyNotify(EffectWindow* w, long a, EffectWindow *addedWindow)
135 136
{
    if (a != m_atom)
137 138
        return; // Not our atom

139
    // if the window is null, the property was set on the root window - see events.cpp
140 141 142 143
    QByteArray byteData = w ? w->readProperty(m_atom, m_atom, 32) :
                          effects->readRootProperty(m_atom, m_atom, 32);
    if (byteData.length() < 1) {
        // Property was removed, clearing highlight
144 145
        if (!addedWindow || w != addedWindow)
            finishHighlighting();
146
        return;
147
    }
148
    auto* data = reinterpret_cast<uint32_t*>(byteData.data());
149

150 151
    if (!data[0]) {
        // Purposely clearing highlight by issuing a NULL target
152
        finishHighlighting();
153
        return;
154
    }
155
    m_monitorWindow = w;
156
    bool found = false;
157 158
    int length = byteData.length() / sizeof(data[0]);
    //foreach ( EffectWindow* e, m_highlightedWindows )
159
    //    effects->setElevatedWindow( e, false );
160
    m_highlightedWindows.clear();
161
    m_highlightedIds.clear();
162
    for (int i = 0; i < length; i++) {
163
        m_highlightedIds << data[i];
164 165
        EffectWindow* foundWin = effects->findWindow(data[i]);
        if (!foundWin) {
166
            qDebug() << "Invalid window targetted for highlight. Requested:" << data[i];
167
            continue; // might come in later.
168
        }
169 170 171 172
        m_highlightedWindows.append(foundWin);
        // TODO: We cannot just simply elevate the window as this will elevate it over
        // Plasma tooltips and other such windows as well
        //effects->setElevatedWindow( foundWin, true );
173 174 175
        found = true;
    }
    if (!found) {
176
        finishHighlighting();
177
        return;
178
    }
179
    prepareHighlighting();
180
    if (w)
181
        m_windowOpacity[w] = 1.0; // Because it's not in stackingOrder() yet
182 183

    /* TODO: Finish thumbnails of offscreen windows, not sure if it's worth it though
184
    if ( !m_highlightedWindow->isOnCurrentDesktop() )
185 186 187 188 189 190 191 192 193 194 195 196
        { // Window is offscreen, determine thumbnail position
        QRect screenArea = effects->clientArea( MaximizeArea ); // Workable area of the active screen
        QRect outerArea = outerArea.adjusted( outerArea.width() / 10, outerArea.height() / 10,
            -outerArea.width() / 10, -outerArea.height() / 10 ); // Add 10% margin around the edge
        QRect innerArea = outerArea.adjusted( outerArea.width() / 40, outerArea.height() / 40,
            -outerArea.width() / 40, -outerArea.height() / 40 ); // Outer edge of the thumbnail border (2.5%)
        QRect thumbArea = outerArea.adjusted( 20, 20, -20, -20 ); // Outer edge of the thumbnail (20px)

        // Determine the maximum size that we can make the thumbnail within the innerArea
        double areaAspect = double( thumbArea.width() ) / double( thumbArea.height() );
        double windowAspect = aspectRatio( m_highlightedWindow );
        QRect thumbRect; // Position doesn't matter right now, but it will later
197
        if ( windowAspect > areaAspect )
198 199 200 201
            // Top/bottom will touch first
            thumbRect = QRect( 0, 0, widthForHeight( thumbArea.height() ), thumbArea.height() );
        else // Left/right will touch first
            thumbRect = QRect( 0, 0, thumbArea.width(), heightForWidth( thumbArea.width() ));
202
        if ( thumbRect.width() >= m_highlightedWindow->width() )
203 204 205 206
            // Area is larger than the window, just use the window's size
            thumbRect = m_highlightedWindow->geometry();

        // Determine position of desktop relative to the current one
207 208
        QPoint direction = effects->desktopGridCoords( m_highlightedWindow->desktop() ) -
            effects->desktopGridCoords( effects->currentDesktop() );
209 210 211 212 213 214 215 216 217 218

        // Draw a line from the center of the current desktop to the center of the target desktop.
        QPointF desktopLine( 0, 0, direction.x() * screenArea.width(), direction.y() * screenArea.height() );
        desktopLeft.translate( screenArea.width() / 2, screenArea.height() / 2 ); // Move to the screen center

        // Take the point where the line crosses the outerArea, this will be the tip of our arrow
        QPointF arrowTip;
        QLineF testLine( // Top
            outerArea.x(), outerArea.y(),
            outerArea.x() + outerArea.width(), outerArea.y() );
219
        if ( desktopLine.intersect( testLine, &arrowTip ) != QLineF::BoundedIntersection )
220 221 222 223
            {
            testLine = QLineF( // Right
                outerArea.x() + outerArea.width(), outerArea.y(),
                outerArea.x() + outerArea.width(), outerArea.y() + outerArea.height() );
224
            if ( desktopLine.intersect( testLine, &arrowTip ) != QLineF::BoundedIntersection )
225 226 227 228
                {
                testLine = QLineF( // Bottom
                    outerArea.x() + outerArea.width(), outerArea.y() + outerArea.height(),
                    outerArea.x(), outerArea.y() + outerArea.height() );
229
                if ( desktopLine.intersect( testLine, &arrowTip ) != QLineF::BoundedIntersection )
230 231 232 233 234 235 236 237 238 239
                    {
                    testLine = QLineF( // Left
                        outerArea.x(), outerArea.y() + outerArea.height(),
                        outerArea.x(), outerArea.y() );
                    desktopLine.intersect( testLine, &arrowTip ); // Should never fail
                    }
                }
            }
        m_arrowTip = arrowTip.toPoint();
        } */
240
}
241 242

void HighlightWindowEffect::prepareHighlighting()
243
{
244 245
    // Create window data for every window. Just calling [w] creates it.
    m_finishing = false;
246 247 248 249 250 251
    foreach (EffectWindow * w, effects->stackingOrder()) {
        if (!m_windowOpacity.contains(w))    // Just in case we are still finishing from last time
            m_windowOpacity.insertMulti(w, isInitiallyHidden(w) ? 0.0 : 1.0);
        if (!m_highlightedWindows.isEmpty())
            m_highlightedWindows.at(0)->addRepaintFull();
    }
252
}
253 254

void HighlightWindowEffect::finishHighlighting()
255
{
256 257
    m_finishing = true;
    m_monitorWindow = NULL;
258
    m_highlightedWindows.clear();
259 260
    if (!m_windowOpacity.isEmpty())
        m_windowOpacity.constBegin().key()->addRepaintFull();
261
}
262

263 264 265 266 267
bool HighlightWindowEffect::isActive() const
{
    return !m_windowOpacity.isEmpty();
}

268
} // namespace