
/*
   Copyright (c) 2003-2007 Clarence Dang <dang@kde.org>
   All rights reserved.

   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions
   are met:

   1. Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
   2. Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.

   THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
   IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
   IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
   INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
   NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/


#ifndef KP_TOOL_WIDGET_FILL_STYLE_H
#define KP_TOOL_WIDGET_FILL_STYLE_H


#include <kpToolWidgetBase.h>


class QBrush;
class QPixmap;

class kpColor;


class kpToolWidgetFillStyle : public kpToolWidgetBase
{
Q_OBJECT

public:
    kpToolWidgetFillStyle (QWidget *parent, const QString &name);
    virtual ~kpToolWidgetFillStyle ();

    enum FillStyle
    {
        NoFill,
        FillWithBackground,
        FillWithForeground,
        FillStyleNum  /* not (a valid FillStyle) */
    };

private:
    QPixmap fillStylePixmap (FillStyle fs, int width, int height);
    QString fillStyleName (FillStyle fs) const;

public:
    FillStyle fillStyle () const;

    static QBrush maskBrushForFillStyle (FillStyle fs,
                                         const kpColor &foregroundColor,
                                         const kpColor &backgroundColor);
    QBrush maskBrush (const kpColor &foregroundColor,
                      const kpColor &backgroundColor);

    static QBrush brushForFillStyle (FillStyle fs,
                                     const kpColor &foregroundColor,
                                     const kpColor &backgroundColor);
    QBrush brush (const kpColor &foregroundColor,
                  const kpColor &backgroundColor);

    // Returns the actual fill colour.
    // e.g. "FillWithBackground" fillStyle() -> <backgroundColor>,
    //      "FillWithForeground" fillStyle() -> <foregroundColor>.
    kpColor drawingBackgroundColor (
        const kpColor &foregroundColor, const kpColor &backgroundColor) const;

signals:
    void fillStyleChanged (kpToolWidgetFillStyle::FillStyle fillStyle);

protected slots:
    virtual bool setSelected (int row, int col, bool saveAsDefault);
};


#endif  // KP_TOOL_WIDGET_FILL_STYLE_H
