tdestyle.h

/*
 * $Id$
 * 
 * TDEStyle
 * Copyright (C) 2001-2002 Karol Szwed <gallium@kde.org>
 * 
 * TQWindowsStyle CC_ListView and style images were kindly donated by TrollTech,
 * Copyright (C) 1998-2000 TrollTech AS.
 * 
 * Many thanks to Bradley T. Hughes for the 3 button scrollbar code.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License version 2 as published by the Free Software Foundation.
 *
 * This library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */
 
#ifndef __TDESTYLE_H
#define __TDESTYLE_H
 
// W A R N I N G
// -------------
// This API is still subject to change.
// I will remove this warning when I feel the API is sufficiently flexible.
 
#include <tqcommonstyle.h>
 
#include <tdelibs_export.h>
 
class KPixmap;
 
struct TDEStylePrivate;
class TDEFX_EXPORT TDEStyle: public TQCommonStyle
{
    TQ_OBJECT
    
 
    public:
 
        typedef uint TDEStyleFlags;
        enum TDEStyleOption {
            Default           =     0x00000000, 
            AllowMenuTransparency =     0x00000001, 
            FilledFrameWorkaround =     0x00000002  
        };
 
        enum TDEStyleScrollBarType {
            WindowsStyleScrollBar  =    0x00000000, 
            PlatinumStyleScrollBar =    0x00000001, 
            ThreeButtonScrollBar   =    0x00000002, 
            NextStyleScrollBar     =    0x00000004  
        };
 
        TDEStyle( TDEStyleFlags flags = TDEStyle::Default, 
            TDEStyleScrollBarType sbtype = TDEStyle::WindowsStyleScrollBar );
 
        ~TDEStyle();
 
        static TQString defaultStyle();
 
        void setScrollBarType(TDEStyleScrollBarType sbtype);
 
        TDEStyleFlags styleFlags() const;
 
        // ---------------------------------------------------------------------------
 
        virtual void renderMenuBlendPixmap( KPixmap& pix, const TQColorGroup& cg, 
                            const TQPopupMenu* popup ) const;
 
        enum TDEStylePrimitive {
            KPE_DockWindowHandle,
            KPE_ToolBarHandle,
            KPE_GeneralHandle,
 
            KPE_SliderGroove,
            KPE_SliderHandle,
 
            KPE_ListViewExpander,
            KPE_ListViewBranch
        };
 
        // Old API
        // DEPRECATED
        virtual void drawTDEStylePrimitive( TDEStylePrimitive kpe,
                    TQPainter* p,
                    const TQWidget* widget,
                    const TQRect &r,
                    const TQColorGroup &cg,
                    SFlags flags = Style_Default,
                    const TQStyleOption& = TQStyleOption::Default ) const;
 
        virtual void drawTDEStylePrimitive( TDEStylePrimitive kpe,
                    TQPainter* p,
                    const TQStyleControlElementData &ceData,
                    ControlElementFlags elementFlags,
                    const TQRect &r,
                    const TQColorGroup &cg,
                    SFlags flags = Style_Default,
                    const TQStyleOption& = TQStyleOption::Default,
                    const TQWidget* widget = 0 ) const;
 
 
        enum TDEStylePixelMetric {
            KPM_MenuItemSeparatorHeight     = 0x00000001,
            KPM_MenuItemHMargin         = 0x00000002,
            KPM_MenuItemVMargin         = 0x00000004,
            KPM_MenuItemHFrame          = 0x00000008,
            KPM_MenuItemVFrame          = 0x00000010,
            KPM_MenuItemCheckMarkHMargin            = 0x00000020,
            KPM_MenuItemArrowHMargin        = 0x00000040,
            KPM_MenuItemTabSpacing          = 0x00000080,
            KPM_ListViewBranchThickness     = 0x00000100
        };
 
        int kPixelMetric( TDEStylePixelMetric kpm, const TQStyleControlElementData &ceData, ControlElementFlags elementFlags, const TQWidget* widget = 0 ) const;
 
        // ---------------------------------------------------------------------------
 
        void polish( const TQStyleControlElementData &ceData, ControlElementFlags elementFlags, void * );
        void unPolish( const TQStyleControlElementData &ceData, ControlElementFlags elementFlags, void * );
        void polishPopupMenu( const TQStyleControlElementData &ceData, ControlElementFlags elementFlags, void *ptr );
 
        void drawPrimitive( PrimitiveElement pe,
                    TQPainter* p,
                    const TQStyleControlElementData &ceData,
                    ControlElementFlags elementFlags,
                    const TQRect &r,
                    const TQColorGroup &cg,
                    SFlags flags = Style_Default,
                    const TQStyleOption& = TQStyleOption::Default ) const;
 
        void drawControl( ControlElement element,
                    TQPainter* p,
                    const TQStyleControlElementData &ceData,
                    ControlElementFlags elementFlags,
                    const TQRect &r,
                    const TQColorGroup &cg,
                    SFlags flags = Style_Default,
                    const TQStyleOption& = TQStyleOption::Default,
                    const TQWidget* widget = 0 ) const;
 
        void drawComplexControl( ComplexControl control,
                    TQPainter *p,
                    const TQStyleControlElementData &ceData,
                    ControlElementFlags elementFlags,
                    const TQRect &r,
                    const TQColorGroup &cg,
                    SFlags flags = Style_Default,
                    SCFlags controls = SC_All,
                    SCFlags active = SC_None,
                    const TQStyleOption& = TQStyleOption::Default,
                    const TQWidget* widget = 0 ) const;
 
        SubControl querySubControl( ComplexControl control,
                    const TQStyleControlElementData &ceData,
                    ControlElementFlags elementFlags,
                    const TQPoint &pos,
                    const TQStyleOption& = TQStyleOption::Default,
                    const TQWidget* widget = 0 ) const;
 
        TQRect querySubControlMetrics( ComplexControl control,
                    const TQStyleControlElementData &ceData,
                    ControlElementFlags elementFlags,
                    SubControl sc,
                    const TQStyleOption& = TQStyleOption::Default,
                    const TQWidget* widget = 0 ) const;
 
        int pixelMetric( PixelMetric m, const TQStyleControlElementData &ceData, ControlElementFlags elementFlags, 
                    const TQWidget* widget = 0 ) const;
 
        TQRect subRect( SubRect r, const TQStyleControlElementData &ceData, const ControlElementFlags elementFlags, 
                    const TQWidget* widget = 0 ) const;
 
        TQPixmap stylePixmap( StylePixmap stylepixmap,
                    const TQStyleControlElementData &ceData,
                    ControlElementFlags elementFlags,
                    const TQStyleOption& = TQStyleOption::Default,
                    const TQWidget* widget = 0 ) const;
 
        int styleHint( StyleHint sh, const TQStyleControlElementData &ceData,
                    ControlElementFlags elementFlags,
                    const TQStyleOption &opt = TQStyleOption::Default,
                    TQStyleHintReturn* shr = 0,
                    const TQWidget* w = 0 ) const;
 
    protected:
        virtual bool objectEventHandler( const TQStyleControlElementData &ceData, ControlElementFlags elementFlags, void* source, TQEvent *e );
 
    private:
        // Disable copy constructor and = operator
        TDEStyle( const TDEStyle & );
        TDEStyle& operator=( const TDEStyle & );
 
    protected:
        virtual void virtual_hook( int id, void* data );
    private:
        TDEStylePrivate *d;
};
#endif