rvc/style.h

Go to the documentation of this file.

#ifndef INC_RVC_STYLE_H
#define INC_RVC_STYLE_H

#ifndef INC_RVC_OBJECT_H
   #include <rvc/object.h>
#endif

#ifndef INC_RVC_STYLETYPE_H
   #include <rvc/styletype.h>
#endif

#ifndef INC_RVC_GETOBJFILTER_H
   #include <rvc/getobjfilter.h>
#endif


#ifndef GENERATING_DOXYGEN_OUTPUT
// Forward declarations
struct POINTSTYLE;
struct LINESTYLE;
struct MULTISTYLE;
struct POLYSTYLE;
struct TEXTSTYLE;
struct RVCPOINTSTYLE;
struct RVCLINESTYLE;
struct RVCPOLYGONSTYLE;
struct RVCTEXTSTYLE;
namespace RVC {
   class DESCRIPTOR;
   class STYLEPATTERN_BASE;
   class STYLEPATTERN_BITMAP;
   class STYLEPATTERN_HATCH;
   class STYLEPATTERN_LINE;
   class STYLEPATTERN_SYMBOL;
   class STYLEHANDLE;
   }
#endif


namespace RVC {

class STYLE : public RVC::OBJECT {
   public:
   
      #ifndef GENERATING_DOXYGEN_OUTPUT
      class GETOBJFILTER_ISSELECTABLE;
      class GETOBJFILTER_HASPATTERNTYPE;
      class GETOBJFILTER_HASSTYLETYPE;
      class UNIQUEPATTERNNAMEFILTER;
      class UNIQUESTYLENAMEFILTER;
      #endif // GENERATING_DOXYGEN_OUTPUT
      
      STYLE (
         );

      STYLE (
         const RVC::STYLE& obj
         );

      virtual ~STYLE (
         );

      RVC::STYLE& operator= (
         const RVC::STYLE& rhs
         );

      INT32 AddPattern (
         RVC::PATTERNTYPE PattType,             
         void *Pattern                 
         );
                              
      INT32 AddPattern (
         RVC::PATTERNTYPE PattType,          
         const STYLEPATTERN_BASE& Pattern             
         );
         
      INT32 AddPattern (
         const STYLEPATTERN_BITMAP& Pattern              
         );
         
      INT32 AddPattern (
         const STYLEPATTERN_HATCH& Pattern               
         );
         
      INT32 AddPattern (
         const STYLEPATTERN_LINE& Pattern             
         );
         
      INT32 AddPattern (
         const STYLEPATTERN_SYMBOL& Pattern              
         );
         
      DEPRECATED INT32 AddStyle (            
         RVCPOINTSTYLE& style          
         );
                              
      INT32 AddStyle (
         const RVC::OBJECTNAME& name,
         const POINTSTYLE& style          
         );
                              
      DEPRECATED INT32 AddStyle (            
         RVCPOLYGONSTYLE& style           
         );
                              
      INT32 AddStyle (
         const RVC::OBJECTNAME& name,
         const POLYSTYLE& style           
         );
                              
      DEPRECATED INT32 AddStyle (            
         RVCLINESTYLE& style           
         );
                              
      INT32 AddStyle (
         const RVC::OBJECTNAME& name,
         const LINESTYLE& style           
         );
                              
      DEPRECATED INT32 AddStyle (            
         RVCTEXTSTYLE& style           
         );

      INT32 AddStyle (
         const RVC::OBJECTNAME& name,
         const TEXTSTYLE& style           
         );

      ERRVALUE Combine (
         const RVC::OBJECT& DestParentObj,            
         RVC::STYLE& DestStyleObj,                    
         SIMPLE_ARRAY<INT32>& FontTrans,
         SIMPLE_ARRAY<INT32> PattTrans[PATTERNTYPE_NumTypes]
         );
         
      ERRVALUE Combine (
         const RVC::OBJECT& DestParentObj,            
         RVC::STYLE& DestStyleObj                     
         );
         
      DEPRECATED void ConvertStyle (
         RVCLINESTYLE& rvcstyle,
         const LINESTYLE& linestyle
         ) const;
         
      DEPRECATED void ConvertStyle (
         LINESTYLE& linestyle,
         const RVCLINESTYLE& rvcstyle
         ) const;
         
      DEPRECATED void ConvertStyle (
         RVCPOINTSTYLE& rvcstyle,
         const POINTSTYLE& pointstyle
         ) const;
         
      DEPRECATED void ConvertStyle (
         POINTSTYLE& pointstyle,
         const RVCPOINTSTYLE& rvcstyle
         ) const;
         
      DEPRECATED void ConvertStyle (
         RVCPOLYGONSTYLE& rvcstyle,
         const POLYSTYLE& polystyle
         ) const;
         
      DEPRECATED void ConvertStyle (
         POLYSTYLE& polystyle,
         const RVCPOLYGONSTYLE& rvcstyle
         ) const;
         
      DEPRECATED void ConvertStyle (
         RVCTEXTSTYLE& rvcstyle,
         const TEXTSTYLE& textstyle
         );             
         
      DEPRECATED void ConvertStyle (
         TEXTSTYLE& textstyle,
         const RVCTEXTSTYLE& rvcstyle
         ) const;
         
      INT32 DeletePattern (
         PATTERNTYPE PattType,               
         INT32 PattNum                 
         );

      INT32 DeleteStyle (
         STYLETYPE StyleType,             
         INT32 StyleNum                
         );

      ERRVALUE DeleteStyleType (
         STYLETYPE StyleType                 
         );

      INT32 FindFontName (
         INT32 start,                  
         const MISTRING& name          
         ) const;

      INT32 FontTransAdd (
         const MISTRING& name          
         );

      INT32 FontTransIndexToHandle (
         INT32 FontNum                 
         );

      ERRVALUE FontTransIndexToName (
         INT32 FontNum,          
         MISTRING& name                
         ) const;

      INT32 FindPattern (
         PATTERNTYPE PattType,               
         INT32 StartPattNum,           
         const RVC::OBJECTNAME& name   
         ) const;

      INT32 FindPattern (
         PATTERNTYPE PattType,               
         const RVC::DESCRIPTOR& Descriptor,  
         INT32 StartPattNum = 0           
         ) const;

      INT32 FindStyle (
         STYLETYPE StyleType,             
         INT32 StartStyleNum,          
         const RVC::OBJECTNAME& name   
         ) const;

      INT32 FindStyle (
         STYLETYPE StyleType,             
         const RVC::DESCRIPTOR& Descriptor,  
         INT32 StartStyleNum = 0          
         ) const;

      INT32 GetFontNameCount (
         ) const;

      INT32 GetPatternCount (
         PATTERNTYPE PattType             
         ) const;

      INT32 GetPatternMaxSize (
         PATTERNTYPE PattType             
         ) const;

      INT32 GetPatternSize (
         PATTERNTYPE PattType,               
         INT32 PattNum                 
         ) const;

      INT32 GetStyleCount (
         STYLETYPE StyleType                 
         ) const;

      ERRVALUE Make (
         const RVC::OBJECT& parent,    
         const RVC::DESCRIPTOR& Descriptor,
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS            
         );

      ERRVALUE Make (
         RVC::OBJITEM& ObjItem,  
#ifdef RVC_CREDENTIALS_MANDATORY
         const char* Source,        
         const CREDENTIALS* Credentials 
#else
         const char* Source = 0,       
         const CREDENTIALS* Credentials = 0           
#endif
         );

      ERRVALUE ReadPattern (
         PATTERNTYPE PattType,               
         INT32 PatternNum,             
         void *Pattern                 
         ) const;
      
      ERRVALUE ReadPattern (
         PATTERNTYPE PattType,               
         INT32 PatternNum,             
         STYLEPATTERN_BASE& Pattern          
         ) const;
      
      ERRVALUE ReadPattern (
         INT32 PatternNum,             
         STYLEPATTERN_BITMAP& Pattern           
         ) const;
      
      ERRVALUE ReadPattern (
         INT32 PatternNum,             
         STYLEPATTERN_HATCH& Pattern            
         ) const;
      
      ERRVALUE ReadPattern (
         INT32 PatternNum,             
         STYLEPATTERN_LINE& Pattern          
         ) const;
      
      ERRVALUE ReadPattern (
         INT32 PatternNum,             
         STYLEPATTERN_SYMBOL& Pattern           
         ) const;
      
      ERRVALUE ReadPatternDescriptor (
         PATTERNTYPE PattType,               
         INT32 PattNum,                
         RVC::DESCRIPTOR& Descriptor   
         ) const;

      ERRVALUE ReadPatternHdr (
         PATTERNTYPE PattType,               
         INT32 PatternNum,             
         void *PattHdr                 
         ) const;

      ERRVALUE ReadPatternName (
         PATTERNTYPE PattType,               
         INT32 PattNum,                
         RVC::OBJECTNAME& name         
         ) const;

      DEPRECATED ERRVALUE ReadStyle (
         INT32 StyleNum,               
         RVCPOINTSTYLE& style          
         ) const;

      ERRVALUE ReadStyle (
         INT32 StyleNum,               
         POINTSTYLE& style          
         ) const;

      DEPRECATED ERRVALUE ReadStyle (
         INT32 StyleNum,               
         RVCPOLYGONSTYLE& style           
         ) const;

      ERRVALUE ReadStyle (
         INT32 StyleNum,               
         POLYSTYLE& style           
         ) const;

      DEPRECATED ERRVALUE ReadStyle (
         INT32 StyleNum,               
         RVCLINESTYLE& style           
         ) const;

      ERRVALUE ReadStyle (
         INT32 StyleNum,               
         LINESTYLE& style           
         ) const;

      DEPRECATED ERRVALUE ReadStyle (
         INT32 StyleNum,               
         RVCTEXTSTYLE& style           
         ) const;

      ERRVALUE ReadStyle (
         INT32 StyleNum,               
         TEXTSTYLE& style           
         ) const;

      ERRVALUE ReadStyleDescriptor (
         STYLETYPE StyleType,             
         INT32 StyleNum,                  
         RVC::DESCRIPTOR& Descriptor   
         ) const;

      ERRVALUE ReadStyleName (
         STYLETYPE StyleType,             
         INT32 StyleNum,               
         RVC::OBJECTNAME& name         
         ) const;

      ERRVALUE WritePattern (
         PATTERNTYPE PattType,               
         INT32 PatternNum,             
         void *Pattern                 
         );

      ERRVALUE WritePattern (
         PATTERNTYPE PattType,               
         INT32 PatternNum,             
         const STYLEPATTERN_BASE& Pattern                
         );

      ERRVALUE WritePattern (
         INT32 PatternNum,             
         const STYLEPATTERN_BITMAP& Pattern                 
         );

      ERRVALUE WritePattern (
         INT32 PatternNum,             
         const STYLEPATTERN_HATCH& Pattern                  
         );

      ERRVALUE WritePattern (
         INT32 PatternNum,             
         const STYLEPATTERN_LINE& Pattern                
         );

      ERRVALUE WritePattern (
         INT32 PatternNum,             
         const STYLEPATTERN_SYMBOL& Pattern                 
         );

      ERRVALUE WritePatternDescriptor (
         PATTERNTYPE PattType,               
         INT32 PatternNum,             
         const DESCRIPTOR& Descriptor  
         );
   
      ERRVALUE WritePatternName (
         PATTERNTYPE PattType,               
         INT32 PatternNum,             
         const OBJECTNAME& name        
         );
   
      DEPRECATED ERRVALUE WriteStyle (
         INT32 StyleNum,               
         RVCPOINTSTYLE& style          
         );

      ERRVALUE WriteStyle (
         INT32 StyleNum,               
         const RVC::OBJECTNAME& name,
         const POINTSTYLE& style          
         );

      DEPRECATED ERRVALUE WriteStyle (          
         INT32 StyleNum,               
         RVCPOLYGONSTYLE& style           
         );

      ERRVALUE WriteStyle (            
         INT32 StyleNum,               
         const RVC::OBJECTNAME& name,
         const POLYSTYLE& style           
         );

      DEPRECATED ERRVALUE WriteStyle (
         INT32 StyleNum,               
         RVCLINESTYLE& style           
         );

      ERRVALUE WriteStyle (
         INT32 StyleNum,               
         const RVC::OBJECTNAME& name,
         const LINESTYLE& style           
         );

      DEPRECATED ERRVALUE WriteStyle (
         INT32 StyleNum,               
         RVCTEXTSTYLE& style           
         );

      ERRVALUE WriteStyle (
         INT32 StyleNum,               
         const RVC::OBJECTNAME& name,
         const TEXTSTYLE& style           
         );

      ERRVALUE WriteStyleDescriptor (
         STYLETYPE StyleType,             
         INT32 StyleNum,               
         const DESCRIPTOR& Descriptor  
         );

      ERRVALUE WriteStyleName (
         STYLETYPE StyleType,             
         INT32 StyleNum,               
         const RVC::OBJECTNAME& name   
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      virtual ERRVALUE v_CloseObject ();
      virtual OBJTYPE v_GetDftObjectType () const;
      virtual bool v_IsObjectOpen () const;
      virtual ERRVALUE v_OpenObject (OPENMODE OpenFlags, MDLGPARENT parent, const CREDENTIALS* Credentials);

      STYLEHANDLE* m_StyleHandle;
      #endif // GENERATING_DOXYGEN_OUTPUT

   };


class STYLE::GETOBJFILTER_ISSELECTABLE : public GETOBJFILTER {
   public:
      GETOBJFILTER_ISSELECTABLE (
         bool IsSaving = false      
         );
   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      bool m_IsSaving;
      virtual bool v_HasSelectableSubObjects (const RVC::OBJITEM& objitem);
      virtual bool v_IsSelectable (const RVC::OBJITEM& ObjItem, int position);
      #endif // GENERATING_DOXYGEN_OUTPUT
   };


class STYLE::GETOBJFILTER_HASPATTERNTYPE : public GETOBJFILTER {
   public:
      GETOBJFILTER_HASPATTERNTYPE (
         PATTERNTYPE PatternType
         ) : m_PatternType(PatternType) {}
         
   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      PATTERNTYPE m_PatternType;
      
      virtual bool v_HasSelectableSubObjects (const RVC::OBJITEM& objitem);
      virtual bool v_IsSelectable (const RVC::OBJITEM& ObjItem, int position);
      #endif // GENERATING_DOXYGEN_OUTPUT
   };


class STYLE::GETOBJFILTER_HASSTYLETYPE : public GETOBJFILTER {
   public:
      GETOBJFILTER_HASSTYLETYPE (
         STYLETYPE StyleType
         ) : m_StyleType(StyleType) {}
         
   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      STYLETYPE m_StyleType;
      
      virtual bool v_HasSelectableSubObjects (const RVC::OBJITEM& objitem);
      virtual bool v_IsSelectable (const RVC::OBJITEM& ObjItem, int position);
      #endif // GENERATING_DOXYGEN_OUTPUT
   };


class STYLE::UNIQUEPATTERNNAMEFILTER : public OBJECT::UNIQUENAMEFILTER {
   public:
      UNIQUEPATTERNNAMEFILTER (
         const STYLE& StyleObj,
         PATTERNTYPE PatternType
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      const STYLE& m_StyleObj;
      PATTERNTYPE m_PatternType;
      
      virtual int Filter (const RVC::OBJECTNAME& name);
      #endif // GENERATING_DOXYGEN_OUTPUT
   };
   
   
class STYLE::UNIQUESTYLENAMEFILTER : public OBJECT::UNIQUENAMEFILTER {
   public:
      UNIQUESTYLENAMEFILTER (
         const STYLE& StyleObj,
         STYLETYPE StyleType
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      const STYLE& m_StyleObj;
      STYLETYPE m_StyleType;
      
      virtual int Filter (const RVC::OBJECTNAME& name);
      #endif // GENERATING_DOXYGEN_OUTPUT
   };


#ifdef USE_MGUI
namespace UI {

enum STYLECOPYPATTERNFLAGS {
   STYLECOPYPATTERNFLAG_None =               0,
   STYLECOPYPATTERNFLAG_NoCheckDupPattern =  0x01,    
   STYLECOPYPATTERNFLAG_AskUserDupPattern =  0x02,    
   };
#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(STYLECOPYPATTERNFLAGS)
#endif

INT32 StyleCopyPattern (
   RVC::STYLE& ObjStyleTgt,         
   RVC::STYLE& ObjStyleSrc,         
   RVC::PATTERNTYPE PatternType,    
   INT32 SrcPatternNum,             
   STYLECOPYPATTERNFLAGS flags = STYLECOPYPATTERNFLAG_None, 
   MDLGPARENT dlgparent = 0         
   );
}  // End namespace UI
#endif


}     // End of RVC namespace

#endif   // INC_RVC_STYLE_H

---