titleblocktemplate.h

Go to the documentation of this file.

/*
        Copyright 2006-2026 The QElectroTech Team
        This file is part of QElectroTech.
        
        QElectroTech 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 of the License, or
        (at your option) any later version.
        
        QElectroTech 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.
        
        You should have received a copy of the GNU General Public License
        along with QElectroTech.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef TITLEBLOCK_TEMPLATE_H
#define TITLEBLOCK_TEMPLATE_H
#include "diagramcontext.h"
#include "qet.h"
#include "titleblock/dimension.h"
#include "titleblockcell.h"
 
#include <QtSvg>
#include <QtXml>
#include <optional>

class TitleBlockTemplate : public QObject {
        Q_OBJECT
 
        public:
                enum class WidthConstraintCase : int {
                        Unconstrained = -1,

                        RelativeWidthExceeds100Percent = -2,

                        AbsoluteColumnsExceedRemainingWidth = -3
                };
        
        // constructors, destructor
        TitleBlockTemplate(QObject * = nullptr);
        ~TitleBlockTemplate() override;
        private:
        TitleBlockTemplate(const TitleBlockTemplate &);
        
        // methods
        public:
        TitleBlockCell *createCell(const TitleBlockCell * = nullptr);
        static QFont fontForCell(const TitleBlockCell &);
        bool loadFromXmlFile(const QString &);
        bool loadFromXmlElement(const QDomElement &);
        bool saveToXmlFile(const QString &);
        bool saveToXmlElement(QDomElement &) const;
        void exportCellToXml(TitleBlockCell *,QDomElement &) const;
        TitleBlockTemplate *clone() const;
        QString name() const;
        QString information() const;
        void setInformation(const QString &);
        int rowDimension(int);
        void setRowDimension(int, const TitleBlockDimension &);
        TitleBlockDimension columnDimension(int);
        void setColumnDimension(int, const TitleBlockDimension &);
        int columnsCount() const;
        int rowsCount() const;
        QList<int> columnsWidth(int) const;
        QList<int> rowsHeights() const;
        int columnTypeCount(QET::TitleBlockColumnLength);
        int columnTypeTotal(QET::TitleBlockColumnLength);
        int minimumWidth();
        int maximumWidth();
        int width(int);
        int height() const;
        
        bool moveRow(int, int);
        void addRow(int = -1);
        bool insertRow(int, const QList<TitleBlockCell *> &, int = -1);
        QList<TitleBlockCell *> takeRow(int);
        QList<TitleBlockCell *> createRow();
        
        bool moveColumn(int, int);
        void addColumn(int = -1);
        bool insertColumn(const TitleBlockDimension &,
                          const QList<TitleBlockCell *> &, int = -1);
        QList<TitleBlockCell *> takeColumn(int);
        QList<TitleBlockCell *> createColumn();
        
        TitleBlockCell *cell(int, int) const;
        QSet<TitleBlockCell *> spannedCells(
                        const TitleBlockCell *, bool = false) const;
        QHash<TitleBlockCell *, QPair<int, int> > getAllSpans() const;
        void setAllSpans(const QHash<TitleBlockCell *, QPair<int, int> > &);
        bool addLogo(
                        const QString &,
                        QByteArray *,
                        const QString & = "svg",
                        const QString & = "xml");
        bool addLogoFromFile(const QString &, const QString & = QString());
        bool saveLogoToFile(const QString &, const QString &);
        bool removeLogo(const QString &);
        bool renameLogo(const QString &, const QString &);
        void setLogoStorage(const QString &, const QString &);
        QList<QString> logos() const;
        QString logoType(const QString &) const;
        QSvgRenderer *vectorLogo(const QString &) const;
        QPixmap bitmapLogo(const QString &) const;
        
        void render(QPainter &, const DiagramContext &, int) const;
        void renderDxf(
                        QRectF &,
                        const DiagramContext &,
                        int,
                        QString &,
                        int) const;
        void renderCell(QPainter &,
                        const TitleBlockCell &,
                        const DiagramContext &,
                        const QRect &) const;
        void applyCellSpans();
        void forgetSpanning();
        void forgetSpanning(TitleBlockCell *, bool = true);
        bool checkCellSpan(TitleBlockCell *);
        void applyCellSpan(TitleBlockCell *);
        void applyRowColNums();
        void rowColsChanged();
        QStringList listOfVariables();
        
        protected:
        void loadInformation(const QDomElement &);
        bool loadLogos(const QDomElement &, bool = false);
        bool loadLogo(const QDomElement &);
        bool loadGrid(const QDomElement &);
        bool loadCells(const QDomElement &);
        void loadCell(const QDomElement &);
        void saveInformation(QDomElement &) const;
        void saveLogos(QDomElement &) const;
        void saveLogo(const QString &, QDomElement &) const;
        void saveGrid(QDomElement &) const;
        void saveCells(QDomElement &) const;
        void saveCell(TitleBlockCell *, QDomElement &, bool = false) const;
        QList<TitleBlockCell *> createCellsList(int);
        
        private:
        void parseRows(const QString &);
        void parseColumns(const QString &);
        bool checkCell(const QDomElement &, TitleBlockCell ** = nullptr);
        void flushCells();
        void initCells();
        std::optional<WidthConstraintCase> classifyWidthConstraint(int &abs_total, qreal &remaining_width_fraction);
        int lengthRange(int, int, const QList<int> &) const;
        QString finalTextForCell(
                        const TitleBlockCell &,
                        const DiagramContext &) const;
        QString interpreteVariables(
                        const QString &,
                        const DiagramContext &) const;
        void renderTextCell(
                        QPainter &,
                        const QString &,
                        const TitleBlockCell &,
                        const QRectF &) const;
        void renderTextCellDxf(
                        QString &,
                        const QString &,
                        const TitleBlockCell &,
                        qreal,
                        qreal,
                        qreal,
                        qreal,
                        int) const;
        
        // attributes
        private:
        QString name_;
        QString information_;
        QHash<QString, QByteArray >    data_logos_;
        QHash<QString, QString>        storage_logos_;
        QHash<QString, QString>        type_logos_;
        QHash<QString, QSvgRenderer *> vector_logos_;
        QHash<QString, QPixmap>        bitmap_logos_;
        
        QList<int> rows_heights_; 
        QList<TitleBlockDimension> columns_width_;
        QList<TitleBlockCell *> registered_cells_;
        QList< QList<TitleBlockCell *> > cells_;         
};
#endif