gre/datatip.h

Go to the documentation of this file.

#ifndef  INC_GRE_DATATIP_H
#define  INC_GRE_DATATIP_H

#ifndef  INC_RVC_OBJECTNAME_H
   #include <rvc/objectname.h>
#endif

#ifndef  INC_MI32_ELEMTYPE_H
   #include <mi32/elemtype.h>
#endif

#ifndef  GENERATING_DOXYGEN_OUTPUT
class SERIALIZERITEM;
namespace RVC {
   class DBTABLE;
   }
namespace SPATMOD {
   namespace IMAGE {
      class STAGE_ARRAY;
      }
   }
#endif


namespace GRE {

struct DATATIPPARMS {
   public:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      class FORM;
      #endif // GENERATING_DOXYGEN_OUTPUT

      // At present only one value is allowed, however defined as bits so could allow multiple in future
      enum PREDEFINED {
         PREDEFINED_None =             0x00,
         PREDEFINED_ImageCellValue =   0x01,
         PREDEFINED_LinkTileName =     0x02,
         };

      RVC::OBJECTNAME TableName;             
      RVC::OBJECTNAME FieldName;             
      INT32 TableNum;                        
      mutable INT32 FieldNum;                
      UINT8 Visible;                         
      UINT8 IsNumeric;                       
      UINT8 UnitType;                        
      UINT8 m_Predefined;                    
      UINT8 UnitShown;                       
      UINT8 DecPlaces;                       
      UINT8 NoChgField;                      
      UINT8 HighlightElem;                   
      MISTRING Prefix;                       
      MISTRING Suffix;                       

      static const SERIALIZERITEM *GetSerialItemDef();

      DATATIPPARMS (
         );

      DATATIPPARMS (
         const DATATIPPARMS& rhs
         );

      DATATIPPARMS& operator= (
         const DATATIPPARMS& rhs
         );

      ERRVALUE CheckField (
         RVC::DBTABLE& ObjTable
         );

      void FormatString (
         MISTRING& ostr,                  
         const MISTRING& istr             
         ) const;

      int ReadString (
         RVC::DBTABLE& ObjTable,          
         ELEMTYPE ElemType,               
         INT32 ElemNum,                   
         MISTRING& string,                
         SPATMOD::IMAGE::STAGE_ARRAY& images, 
         RVC::DBTABLE *pSourceTable = 0   
         ) const;

      int ReadStringFormatted (
         RVC::DBTABLE& ObjTable,          
         ELEMTYPE ElemType,               
         INT32 ElemNum,                   
         MISTRING& string,                
         SPATMOD::IMAGE::STAGE_ARRAY& images, 
         RVC::DBTABLE *pSourceTable = 0   
         ) const;

      void SetDefaultSuffix (
         );

   };

}  // End namespace GRE

#endif   // INC_GRE_DATATIP_H

---