/*
   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_ERASER_SIZE_H
#define KP_TOOL_WIDGET_ERASER_SIZE_H


#include <qpixmap.h>

#include <kpColor.h>
#include <kpTempImage.h>
#include <kpToolWidgetBase.h>


class kpColor;


class kpToolWidgetEraserSize : public kpToolWidgetBase
{
Q_OBJECT

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

    int eraserSize () const;
    
    struct DrawPackage
    {
        int selected;
        kpColor color;
    };

    // Call the function returned by <drawFunction> to render the current
    // brush onto an image/document, in <color>.  Pass the pointer returned by
    // <drawFunctionData> to it.
    //
    // <drawCursorFunction> is to same as <drawFunction> but adds a black
    // border suitable as a cursor only.
    //
    // TODO: change function + data -> object
    kpTempImage::UserFunctionType drawFunction () const;
    kpTempImage::UserFunctionType drawCursorFunction () const;
    
    static DrawPackage drawFunctionDataForSelected (const kpColor &color,
        int selectedIndex);
    DrawPackage drawFunctionData (const kpColor &color) const;

signals:
    void eraserSizeChanged (int size);

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


#endif  // KP_TOOL_WIDGET_ERASER_SIZE_H