CRNAltoLayout.hpp

Go to the documentation of this file.

/* Copyright 2011-2016 CoReNum
 * 
 * This file is part of libcrn.
 * 
 * libcrn is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * libcrn 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 Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with libcrn.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * file: CRNAltoLayout.h
 * \author Yann LEYDIER
 */

#ifdef CRNAlto_HEADER

class Layout: public Element
{
    public:
        Layout(const Layout&) = delete;
        Layout(Layout&&) = default;
        virtual ~Layout() override {}
        Layout& operator=(const Layout&) = delete;
        Layout& operator=(Layout&&) = default;

        std::vector<Id> GetStyles() const;
        void AddStyle(const Id &styleid);
        void RemoveStyle(const Id &styleid);

        class Page: public Element
        {
            public:
                enum class Position { Undef = 0, Left, Right, Foldout, Single, Cover };

                Page(const Page&) = delete;
                Page(Page&&) = default;
                virtual ~Page() override {}
                Page& operator=(const Page&) = delete;
                Page& operator=(Page&&) = default;

                const Id& GetId() const { return id; }
                Option<StringUTF8> GetPageClass() const;
                void SetPageClass(const StringUTF8 &s);
                std::vector<Id> GetStyles() const;
                void AddStyle(const Id &styleid);
                void RemoveStyle(const Id &styleid);
                Option<int> GetHeight() const;
                void SetHeight(int i);
                Option<int> GetWidth() const;
                void SetWidth(int i);
                int GetPhysicalImageNumber() const;
                void SetPhysicalImageNumber(int pnum);
                Option<StringUTF8> GetPrintedImageNumber() const;
                void SetPrintedImageNumber(const StringUTF8 &s);
                enum class Quality { Undef = 0, Ok, Missing, MissingInOriginal, Damaged, Retained, Target, AsInOriginal };
                Option<Quality> GetQuality() const;
                void SetQuality(Quality q);
                Option<StringUTF8> GetQualityDetail() const;
                void SetQualityDetail(const StringUTF8 &s);
                Option<Position> GetPosition() const;
                Option<Id> GetProcessing() const;
                Option<double> GetAccuracy() const;
                void SetAccuracy(double acc);
                Option<double> GetPageConfidence() const;
                void SetPageConfidence(double c);

#include <CRNXml/CRNAltoSpace.hpp>
                typedef std::weak_ptr<Space> SpacePtr;
                SpacePtr GetTopMargin() { return topMargin; }
                SpacePtr GetLeftMargin() { return leftMargin; }
                SpacePtr GetRightMargin() { return rightMargin; }
                SpacePtr GetBottomMargin() { return bottomMargin; }
                SpacePtr GetPrintSpace() { return printSpace; }
                Space& GetSpace(const Id &sid);

                Space& AddTopMargin(const Id &id_, double x, double y, double w, double h);
                Space& AddLeftMargin(const Id &id_, double x, double y, double w, double h);
                Space& AddRightMargin(const Id &id_, double x, double y, double w, double h);
                Space& AddBottomMargin(const Id &id_, double x, double y, double w, double h);
                Space& AddPrintSpace(const Id &id_, double x, double y, double w, double h);
                std::vector<SpacePtr> GetSpaces() const;
                
                void RemoveSpace(const Id &sid);

            private:
                Page(const Element &el);
                Page(const Element &el, const Id &id_, int image_number, Option<int> width, Option<int> height, Option<Position> position);
                void update_subelements();

                Id id;
                SpacePtr topMargin, leftMargin, rightMargin, bottomMargin, printSpace;
                std::vector<std::shared_ptr<Space> > spaces;
                std::map<Id, std::weak_ptr<Space> > id_spaces;
                
            friend class Layout;
        };
        typedef std::weak_ptr<Page> PagePtr;

        Page& GetPage(const Id &pid);
        std::vector<PagePtr> GetPages() const;
        Page& AddPage(const Id &id_, int image_number, Option<int> width_ = Option<int>(), Option<int> height_ = Option<int>(), Option<Page::Position> pos = Option<Page::Position>());
        Page& AddPageAfter(const Id &pred, const Id &id_, int image_number, Option<int> width_ = Option<int>(), Option<int> height_ = Option<int>(), Option<Page::Position> pos = Option<Page::Position>());
        Page& AddPageBefore(const Id &next, const Id &id_, int image_number, Option<int> width_ = Option<int>(), Option<int> height_ = Option<int>(), Option<Page::Position> pos = Option<Page::Position>());

        void RemovePage(const Id &pid);

    private:
        Layout(const Element &el);
        void update_subelements();

        std::vector<std::shared_ptr<Page> > pages;
        std::map<Id, std::weak_ptr<Page> > id_pages;

    friend class Root;
};

#else
#error  you cannot include this file directly
#endif