highlightwindow.cpp 10.5 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 23 24 25 26 27 28 29 30
/********************************************************************
 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"

#include <kdebug.h>

namespace KWin
{

KWIN_EFFECT( highlightwindow, HighlightWindowEffect )

HighlightWindowEffect::HighlightWindowEffect()
31 32
    : m_finishing( false )
    , m_fadeDuration( double( animationTime( 150 )))
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
    , m_monitorWindow( NULL )
    {
    m_atom = XInternAtom( display(), "_KDE_WINDOW_HIGHLIGHT", False );
    effects->registerPropertyType( m_atom, true );

    // Announce support by creating a dummy version on the root window
    unsigned char dummy = 0;
    XChangeProperty( display(), rootWindow(), m_atom, m_atom, 8, PropModeReplace, &dummy, 1 );
    }

HighlightWindowEffect::~HighlightWindowEffect()
    {
    XDeleteProperty( display(), rootWindow(), m_atom );
    effects->registerPropertyType( m_atom, false );
    }

49
static bool isInitiallyHidden( EffectWindow* w )
50
    { // Is the window initially hidden until it is highlighted?
51 52 53
    return !w->visibleInClientGroup() || !w->isOnCurrentDesktop();
    }

54 55
void HighlightWindowEffect::prePaintWindow( EffectWindow* w, WindowPrePaintData& data, int time )
    {
56
    // Calculate window opacities
57
    if( !m_highlightedWindows.isEmpty() )
58 59
        { // Initial fade out and changing highlight animation
        double oldOpacity = m_windowOpacity[w];
60
        if( m_highlightedWindows.contains( w ))
61
            m_windowOpacity[w] = qMin( 1.0, m_windowOpacity[w] + time / m_fadeDuration );
62
        else if( w->isNormalWindow() || w->isDialog() ) // Only fade out windows
63 64
            m_windowOpacity[w] = qMax( isInitiallyHidden( w ) ? 0.0 : 0.15,
                m_windowOpacity[w] - time / m_fadeDuration );
65 66 67 68 69 70 71 72 73

        if( m_windowOpacity[w] != 1.0 )
            data.setTranslucent();
        if( oldOpacity != m_windowOpacity[w] )
            w->addRepaintFull();
        }
    else if( m_finishing && m_windowOpacity.contains( w ))
        { // Final fading back in animation
        double oldOpacity = m_windowOpacity[w];
74 75 76 77
        if( isInitiallyHidden( w ))
            m_windowOpacity[w] = qMax( 0.0, m_windowOpacity[w] - time / m_fadeDuration );
        else
            m_windowOpacity[w] = qMin( 1.0, m_windowOpacity[w] + time / m_fadeDuration );
78 79 80 81 82 83

        if( m_windowOpacity[w] != 1.0 )
            data.setTranslucent();
        if( oldOpacity != m_windowOpacity[w] )
            w->addRepaintFull();

84
        if( m_windowOpacity[w] == 1.0 || m_windowOpacity[w] == 0.0 )
85 86 87
            m_windowOpacity.remove( w ); // We default to 1.0
        }

88 89 90 91
    // Show tabbed windows and windows on other desktops if highlighted
    if( m_windowOpacity.contains( w ) && m_windowOpacity[w] != 0.0 )
        {
        if( !w->visibleInClientGroup() )
92
            w->enablePainting( EffectWindow::PAINT_DISABLED_BY_CLIENT_GROUP );
93 94 95 96
        if( !w->isOnCurrentDesktop() )
            w->enablePainting( EffectWindow::PAINT_DISABLED_BY_DESKTOP );
        }

97 98 99 100 101
    effects->prePaintWindow( w, data, time );
    }

void HighlightWindowEffect::paintWindow( EffectWindow* w, int mask, QRegion region, WindowPaintData& data )
    {
102 103
    if( m_windowOpacity.contains( w ))
        data.opacity *= m_windowOpacity[w];
104 105 106 107 108
    effects->paintWindow( w, mask, region, data );
    }

void HighlightWindowEffect::windowAdded( EffectWindow* w )
    {
109
    if( !m_highlightedWindows.isEmpty() )
110
        { // The effect is activated thus we need to add it to the opacity hash
111
        if( w->isNormalWindow() || w->isDialog() ) // Only fade out windows
112
            m_windowOpacity[w] = isInitiallyHidden( w ) ? 0.0 : 0.15;
113 114 115
        else
            m_windowOpacity[w] = 1.0;
        }
116 117 118
    propertyNotify( w, m_atom ); // Check initial value
    }

119
void HighlightWindowEffect::windowClosed( EffectWindow* w )
120
    {
121 122
    if( m_monitorWindow == w ) // The monitoring window was destroyed
        finishHighlighting();
123 124
    }

125 126 127 128 129
void HighlightWindowEffect::windowDeleted( EffectWindow* w )
    {
    m_windowOpacity.remove( w );
    }

130 131
void HighlightWindowEffect::propertyNotify( EffectWindow* w, long a )
    {
132
    if( a != m_atom )
133 134
        return; // Not our atom

135 136 137
    // if the window is null, the property was set on the root window - see events.cpp
    QByteArray byteData = w ? w->readProperty( m_atom, m_atom, 32 ) :
                              effects->readRootProperty( m_atom, m_atom, 32 );
138
    if( byteData.length() < 1 )
139 140 141 142
        { // Property was removed, clearing highlight
        finishHighlighting();
        return;
        }
143 144 145
    long* data = reinterpret_cast<long*>( byteData.data() );

    if( !data[0] )
146
        { // Purposely clearing highlight by issuing a NULL target
147
        finishHighlighting();
148 149 150
        return;
        }
    m_monitorWindow = w;
151 152
    bool found = false;
    int length = byteData.length() / sizeof( data[0] );
153 154
    //foreach( EffectWindow* e, m_highlightedWindows )
    //    effects->setElevatedWindow( e, false );
155
    m_highlightedWindows.clear();
156
    for( int i=0; i<length; i++ )
157
        {
158 159 160 161 162 163
        EffectWindow* foundWin = effects->findWindow( data[i] );
        if( !foundWin )
            {
            kDebug(1212) << "Invalid window targetted for highlight. Requested:" << data[i];
            continue;
            }
164
        if( !foundWin->isMinimized() )
165
            {
166
            m_highlightedWindows.append( foundWin );
167 168 169
            // 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 );
170
            }
171
        found = true;
172
        }
173
    if( !found )
174 175
        {
        finishHighlighting();
176
        return;
177
        }
178
    prepareHighlighting();
179 180
    if( w )
        m_windowOpacity[w] = 1.0; // Because it's not in stackingOrder() yet
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205

    /* TODO: Finish thumbnails of offscreen windows, not sure if it's worth it though
    if( !m_highlightedWindow->isOnCurrentDesktop() )
        { // 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
        if( windowAspect > areaAspect )
            // 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() ));
        if( thumbRect.width() >= m_highlightedWindow->width() )
            // 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
206 207
        QPoint direction = effects->desktopGridCoords( m_highlightedWindow->desktop() ) -
            effects->desktopGridCoords( effects->currentDesktop() );
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238

        // 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() );
        if( desktopLine.intersect( testLine, &arrowTip ) != QLineF::BoundedIntersection )
            {
            testLine = QLineF( // Right
                outerArea.x() + outerArea.width(), outerArea.y(),
                outerArea.x() + outerArea.width(), outerArea.y() + outerArea.height() );
            if( desktopLine.intersect( testLine, &arrowTip ) != QLineF::BoundedIntersection )
                {
                testLine = QLineF( // Bottom
                    outerArea.x() + outerArea.width(), outerArea.y() + outerArea.height(),
                    outerArea.x(), outerArea.y() + outerArea.height() );
                if( desktopLine.intersect( testLine, &arrowTip ) != QLineF::BoundedIntersection )
                    {
                    testLine = QLineF( // Left
                        outerArea.x(), outerArea.y() + outerArea.height(),
                        outerArea.x(), outerArea.y() );
                    desktopLine.intersect( testLine, &arrowTip ); // Should never fail
                    }
                }
            }
        m_arrowTip = arrowTip.toPoint();
        } */
239 240 241 242 243 244 245 246
    }

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

void HighlightWindowEffect::finishHighlighting()
    {
    m_finishing = true;
    m_monitorWindow = NULL;
254
    m_highlightedWindows.clear();
255 256 257
    }

} // namespace