ElementAppearance.h

Go to the documentation of this file.

// Copyright 2015 - 2026, GIBIS-UNIFESP and the wiRedPanda contributors
// SPDX-License-Identifier: GPL-3.0-or-later

 
#pragma once
 
#include <memory>
 
#include <QColor>
#include <QCoreApplication>
#include <QPixmap>
#include <QSize>
#include <QStringList>
 
class GraphicElement;
class QPainter;
class QSvgRenderer;
class ThemeAttributes;

class ElementAppearance
{
    Q_DECLARE_TR_FUNCTIONS(ElementAppearance)
 
public:
    explicit ElementAppearance(GraphicElement *owner);

    ~ElementAppearance();

    void seedFromMetadata(const QStringList &defaultAppearances,
                          const QStringList &alternativeAppearances,
                          const QString &pixmapPath);
 
    // --- Pixmap access ---

    QPixmap pixmap() const { return m_pixmap; }

    QPointF pixmapCenter() const;

    bool hasDefaultAppearances() const { return !m_defaultAppearances.isEmpty(); }

    void setPixmap(const int index);

    void setPixmap(const QString &pixmapPath);

    QPixmap previewPixmapAt(const int index, const QSize &size) const;

    void setRenderPixmap(const QPixmap &pixmap);

    void applyOrientation();
 
    // --- Appearance list ---

    void setAppearance(const bool defaultAppearance, const QString &fileName);

    void setAppearanceAt(const int index, const QString &fileName);

    const QStringList &defaultAppearances() const { return m_defaultAppearances; }

    const QStringList &alternativeAppearances() const { return m_alternativeAppearances; }

    void resetAlternativeToDefault() { m_alternativeAppearances = m_defaultAppearances; }

    void setAlternativeAppearanceAt(const int index, const QString &path);

    void setUsingDefaultAppearance(const bool value) { m_usingDefaultAppearance = value; }

    bool usingDefaultAppearance() const { return m_usingDefaultAppearance; }

    void recomputeUsingDefault();

    QStringList externalFiles() const;
 
    // --- Painting ---

    void render(QPainter *painter, const QRectF &boundingRect, const bool selected) const;

    void applyTheme(const ThemeAttributes &theme);

    QColor selectionBrush() const { return m_selectionBrush; }

    QColor selectionPen() const { return m_selectionPen; }
 
private:
    void rebuildSvgRenderer();
 
    GraphicElement *m_owner = nullptr;
 
    QPixmap m_pixmap;     
    QPixmap m_basePixmap; 
    bool m_hasCustomRenderPixmap = false; 
    std::shared_ptr<QSvgRenderer> m_svgRenderer; 
 
    QString m_pixmapPath;         
    QString m_currentPixmapPath;  
    QString m_resolvedPixmapPath; 
 
    QStringList m_defaultAppearances;     
    QStringList m_alternativeAppearances; 
    bool m_usingDefaultAppearance = true; 
 
    QColor m_selectionBrush; 
    QColor m_selectionPen;   
};