lrtext.h

Go to the documentation of this file.

/**
 * \file lrtext.h <gre/lrtext.h>
 * \brief GRE_LAYER_TEXT class definitions
 *
 * \if NODOC
 * $Id: lrtext.h_v 1.14 2005/04/21 20:26:37 mju Exp $
 *
 * $Log: lrtext.h_v $
 * Revision 1.14  2005/04/21 20:26:37  mju
 * Remove unused flag.
 *
 * Revision 1.13  2005/03/31 16:57:06  fileserver!dwilliss
 * Rename one of our types to MIUNICODE because it conflicted with a Microsoft #define
 *
 * Revision 1.12  2005/02/25 23:46:55  scowan
 * Added copy virtual method implementation.
 *
 * Revision 1.11  2005/02/14 21:39:49  mju
 * use device in usesTransparency.
 *
 * Revision 1.10  2005/01/20 16:57:47  mju
 * Redesign layer type registration.
 *
 * Revision 1.9  2004/10/15 21:29:30  ldyas
 * added needsmem24 method
 *
 * Revision 1.8  2004/10/15 14:32:47  ldyas
 * *** empty log message ***
 *
 * Revision 1.7  2004/10/14 22:05:38  ldyas
 * isantialiased is nonconst.
 *
 * Revision 1.6  2004/10/07 14:28:12  ldyas
 * added method for to allow IsAntialiased to detect smoothing in text style.
 *
 * Revision 1.5  2004/03/05 21:29:24  mju
 * Make dtor virtual if virtual fns.
 *
 * Revision 1.4  2004/02/18 23:37:30  scowan
 * Forward declare the text block from mgd namespace.
 *
 * Revision 1.3  2003/09/15 13:48:59  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.2  2003/07/30 15:29:08  mju
 * Ignore private sections.
 *
 * Revision 1.1  2002/09/20 17:47:44  mju
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_GRE_LRTEXT_H
#define  INC_GRE_LRTEXT_H

#ifndef INC_MI32_GRE_H
#include <mi32/gre.h>
#endif

namespace MGD {
   struct TEXTBLOCK;
   }

//===================================================================================================================

class GRE_LAYER_TEXT : public GRE_LAYER {
   public:

      class DISPPARM : public GRE_LAYER::DISPPARM {
         public:

            class DLG;

            MIUNICODE filename[FILENAME_MAX];   //!< Filename of the object
            RVCTEXTINFO objinfo;
            MISTRING Text;
            MISTRING encoding;
            TEXTSTYLE Style;           
            time_t LastModTime;              //!< Used to determine if linked file has changed
            char* String;                    //!< For backwards compatibility

            DISPPARM (GRE_LAYER_TEXT *layer);

            DISPPARM (const DISPPARM& rhs) { Copy(rhs); }

            virtual ~DISPPARM () { Free(); }

            DISPPARM& operator= (const DISPPARM& rhs) {
               if (this != &rhs) {
                  Free();
                  Copy(rhs);
                  }
               return (*this);
               }

            //! Validate dispparm, adjusting if possible.
            virtual ERRVALUE Validate ();

         protected:
            virtual const SERIALIZER::ITEMDEF* SerialGetItemDef (SERIALIZER& serializer) const;

         private:
            #ifndef GENERATING_DOXYGEN_OUTPUT
            GRE_LAYER_TEXT *m_layer;
            void Copy (const DISPPARM&);
            void Free ();
            #endif //!< GENERATING_DOXYGEN_OUTPUT
         };

      //! Register this layer type
      static void RegisterType (
         );

      //! Install SML class, called by internal SML function.
      static void SMLClassInstall (
         SMLCONTEXT *context                    //!< SML context
         );

      //! Construct layer and insert into list
      explicit GRE_LAYER_TEXT (
         GRE_GROUP *group,                            //!< Group to contain layer
         CREATEFLAGS createflags = CREATEFLAG_None    //!< Creation flags
         );

      //! Destructor.
      virtual ~GRE_LAYER_TEXT ();

      //! Retrieve layer-specific display parameters.
      const DISPPARM& GetDispParm (
         ) const { return (m_dispparm); }

      //! Set layer-specific display parameters.
      //! This is the recommended method for changing how an existing layer is to be
      //! rendered.  Validation will be performed on the specified parameters and
      //! adjustments made to the layer's copy if necessary.  Use of this method
      //! usually result in a ChangeBegin / ChangeEnd message pair, and will also
      //! generate a ChangeObject message if the spatial object used in the layer
      //! is changed.
      ERRVALUE SetDispParm (
         const DISPPARM& dispparm               //!< Parameters to set
         );

   protected:

      DISPPARM m_dispparm;                      //!< Layer-specific display parameters

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      void CleanupTextBlock (MGD::TEXTBLOCK&);
      ERRVALUE SetupTextBlock (MGD::TEXTBLOCK&);

      //! Overrides from GRE_LAYER.
   #if defined(X_NATIVE) || defined(WIN32_MFC)
      virtual int v_ControlPanel (MDLGPARENT dlgparent,UINT32 flags = 0);
   #endif
      virtual GRE_LAYER* v_Copy (GRE_GROUP *group) const;
      virtual ERRVALUE v_Draw (GRE_LAYERDC& layerdc);
      virtual const RVC::OBJITEM& v_GetObjItem (int component) const;
      virtual bool v_IsAntialiased () const;
      virtual bool v_NeedsMEM24 (bool hirez) const;
      virtual const char* v_SerialGetTagName () const;
      virtual ERRVALUE v_SerialRead (SERIALIZER& serializer);
      virtual void v_SetDftName (bool ReplaceExisting);
      virtual ERRVALUE v_TemplateRead (SERIALIZER& serializer);
      virtual int v_UpdateExtents (bool forceupdate);
      virtual bool v_UsesTransparency (const MGD::DEVICE *pDevice = 0) const;

      GRE_LAYER_TEXT (const GRE_LAYER_TEXT&);
      GRE_LAYER_TEXT& operator= (const GRE_LAYER_TEXT&);

      #endif //!< GENERATING_DOXYGEN_OUTPUT
   };

#define  TEXTDISPFLAG_Link          0x00000002  //!< Link to a file
#define  TEXTDISPFLAG_RVCObject     0x00000004  //!< Link is RVC object

//===================================================================================================================


#endif   //!< INC_GRE_LRTEXT_H

---