kwin/clients/oxygen/oxygenclient.h
Hugo Pereira Da Costa 4b6c98b7ac use bias to set window state glow intensity and have emulate faster responding animations
svn path=/trunk/KDE/kdebase/workspace/; revision=1050705
2009-11-17 22:26:36 +00:00

447 lines
13 KiB
C++

#ifndef oxygenclient_h
#define oxygenclient_h
//////////////////////////////////////////////////////////////////////////////
// oxygenclient.h
// -------------------
//
// Copyright (c) 2009 Hugo Pereira Da Costa <hugo.pereira@free.fr>
// Copyright (c) 2003, 2004 David Johnson <david@usermode.org>
// Copyright (c) 2006, 2007 Riccardo Iaconelli <ruphy@fsfe.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 "oxygen.h"
#include "oxygenclientgroupitemdata.h"
#include "oxygenconfiguration.h"
#include "lib/oxygenanimation.h"
#include "lib/helper.h"
#include <kcommondecoration.h>
#include <QBasicTimer>
#include <QTimerEvent>
namespace Oxygen
{
class OxygenSizeGrip;
class OxygenClient : public KCommonDecorationUnstable
{
Q_OBJECT
//! declare glow intensity property
//!Q_PROPERTY( qreal glowIntensity READ glowIntensity WRITE setGlowIntensity )
Q_PROPERTY( qreal glowIntensity READ glowIntensityUnbiased WRITE setGlowIntensity )
//! declare title opacity
Q_PROPERTY( qreal titleOpacity READ titleOpacity WRITE setTitleOpacity )
public:
//! constructor
OxygenClient(KDecorationBridge *b, OxygenFactory *f);
//! destructor
virtual ~OxygenClient();
//! decoration name
virtual QString visibleName() const;
//! buttons
virtual KCommonDecorationButton *createButton(::ButtonType type);
//!@name flags
//@{
//! true if decoration has iquired behavior
virtual bool decorationBehaviour(DecorationBehaviour behaviour) const;
//! true if window is maximized
virtual bool isMaximized( void ) const
{ return maximizeMode()==MaximizeFull && !options()->moveResizeMaximizedWindows(); }
//! true if glow is animated
bool glowIsAnimated( void ) const
{ return glowAnimation_.data()->isRunning(); }
//! true when decoration is forced active
bool isForcedActive( void ) const
{ return forceActive_ && clientGroupItems().count() > 1; }
//! true when separator is to be drawn
bool drawSeparator( void ) const
{
return
( glowIsAnimated() || isActive() ) &&
configuration().drawSeparator() &&
!configuration().hideTitleBar() &&
!configuration().drawTitleOutline();
}
//@}
//! window shape
virtual void updateWindowShape();
//! initialization
virtual void init();
// reset
virtual void reset( unsigned long changed );
//! return associated configuration
const OxygenConfiguration& configuration( void ) const
{ return configuration_; }
//!@name glow animation
//@{
virtual const Animation::Pointer& glowAnimation( void ) const
{ return glowAnimation_; }
void setGlowIntensity( qreal value )
{ glowIntensity_ = value; }
//! unbiased glow intensity
qreal glowIntensityUnbiased( void ) const
{ return glowIntensity_; }
//! glow bias
static qreal glowBias( void )
{ return 0.2; }
//! true (biased) intensity
/*! this is needed to have glow go from either 0.2->1 or 0.8->0 depending on the animation direction */
qreal glowIntensity( void ) const
{ return glowAnimation().data()->direction() == Animation::Forward ? glowIntensity_ : glowIntensity_-glowBias(); }
//@}
//! helper class
OxygenHelper& helper( void ) const
{ return factory_->helper(); }
//! helper class
OxygenShadowCache& shadowCache( void ) const
{ return factory_->shadowCache(); }
//!@name metrics and color definitions
//@{
//! dimensions
virtual int layoutMetric(LayoutMetric lm, bool respectWindowState = true, const KCommonDecorationButton * = 0) const;
//! get title rect for untabbed window
virtual QRect defaultTitleRect( bool active = true ) const;
//! get title bounding rect
virtual QRect titleBoundingRect( const QFont& font, const QString& caption ) const
{ return titleBoundingRect( font, titleRect(), caption ); }
//! get title bounding rect
virtual QRect titleBoundingRect( const QFont&, QRect, const QString& ) const;
//! palette background
QPalette backgroundPalette( const QWidget*, QPalette ) const;
//! background
QColor backgroundColor( const QWidget* widget, QPalette palette ) const
{ return backgroundColor( widget, palette, isActive() || isForcedActive() ); }
//! background
QColor backgroundColor( const QWidget*, QPalette, bool ) const;
//@}
//! default buttons located on the left
virtual QString defaultButtonsLeft() const;
//! default buttons located on the right
virtual QString defaultButtonsRight() const;
//!@name status change methods (overloaded from KCommonDecorationUnstable)
//@{
//! triggered when window activity is changed
virtual void activeChange();
//! triggered when maximize state changed
virtual void maximizeChange();
//! triggered when window shade is changed
virtual void shadeChange();
//! triggered when window shade is changed
virtual void captionChange();
//@}
//! event filter
virtual bool eventFilter( QObject*, QEvent* );
//! resize event
virtual void resizeEvent(QResizeEvent *e);
protected:
//! true when decoration is forced active
void setForceActive( bool value )
{ forceActive_ = value; }
//!@name event filters
//@{
//! paint
virtual void paintEvent( QPaintEvent* );
//! mouse press event
virtual bool mousePressEvent( QMouseEvent* );
//! mouse release event
virtual bool mouseReleaseEvent( QMouseEvent* );
//! mouse move event
virtual bool mouseMoveEvent( QMouseEvent* );
//! drag enter event
virtual bool dragEnterEvent( QDragEnterEvent* );
//! drag move event
virtual bool dragMoveEvent( QDragMoveEvent* );
//! drag leave event
virtual bool dragLeaveEvent( QDragLeaveEvent* );
//! drop event
virtual bool dropEvent( QDropEvent* );
//! timer event
virtual void timerEvent( QTimerEvent* );
//@}
//!@name rendering methods (called in paintEvent)
//@{
//! window background
virtual void renderWindowBackground( QPainter*, const QRect&, const QWidget*, const QPalette& ) const;
//! window border
// this draws a "blue" border around active window
virtual void renderWindowBorder( QPainter*, const QRect&, const QWidget*, const QPalette& ) const;
//! separator
virtual void renderSeparator( QPainter*, const QRect&, const QWidget*, const QColor& ) const;
//! title outline
virtual void renderTitleOutline( QPainter*, const QRect&, const QPalette& ) const;
//! title text
/*! second color, if valid, is for contrast pixel */
virtual void renderTitleText( QPainter*, const QRect&, const QColor&, const QColor& = QColor() ) const;
//! title text
/*! second color, if valid, is for contrast pixel */
virtual void renderTitleText( QPainter*, const QRect&, const QString&, const QColor&, const QColor& = QColor() ) const;
//! GroupItem
virtual void renderItem( QPainter*, int, const QPalette& );
//! tabbing target rect
virtual void renderTargetRect( QPainter*, const QPalette& );
//! render float frame
virtual void renderFloatFrame( QPainter*, const QRect&, const QPalette& ) const;
//! render dots
virtual void renderDots( QPainter*, const QRect&, const QColor& ) const;
//@}
//! close tab matching give button
virtual bool closeItem( const OxygenButton* );
//! index of item matching point
int itemClicked( const QPoint& position, bool between = false ) const
{ return itemData_.itemAt( position , between ); }
//! return pixmap corresponding to a given tab, for dragging
QPixmap itemDragPixmap( int, const QRect& );
//!@name title animation
//@{
const Animation::Pointer& titleAnimation( void ) const
{ return titleAnimation_; }
bool titleIsAnimated( void ) const
{ return titleAnimation().data()->isRunning(); }
qreal titleOpacity( void ) const
{ return titleOpacity_; }
void setTitleOpacity( qreal value )
{ titleOpacity_ = value; }
//@}
//! old caption if any
const QString& oldCaption( void ) const
{ return oldCaption_; }
//! old caption
void setOldCaption( const QString& value )
{ oldCaption_ = value; }
//! return true when activity change are animated
bool animateActiveChange( void ) const
{ return ( configuration().useAnimations() && !isPreview() ); }
//! return true when activity change are animated
bool animateTitleChange( void ) const
{
return
configuration().useAnimations() &&
!configuration().drawTitleOutline() &&
!configuration().hideTitleBar() &&
!isPreview();
}
//! calculate mask
QRegion calcMask( void ) const;
//! text color
QColor titlebarTextColor(const QPalette&);
//! text color
QColor titlebarTextColor(const QPalette&, bool active);
//! text color
QColor titlebarContrastColor(const QPalette& palette ) const
{ return titlebarContrastColor( palette.color( widget()->window()->backgroundRole() ) ); }
//! text color
QColor titlebarContrastColor(const QColor& color ) const
{ return helper().calcLightColor( color ); }
//!@name size grip
//@{
//! create size grip
void createSizeGrip( void );
//! delete size grip
void deleteSizeGrip( void );
// size grip
bool hasSizeGrip( void ) const
{ return (bool)sizeGrip_; }
//! size grip
OxygenSizeGrip& sizeGrip( void ) const
{ return *sizeGrip_; }
//@}
protected slots:
//! update old caption with current
void updateOldCaption( void )
{ setOldCaption( caption() ); }
//! set target item to -1
void clearTargetItem( void );
//! clear force active flag
void clearForceActive( void )
{ if( isActive() ) setForceActive( false ); }
//! title bounding rects
/*! calculate and return title bounding rects in case of tabbed window */
void updateItemBoundingRects( bool alsoUpdate = true );
private:
//! factory
OxygenFactory* factory_;
//! size grip widget
OxygenSizeGrip* sizeGrip_;
//! configuration
OxygenConfiguration configuration_;
//! glow animation
Animation::Pointer glowAnimation_;
//! title animation
Animation::Pointer titleAnimation_;
//! glow intensity
qreal glowIntensity_;
//! title opacity
qreal titleOpacity_;
//! old caption
QString oldCaption_;
//! true when initialized
bool initialized_;
//! true when decoration is forced active
bool forceActive_;
//! mouse button
Qt::MouseButton mouseButton_;
//! tab bounding rects
ClientGroupItemDataList itemData_;
//! index of tab being dragged if any, -1 otherwise
int sourceItem_;
//! drag start point
QPoint dragPoint_;
//! drag start timer.
/*!
it is needed to activate animations when this was not done via either
dragMoveEvent or dragLeaveEvent
*/
QBasicTimer dragStartTimer_;
};
//!@name utility functions
//@{
// dot
void renderDot(QPainter*, const QPointF&, qreal );
// contrast
QColor reduceContrast(const QColor&, const QColor&, double t);
//@}
} // namespace Oxygen
#endif // EXAMPLECLIENT_H