mi32/micon.h

Go to the documentation of this file.

#ifndef  INC_MI32_MICON_H
#define  INC_MI32_MICON_H

#ifndef  INC_MI32_ICONID_H
   #include <mi32/iconid.h>
#endif

#ifndef  INC_MI32_SIMPLEAR_H
   #include <mi32/simplear.h>
#endif

#ifndef GENERATING_DOXYGEN_OUTPUT
namespace RVC {
   class STYLE;
   class STYLEPATTERN_BITMAP;
   class DESCRIPTOR;
   }
class FILEPATH;
#endif

//----------------------------------------------------------------------------
//    Types and constants                                                     
//----------------------------------------------------------------------------

enum MICONFLAGS {
   MICONFLAG_None =              0x0000,  
   MICONFLAG_Stippled =          0x0001,  
   MICONFLAG_DefaultBackground = 0x0002,  
   MICONFLAG_StippledSelected =  0x0008,  
   MICONFLAG_SizeMask =          0x0FF0,  
   MICONFLAG_Size16 =            0x0100,  
   MICONFLAG_Size32 =            0x0200,  
   MICONFLAG_NoDarkenSelected =  0x1000,  
   MICONFLAG_DisplayError =      0x2000,  
   };
#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(MICONFLAGS)
#endif


struct MICONSTRUCT {
   MIUNICODE group[16];
   MIUNICODE name[16];
   UINT8 height;
   UINT8 width;
   UINT8 resized;
   UINT8 spare;                        
   UINT32 refcount;
   MPIXEL bgpixel;                     
   ICONID id;
   void *privptr;
   };

DEPRECATED_MSG("Use MICONSTRUCT*") typedef MICONSTRUCT *MICON;


//----------------------------------------------------------------------------
//    Function prototypes                                                     
//----------------------------------------------------------------------------

// Note, these functions use C++ linkage.


int MiconCreate (
   MICONSTRUCT **icon,                       
   const char *group,                  
   const char *name,                   
   MPIXEL bgpixel,                     
   UINT8 width,                        
   UINT8 height,                       
   UINT32 flags                        
   );

int MiconCreate (
   MICONSTRUCT **icon,                       
   ICONID iconid,                      
   MPIXEL bgpixel,                     
   UINT8 width,                        
   UINT8 height,                       
   UINT32 flags                        
   );

void MiconDestroy (
   MICONSTRUCT *icon                         
   );

inline UINT8 MiconGetHeight (
   const MICONSTRUCT *icon                   
   ) { return (icon->height); }

inline UINT8 MiconGetWidth (
   const MICONSTRUCT *icon                   
   ) { return (icon->width); }

ICONID MiconGenerateID (
   const char *name,                   
   const char *group = 0,              
   int size = 16                       
   );

ERRVALUE MiconOpen (
   RVC::STYLE& Object,                    
   const FILEPATH& filepath,              
   const MIUNICODE *group                 
   );

ERRVALUE MiconOpen (
   RVC::STYLE& Object,                    
   const MIUNICODE *group                 
   );

int MiconReadPatternExt (
   RVC::STYLE& StyleObj,
   INT32 pattnum,                      
   const MIUNICODE* name,              
   int width,                          
   int height,                         
   SIMPLE_ARRAY<UINT8>& pattdata       
   );

int MiconReadPatternExt (
   RVC::STYLE& StyleObj,
   INT32 pattnum,                      
   const MIUNICODE* name,              
   int width,                          
   int height,                         
   RVC::STYLEPATTERN_BITMAP& Pattern
   );

int MiconRead (
   const char *group,                  
   const char *name,                   
   MICONSTRUCT **normalicon,                 
   MICONSTRUCT **armselicon,                 
   MPIXEL normalbg,                    
   MPIXEL armselbg,                    
   UINT32 flags,                       
   RVC::STYLE* StyleObj = 0
   );

int MiconRead (
   const char *group,                  
   const char *name,                   
   MICONSTRUCT **normalicon,                 
   MICONSTRUCT **armeselicon,                   
   UINT32 flags                        
   );

ERRVALUE MiconRead (
   ICONID iconid,                      
   MICONSTRUCT **normalicon,                 
   MICONSTRUCT **armselicon = 0,             
   MICONFLAGS flags = MICONFLAG_None   
   );

ERRVALUE MiconRead (
   ICONID iconid,                      
   MICONSTRUCT **normalicon,                 
   MICONSTRUCT **armselicon,                 
   MPIXEL normalbg,                    
   MPIXEL armselbg,                    
   MICONFLAGS flags = MICONFLAG_None   
   );

ERRVALUE MiconRead (
   ICONID iconid,                      
   SIMPLE_ARRAY<UINT32>& data          
   );

ERRVALUE MiconRead (
   ICONID iconid,
   RVC::STYLEPATTERN_BITMAP& pattern
   );
   
ERRVALUE MiconRead (
   const char *group,                  
   const char *name,                   
   RVC::STYLEPATTERN_BITMAP& pattern
   );

   
#endif   // INC_MI32_MICON_H

---