kcommondecoration.h

/*
  This file is part of the KDE project.
 
  Copyright (C) 2005 Sandro Giessl <sandro@giessl.com>
 
  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.
 */
 
#ifndef KCOMMONDECORATION_H
#define KCOMMONDECORATION_H
 
#include <tqbutton.h>
#include <tqvaluevector.h>
 
#include "kdecoration.h"
 
class KDecorationBridge;
class KDecorationFactory;
 
enum ButtonType {
    HelpButton=0,
    MaxButton,
    MinButton,
    CloseButton,
    MenuButton,
    OnAllDesktopsButton,
    AboveButton,
    BelowButton,
    ShadeButton,
    NumButtons
};
 
class KCommonDecorationButton;
 
class KCommonDecorationButtonPrivate;
class KCommonDecorationPrivate;

class KWIN_EXPORT KCommonDecoration : public KDecoration
{
    TQ_OBJECT
 
    public:
        KCommonDecoration(KDecorationBridge* bridge, KDecorationFactory* factory);
        virtual ~KCommonDecoration();

        enum LayoutMetric
        {
            LM_BorderLeft,
            LM_BorderRight,
            LM_BorderBottom,
            LM_TitleHeight,
            LM_TitleBorderLeft,
            LM_TitleBorderRight,
            LM_TitleEdgeLeft,
            LM_TitleEdgeRight,
            LM_TitleEdgeTop,
            LM_TitleEdgeBottom,
            LM_ButtonWidth,
            LM_ButtonHeight,
            LM_ButtonSpacing,
            LM_ExplicitButtonSpacer,
            LM_ButtonMarginTop,
            LM_RightButtonsMarginTop
        };
 
        enum DecorationBehaviour
        {
            DB_MenuClose, 
            DB_WindowMask, 
            DB_ButtonHide  
        };
 
        enum WindowCorner
        {
            WC_TopLeft,
            WC_TopRight,
            WC_BottomLeft,
            WC_BottomRight
        };

        virtual TQString visibleName() const = 0;
        virtual TQString defaultButtonsLeft() const = 0;
        virtual TQString defaultButtonsRight() const = 0;

        virtual bool decorationBehaviour(DecorationBehaviour behaviour) const;

        virtual int layoutMetric(LayoutMetric lm, bool respectWindowState = true, const KCommonDecorationButton *button = 0) const;

        virtual KCommonDecorationButton *createButton(ButtonType type) = 0;

        virtual TQRegion cornerShape(WindowCorner corner);

        virtual void updateWindowShape();

        virtual void paintEvent(TQPaintEvent *e) = 0;

        virtual void updateCaption();
 
        int buttonsLeftWidth() const;
        int buttonsRightWidth() const;

        void updateLayout() const;
        void updateButtons() const;
        void resetButtons() const;

        bool isToolWindow() const;
         TQRect titleRect() const;
 
    public:
        virtual void init();
        virtual void reset( unsigned long changed );
        virtual void borders( int& left, int& right, int& top, int& bottom ) const;
        virtual void show();
        virtual void resize(const TQSize& s);
        virtual TQSize minimumSize() const;
        virtual void maximizeChange();
        virtual void desktopChange();
        virtual void shadeChange();
        virtual void iconChange();
        virtual void activeChange();
        virtual void captionChange();
    public slots:
        void keepAboveChange(bool above);
        void keepBelowChange(bool below);
        void slotMaximize();
        void slotShade();
        void slotKeepAbove();
        void slotKeepBelow();
        void menuButtonPressed();
        void menuButtonReleased();
    public:
        virtual Position mousePosition(const TQPoint &point) const;
 
        virtual bool eventFilter( TQObject* o, TQEvent* e );
        virtual void resizeEvent(TQResizeEvent *e);
        virtual void mouseDoubleClickEvent(TQMouseEvent *e);
        virtual void wheelEvent(TQWheelEvent *e);
 
    private:
        void resetLayout();
 
        void moveWidget(int x, int y, TQWidget *widget) const;
        void resizeWidget(int w, int h, TQWidget *widget) const;
 
        typedef TQValueVector <KCommonDecorationButton*> ButtonContainer; 
        int buttonContainerWidth(const ButtonContainer &btnContainer, bool countHidden = false) const;
        bool isModalSystemNotification();
        void addButtons(ButtonContainer &btnContainer, const TQString& buttons, bool isLeft);
 
        KCommonDecorationButton *m_button[NumButtons];
 
        ButtonContainer m_buttonsLeft;
        ButtonContainer m_buttonsRight;
 
        TQWidget *m_previewWidget;
 
        // button hiding for small windows
        void calcHiddenButtons();
        int btnHideMinWidth;
        int btnHideLastWidth;
 
        bool closing; // for menu doubleclick closing...
 
        KCommonDecorationPrivate *d;
};

class KWIN_EXPORT KCommonDecorationButton : public TQButton
{
    friend class KCommonDecoration;
 
    TQ_OBJECT
    
 
    public:
        KCommonDecorationButton(ButtonType type, KCommonDecoration *parent, const char *name);
        virtual ~KCommonDecorationButton();

        enum
        {
            ManualReset     = 1 << 0, 
            SizeChange      = 1 << 1, 
            ToggleChange    = 1 << 2, 
            StateChange     = 1 << 3, 
            IconChange      = 1 << 4, 
            DecorationReset = 1 << 5  
        };
        virtual void reset(unsigned long changed) = 0;
        KCommonDecoration *decoration() const;
        ButtonType type() const;

        bool isLeft() const;

        void setRealizeButtons(int btns);
        void setSize(const TQSize &s);
        void setTipText(const TQString &tip);
        ButtonState lastMousePress() const { return m_lastMouse; }
 
        TQSize sizeHint() const;
 
    protected:
        void setToggleButton(bool toggle);
        void setOn(bool on);
        void setLeft(bool left);
        void mousePressEvent(TQMouseEvent *e);
        void mouseReleaseEvent(TQMouseEvent *e);
 
    private:
        KCommonDecoration *m_decoration;
        ButtonType m_type;
        int m_realizeButtons;
        TQSize m_size;
        ButtonState m_lastMouse;
 
        bool m_isLeft;
 
        KCommonDecorationButtonPrivate *d;
};
 
#endif // KCOMMONDECORATION_H