AcDbMText.h

Go to the documentation of this file.

#pragma once
 
//
// (C) Copyright 2005-2024 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted,
// provided that the above copyright notice appears in all copies and
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#include "..\acdb17\AcDbEntity.h"
#include "..\acdb17\AcDb.h"
#include "..\acad\Acad.h"
 
template < typename Param1 > class AcArrayMemCopyReallocator;
class AcCmColor;
class AcCmTransparency;
class AcDbField;
class AcDbObjectId;
class AcDbSystemInternals;
class AcGeMatrix3d;
class AcGePoint3d;
class AcGeVector3d;
class AcGiWorldDraw;
class AcRxClass;
 
class ARX_API AcDbMText : public AcDbEntity
{
public:
    enum AttachmentPoint
    {
        kTopLeft = 1,
        kTopCenter = 2,
        kTopRight = 3,
        kMiddleLeft = 4,
        kMiddleCenter = 5,
        kMiddleRight = 6,
        kBottomLeft = 7,
        kBottomCenter = 8,
        kBottomRight = 9,
        kBaseLeft = 10,
        kBaseCenter = 11,
        kBaseRight = 12,
        kBaseAlign = 13,
        kBottomAlign = 14,
        kMiddleAlign = 15,
        kTopAlign = 16,
        kBaseFit = 17,
        kBottomFit = 18,
        kMiddleFit = 19,
        kTopFit = 20,
        kBaseMid = 21,
        kBottomMid = 22,
        kMiddleMid = 23,
        kTopMid = 24
    };
        enum ColumnType
        {
                kNoColumns,
                kStaticColumns,
                kDynamicColumns
        };
        enum FlowDirection
        {
                kLtoR = 1,
                kRtoL = 2,
                kTtoB = 3,
                kBtoT = 4,
                kByStyle = 5
        };
public:
          AcDbMText(void);
         bool  backgroundFillOn(void)const ;
         bool  useBackgroundColorOn(void)const ;
         bool  useWordBreak(void)const ;
          AcDbObjectId  textStyle(void)const ;
          AcGePoint3d  location(void)const ;
          AcGeVector3d  direction(void)const ;
          AcGeVector3d  normal(void)const ;
         double  actualHeight( AcGiWorldDraw * = NULL )const ;
         double  actualWidth(void)const ;
         double  ascent(void)const ;
         double  descent(void)const ;
         double  height(void)const ;
         double  lineSpacingFactor(void)const ;
         double  rotation(void)const ;
         double  textHeight(void)const ;
         double  width(void)const ;
          AcDb::LineSpacingStyle  lineSpacingStyle(void)const ;
          AttachmentPoint  attachment(void)const ;
          FlowDirection  flowDirection(void)const ;
          Acad::ErrorStatus  convertFieldToText(void);
          Acad::ErrorStatus  getBackgroundFillColor( AcCmColor &)const ;
          Acad::ErrorStatus  getBackgroundScaleFactor(double &)const ;
          Acad::ErrorStatus  getBackgroundTransparency( AcCmTransparency &)const ;
          Acad::ErrorStatus  getColumnAutoHeight(bool &)const ;
          Acad::ErrorStatus  getColumnCount(int &)const ;
          Acad::ErrorStatus  getColumnFlowReversed(bool &)const ;
          Acad::ErrorStatus  getColumnGutterWidth(double &)const ;
          Acad::ErrorStatus  getColumnHeight(int,double &)const ;
          Acad::ErrorStatus  getColumnType( ColumnType &)const ;
          Acad::ErrorStatus  getColumnWidth(double &)const ;
          Acad::ErrorStatus  setAttachment( AttachmentPoint);
          Acad::ErrorStatus  setAttachmentMovingLocation( AttachmentPoint);
          Acad::ErrorStatus  setBackgroundFill(bool);
          Acad::ErrorStatus  setBackgroundFillColor( AcCmColor const &);
          Acad::ErrorStatus  setBackgroundScaleFactor(const double);
          Acad::ErrorStatus  setBackgroundTransparency( AcCmTransparency const &);
          Acad::ErrorStatus  setColumnAutoHeight(bool);
          Acad::ErrorStatus  setColumnCount(int);
          Acad::ErrorStatus  setColumnFlowReversed(bool);
          Acad::ErrorStatus  setColumnGutterWidth(double);
          Acad::ErrorStatus  setColumnHeight(int,double);
          Acad::ErrorStatus  setColumnType( ColumnType);
          Acad::ErrorStatus  setColumnWidth(double);
          Acad::ErrorStatus  setDirection( AcGeVector3d const &);
          Acad::ErrorStatus  setDynamicColumns(double,double,bool);
          Acad::ErrorStatus  setFlowDirection( FlowDirection);
          Acad::ErrorStatus  setHeight(double);
          Acad::ErrorStatus  setLineSpacingFactor(double);
          Acad::ErrorStatus  setLineSpacingStyle( AcDb::LineSpacingStyle);
          Acad::ErrorStatus  setLocation( AcGePoint3d const &);
          Acad::ErrorStatus  setNormal( AcGeVector3d const &);
          Acad::ErrorStatus  setRotation(double);
          Acad::ErrorStatus  setStaticColumns(double,double,int);
          Acad::ErrorStatus  setTextHeight(double);
          Acad::ErrorStatus  setTextStyle( AcDbObjectId);
          Acad::ErrorStatus  setUseBackgroundColor(bool);
          Acad::ErrorStatus  setUseWordBreak(bool);
          Acad::ErrorStatus  setWidth(double);
         int  correctSpelling(void);
         int  setContents(wchar_t const *);
         int  setContentsRTF(wchar_t const *);
         
         static wchar_t const * __cdecl alignChange(void);
         static wchar_t const * __cdecl blockBegin(void);
         static wchar_t const * __cdecl blockEnd(void);
         static wchar_t const * __cdecl colorChange(void);
         static wchar_t const * __cdecl fontChange(void);
         static wchar_t const * __cdecl heightChange(void);
         static wchar_t const * __cdecl lineBreak(void);
         static wchar_t const * __cdecl nonBreakSpace(void);
         static wchar_t const * __cdecl obliqueChange(void);
         static wchar_t const * __cdecl overlineOff(void);
         static wchar_t const * __cdecl overlineOn(void);
         static wchar_t const * __cdecl paragraphBreak(void);
         static wchar_t const * __cdecl stackStart(void);
         static wchar_t const * __cdecl trackChange(void);
         static wchar_t const * __cdecl underlineOff(void);
         static wchar_t const * __cdecl underlineOn(void);
         static wchar_t const * __cdecl widthChange(void);
     static wchar_t const * __cdecl strikethroughOn(void);
     static wchar_t const * __cdecl strikethroughOff(void);
         virtual  ~AcDbMText(void);
         
         virtual  Acad::ErrorStatus  getClassID( _GUID *)const ;
         virtual  Acad::ErrorStatus  removeField( AcDbObjectId);
         virtual  Acad::ErrorStatus  removeField(wchar_t const *);
         virtual  Acad::ErrorStatus  removeField(wchar_t const *, AcDbObjectId &);
         virtual  Acad::ErrorStatus  setField(wchar_t const *, AcDbField *, AcDbObjectId &);
         virtual void  getEcs( AcGeMatrix3d &)const ;
         void  explodeFragments(int (__cdecl*)( AcDbMTextFragment *,void *),void *, AcGiWorldDraw * = NULL)const ;
         void  getBoundingPoints( AcArray< AcGePoint3d, AcArrayMemCopyReallocator< AcGePoint3d> > &)const ;
         wchar_t *  contents(void)const ;
         wchar_t *  text(void)const ;
 
     virtual  Acad::ErrorStatus  dwgInFields(AcDbDwgFiler *);
     virtual  Acad::ErrorStatus  dwgOutFields(AcDbDwgFiler *)const;
     virtual  Acad::ErrorStatus  dxfInFields(AcDbDxfFiler *);
     virtual  Acad::ErrorStatus  dxfOutFields(AcDbDxfFiler *)const;
     virtual  Acad::ErrorStatus  getPlane(AcGePlane&, AcDb::Planarity&) const;
 
     virtual  Acad::ErrorStatus  subExplode(AcDbVoidPtrArray &)const;
     virtual  Acad::ErrorStatus  subTransformBy(AcGeMatrix3d const &);
     virtual  Acad::ErrorStatus  subClose( void );
     virtual  Acad::ErrorStatus  subGetTransformedCopy(AcGeMatrix3d const & param_1, AcDbEntity * & param_2)const;
     virtual  Acad::ErrorStatus  subGetGeomExtents( AcDbExtents & )const;
     virtual  bool subWorldDraw(AcGiWorldDraw* param_1) const;
     virtual  void subViewportDraw(AcGiViewportDraw*) const;
     virtual  void subSetDatabaseDefaults(AcDbDatabase *);
 
     bool showBorders();
     Acad::ErrorStatus setShowBorders(bool);
     ACRX_DECLARE_MEMBERS( AcDbMText )
 
     Acad::ErrorStatus contents( AcString & ) const;
     Acad::ErrorStatus contentsRTF( AcString & ) const;
     void getBoundingPointsByLine( AcArray<AcGePoint3dArray>& ) const;
     bool hitTest(AcGePoint3d const &) const;
     Adesk::Boolean isPlanar() const;
     Acad::ErrorStatus text(AcString & param_1) const;
 
protected:
    AcDbMText( AcDbSystemInternals *);
};