ButtonStyle.h

/* Copyright (C) 2016 Laurentiu-Gheorghe Crisan
   Copyright (C) 2016 Marc Boris Duerner
 
 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public
 License as published by the Free Software Foundation; either
 version 2.1 of the License, or (at your option) any later version.
 
 As a special exception, you may use this file as part of a free
 software library without restriction. Specifically, if other files
 instantiate templates or use macros or inline functions from this
 file, or you compile this file and link it with other files to
 produce an executable, this file does not by itself cause the
 resulting executable to be covered by the GNU General Public
 License. This exception does not however invalidate any other
 reasons why the executable file might be covered by the GNU Library
 General Public License.
 
 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
 Lesser General Public License for more details.
 
 You should have received a copy of the GNU Lesser General Public
 License along with this library; if not, write to the Free Software
 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 
 MA 02110-1301 USA
*/
 
#ifndef Pt_Forms_ButtonStyle_h
#define Pt_Forms_ButtonStyle_h
 
#include <Pt/Forms/Style.h>
 
namespace Pt {
 
namespace Forms {
 
class PT_FORMS_API ButtonStyleOptions
{
    public:
        ButtonStyleOptions();
 
        bool hasOverrides() const;
 
        std::size_t generation() const;
 
        const Gfx::Brush* foreground() const;
 
        void setForeground(const Gfx::Brush& brush);
 
        const Gfx::Pen* contour() const;
 
        void setContour(const Gfx::Pen& pen);
 
        const Gfx::Color* accentColor() const;
 
        void setAccentColor(const Gfx::Color& color);
 
        const Gfx::Color* highlightColor() const;
 
        void setHighlightColor(const Gfx::Color& color);
 
        const Gfx::Color* textColor() const;
 
        void setTextColor(const Gfx::Color& color);
 
        const Gfx::Font* font() const;
 
        void setFont(const Gfx::Font& font);
 
        void setFontSize(std::size_t size);
 
        void setFontWeight(Gfx::Font::Weight weight);
 
        void setFontSlant(Gfx::Font::Slant slant);
 
        Gfx::Font getFont(const Gfx::Font& base) const;
 
    private:
        enum StyleOverride
        {
            Foreground     = 0x01,
            Contour        = 0x02,
            AccentColor    = 0x04,
            HighlightColor = 0x08,
            TextColor      = 0x10,
            Font           = 0x20
        };
 
        bool hasOverride(StyleOverride mask) const;
 
        void setOverride(StyleOverride mask);
 
    private:
        AutoPtr<Gfx::Brush> _foreground;
        AutoPtr<Gfx::Pen>   _contour;
        AutoPtr<Gfx::Color> _accentColor;
        AutoPtr<Gfx::Color> _highlightColor;
        AutoPtr<Gfx::Color> _textColor;
        FontOption          _font;
        std::size_t         _generation;
        unsigned            _overrides;
};
 
class PT_FORMS_API ButtonState
{
    public:
        ButtonState();
 
        bool isEnabled() const;
 
        void setEnabled(bool value);
 
        bool isHovered() const;
 
        void setHovered(bool value);
 
        bool isFocused() const;
 
        void setFocused(bool value);
 
        bool isPressed() const;
 
        void setPressed(bool value);
 
        bool isFlat() const;
 
        void setFlat(bool value);
 
    private:
        bool _enabled;
        bool _hovered;
        bool _focused;
        bool _pressed;
        bool _flat;
};
 
class PT_FORMS_API ButtonRenderer : public Style::Facet
{
    public:
        explicit ButtonRenderer(std::size_t refs = 0);
 
        virtual ~ButtonRenderer();
 
        ButtonRenderer* create() const;
 
        void prepare(const StyleOptions& options,
                     const ButtonStyleOptions& buttonOptions);
 
    public:
        Gfx::SizeF measureContent(PaintSurface& surface,
                                  Direction direction,
                                  const Gfx::SizeF& iconSize,
                                  const Gfx::SizeF& textSize);
 
        Gfx::SizeF measureFrame(PaintSurface& surface,
                                const Gfx::SizeF& contentSize);
 
        Gfx::RectF layoutFrame(PaintSurface& surface,
                               const Gfx::RectF& frameRect);
 
        Gfx::RectF layoutMnemonic(PaintSurface& surface,
                                  const String& text,
                                  const Gfx::PointF& textPos,
                                  const Gfx::FontMetrics& fontMetrics,
                                  String::size_type mnemonicIndex);
 
        const Painter& textPainter(PaintSurface& surface);
 
        void layoutContent(PaintSurface& surface,
                           const Gfx::RectF& contentRect,
                           Direction direction,
                           const Gfx::SizeF& iconSize,
                           const Gfx::SizeF& textSize,
                           Gfx::RectF& iconRect,
                           Gfx::RectF& textRect);
 
        void prepareIcon(const Gfx::Image& icon,
                         Pixmap& picture,
                         const ButtonState& state) const;
 
        void renderBackground(PaintContext& context,
                              const Gfx::RectF& rect,
                              const ButtonState& state);
 
        void renderChrome(PaintContext& context,
                          const Gfx::RectF& rect,
                          const ButtonState& state);
 
        void renderText(PaintContext& context,
                        const Gfx::RectF& rect,
                        const String& text,
                        const Gfx::PointF& pos,
                        const ButtonState& state);
 
        void renderMnemonic(PaintContext& context,
                            const Gfx::RectF& rect,
                            const Gfx::RectF& mnemonic,
                            const ButtonState& state);
 
        void renderIcon(PaintContext& context,
                        const Gfx::RectF& rect,
                        const Pixmap& picture,
                        const Gfx::PointF& pos,
                        const ButtonState& state);
 
    protected:
        virtual void onReset(const StyleOptions& options);
 
        virtual ButtonRenderer* onCreate() const = 0;
 
        virtual void onPrepare(const StyleOptions& options,
                               const ButtonStyleOptions& buttonOptions) = 0;
 
        virtual Gfx::SizeF onMeasureFrame(PaintSurface& surface,
                                          const Gfx::SizeF& contentSize) = 0;
 
        virtual Gfx::SizeF onMeasureContent(PaintSurface& surface,
                                            Direction direction,
                                            const Gfx::SizeF& iconSize,
                                            const Gfx::SizeF& textSize) = 0;
 
        virtual Gfx::RectF onLayoutFrame(PaintSurface& surface,
                                         const Gfx::RectF& frameRect) = 0;
 
        virtual Gfx::RectF onLayoutMnemonic(PaintSurface& surface,
                                            const String& text,
                                            const Gfx::PointF& textPos,
                                            const Gfx::FontMetrics& fontMetrics,
                                            String::size_type mnemonicIndex) = 0;
 
        virtual const Painter& onGetTextPainter(PaintSurface& surface) = 0;
 
        virtual void onLayoutContent(PaintSurface& surface,
                                     const Gfx::RectF& contentRect,
                                     Direction direction,
                                     const Gfx::SizeF& iconSize,
                                     const Gfx::SizeF& textSize,
                                     Gfx::RectF& iconRect,
                                     Gfx::RectF& textRect) = 0;
 
        virtual void onRenderBackground(PaintContext& context,
                                        const Gfx::RectF& rect,
                                        const ButtonState& state) = 0;
 
        virtual void onPrepareIcon(const Gfx::Image& icon,
                                   Pixmap& picture,
                                   const ButtonState& state) const = 0;
 
        virtual void onRenderChrome(PaintContext& context,
                                    const Gfx::RectF& rect,
                                    const ButtonState& state) = 0;
 
        virtual void onRenderText(PaintContext& context,
                                  const Gfx::RectF& rect,
                                  const String& text,
                                  const Gfx::PointF& pos,
                                  const ButtonState& state) = 0;
 
        virtual void onRenderMnemonic(PaintContext& context,
                                      const Gfx::RectF& rect,
                                      const Gfx::RectF& mnemonic,
                                      const ButtonState& state) = 0;
 
        virtual void onRenderIcon(PaintContext& context,
                                  const Gfx::RectF& rect,
                                  const Pixmap& picture,
                                  const Gfx::PointF& pos,
                                  const ButtonState& state) = 0;
};
 
class PT_FORMS_API ButtonStyle : public StyleBinder<ButtonRenderer, 
                                                    ButtonStyleOptions>
{
    public:
        ButtonStyle();
};
 
} // namespace
 
} // namespace
 
#endif