gre/elemparms.h

Go to the documentation of this file.

#ifndef  INC_GRE_ELEMPARMS_H
#define  INC_GRE_ELEMPARMS_H

#ifndef  INC_GRE_BASE_H
   #include <gre/base.h>
#endif

#ifndef  INC_MI32_GREMODE_H
   #include <mi32/gremode.h>
#endif

#ifndef  INC_MI32_LABLSTYL_H
   #include <mi32/lablstyl.h>
#endif

#ifndef  INC_GRE_DATATIP_H
   #include <gre/datatip.h>
#endif

#ifndef  INC_GRE_LEGENDPARMS_H
   #include <gre/legendparms.h>
#endif


#ifndef GENERATING_DOXYGEN_OUTPUT
namespace RVC {
   class DBASE;
   }
#endif


namespace GRE {
//===================================================================================================================

#define  LABELSELECT_None           0x0000
#define  LABELSELECT_AllDrawnElem   0x0001   
#define  LABELSELECT_IfFit          0x0002   

#define  LABELTEXT_None             0x0000
#define  LABELTEXT_ByAttribute      0x0001
#define  LABELTEXT_ByField          LABELTEXT_ByAttribute
#define  LABELTEXT_ByScript         0x0002
#define  LABELTEXT_ByQuery          LABELTEXT_ByScript

#define  LABELPOSN_Default             0

#define  LABELPOSN_PointAboveLeft      1
#define  LABELPOSN_PointAboveCenter    2
#define  LABELPOSN_PointAboveRight     3
#define  LABELPOSN_PointCenterLeft     4
#define  LABELPOSN_PointCenter         5
#define  LABELPOSN_PointCenterRight    6
#define  LABELPOSN_PointBelowLeft      7
#define  LABELPOSN_PointBelowCenter    8
#define  LABELPOSN_PointBelowRight     9

#define  AUTOLABELOPTM_None            0x00
#define  AUTOLABELOPTM_Fast            0x01
#define  AUTOLABELOPTM_Full            0x02
#define  AUTOLABELOPTM_HideOverlap     0x04

#define  AUTOLABELPRIORITY_AllSame     0
#define  AUTOLABELPRIORITY_ByField     1
#define  AUTOLABELPRIORITY_ByScript    2


//===================================================================================================================
//    Parameters needed for various element types

struct SELECTPARMS {
   public:
      UINT16 Mode;                           
      INT16 Table;                           
      MIUNICODE *QueryStr;                   
      RVC::OBJECTNAME TableName;             

      SELECTPARMS (                          
         );
      SELECTPARMS (                          
         const SELECTPARMS& rhs
         );
      ~SELECTPARMS ();                       

      SELECTPARMS& operator= (               
         const SELECTPARMS& rhs
         );

      void CheckTable (
         const RVC::DBASE& db,               
         bool fixmode                        
         );

      bool NeedTable (
         ) const { return ((Mode & SELECTMODE_NeedsTable) != 0); }

      void Validate ();
   };

struct STYLEPARMS {
   public:
      UINT16 Mode;                           
      INT16 Table;                           
      MIUNICODE *QueryStr;                   
      RVC::OBJECTNAME TableName;             
      MISTRING m_ImageFieldName;             

      STYLEPARMS (                           
         );
      STYLEPARMS (                           
         const STYLEPARMS& rhs
         );
      ~STYLEPARMS ();                        

      STYLEPARMS& operator= (                
         const STYLEPARMS& rhs
         );

      void CheckTable (
         const RVC::DBASE& db,               
         bool fixmode,                       
         const RVC::STYLETYPE styletype = RVC::STYLETYPE_NumTypes
         );

      bool NeedTable (
         ) const { return ((Mode & STYLEMODE_NeedsTable) != 0); }

      void Validate ();
   };

struct AUTOLABELPARMS {
   public:
      static const SERIALIZERITEM *GetSerialItemDef();
      UINT8 SelectMode;                      
      UINT8 TextMode;                        
      UINT8 Posn;                            
      UINT8 Optm;                            
      UINT8 Priority;                        
      RVC::OBJECTNAME TableName;             
      RVC::OBJECTNAME FieldName;             
      MIUNICODE *QueryStr;                   
      TEXTSTYLE Style;                       
      LABELFRAMEPARMS FrameParms;            
      RVC::OBJECTNAME PriorityTableName;     
      RVC::OBJECTNAME PriorityFieldName;     
      double m_MinScaleVisible;              
      double m_MaxScaleVisible;              

      AUTOLABELPARMS (
         );

      AUTOLABELPARMS (
         const AUTOLABELPARMS& rhs
         );

      ~AUTOLABELPARMS (
         );

      AUTOLABELPARMS& operator= (
         const AUTOLABELPARMS& rhs
         );

      void CheckTable (
         const RVC::DBASE& db,               
         bool fixmode                        
         );

      bool IsSelected (
         double scale                  
         ) const { return (SelectMode != LABELSELECT_None && scale >= m_MinScaleVisible && (m_MaxScaleVisible <= 0.0 || scale <= m_MaxScaleVisible)); }

      void Validate ();

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      void Copy (const AUTOLABELPARMS& rhs);
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

struct POINTPARMS {
   public:

      struct POINTSTYLEPARMS : public STYLEPARMS {
         POINTSTYLE Normal;                  
         };

      SELECTPARMS Select;
      POINTSTYLEPARMS Style;
      DATATIPPARMS DataTip;                  
      AUTOLABELPARMS AutoLabel;
      LEGENDPARMS Legend;
      RVC::OBJECTNAME LegendElemTableName;

      POINTPARMS ();
      POINTPARMS (const POINTPARMS& rhs);
      ~POINTPARMS ();

      POINTPARMS& operator= (const POINTPARMS& rhs);
      void Validate ();
   };

struct LINEPARMS {
   public:

      struct LINESTYLEPARMS : public STYLEPARMS {
         LINESTYLE Normal;             
         };

      SELECTPARMS Select;
      LINESTYLEPARMS Style;
      DATATIPPARMS DataTip;            
      AUTOLABELPARMS AutoLabel;
      LEGENDPARMS Legend;
      RVC::OBJECTNAME LegendElemTableName;

      LINEPARMS ();
      LINEPARMS (const LINEPARMS& rhs);
      ~LINEPARMS ();

      LINEPARMS& operator= (const LINEPARMS& rhs);
      void Validate ();
   };

struct POLYPARMS {
   public:

      struct POLYSTYLEPARMS : public STYLEPARMS {
         POLYSTYLE Normal;             
         };

      SELECTPARMS Select;
      POLYSTYLEPARMS Style;
      DATATIPPARMS DataTip;            
      AUTOLABELPARMS AutoLabel;
      LEGENDPARMS Legend;
      LEGENDPARMS LegendInt;           
      RVC::OBJECTNAME LegendElemTableName;
      bool ShowInteriorLabel;          
      bool ShowLabel;                  

      POLYPARMS ();
      POLYPARMS (const POLYPARMS& rhs);
      ~POLYPARMS ();

      POLYPARMS& operator= (const POLYPARMS& rhs);
      void Validate ();
   };

struct LABELPARMS {
   public:

      struct LABELSTYLEPARMS : public STYLEPARMS {
         TEXTSTYLE Normal;             
         LABELFRAMEPARMS FrameParms;
         
         LABELSTYLEPARMS ();
         };

      SELECTPARMS Select;
      LABELSTYLEPARMS Style;
      DATATIPPARMS DataTip;            
      double MinScaleVisible;          
      double MaxScaleVisible;          

      LABELPARMS ();
      LABELPARMS (const LABELPARMS& rhs);
      ~LABELPARMS ();

      LABELPARMS& operator= (const LABELPARMS& rhs);

      bool IsVisibleAtScale (
         double scale                  
         ) const { return (scale >= MinScaleVisible && (MaxScaleVisible <= 0.0 || scale <= MaxScaleVisible)); }
      void Validate ();
   };

//===================================================================================================================
}  // End namespace GRE
#endif   // INC_GRE_ELEMPARMS_H

---