hdicoreGrid.h

Go to the documentation of this file.

 
#ifndef __HDI_CORE_GRID__
#define __HDI_CORE_GRID__
 
#if defined(HDI_CORE_AIP_MODE)
 
#include "hdicoreTypes.h"
#include "hdicoreColor.h"
 
namespace hdi
{
    namespace core
    {
        class Grid
        {
            public:
                enum Style
                {
                    UnknownStyle    = 0,
                    GraphStyle      = 10,
                    DottedStyle     = 20
                };
                
                class Spacing
                {
                    public:
                        double spacing;
                        
                        int32_t ticks;
                        
                        Spacing();
                        
                        virtual ~Spacing();
                };
        
                typedef std::unique_ptr<Spacing> SpacingUP;
                typedef std::shared_ptr<Spacing> SpacingSP;
                typedef std::weak_ptr<Spacing> SpacingWP;
 
                ~Grid();
 
                void show();
                
                void hide();
                
                bool visible() const;
                
                void setVisible(const bool visible_);
                
                bool snaps() const;
                
                void setSnaps(const bool snaps_);
                
                bool behindArt() const;
 
                void setBehindArt(const bool behind_);
 
                Style style() const;
 
                void setStyle(const Style style_);
                
                Spacing spacing() const;
                
                void setSpacing(const Spacing& spacing_);
                
                void setSpacing(const double spacing_, const int32_t ticks_);
                
                Color darkColor() const;
                
                void setDarkColor(const Color& color_);
                
                Color lightColor() const;
                
                void setLightColor(const Color& color_);
 
 
            private:
                // Only CurrentDocument can construct a Grid object
                friend class CurrentDocument;
                
                Grid();
        };
    }
}
 
#endif
// HDI_CORE_AIP_MODE
 
#endif
// __HDI_CORE_GRID__