bordertitleblock.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 BORDERTITLEBLOCK_H
#define BORDERTITLEBLOCK_H
#include "autoNum/numerotationcontext.h"
#include "borderproperties.h"
#include "diagramcontext.h"
#include "titleblockproperties.h"
 
#include <QDate>
#include <QObject>
#include <QRectF>
class QPainter;
class DiagramPosition;
class TitleBlockTemplate;
class TitleBlockTemplateRenderer;
class BorderTitleBlock : public QObject
{
                Q_OBJECT
        
        public:
                BorderTitleBlock(QObject * = nullptr);
                ~BorderTitleBlock() override;
        
        private:
                BorderTitleBlock(const BorderTitleBlock &);
        
                //METHODS
        public: 
                void draw(QPainter *painter);
                void drawDxf(QString &, int);
        
                //METHODS TO GET DIMENSION
                //COLUMNS
                int   columnsCount() const { return(columns_count_); }
                qreal columnsWidth() const { return(columns_width_); }
                qreal columnsTotalWidth() const {
                        return(columns_count_ * columns_width_); }

                qreal columnsHeaderHeight() const {
                        return(columns_header_height_); }
        
                //ROWS
                int rowsCount() const { return(rows_count_); }
                qreal rowsHeight() const { return(rows_height_); }
                qreal rowsTotalHeight() const {
                        return(rows_count_ * rows_height_); }

                qreal rowsHeaderWidth() const { return(rows_header_width_); }
                Qt::Edge titleBlockEdge() const { return(m_edge); }
        
                // border - title block = diagram
                qreal diagramWidth() const
{
                        return(columnsTotalWidth() + rowsHeaderWidth()); }

                qreal diagramHeight() const
{
                        return(rowsTotalHeight() + columnsHeaderHeight()); }
 
                QRectF titleBlockRect () const;
 
                DiagramContext titleblockInformation() const;
        private:
                QRectF titleBlockRectForQPainter () const;
 
        public:
                QRectF borderAndTitleBlockRect () const;
                QRectF columnsRect () const;
                QRectF rowsRect () const;
                QRectF outsideBorderRect() const;
                QRectF insideBorderRect() const;
        
                // methods to get title block basic data
                QString author() const { return(btb_author_); }
                QDate date() const { return(btb_date_); }
                QString title() const { return(btb_title_); }
                QString folio() const { return(btb_folio_); }
                QString finalfolio() const { return(btb_final_folio_); }
                QString plant() const { return(btb_plant_); }
                QString locmach() const { return(btb_locmach_); }
                QString indexrev() const { return(btb_indexrev_); }
                QString fileName() const { return(btb_filename_); }
                QString version() const { return(btb_version_); }
                DiagramContext additionalFields() const {
                        return (additional_fields_); }

                QString autoPageNum() const { return(btb_auto_page_num_); }
                int folioTotal() const { return(folio_total_);}
        
                // methods to get display options
                bool titleBlockIsDisplayed() const {
                        return(display_titleblock_); }

                bool columnsAreDisplayed() const { return(display_columns_); }
                bool rowsAreDisplayed() const { return(display_rows_); }
                bool borderIsDisplayed() const { return(display_border_); }
                
                // methods to set dimensions
                void setColumnsCount(int);
                void setRowsCount(int);
                void setColumnsWidth(const qreal &);
                void setRowsHeight(const qreal &);
                void setColumnsHeaderHeight(const qreal &);
                void setRowsHeaderWidth(const qreal &);
                void setDiagramHeight(const qreal &);
                
                DiagramPosition convertPosition(const QPointF &);
                
                // methods to set title block basic data
                void setFolio(const QString &folio);
                void setFolioData(int, int, const QString& = nullptr,
                                  const DiagramContext & = DiagramContext());
                void setPreviousFolioNum(const QString &previous);
                void setNextFolioNum(const QString &next);
                
                void titleBlockToXml(QDomElement &);
                void titleBlockFromXml(const QDomElement &);
                void borderToXml(QDomElement &);
                void borderFromXml(const QDomElement &);
                
                TitleBlockProperties exportTitleBlock();
                void importTitleBlock(const TitleBlockProperties &);
                BorderProperties exportBorder();
                void importBorder(const BorderProperties &);
                
                const TitleBlockTemplate *titleBlockTemplate();
                void setTitleBlockTemplate(const TitleBlockTemplate *);
                QString titleBlockTemplateName() const;
                
        public slots:
                void titleBlockTemplateChanged(const QString &);
                void titleBlockTemplateRemoved(
                                const QString &,
                                const TitleBlockTemplate * = nullptr);
                
                // methods to set display options
                void displayTitleBlock(bool);
                void displayColumns(bool);
                void displayRows(bool);
                void displayBorder(bool);
        
        private:
                void updateRectangles();
                void updateDiagramContextForTitleBlock(
                                const DiagramContext & = DiagramContext());
                QString incrementLetters(const QString &);
        
                signals:
                void borderChanged(QRectF old_border, QRectF new_border);
                void displayChanged();
                void titleBlockFolioChanged(const QString &);
                void needFolioData();
                void needTitleBlockTemplate(const QString &);

                void informationChanged();
        
        // attributes
        private:
                // titleblock basic data
                QString btb_author_;        
                QDate   btb_date_;          
                QString btb_title_;         
                QString btb_folio_;         
                QString btb_plant_;         
                QString btb_locmach_;       
                QString btb_indexrev_;      
                QString btb_final_folio_;   
                QString btb_auto_page_num_; 
                int folio_index_;           
                int folio_total_;           
                QString btb_filename_;      
                QString btb_version_;       
                DiagramContext additional_fields_;
                Qt::Edge m_edge;              
                QString m_next_folio_num;     
                QString m_previous_folio_num; 
        
                // border dimensions (rows and columns)
                // columns: number and dimensions
                int columns_count_;           
                qreal columns_width_;         
                qreal columns_header_height_; 
        
                // rows: number and dimensions
                int rows_count_;          
                qreal rows_height_;       
                qreal rows_header_width_; 
        
                // title block dimensions
                qreal titleblock_height_;
        
                // rectangles used for drawing operations
                QRectF diagram_rect_;
        
                        // display options
                bool display_titleblock_;
                bool display_columns_;
                bool display_rows_;
                bool display_border_;
                TitleBlockTemplateRenderer *m_titleblock_template_renderer;
};
#endif