xournalpp/src/control/ToolHandler.h

/*
 * Xournal++
 *
 * Handles Tools
 *
 * @author Xournal++ Team
 * https://github.com/xournalpp/xournalpp
 *
 * @license GNU GPLv2 or later
 */

#pragma once

#include <array>
#include <memory>
#include <string>
#include <vector>

#include <util/Color.h>

#include "settings/Settings.h"

#include "Tool.h"
#include "XournalType.h"


class ToolListener {
public:
    virtual void toolColorChanged(bool userSelection) = 0;
    virtual void setCustomColorSelected() = 0;
    virtual void toolSizeChanged() = 0;
    virtual void toolFillChanged() = 0;
    virtual void toolLineStyleChanged() = 0;
    virtual void toolChanged() = 0;

    virtual ~ToolListener();
};

class ActionHandler;

class ToolHandler {
public:
    ToolHandler(ToolListener* listener, ActionHandler* actionHandler, Settings* settings);
    virtual ~ToolHandler();

    /**
     * Select the color for the tool
     *
     * @param color Color
     * @param userSelection
     * 			true if the user selected the color
     * 			false if the color is selected by a tool change
     * 			and therefore should not be applied to a selection
     */
    void setColor(Color color, bool userSelection);
    Color getColor();

    /**
     * @return -1 if fill is disabled, else the fill alpha value
     */
    int getFill();

    DrawingType getDrawingType();
    void setDrawingType(DrawingType drawingType);

    const LineStyle& getLineStyle();

    ToolSize getSize();
    void setSize(ToolSize size);
    double getThickness();

    void setLineStyle(const LineStyle& style);

    ToolSize getPenSize();
    ToolSize getEraserSize();
    ToolSize getHilighterSize();
    void setPenSize(ToolSize size);
    void setEraserSize(ToolSize size);
    void setHilighterSize(ToolSize size);

    void setPenFillEnabled(bool fill, bool fireEvent = true);
    bool getPenFillEnabled();
    void setPenFill(int alpha);
    int getPenFill();

    void setHilighterFillEnabled(bool fill, bool fireEvent = true);
    bool getHilighterFillEnabled();
    void setHilighterFill(int alpha);
    int getHilighterFill();

    void selectTool(ToolType type, bool fireToolChanged = true, bool stylus = false);
    ToolType getToolType();
    void fireToolChanged();

    Tool& getTool(ToolType type);

    void setEraserType(EraserType eraserType);
    EraserType getEraserType();
    void eraserTypeChanged();

    bool hasCapability(ToolCapabilities cap, bool mainTool = false);

    void saveSettings();
    void loadSettings();

    void pointCurrentToolToButtonTool();
    void pointCurrentToolToToolbarTool();

    std::array<std::unique_ptr<Tool>, TOOL_COUNT> const& getTools() const;

    /**
     * Change the selection tools capabilities, depending on the selected elements
     */
    void setSelectionEditTools(bool setColor, bool setSize, bool setFill);

    const double* getToolThickness(ToolType type);

    /**
     * Returns whether the current tool will create an element that may only reside on a single page even when the
     * pointer moves to another
     * @return
     */
    bool isSinglePageTool();

    bool triggeredByButton = false;

protected:
    void initTools();

private:
    std::array<std::unique_ptr<Tool>, TOOL_COUNT> tools;
    Tool* currentTool = nullptr;

    /**
     * Last selected tool, reference with color values etc.
     */
    Tool* toolbarSelectedTool = nullptr;
    Tool* buttonSelectedTool = nullptr;

    EraserType eraserType = ERASER_TYPE_DEFAULT;

    /**
     * If a color is selected, it may be in the list,
     * so its a "predefined" color for us, but may it is
     * not in the list, so its a "custom" color for us
     */

    ToolListener* listener = nullptr;

    ActionHandler* actionHandler = nullptr;

    Settings* settings = nullptr;
};