FRX SDK Documentation 2025 SP0
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
AcDbLayout Class Reference

#include <AcDbLayout.h>

Inheritance diagram for AcDbLayout:
AcDbPlotSettings AcDbObject AcGiDrawable AcRxObject AcRTTIObject AcObject

Public Member Functions

 AcDbLayout (void)
 
bool annoAllVisible (void) const
 
bool getTabSelected (void) const
 
AcDbObjectIdArray getViewportArray (void) const
 
AcDbObjectId getBlockTableRecordId (void) const
 
Acad::ErrorStatus getLayoutName (wchar_t *&) const
 
Acad::ErrorStatus getLayoutName (wchar_t const *&) const
 
Acad::ErrorStatus getThumbnail (tagBITMAPINFO *&) const
 
Acad::ErrorStatus initialize (AcDbObjectId *)
 
Acad::ErrorStatus setAnnoAllVisible (bool)
 
Acad::ErrorStatus setThumbnail (tagBITMAPINFO const *)
 
int getTabOrder (void) const
 
virtual ~AcDbLayout (void)
 
virtual Acad::ErrorStatus addToLayoutDict (AcDbDatabase *, AcDbObjectId)
 
virtual Acad::ErrorStatus getClassID (_GUID *) const
 
virtual Acad::ErrorStatus setBlockTableRecordId (AcDbObjectId)
 
virtual Acad::ErrorStatus setLayoutName (wchar_t const *)
 
virtual void setTabOrder (int)
 
virtual void setTabSelected (int)
 
void getExtents (AcGePoint3d &, AcGePoint3d &) const
 
void getLimits (AcGePoint2d &, AcGePoint2d &) const
 
virtual Acad::ErrorStatus subClose (void)
 
Acad::ErrorStatus getName (AcString &) const
 
- Public Member Functions inherited from AcDbPlotSettings
 AcDbPlotSettings (bool)
 
 AcDbPlotSettings (void)
 
bool plotAsRaster (void) const
 
bool plotWireframe (void) const
 
AcDbObjectId shadePlotId (void) const
 
PlotPaperUnits plotPaperUnits (void) const
 
PlotRotation plotRotation (void) const
 
PlotType plotType (void) const
 
ShadePlotResLevel shadePlotResLevel (void) const
 
ShadePlotType shadePlot (void) const
 
StdScaleType stdScaleType (void) const
 
Acad::ErrorStatus addToPlotSettingsDict (AcDbDatabase *)
 
Acad::ErrorStatus copyFrom (AcDbPlotSettings *)
 
Acad::ErrorStatus getCanonicalMediaName (wchar_t const *&) const
 
Acad::ErrorStatus getCanonicalMediaName (AcString &mediaName) const
 
Acad::ErrorStatus getCurrentStyleSheet (wchar_t const *&) const
 
Acad::ErrorStatus getCustomPrintScale (double &, double &) const
 
Acad::ErrorStatus getPlotCfgName (wchar_t const *&) const
 
Acad::ErrorStatus getPlotOrigin (double &, double &) const
 
Acad::ErrorStatus getPlotPaperMargins (double &, double &, double &, double &) const
 
Acad::ErrorStatus getPlotPaperSize (double &, double &) const
 
Acad::ErrorStatus getPlotSettingsName (wchar_t *&) const
 
Acad::ErrorStatus getPlotSettingsName (wchar_t const *&) const
 
Acad::ErrorStatus getPlotViewName (wchar_t const *&) const
 
Acad::ErrorStatus getPlotWindowArea (double &, double &, double &, double &) const
 
Acad::ErrorStatus getStdScale (double &) const
 
Acad::ErrorStatus setPlotSettingsName (wchar_t const *)
 
Acad::ErrorStatus setShadePlot (ShadePlotType)
 
Acad::ErrorStatus setShadePlot (ShadePlotType, AcDbObjectId)
 
Acad::ErrorStatus setShadePlotCustomDPI (short)
 
Acad::ErrorStatus setShadePlotResLevel (ShadePlotResLevel)
 
int drawViewportsFirst (void) const
 
int modelType (void) const
 
int plotCentered (void) const
 
int plotHidden (void) const
 
int plotPlotStyles (void) const
 
int plotViewportBorders (void) const
 
int printLineweights (void) const
 
int scaleLineweights (void) const
 
int showPlotStyles (void) const
 
int useStandardScale (void) const
 
short shadePlotCustomDPI (void) const
 
virtual ~AcDbPlotSettings (void)
 
void setDrawViewportsFirst (int)
 
void setPlotHidden (int)
 
void setPlotPlotStyles (int)
 
void setPlotViewportBorders (int)
 
void setPrintLineweights (int)
 
void setScaleLineweights (int)
 
void setShowPlotStyles (int)
 
Acad::ErrorStatus getPlotPaperSize (AcGePoint2d &) const
 
Acad::ErrorStatus getPlotOrigin (AcGePoint2d &) const
 
- Public Member Functions inherited from AcDbObject
 ACRX_DECLARE_MEMBERS (AcDbObject)
 
bool hasFields (void) const
 
bool hasPersistentReactor (AcDbObjectId) const
 
bool hasSaveVersionOverride (void)
 
bool isUndoRecordingDisabled (void) const
 
AcDbVoidPtrArray const * reactors (void) const
 
AcDbDatabasedatabase (void) const
 
AcDbDwgFilerundoFiler (void)
 
AcDbObjectId extensionDictionary (void) const
 
AcDbObjectId getFieldDictionary (void) const
 
AcDbObjectId objectId (void) const
 
AcDbObjectId ownerId (void) const
 
Acad::ErrorStatus cancel (void)
 
Acad::ErrorStatus close (void)
 
Acad::ErrorStatus closeAndPage (int=0)
 
Acad::ErrorStatus createExtensionDictionary (void)
 
Acad::ErrorStatus downgradeOpen (void)
 
Acad::ErrorStatus downgradeToNotify (Adesk::Boolean)
 
Acad::ErrorStatus dwgIn (AcDbDwgFiler *)
 
Acad::ErrorStatus dwgOut (AcDbDwgFiler *) const
 
Acad::ErrorStatus dxfIn (AcDbDxfFiler *)
 
Acad::ErrorStatus dxfOut (AcDbDxfFiler *, Adesk::Boolean, unsigned char *) const
 
Acad::ErrorStatus erase (Adesk::Boolean=true)
 
Acad::ErrorStatus getBinaryData (wchar_t const *, long &, char *&) const
 
Acad::ErrorStatus getField (wchar_t const *, AcDbField *&, AcDb::OpenMode) const
 
Acad::ErrorStatus getField (wchar_t const *, AcDbObjectId &) const
 
Acad::ErrorStatus getFieldDictionary (AcDbDictionary *&, AcDb::OpenMode) const
 
Acad::ErrorStatus getObjectBirthVersion (AcDb::AcDbDwgVersion &, AcDb::MaintenanceReleaseVersion &)
 
Acad::ErrorStatus handOverTo (AcDbObject *, Adesk::Boolean=1, Adesk::Boolean=1)
 
Acad::ErrorStatus releaseExtensionDictionary (void)
 
Acad::ErrorStatus setBinaryData (wchar_t const *, long, char const *)
 
Acad::ErrorStatus swapIdWith (AcDbObjectId, Adesk::Boolean=0, Adesk::Boolean=0)
 
Acad::ErrorStatus upgradeFromNotify (Adesk::Boolean &)
 
Acad::ErrorStatus upgradeOpen (void)
 
Acad::ErrorStatus xDataTransformBy (AcGeMatrix3d const &)
 
Adesk::Boolean isAProxy (void) const
 
Adesk::Boolean isAcDbObjectIdsInFlux (void) const
 
Adesk::Boolean isCancelling (void) const
 
Adesk::Boolean isEraseStatusToggled (void) const
 
Adesk::Boolean isErased (void) const
 
Adesk::Boolean isModified (void) const
 
Adesk::Boolean isModifiedGraphics (void) const
 
Adesk::Boolean isModifiedXData (void) const
 
Adesk::Boolean isNewObject (void) const
 
Adesk::Boolean isNotifyEnabled (void) const
 
Adesk::Boolean isNotifying (void) const
 
Adesk::Boolean isReadEnabled (void) const
 
Adesk::Boolean isReallyClosing (void) const
 
Adesk::Boolean isTransactionResident (void) const
 
Adesk::Boolean isUndoing (void) const
 
Adesk::Boolean isWriteEnabled (void) const
 
virtual ~AcDbObject (void)
 
virtual AcDbObjectId id (void) const
 
virtual AcGiDrawabledrawable (void)
 
virtual AcGsNodegsNode (void) const
 
virtual AcRxObjectclone (void) const
 
virtual AcDb::DuplicateRecordCloning mergeStyle (void) const
 
virtual Acad::ErrorStatus applyPartialUndo (AcDbDwgFiler *, AcRxClass *)
 
virtual Acad::ErrorStatus audit (AcDbAuditInfo *)
 
virtual Acad::ErrorStatus copyFrom (AcRxObject const *)
 
virtual Acad::ErrorStatus decomposeForSave (AcDb::AcDbDwgVersion, AcDbObject *&, AcDbObjectId &, int &)
 
virtual Acad::ErrorStatus deepClone (AcDbObject *, AcDbObject *&, AcDbIdMapping &, Adesk::Boolean=1) 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 getObjectSaveVersion (AcDbDwgFiler const *, AcDb::AcDbDwgVersion &, AcDb::MaintenanceReleaseVersion &)
 
virtual Acad::ErrorStatus getObjectSaveVersion (AcDbDxfFiler const *, AcDb::AcDbDwgVersion &, AcDb::MaintenanceReleaseVersion &)
 
virtual Acad::ErrorStatus removeField (AcDbObjectId)
 
virtual Acad::ErrorStatus removeField (wchar_t const *)
 
virtual Acad::ErrorStatus removeField (wchar_t const *, AcDbObjectId &)
 
virtual Acad::ErrorStatus removePersistentReactor (AcDbObjectId)
 
virtual Acad::ErrorStatus setField (wchar_t const *, AcDbField *, AcDbObjectId &)
 
virtual Acad::ErrorStatus setOwnerId (AcDbObjectId)
 
virtual Acad::ErrorStatus setXData (resbuf const *)
 
virtual Acad::ErrorStatus subCancel (void)
 
virtual Acad::ErrorStatus subErase (Adesk::Boolean)
 
virtual Acad::ErrorStatus subHandOverTo (AcDbObject *)
 
virtual Acad::ErrorStatus subOpen (AcDb::OpenMode)
 
virtual Acad::ErrorStatus subSwapIdWith (AcDbObjectId, Adesk::Boolean=0, Adesk::Boolean=0)
 
virtual Acad::ErrorStatus swapReferences (AcDbIdMapping const &)
 
virtual Acad::ErrorStatus wblockClone (AcRxObject *, AcDbObject *&, AcDbIdMapping &, Adesk::Boolean=1) const
 
virtual Adesk::UInt32 subSetAttributes (AcGiDrawableTraits *pTraits)
 
virtual void subViewportDraw (AcGiViewportDraw *)
 
virtual Adesk::Boolean isPersistent (void) const
 
virtual Adesk::Boolean worldDraw (AcGiWorldDraw *)
 
virtual resbuf * xData (wchar_t const *=NULL) const
 
virtual unsigned long setAttributes (AcGiDrawableTraits *)
 
virtual void addPersistentReactor (AcDbObjectId)
 
virtual void cancelled (AcDbObject const *)
 
virtual void copied (AcDbObject const *, AcDbObject const *)
 
virtual void erased (AcDbObject const *, Adesk::Boolean)
 
virtual void goodbye (AcDbObject const *)
 
virtual void modified (AcDbObject const *)
 
virtual void modifiedGraphics (AcDbEntity const *)
 
virtual void modifiedXData (AcDbObject const *)
 
virtual void modifyUndone (AcDbObject const *)
 
virtual void objectClosed (AcDbObjectId const)
 
virtual void openedForModify (AcDbObject const *)
 
virtual void reappended (AcDbObject const *)
 
virtual void recvPropagateModify (AcDbObject const *)
 
virtual void setGsNode (AcGsNode *)
 
virtual void subObjModified (AcDbObject const *, AcDbObject const *)
 
virtual void unappended (AcDbObject const *)
 
virtual void viewportDraw (AcGiViewportDraw *)
 
virtual void xmitPropagateModify (void) const
 
void addReactor (AcDbObjectReactor *) const
 
void assertNotifyEnabled (void) const
 
void assertReadEnabled (void) const
 
void assertWriteEnabled (Adesk::Boolean=1, Adesk::Boolean=1)
 
void disableUndoRecording (Adesk::Boolean)
 
void getAcDbHandle (AcDbHandle &) const
 
void removeReactor (AcDbObjectReactor *) const
 
void setAcDbObjectIdsInFlux (void)
 
void setHasSaveVersionOverride (bool)
 
virtual Adesk::Boolean subWorldDraw (AcGiWorldDraw *)
 
virtual Acad::ErrorStatus subDeepClone (AcDbObject *, AcDbObject *&, AcDbIdMapping &, Adesk::Boolean=1) const
 
virtual Acad::ErrorStatus subWblockClone (AcRxObject *, AcDbObject *&, AcDbIdMapping &, Adesk::Boolean=1) const
 
virtual Acad::ErrorStatus subGetClassID (_GUID *) const
 
- Public Member Functions inherited from AcGiDrawable
 ACRX_DECLARE_MEMBERS (AcGiDrawable)
 
virtual Adesk::UInt32 subViewportDrawLogicalFlags (AcGiViewportDraw *)
 
virtual bool bounds (AcDbExtents &) const
 
virtual unsigned long viewportDrawLogicalFlags (AcGiViewportDraw *)
 
virtual void setDrawStream (AcGiDrawStream *)
 
virtual AcGiDrawStreamdrawStream (void) const
 
virtual ~AcGiDrawable (void)
 
- Public Member Functions inherited from AcRxObject
virtual AcRxObjectqueryX (AcRxClass const *) const
 
AcRxObjectx (AcRxClass const *) const
 
virtual AcRxClassisA (void) const
 
virtual AcRx::Ordering comparedTo (AcRxObject const *) const
 
virtual int isEqualTo (AcRxObject const *) const
 
bool isKindOf (const AcRxClass *pOtherClass) const
 
virtual ~AcRxObject (void)
 
- Public Member Functions inherited from AcRTTIObject
 AcRTTIObject ()
 
virtual ~AcRTTIObject ()
 
- Public Member Functions inherited from AcObject
 AcObject ()
 
 AcObject (const AcObject &source)
 
virtual ~AcObject ()
 
voiddata () const
 

Protected Member Functions

 AcDbLayout (AcDbSystemInternals *)
 
- Protected Member Functions inherited from AcDbPlotSettings
 AcDbPlotSettings (AcDbSystemInternals *)
 
- Protected Member Functions inherited from AcDbObject
 AcDbObject (AcDbSystemInternals *)
 
 AcDbObject (void)
 
- Protected Member Functions inherited from AcRxObject
 AcRxObject (void)
 
virtual AcRxObjectsubQueryX (AcRxClass const *) const
 

Additional Inherited Members

- Public Types inherited from AcDbPlotSettings
enum  PlotPaperUnits { kInches = 0 , kMillimeters = 1 , kPixels = 2 }
 
enum  PlotRotation { k0degrees = 0 , k90degrees = 1 , k180degrees = 2 , k270degrees = 3 }
 
enum  PlotType {
  kDisplay = 0 , kExtents = 1 , kLimits = 2 , kView = 3 ,
  kWindow = 4 , kLayout = 5
}
 
enum  ShadePlotResLevel {
  kDraft = 0 , kPreview = 1 , kNormal = 2 , kPresentation = 3 ,
  kMaximum = 4 , kCustom = 5
}
 
enum  ShadePlotType {
  kAsDisplayed = 0 , kWireframe = 1 , kHidden = 2 , kRendered = 3 ,
  kVisualStyle = 4 , kRenderPreset = 5
}
 
enum  StdScaleType {
  kScaleToFit = 0 , k1_128in_1ft = 1 , k1_64in_1ft = 2 , k1_32in_1ft = 3 ,
  k1_16in_1ft = 4 , k3_32in_1ft = 5 , k1_8in_1ft = 6 , k3_16in_1ft = 7 ,
  k1_4in_1ft = 8 , k3_8in_1ft = 9 , k1_2in_1ft = 10 , k3_4in_1ft = 11 ,
  k1in_1ft = 12 , k3in_1ft = 13 , k6in_1ft = 14 , k1ft_1ft = 15 ,
  k1_1 = 16 , k1_2 = 17 , k1_4 = 18 , k1_8 = 19 ,
  k1_10 = 20 , k1_16 = 21 , k1_20 = 22 , k1_30 = 23 ,
  k1_40 = 24 , k1_50 = 25 , k1_100 = 26 , k2_1 = 27 ,
  k4_1 = 28 , k8_1 = 29 , k10_1 = 30 , k100_1 = 31 ,
  k1000_1 = 32
}
 
- Public Types inherited from AcGiDrawable
enum  DrawableType {
  kGeometry = 0 , kDistantLight = 1 , kPointLight = 2 , kSpotLight = 3 ,
  kAmbientLight , kSolidBackground , kGradientBackground , kImageBackground ,
  kGroundPlaneBackground , kViewport , kWebLight , kSkyBackground
}
 
enum  SetAttributesFlags {
  kDrawableNone = 0 , kDrawableIsAnEntity = 1 , kDrawableUsesNesting = 2 , kDrawableIsCompoundObject = 4 ,
  kDrawableViewIndependentViewportDraw = 8 , kDrawableIsInvisible = 16 , kDrawableHasAttributes = 32 , kDrawableRegenTypeDependentGeometry = 64 ,
  kDrawableIsDimension = (kDrawableIsAnEntity + kDrawableIsCompoundObject + 128) , kDrawableRegenDraw = 256 , kDrawableViewDependentViewportDraw = 2048
}
 
- Static Public Member Functions inherited from AcRxObject
static AcRxClass *__cdecl desc (void)
 
static AcRxObject *__cdecl cast (AcRxObject const *)
 
- Protected Attributes inherited from AcDbObject
AcDbObjectImplm_pImpl
 
- Protected Attributes inherited from AcObject
voidm_pData
 

Detailed Description

Definition at line 30 of file AcDbLayout.h.

Constructor & Destructor Documentation

◆ AcDbLayout() [1/2]

AcDbLayout::AcDbLayout ( void )

◆ ~AcDbLayout()

virtual AcDbLayout::~AcDbLayout ( void )
virtual

◆ AcDbLayout() [2/2]

AcDbLayout::AcDbLayout ( AcDbSystemInternals * )
protected

Member Function Documentation

◆ addToLayoutDict()

virtual Acad::ErrorStatus AcDbLayout::addToLayoutDict ( AcDbDatabase * ,
AcDbObjectId  )
virtual

◆ annoAllVisible()

bool AcDbLayout::annoAllVisible ( void ) const

◆ getBlockTableRecordId()

AcDbObjectId AcDbLayout::getBlockTableRecordId ( void ) const

◆ getClassID()

virtual Acad::ErrorStatus AcDbLayout::getClassID ( _GUID * ) const
virtual

Reimplemented from AcDbPlotSettings.

◆ getExtents()

void AcDbLayout::getExtents ( AcGePoint3d & ,
AcGePoint3d &  ) const

◆ getLayoutName() [1/2]

Acad::ErrorStatus AcDbLayout::getLayoutName ( wchar_t *& ) const

◆ getLayoutName() [2/2]

Acad::ErrorStatus AcDbLayout::getLayoutName ( wchar_t const *& ) const

◆ getLimits()

void AcDbLayout::getLimits ( AcGePoint2d & ,
AcGePoint2d &  ) const

◆ getName()

Acad::ErrorStatus AcDbLayout::getName ( AcString & ) const

◆ getTabOrder()

int AcDbLayout::getTabOrder ( void ) const

◆ getTabSelected()

bool AcDbLayout::getTabSelected ( void ) const

◆ getThumbnail()

Acad::ErrorStatus AcDbLayout::getThumbnail ( tagBITMAPINFO *& ) const

◆ getViewportArray()

AcDbObjectIdArray AcDbLayout::getViewportArray ( void ) const

◆ initialize()

Acad::ErrorStatus AcDbLayout::initialize ( AcDbObjectId * )

◆ setAnnoAllVisible()

Acad::ErrorStatus AcDbLayout::setAnnoAllVisible ( bool )

◆ setBlockTableRecordId()

virtual Acad::ErrorStatus AcDbLayout::setBlockTableRecordId ( AcDbObjectId )
virtual

◆ setLayoutName()

virtual Acad::ErrorStatus AcDbLayout::setLayoutName ( wchar_t const * )
virtual

◆ setTabOrder()

virtual void AcDbLayout::setTabOrder ( int )
virtual

◆ setTabSelected()

virtual void AcDbLayout::setTabSelected ( int )
virtual

◆ setThumbnail()

Acad::ErrorStatus AcDbLayout::setThumbnail ( tagBITMAPINFO const * )

◆ subClose()

virtual Acad::ErrorStatus AcDbLayout::subClose ( void )
virtual

Reimplemented from AcDbPlotSettings.


The documentation for this class was generated from the following file: