CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
OdOleItemHandlerBase Class Reference

#include <OleItemHandlerBase.h>

Inheritance diagram for OdOleItemHandlerBase:
OdOleItemHandler OdGiSelfGdiDrawable OdRxObject OdOleItemSimplestHandler

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdOleItemHandlerBase)
 
void load (OdStreamBuf &streamBuf)
 
void save (OdStreamBuf &streamBuf) const
 
bool draw (const OdGiCommonDraw &drawObj, void *hdc, const OdGsDCRect &screenRect) const
 
Type type () const
 
OdString linkName () const
 
OdString linkPath () const
 
OdString userType () const
 
DvAspect drawAspect () const
 
void setDrawAspect (DvAspect drawAspect)
 
OdUInt32 itemId () const
 
void setItemId (OdUInt32 nId)
 
DvAspect adviseType () const
 
void setAdviseType (DvAspect at)
 
bool monikerAssigned () const
 
void setMonikerAssigned (bool assigned)
 
OdUInt32 oleVersion () const
 
void setOleVersion (OdUInt32 oleVer)
 
PlotQuality outputQuality () const
 
void setOutputQuality (PlotQuality quality)
 
virtual COleClientItem * getOleClientItem (void) const
 
virtual bool embedRaster (OdSmartPtr< OdGiRasterImage > pImage, OdRxObject *pRxDb=NULL)
 
virtual OdGiRasterImagePtr getRaster (bool=true) const
 
virtual bool getWmfData (OdBinaryData &data) const
 
- Public Member Functions inherited from OdOleItemHandler
 ODRX_DECLARE_MEMBERS (OdOleItemHandler)
 
virtual void load (OdStreamBuf &streamBuf)=0
 
virtual void save (OdStreamBuf &streamBuf) const =0
 
virtual OdUInt32 getCompoundDocumentDataSize () const =0
 
virtual void getCompoundDocument (OdStreamBuf &streamBuf) const =0
 
virtual void setCompoundDocument (OdUInt32 numBytes, OdStreamBuf &streamBuf)=0
 
virtual Type type () const =0
 
virtual DvAspect drawAspect () const =0
 
virtual OdString linkName () const =0
 
virtual OdString linkPath () const =0
 
virtual OdString userType () const =0
 
virtual void setDrawAspect (DvAspect drawAspect)=0
 
virtual PlotQuality outputQuality () const =0
 
virtual void setOutputQuality (PlotQuality quality)=0
 
virtual COleClientItem * getOleClientItem (void) const =0
 
virtual bool embedRaster (OdSmartPtr< class OdGiRasterImage > pImage, OdRxObject *pRxDb=NULL)=0
 
virtual OdGiRasterImagePtr getRaster (bool bDisplayedOnly=true) const =0
 
- Public Member Functions inherited from OdGiSelfGdiDrawable
 ODRX_DECLARE_MEMBERS (OdGiSelfGdiDrawable)
 
virtual bool draw (const OdGiCommonDraw &drawObj, void *hdc, const OdGsDCRect &screenRect) const =0
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObject * queryX (const OdRxClass *pClass) const
 
virtual OdRxObject * x (const OdRxClass *pClass) const
 
virtual OdRxClass * isA () const
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Protected Member Functions

 OdOleItemHandlerBase ()
 

Protected Attributes

OdUInt32 m_nOleVer
 
OdUInt32 m_nItemId
 
DvAspect m_adviseType
 
OdUInt16 m_bMoniker
 
DvAspect m_drawAspect
 
PlotQuality m_quality
 

Additional Inherited Members

- Public Types inherited from OdOleItemHandler
enum  Type { kUnknown = 0 , kLink = 1 , kEmbedded = 2 , kStatic = 3 }
 
enum  DvAspect { kContent = 1 , kThumbnail = 2 , kIcon = 4 , kDocPrint = 8 }
 
enum  PlotQuality { kMonochrome = 0 , kLowGraphics = 1 , kHighGraphics = 2 , kAutomatic = 3 }
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClass * desc ()
 

Detailed Description

This class is intended to be used in implementing custom OLE handlers.

Remarks
This class represents header of OdDbOle2Frame binary data.

The header is an MFC COleClientItem object's fields serialized through MFC CArchive object. See MFC source code for details.

<group Other_Classes>

Definition at line 45 of file OleItemHandlerBase.h.

Constructor & Destructor Documentation

◆ OdOleItemHandlerBase()

OdOleItemHandlerBase::OdOleItemHandlerBase ( )
protected

Member Function Documentation

◆ adviseType()

DvAspect OdOleItemHandlerBase::adviseType ( ) const

◆ draw()

bool OdOleItemHandlerBase::draw ( const OdGiCommonDraw &  drawObj,
void *  hdc,
const OdGsDCRect &  screenRect 
) const
virtual
Remarks
The default implementation of this function does nothing.

Implements OdGiSelfGdiDrawable.

◆ drawAspect()

DvAspect OdOleItemHandlerBase::drawAspect ( ) const
virtual

Returns the draw aspect of this OleItemHandler object.

Remarks
drawAspect() returns one of the following:

Value kContent 1 kThumbnail 2 kIcon 4 kDocPrint 8

Implements OdOleItemHandler.

◆ embedRaster()

virtual bool OdOleItemHandlerBase::embedRaster ( OdSmartPtr< OdGiRasterImage >  pImage,
OdRxObject *  pRxDb = NULL 
)
virtual

Embeds a raster image to this OLE object.

Parameters
pImage[in] Pointer to a raster image.
pRxDb[in] Pointer to a database object.
Returns
Returns true if a raster image is successfully embedded to the OLE object, or returns false in the other case.

Implements OdOleItemHandler.

◆ getOleClientItem()

virtual COleClientItem * OdOleItemHandlerBase::getOleClientItem ( void  ) const
virtual

Implements OdOleItemHandler.

◆ getRaster()

virtual OdGiRasterImagePtr OdOleItemHandlerBase::getRaster ( bool  = true) const
virtual

Implements OdOleItemHandler.

◆ getWmfData()

virtual bool OdOleItemHandlerBase::getWmfData ( OdBinaryData &  data) const
virtual

◆ itemId()

OdUInt32 OdOleItemHandlerBase::itemId ( ) const

◆ linkName()

OdString OdOleItemHandlerBase::linkName ( ) const
virtual
Remarks
The default implementation of this function returns an empty string.

Implements OdOleItemHandler.

◆ linkPath()

OdString OdOleItemHandlerBase::linkPath ( ) const
virtual
Remarks
The default implementation of this function returns an empty string.

Implements OdOleItemHandler.

◆ load()

void OdOleItemHandlerBase::load ( OdStreamBuf &  streamBuf)
virtual

Reads the header of the OdDbOle2Frame object.

Parameters
streamBuf[in] StreamBuf object from which the data are to be read.

Implements OdOleItemHandler.

◆ monikerAssigned()

bool OdOleItemHandlerBase::monikerAssigned ( ) const

◆ ODRX_DECLARE_MEMBERS()

OdOleItemHandlerBase::ODRX_DECLARE_MEMBERS ( OdOleItemHandlerBase  )

◆ oleVersion()

OdUInt32 OdOleItemHandlerBase::oleVersion ( ) const

◆ outputQuality()

PlotQuality OdOleItemHandlerBase::outputQuality ( ) const
virtual

Returns the output quality for this OLE object (DXF 73).

Remarks
Controls the color depth and resolution when plotted.

outputQuality() returns one of the following:

Value Example kMonochrome 0 Spreadsheet kLowGraphics 1 Color text & pie charts kHighGraphics 2 Photograph kAutomatic 3 Automatic dependent on document type

Implements OdOleItemHandler.

◆ save()

void OdOleItemHandlerBase::save ( OdStreamBuf &  streamBuf) const
virtual

Writes the header of the OdDbOle2Frame object.

Parameters
streamBuf[in] StreamBuf object to which which the data are to be written.

Implements OdOleItemHandler.

◆ setAdviseType()

void OdOleItemHandlerBase::setAdviseType ( DvAspect  at)

◆ setDrawAspect()

void OdOleItemHandlerBase::setDrawAspect ( DvAspect  drawAspect)
virtual

Sets the draw aspect of this OleItemHandler object.

Parameters
drawAspect[in] Draw aspect.
Remarks
drawAspect must be one of the following:

Value kContent 1 kThumbnail 2 kIcon 4 kDocPrint 8

Implements OdOleItemHandler.

◆ setItemId()

void OdOleItemHandlerBase::setItemId ( OdUInt32  nId)

◆ setMonikerAssigned()

void OdOleItemHandlerBase::setMonikerAssigned ( bool  assigned)

◆ setOleVersion()

void OdOleItemHandlerBase::setOleVersion ( OdUInt32  oleVer)

◆ setOutputQuality()

void OdOleItemHandlerBase::setOutputQuality ( PlotQuality  quality)
virtual

Sets the output quality for this OLE object (DXF 73).

Parameters
quality[in] Output quality.
Remarks
Controls the color depth and resolution when plotted.

quality must be one of the following:

Value Example kMonochrome 0 Spreadsheet kLowGraphics 1 Color text & pie charts kHighGraphics 2 Photograph kAutomatic 3 Automatic dependent on document type

Implements OdOleItemHandler.

◆ type()

Type OdOleItemHandlerBase::type ( ) const
virtual
Remarks
The default implementation of this function returns kUnknown.

Implements OdOleItemHandler.

◆ userType()

OdString OdOleItemHandlerBase::userType ( ) const
virtual
Remarks
The default implementation of this function returns an empty string.

Implements OdOleItemHandler.

Member Data Documentation

◆ m_adviseType

DvAspect OdOleItemHandlerBase::m_adviseType
protected

Definition at line 73 of file OleItemHandlerBase.h.

◆ m_bMoniker

OdUInt16 OdOleItemHandlerBase::m_bMoniker
protected

Definition at line 74 of file OleItemHandlerBase.h.

◆ m_drawAspect

DvAspect OdOleItemHandlerBase::m_drawAspect
protected

Definition at line 75 of file OleItemHandlerBase.h.

◆ m_nItemId

OdUInt32 OdOleItemHandlerBase::m_nItemId
protected

Definition at line 72 of file OleItemHandlerBase.h.

◆ m_nOleVer

OdUInt32 OdOleItemHandlerBase::m_nOleVer
protected

Definition at line 71 of file OleItemHandlerBase.h.

◆ m_quality

PlotQuality OdOleItemHandlerBase::m_quality
protected

Definition at line 76 of file OleItemHandlerBase.h.

The documentation for this class was generated from the following file:
Generated on Wed Apr 5 2023 17:31:28