hdicoreDocument.h

Go to the documentation of this file.

#ifndef __HDI_CORE_DOCUMENT__
#define __HDI_CORE_DOCUMENT__

#include "hdicoreSize.h"
#include "hdicoreTypes.h"

namespace hdi
{
    namespace plugin
    {
        class Document;
    }
    
    namespace core
    {
        class ArtStyle;
        class Symbol;
    
        class Document
        {
            public:
                class Preset
                {
                    public:
                        enum PreviewMode
                        {
                            PreviewModeDefault      = 10,
                            PreviewModePixel        = 20,
                            PreviewModeOverprint    = 30
                        };

                        enum TransparencyGrid
                        {
                            TransparencyGridNone        = 0,
                            TransparencyGridLightGray   = 10,
                            TransparencyGridGray        = 20,
                            TransparencyGridDarkGray    = 30,
                            TransparencyGridRed         = 40,
                            TransparencyGridOrange      = 50,
                            TransparencyGridGreen       = 60,
                            TransparencyGridBlue        = 70,
                            TransparencyGridPurple      = 80
                        };

                        enum RasterResolution
                        {
                            RasterResolutionScreen  = 10,   // 72 ppi
                            RasterResolutionMedium  = 20,   // 150 ppi
                            RasterResolutionHigh    = 30    // 300 ppi
                        };

                        enum ArtboardLayout
                        {
                            ArtboardLayoutColumn            = 10,
                            ArtboardLayoutRowLR             = 20,
                            ArtboardLayoutRowRL             = 30,
                            ArtboardLayoutGridByRowLR       = 40,
                            ArtboardLayoutGridByColumnLR    = 50,
                            ArtboardLayoutGridByRowRL       = 60,
                            ArtboardLayoutGridByColumnRL    = 70
                        };

                        static const uint32_t maxArtboardCount = 100;
                    
                        std::string title;
                        
                        Size size;
                        
                        uint32_t artboardCount;

                        ArtboardLayout artboardLayout;
                        
                        double artboardSpacing;

                        uint32_t artboardRowOrColumnSize;

                        DocumentColorModel colorModel;

                        RulerUnits rulerUnits;

                        PreviewMode previewMode;

                        TransparencyGrid transparencyGrid;

                        RasterResolution rasterResolution;
                        
                        Preset();
                        
                        virtual ~Preset();
                };

                Document();

                Document(const Document& doc_);
                
                Document(const AIDocumentHandle aiDoc_);

                Document(const std::string& preset_, const bool showDialog_);

                Document(const Preset& preset_, const bool showDialog_);

                virtual ~Document();
            
                virtual Document& operator=(const Document& rhs_);

                virtual AIDocumentHandle aiDocumentHandle() const;

                virtual bool isEmpty() const;

                virtual void save() const;

                virtual void close() const;

                virtual void activate() const;

                virtual void print(const bool showDialog_) const;

                virtual std::string url() const;

                virtual bool exists() const;
            
                virtual bool operator==(const Document& rhs_) const;
            
                virtual bool operator!=(const Document& rhs_) const;
                
                uint32_t artStyleCount() const;
                
                std::auto_ptr<ArtStyle> artStyleAtIndex(const uint32_t index_) const;
                
                uint32_t symbolDefCount() const;
                
                std::auto_ptr<Symbol> symbolDefAtIndex(const uint32_t index_) const;


            private:
                friend plugin::Document* __accessImpl(const Document&);
                friend Document __accessCtor(plugin::Document*&);

                void* __data;
                
                void* __impl() const;
                
                Document(plugin::Document*&);
        };
        
        typedef std::auto_ptr<Document> DocumentAP;
        
        extern plugin::Document* __accessImpl(const Document&);
        extern Document __accessCtor(plugin::Document*&);
    }
}

#endif
// __HDI_CORE_DOCUMENT__