#include <DbOle2Frame.h>
Public Types inherited from Detailed Description
This class represents OLE2 entities in an OdDbDatabase instance.
<group OdDb_Classes>
Definition at line 55 of file DbOle2Frame.h.
Member Enumeration Documentation
◆ PlotQuality
| Enumerator | |
|---|---|
| kMonochrome | |
| kLowGraphics | |
| kHighGraphics | |
| kAutomatic | |
Definition at line 161 of file DbOle2Frame.h.
◆ Type
| enum OdDbOle2Frame::Type |
| Enumerator | |
|---|---|
| kUnknown | |
| kLink | |
| kEmbedded | |
| kStatic | |
Definition at line 116 of file DbOle2Frame.h.
Constructor & Destructor Documentation
◆ OdDbOle2Frame()
| OdDbOle2Frame::OdDbOle2Frame | ( | ) |
Member Function Documentation
◆ autoOutputQuality()
| bool OdDbOle2Frame::autoOutputQuality | ( | ) | const |
Returns automatically selectable by application plot quality.
◆ dwgInFields()
|
virtual |
Reads the .dwg file data of this object.
- Parameters
-
pFiler [in] Filer object from which data are read.
- Returns
- Returns the filer status.
This function is called by dwgIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dwgInFields(pFiler) returned. 4) Call the OdDbDwgFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbEntity.
◆ DWGMAP_DECLARE_MEMBERS()
| OdDbOle2Frame::DWGMAP_DECLARE_MEMBERS | ( | OdDbOle2Frame | ) |
◆ dwgOutFields()
|
virtual |
Writes the .dwg file data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are written.
- Remarks
This function is called by dwgIn() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dwgOutFields(pFiler). 3) Call the OdDbDwgFiler(pFiler) methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbEntity.
◆ dxfInFields()
|
virtual |
Reads the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer from which data are read.
- Returns
- Returns the filer status.
This function is called by dxfIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfInFields(pFiler) returned. 4) Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbEntity.
◆ dxfOutFields()
|
virtual |
Writes the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are to be written.
- Remarks
This function is called by dxfOut() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dxfOutFields(pFiler). 4) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbEntity.
◆ getCompoundDocument()
| void OdDbOle2Frame::getCompoundDocument | ( | OdStreamBuf & | streamBuf | ) | const |
Writes the compound document data to the specified stream.
- Parameters
-
streamBuf [out] StreamBuf object to which the data are to be written.
◆ getCompoundDocumentDataSize()
| OdUInt32 OdDbOle2Frame::getCompoundDocumentDataSize | ( | ) | const |
Returns the compound document data size for this OLE object.
◆ getItemHandler()
| OdOleItemHandler * OdDbOle2Frame::getItemHandler | ( | ) |
Creates an Item Handler for this OLE object.
- Returns
- Returns the Item Handler.
◆ getLinkName()
| OdString OdDbOle2Frame::getLinkName | ( | ) | const |
Returns the filename and item to which this OLE object is linked.
Example: D:/My Documents/My Workbook.xls!Sheet2!R1C1:R10C10
- See also
- <link OdDbOle2Frame::getLinkPath@const, getLinkPath() method>
◆ getLinkPath()
| OdString OdDbOle2Frame::getLinkPath | ( | ) | const |
Returns the filename to which this OLE object is linked.
Example: D:/My Documents/My Workbook.xls
- See also
- <link OdDbOle2Frame::getLinkName@const, getLinkName() method>
◆ getLocation()
| void OdDbOle2Frame::getLocation | ( | OdGePoint3d & | point3d | ) | const |
Returns the upper-left corner of the OLE object (DXF 10).
- Parameters
-
point3d [out] Receives the upper-left corner.
◆ getOleClientItem()
| COleClientItem * OdDbOle2Frame::getOleClientItem | ( | ) | const |
Returns pointer to MFC COleClientItem object.
- Returns
- Returns non-Null pointer only if OleItemHandler implementation is MFC-based and supports this method.
◆ getType()
| Type OdDbOle2Frame::getType | ( | ) | const |
Returns the type of this OLE object (DXF 71).
- Remarks
- getType() returns one of the following:
Value kUnknown 0 kLink 1 kEmbedded 2 kStatic 3
◆ getUserType()
| OdString OdDbOle2Frame::getUserType | ( | ) | const |
Returns the user type-string for the OLE object (DXF 3).
Examples:
"Word Document"
"Excel Chart"
◆ itemHandler()
| const OdOleItemHandler * OdDbOle2Frame::itemHandler | ( | ) | const |
Returns the Item Handler for this OLE object.
◆ lockAspect()
| bool OdDbOle2Frame::lockAspect | ( | ) | const |
Returns lock aspect property.
◆ outputQuality()
| PlotQuality OdDbOle2Frame::outputQuality | ( | ) | const |
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
◆ position()
| void OdDbOle2Frame::position | ( | OdRectangle3d & | rect3d | ) | const |
Returns the corner points of the OLE object (DXF 10 & 11).
- Parameters
-
rect3d [out] Receives the corner points.
◆ reset()
Resets current OLE XData.
- Parameters
-
bInitSize [in] Init actual OLE object size using current WCS size.
◆ rotation()
| double OdDbOle2Frame::rotation | ( | ) | const |
Returns rotation angle for this OLE object.
◆ scaleHeight()
| double OdDbOle2Frame::scaleHeight | ( | ) | const |
Returns percentage of the current OLE object height scale to original object height scale.
◆ scaleWidth()
| double OdDbOle2Frame::scaleWidth | ( | ) | const |
Returns percentage of the current OLE object width scale to original object width scale.
◆ setAutoOutputQuality()
| void OdDbOle2Frame::setAutoOutputQuality | ( | bool | bFlag | ) |
Sets plot quality to automatically selectable by application.
- Parameters
-
bFlag [in] New value.
◆ setCompoundDocument()
| void OdDbOle2Frame::setCompoundDocument | ( | OdUInt32 | nSize, |
| OdStreamBuf & | streamBuf | ||
| ) |
Reads the compound document data from the specified stream.
- Parameters
-
nSize [in] Size of compound data. streamBuf [in] StreamBuf object from which the data are to be read.
◆ setLockAspect()
| void OdDbOle2Frame::setLockAspect | ( | bool | bLockAspect | ) |
Sets lock aspect property.
- Parameters
-
bFlag [in] New value.
◆ setOutputQuality()
| void OdDbOle2Frame::setOutputQuality | ( | PlotQuality | quality | ) |
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
◆ setPosition()
| void OdDbOle2Frame::setPosition | ( | const OdRectangle3d & | rect3d | ) |
Sets the corner points of the OLE object (DXF 10 & 11).
- Parameters
-
rect3d [in] Corner points.
◆ setRotation()
| void OdDbOle2Frame::setRotation | ( | double | fAngle | ) |
Sets rotation angle for this OLE object.
- Parameters
-
fAngle [in] New value.
◆ setScaleHeight()
| void OdDbOle2Frame::setScaleHeight | ( | double | fScale | ) |
Sets new OLE object height scale relative to original object height.
- Parameters
-
fScale [in] New height scale in percents.
◆ setScaleWidth()
| void OdDbOle2Frame::setScaleWidth | ( | double | fScale | ) |
Sets new OLE object width scale relative to original object width.
- Parameters
-
fScale [in] New width scale in percents.
◆ setWcsHeight()
| void OdDbOle2Frame::setWcsHeight | ( | double | fHeight | ) |
Sets actual height of this OLE object in WCS.
- Parameters
-
fHeight [in] New OLE object WCS height.
◆ setWcsWidth()
| void OdDbOle2Frame::setWcsWidth | ( | double | fWidth | ) |
Sets actual width of this OLE object in WCS.
- Parameters
-
fWidth [in] New OLE object WCS width.
◆ subClose()
|
virtual |
Called as the first operation as this object is being closed, for database -resident objects only.
- Remarks
- This function is notified just before the current open operation is to be closed, giving this function the ability to perform necessary operatons.
When overriding this function:
1) If the OdDbObject's state is incorrect, throw exception.
2) Call parent class's subClose().
3) If other actions are required before close, do them.
The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented from OdDbObject.
◆ subGetClassID()
Reimplemented from OdDbEntity.
◆ subGetTransformedCopy()
|
virtual |
Reimplemented from OdDbEntity.
◆ subSetDatabaseDefaults()
|
virtual |
Called by setDatabaseDefaults() after the values are set.
- Parameters
-
pDb [in] Pointer to the database whose default values are to be used. doSubents [in] Set to true if subentities should be processed
- Remarks
- If pDb is null, the database containing this entity is used.
This function allows custom classes to inspect and modify the values set by setDatabaseDefaults.
The default implementation of this function returns eNotApplicable. This function can be overridden in custom classes.
- Remarks
- This function is not intended to be called by the user.
Reimplemented from OdDbEntity.
◆ subTransformBy()
|
virtual |
Reimplemented from OdDbEntity.
◆ subViewportDraw()
|
virtual |
Reimplemented from OdDbEntity.
◆ subWorldDraw()
|
virtual |
Reimplemented from OdDbEntity.
◆ unhandled_himetricHeight()
| OdUInt16 OdDbOle2Frame::unhandled_himetricHeight | ( | ) | const |
- Remarks
- OdDbOle2Frame::getPixelHeight() in DD1.12
- Currently the Drawings does not handle this field. This method will be removed or renamed in future releases.
◆ unhandled_himetricWidth()
| OdUInt16 OdDbOle2Frame::unhandled_himetricWidth | ( | ) | const |
- Remarks
- OdDbOle2Frame::getPixelWidth() in DD1.12
- Currently the Drawings does not handle this field. This method will be removed or renamed in future releases.
◆ unhandled_setHimetricSize()
Sets unhandled fields.
- Remarks
- Currently the Drawings does not handle these fields. This method will be removed or renamed in future releases.
◆ unhandled_setUnknown()
| void OdDbOle2Frame::unhandled_setUnknown | ( | OdInt32 | unk0 = 0, |
| OdUInt8 | unk1 = 0x80, |
||
| OdUInt8 | unk2 = 0x55 |
||
| ) |
Sets unknown fields.
- Remarks
- Currently the Drawings does not handle these fields. This method will be removed or renamed in future releases.
◆ unhandled_unknown0()
| OdInt32 OdDbOle2Frame::unhandled_unknown0 | ( | ) | const |
Returns unknown field.
- Remarks
- Was not accessible in DD1.12 (OdDbOle2FrameImpl::m_UnknownFromDWG)
- Currently the Drawings does not handle this field. This method will be removed or renamed in future releases.
◆ unhandled_unknown1()
| OdUInt8 OdDbOle2Frame::unhandled_unknown1 | ( | ) | const |
Returns unknown field.
- Remarks
- Still unknown. OdDbOle2Frame::getUnknown1() in DD1.12
- Currently the Drawings does not handle this field. This method will be removed or renamed in future releases.
◆ unhandled_unknown2()
| OdUInt8 OdDbOle2Frame::unhandled_unknown2 | ( | ) | const |
Returns unknown field.
- Remarks
- Still unknown. OdDbOle2Frame::getUnknown2() in DD1.12
- Currently the Drawings does not handle this field. This method will be removed or renamed in future releases.
◆ wcsHeight()
| double OdDbOle2Frame::wcsHeight | ( | ) | const |
Returns actual height of this OLE object in WCS.
◆ wcsWidth()
| double OdDbOle2Frame::wcsWidth | ( | ) | const |
Returns actual width of this OLE object in WCS.
The documentation for this class was generated from the following file: