//  Frame.hpp
//
//  Copyright (C) 2013-2016  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_Frame_hpp
#define model_Frame_hpp


#include "Distance.hpp"
#include "Layout.hpp"
#include "Markup.hpp"
#include "Point.hpp"

#include <QCoreApplication>
#include <QDebug>
#include <QPainterPath>
#include <QString>
#include <QVector>

#include <list>


namespace glabels::model
{

        class Frame
        {
                Q_DECLARE_TR_FUNCTIONS(Frame)

        protected:
                Frame( const QString& id = "0" );
                Frame( const Frame& other );

        public:
                virtual ~Frame() = default;

                virtual std::unique_ptr<Frame> clone() const = 0;

                QString id() const;
                int nLabels() const;
                QString layoutDescription() const;
                const std::list<Layout>&  layouts() const;
                const std::list<std::unique_ptr<Markup>>& markups() const;

                QVector<Point> getOrigins() const;

                void addLayout( const Layout& layout );
                void addMarkup( const Markup& markup );

                virtual Distance w() const = 0;
                virtual Distance h() const = 0;

                virtual bool setH( Distance h );

                virtual QString sizeDescription( Units units ) const = 0;
                virtual bool isSimilarTo( const Frame& other ) const = 0;

                virtual const QPainterPath& path() const = 0;
                virtual const QPainterPath& clipPath() const = 0;
                virtual QPainterPath marginPath( Distance xSize, Distance ySize ) const = 0;

                // Debugging support
                virtual void print( QDebug& dbg ) const = 0;


        private:
                QString mId;
                int     mNLabels;
                QString mLayoutDescription;

                std::list<Layout>                  mLayouts;
                std::list<std::unique_ptr<Markup>> mMarkups;
        };

}


// Debugging support
QDebug operator<<( QDebug dbg, const glabels::model::Frame& frame );


#endif // model_Frame_hpp