kwin/clients/nitrogen/nitrogen.h

#ifndef nitrogen_h
#define nitrogen_h

// Copyright (c) 2006, 2007 Riccardo Iaconelli <ruphy@fsfe.org>
// Copyright (c) 2009, 2010 Hugo Pereira <hugo.pereira@free.fr>
//
// 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 <QObject>
#include <kdecorationfactory.h>
#include <kdeversion.h>

#include "nitrogenconfiguration.h"
#include "nitrogenexceptionlist.h"

// TODO:
// should review implementation not to use static objects

namespace Nitrogen
{
  
  class NitrogenClient;
  
  //! button size
  // enum { NITROGEN_BUTTONSIZE = 22 };
    
  //! buttons
  enum ButtonType 
  {
    ButtonHelp=0,
    ButtonMax,
    ButtonMin,
    ButtonClose,
    ButtonMenu,
    ButtonSticky,
    ButtonAbove,
    ButtonBelow,
    ButtonShade,
    ButtonTypeCount
  };

  #if KDE_IS_VERSION(4,2,92)
  static const qreal SHADOW_WIDTH = 25.5;
  #endif

  Q_DECLARE_FLAGS(ButtonTypes, ButtonType)
    
  //! window decoration factory
  class NitrogenFactory: public QObject, public KDecorationFactoryUnstable
  {
    
    Q_OBJECT
    
    public:
    
    //! constructor
    NitrogenFactory();
    
    //! destructor
    virtual ~NitrogenFactory();
    
    //! create decoration
    virtual KDecoration *createDecoration(KDecorationBridge *b);
    
    //! configuration reset
    virtual bool reset(unsigned long changed);

    //! configuration capabilities
    virtual bool supports( Ability ability ) const;
    
    #if !KDE_IS_VERSION(4,2,92)
    //! shadow textures
    virtual QList< QList<QImage> > shadowTextures();
    
    //! shadow textures
    virtual int shadowTextureList( ShadowType type ) const;
    
    //! shadow rectangles
    virtual QList<QRect> shadowQuads( ShadowType type, QSize size ) const;
    
    //! shadow opacity
    virtual double shadowOpacity( ShadowType type ) const;
    #endif
    
    //! true if initialized
    static bool initialized()
    { return initialized_; }
    
    //! get configuration for a give client
    static NitrogenConfiguration configuration( const NitrogenClient& );
    
    signals:
    
    //! configuration has changed
    void configurationChanged( void );
    
    private:
     
    //! read configuration from KConfig
    bool readConfig();

    #if !KDE_IS_VERSION(4,2,92)
    //! make texture from a given image
    QImage makeTexture( const QPixmap&, const QRect& ) const;

    //! make texture from a given image
    QList<QImage> makeTextures( const QPixmap& ) const;
    
    // active state
    enum Activity
    {
      Active,
      Inactive
    };
    
    //! make texture from a given image
    QList<QImage> makeTextures( Activity ) const;
    #endif
    
    //! default configuration
    static NitrogenConfiguration defaultConfiguration( void )
    { return defaultConfiguration_; }
        
    //! initialization
    static void setInitialized( bool value )
    { initialized_ = value; }
    
    //! set default configuration
    static void setDefaultConfiguration( NitrogenConfiguration value )
    { defaultConfiguration_ = value; }
    
    //! initialization flag
    static bool initialized_;
    
    //! default configuration
    static NitrogenConfiguration defaultConfiguration_;
    
    //! exceptions
    static NitrogenExceptionList exceptions_;
    
    //! true if compiz is used
    static bool useCompiz_;
    
  };
      
}

#endif