sketchwidget.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2008-05-19
 * Description : a widget to draw sketch.
 *
 * Copyright (C) 2008-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C) 2008-2010 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option)
 * any later version.
 *
 * This program 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 General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_SKETCH_WIDGET_H
#define DIGIKAM_SKETCH_WIDGET_H
 
// Qt includes
 
#include <QWidget>
#include <QXmlStreamReader>
#include <QXmlStreamWriter>
 
namespace Digikam
{
 
class SketchWidget : public QWidget
{
    Q_OBJECT
 
public:
 
    explicit SketchWidget(QWidget* const parent = nullptr);
    ~SketchWidget() override;
 
    QColor  penColor() const;
    int     penWidth() const;
    bool    isClear()  const;
 
    QImage  sketchImage() const;
    void    setSketchImage(const QImage& image);
 
    void sketchImageToXML(QXmlStreamWriter& writer);
    QString sketchImageToXML();
 
    bool setSketchImageFromXML(QXmlStreamReader& reader);
    bool setSketchImageFromXML(const QString& xml);
 
Q_SIGNALS:
 
    void signalSketchChanged(const QImage&);
    void signalPenSizeChanged(int);
    void signalPenColorChanged(const QColor&);
    void signalUndoRedoStateChanged(bool hasUndo, bool hasRedo);
 
public Q_SLOTS:
 
    void setPenColor(const QColor& newColor);
    void setPenWidth(int newWidth);
    void slotClear();
    void slotUndo();
    void slotRedo();
 
protected:
 
    void mousePressEvent(QMouseEvent*)      override;
    void mouseMoveEvent(QMouseEvent*)       override;
    void wheelEvent(QWheelEvent*)           override;
    void mouseReleaseEvent(QMouseEvent*)    override;
    void keyPressEvent(QKeyEvent*)          override;
    void keyReleaseEvent(QKeyEvent*)        override;
    void paintEvent(QPaintEvent*)           override;
 
private:
 
    void updateDrawCursor();
    void replayEvents(int index);
    void drawLineTo(const QPoint& endPoint);
    void drawLineTo(int width, const QColor& color, const QPoint& start, const QPoint& end);
    void drawPath(int width, const QColor& color, const QPainterPath& path);
    void addPath(QXmlStreamReader& reader);
/*
    QDomElement addXmlTextElement(QDomDocument& document, QDomElement& target,
                                  const QString& tag, const QString& text);
*/
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_SKETCH_WIDGET_H