sethLabels/model/Model.hpp

//  Model.hpp
//
//  Copyright (C) 2013-2026  Jaye Evins <evins@snaught.com>
//
//  This file is part of gLabels-qt.
//
//  gLabels-qt 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 3 of the License, or
//  (at your option) any later version.
//
//  gLabels-qt 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 gLabels-qt.  If not, see <http://www.gnu.org/licenses/>.
//

#ifndef model_Model_hpp
#define model_Model_hpp


#include "Settings.hpp"
#include "Template.hpp"
#include "Variables.hpp"

#include "merge/Merge.hpp"
#include "merge/Record.hpp"

#include <QDir>
#include <QList>
#include <QMimeData>
#include <QObject>
#include <QPainter>


namespace glabels::model
{

        // Forward References
        class ColorNode;
        class Handle;
        class ModelObject;
        class Region;

        ///
        /// Model
        ///
        class Model : public QObject
        {
                Q_OBJECT


                /////////////////////////////////
                // Lifecycle
                /////////////////////////////////
        public:
                Model();
                Model( merge::Merge* merge );
                ~Model();


                /////////////////////////////////
                // Save/restore model state
                /////////////////////////////////
                Model* save() const;
                void restore( const Model *savedModel );


                /////////////////////////////////
                // Signals
                /////////////////////////////////
        signals:
                void changed();
                void nameChanged();
                void sizeChanged();
                void selectionChanged();
                void modifiedChanged();
                void variablesChanged();
                void mergeChanged();
                void mergeSourceChanged();
                void mergeSelectionChanged();


                /////////////////////////////////
                // Properties
                /////////////////////////////////
        public:
                bool isModified() const;
                void setModified();
                void clearModified();

                QDir dir() const;
                QString dirPath() const;
                QString shortName();
                const QString& fileName() const;
                void setFileName( const QString &fileName );

                const Template& tmplate() const;
                const Frame* frame( const QString& id = "0" ) const;
                void setTmplate( const Template& tmplate );

                bool rotate() const;
                void setRotate( bool rotate );

                Distance w() const;
                Distance h() const;

                void setH( Distance h );

                const QList<ModelObject*>& objectList() const;

                Variables& variables();
                const Variables& constVariables() const;

                merge::Merge* merge() const;
                void setMerge( merge::Merge* merge );


                /////////////////////////////////
                // Manage objects
                /////////////////////////////////
        public:
                void addObject( ModelObject* object );
                void deleteObject( ModelObject* object );

                ModelObject* objectAt( double   scale,
                                       Distance x,
                                       Distance y ) const;

                const Handle& handleAt( double   scale,
                                        Distance x,
                                        Distance y ) const;


                /////////////////////////////////
                // Manipulate selection
                /////////////////////////////////
        public:
                void selectObject( ModelObject* object );
                void unselectObject( ModelObject* object );
                void selectAll();
                void unselectAll();
                void selectRegion( const Region& region );
                bool isSelectionEmpty();
                bool isSelectionAtomic();


                /////////////////////////////////
                // Get selected objects
                /////////////////////////////////
        public:
                QList<ModelObject*> getSelection();
                ModelObject* getFirstSelectedObject();


                /////////////////////////////////
                // Query selection capabilities
                /////////////////////////////////
        public:
                bool canSelectionText();
                bool canSelectionFill();
                bool canSelectionLineColor();
                bool canSelectionLineWidth();


                /////////////////////////////////
                // Operations on selections
                /////////////////////////////////
        public:
                void deleteSelection();
                void raiseSelectionToTop();
                void lowerSelectionToBottom();
                void rotateSelection( double thetaDegs );
                void rotateSelectionLeft();
                void rotateSelectionRight();
                void flipSelectionHoriz();
                void flipSelectionVert();
                void alignSelectionLeft();
                void alignSelectionRight();
                void alignSelectionHCenter();
                void alignSelectionTop();
                void alignSelectionBottom();
                void alignSelectionVCenter();
                void centerSelection();
                void centerSelectionHoriz();
                void centerSelectionVert();
                void moveSelection( Distance dx, Distance dy );
                void setSelectionFontFamily( const QString& fontFamily );
                void setSelectionFontSize( double fontSize );
                void setSelectionFontWeight( QFont::Weight fontWeight );
                void setSelectionFontItalicFlag( bool fontItalicFlag );
                void setSelectionTextHAlign( Qt::Alignment textHAlign );
                void setSelectionTextVAlign( Qt::Alignment textVAlign );
                void setSelectionTextLineSpacing( double textLineSpacing );
                void setSelectionTextColorNode( ColorNode textColorNode );
                void setSelectionLineWidth( Distance lineWidth );
                void setSelectionLineColorNode( ColorNode lineColorNode );
                void setSelectionFillColorNode( ColorNode fillColorNode );


                /////////////////////////////////
                // Clipboard operations
                /////////////////////////////////
                void copySelection();
                void cutSelection();
                bool canPaste();
                void paste( Point p );
                void pasteAsNativeObjects( const QMimeData* mimeData, Point p );
                void pasteAsUrls( const QMimeData* mimeData, Point p );
                void pasteAsImage( const QMimeData* mimeData, Point p );
                void pasteAsText( const QMimeData* mimeData, Point p );

                /////////////////////////////////
                // Drawing operations
                /////////////////////////////////
        public:
                void draw( QPainter*            painter,
                           bool                 inEditor,
                           const merge::Record& record,
                           const Variables&     variablesInstance ) const;


                /////////////////////////////////
                // Slots
                /////////////////////////////////
        private slots:
                void onObjectChanged();
                void onObjectMoved();
                void onVariablesChanged();
                void onMergeSourceChanged();
                void onMergeSelectionChanged();


                /////////////////////////////////
                // Private data
                /////////////////////////////////
        private:
                int                       mUntitledInstance{0};
                bool                      mModified{true};
                QString                   mFileName;
                Template                  mTmplate;
                bool                      mRotate{false};

                QList<ModelObject*>       mObjectList;

                Variables                 mVariables;

                QSharedPointer<merge::Merge> mMerge;
        };

}


#endif // model_Model_hpp