Dtk_OLEObject Class Reference

This is the Dtk_OLEObject Class.
The Dtk_OLEObject object is used to store any informations about Object Linking and Embedding items. More...

Inheritance diagram for Dtk_OLEObject:

Public Types
enum	Dtk_OLEObjectViewingAspect { OLE_ASPECT_UNKNOWN = 0, OLE_ASPECT_CONTENT, OLE_ASPECT_ICON }

Public Member Functions
Dtk_Int32	DtkDynamicType (const Dtk_Int32 &inId)
	Retrieves the dynamic entity type. More...
virtual int	DtkDynamicType (const int &inId)=0
virtual void	dump (FILE *file=stdout)
Dtk_ErrorStatus	ExtractPreviewPicture (Dtk_picturePtr &outPreviewPicture) const
	Extract the currently displayed picture from the OLE Object. More...
type_detk	get_type_detk () const
const Dtk_Char8 *const	GetBinaryContent () const
	Returns the OLE Object data size. More...
const Dtk_Size_t	GetBinaryContentSize () const
	Returns the OLE Object data. More...
Dtk_Oriented2dBBox &	GetPlacement ()
	Returns the position and orientation of the OLE Object in space. More...
const Dtk_Oriented2dBBox &	GetPlacement () const
	Returns the position and orientation of the OLE Object in space. More...
Dtk_Double64	GetScale () const
	Returns the scale that is applied to the OLE Object. More...
virtual Dtk_Size_t	GetSize () const
Dtk_OLEObjectViewingAspect	GetViewingAspect () const
	Returns the way the OLE Object should be displayed at screen. More...
Dtk_OLEObject &	operator= (const Dtk_OLEObject &in)
	Copy assignment operator. More...
void	SetBinaryContent (const Dtk_Char8 *const inNewContent, const Dtk_Size_t inNewContentSize)
	Set the OLE Object data. More...
void	SetPlacement (const Dtk_Oriented2dBBox &inNewPlacement)
	Set the position and orientation of the OLE Object in space. More...
void	SetScale (const Dtk_Double64 &inNewScale)
	Set the scale that is applied to the OLE Object. More...
void	SetViewingAspect (const Dtk_OLEObjectViewingAspect &inNewAspect)
	Set the way the OLE Object should be displayed at screen. More...
Dtk_ErrorStatus	Transform (const Dtk_transfo &inTransfo)
	Applies a transformation matrix to the entity. //! More...

Static Public Member Functions
static Dtk_OLEObjectPtr	Create (const Dtk_Char8 *const binaryContent, const Dtk_Size_t &binaryContentSize, const Dtk_Oriented2dBBox &positioning, const Dtk_OLEObjectViewingAspect viewingAspect, const Dtk_Double64 &scale=1)
	Create a Dtk_OLEObjectPtr. More...
static Dtk_OLEObjectPtr	Create (const Dtk_OLEObject &in)
	Calls copy constructor to allocate a new object. More...
static Dtk_string	Dtk_OLEObjectViewingAspectToString (const Dtk_OLEObjectViewingAspect &inEnum)
static Dtk_OLEObject *	DtkDynamicCast (Dtk_Object *o)
	Performs a dynamic cast - doesn't need RTTI -. More...

Protected Types
enum	{ _typeID = DTK_TYPE_OLE_OBJECT }

Protected Member Functions
virtual Dtk_Object *	Clone ()
	Dtk_OLEObject (const Dtk_Char8 *const binaryContent, const Dtk_Size_t &binaryContentSize, const Dtk_Oriented2dBBox &placement, const Dtk_OLEObjectViewingAspect viewingAspect, const Dtk_Double64 &scale=1)
	Base Constructor. More...
	Dtk_OLEObject (const Dtk_OLEObject &o)
	Copy Constructor. More...
	~Dtk_OLEObject ()
	Destructor. More...

Protected Attributes
Dtk_Handle *	_Private
unsigned long	count_

Detailed Description

This is the Dtk_OLEObject Class.
The Dtk_OLEObject object is used to store any informations about Object Linking and Embedding items.

See also

Use Dtk_OLEObjectPtr class to handle it.

Member Enumeration Documentation

anonymous enum

anonymous enum

protected

Enumerator
_typeID

     {
          _typeID = DTK_TYPE_OLE_OBJECT
     };

Dtk_OLEObjectViewingAspect

enum Dtk_OLEObject::Dtk_OLEObjectViewingAspect

Enumerator
OLE_ASPECT_UNKNOWN
OLE_ASPECT_CONTENT
OLE_ASPECT_ICON

     {
          OLE_ASPECT_UNKNOWN = 0,
          OLE_ASPECT_CONTENT,
          // OLE_ASPECT_DOCPRINT,
          OLE_ASPECT_ICON,
          // OLE_ASPECT_THUMBNAIL
     };

Constructor & Destructor Documentation

Dtk_OLEObject() [1/2]

Dtk_OLEObject::Dtk_OLEObject ( const Dtk_Char8 *const  binaryContent, const Dtk_Size_t &  binaryContentSize, const Dtk_Oriented2dBBox &  placement, const Dtk_OLEObjectViewingAspect  viewingAspect, const Dtk_Double64 &  scale = 1  )

protected

Base Constructor.

Dtk_OLEObject() [2/2]

Dtk_OLEObject::Dtk_OLEObject ( const Dtk_OLEObject &  o )

protected

Copy Constructor.

~Dtk_OLEObject()

Dtk_OLEObject::~Dtk_OLEObject ( )

protected

Destructor.

Member Function Documentation

Clone()

virtual Dtk_Object* Dtk_OLEObject::Clone ( )

protectedvirtual

     {
          return new Dtk_OLEObject( *this );
     }

Create() [1/2]

static Dtk_OLEObjectPtr Dtk_OLEObject::Create ( const Dtk_Char8 *const  binaryContent, const Dtk_Size_t &  binaryContentSize, const Dtk_Oriented2dBBox &  positioning, const Dtk_OLEObjectViewingAspect  viewingAspect, const Dtk_Double64 &  scale = 1  )

static

Create a Dtk_OLEObjectPtr.

Parameters

binaryContent	The OLE Object data.
binaryContentSize	The OLE Object data size.
positioning	Position and orientation of the OLE Object in space.
viewingAspect	The way the OLE Object should be displayed at screen.
scale	The scale that is applied to the OLE Object.

Returns

The constructed Dtk_OLEObjectPtr.

Create() [2/2]

static Dtk_OLEObjectPtr Dtk_OLEObject::Create ( const Dtk_OLEObject &  in )

static

Calls copy constructor to allocate a new object.

Parameters

in	Object to copy from.

Dtk_OLEObjectViewingAspectToString()

static Dtk_string Dtk_OLEObject::Dtk_OLEObjectViewingAspectToString ( const Dtk_OLEObjectViewingAspect &  inEnum )

static

     {
          switch( inEnum )
          {
               case OLE_ASPECT_CONTENT:     return L"OLE_ASPECT_CONTENT";
               //case OLE_ASPECT_DOCPRINT:  return L"OLE_ASPECT_DOCPRINT";
               case OLE_ASPECT_ICON:        return L"OLE_ASPECT_ICON";
               //case OLE_ASPECT_THUMBNAIL: return L"OLE_ASPECT_THUMBNAIL";
               default:
               case OLE_ASPECT_UNKNOWN:     return L"OLE_ASPECT_UNKNOWN";
          }
     }

DtkDynamicCast()

static Dtk_OLEObject* Dtk_OLEObject::DtkDynamicCast ( Dtk_Object *  o )

static

Performs a dynamic cast - doesn't need RTTI -.

DtkDynamicType() [1/2]

Dtk_Int32 Dtk_OLEObject::DtkDynamicType

(

const Dtk_Int32 &

inId

)

Retrieves the dynamic entity type.

DtkDynamicType() [2/2]

virtual int Dtk_Object::DtkDynamicType ( const int &  inId )

pure virtualinherited

Implemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_TopologicalEntity, Dtk_MeshPolyline, Dtk_MeshSurface, Dtk_TransformedSurface, Dtk_FilletSurface, Dtk_OffsetSurface, Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_ConicalSurface, Dtk_CylindricalSurface, Dtk_RuledSurface, Dtk_LinearExtrusionSurface, Dtk_StandardRevolutionSurface, Dtk_RevolutionSurface, Dtk_PlaneSurface, Dtk_NurbsSurface, Dtk_Surface, Dtk_Hyperbola, Dtk_Parabola, Dtk_Ellipse, Dtk_Conic, Dtk_Line, Dtk_Polyline, Dtk_NurbsCurve, Dtk_Curve, Dtk_Point, Dtk_Constraint, Dtk_ConstraintReference, Dtk_AxisSystem, Dtk_Preview, Dtk_Entity, Dtk_picture, Dtk_OverrideSet, Dtk_OverrideInfo, Dtk_MainDoc, Dtk_Component, Dtk_Node, Dtk_DocElement, Dtk_Log, and Dtk_Properties.

dump()

virtual void Dtk_Object::dump ( FILE *  file = stdout )

virtualinherited

ExtractPreviewPicture()

Dtk_ErrorStatus Dtk_OLEObject::ExtractPreviewPicture

(

Dtk_picturePtr &

outPreviewPicture

)

const

Extract the currently displayed picture from the OLE Object.

Returns

dtkNoError if OK.

get_type_detk()

type_detk Dtk_OLEObject::get_type_detk

(

)

const

     {
          return DTK_TYPE_OLE_OBJECT;
     }

GetBinaryContent()

const Dtk_Char8* const Dtk_OLEObject::GetBinaryContent

(

)

const

Returns the OLE Object data size.

GetBinaryContentSize()

const Dtk_Size_t Dtk_OLEObject::GetBinaryContentSize

(

)

const

Returns the OLE Object data.

GetPlacement() [1/2]

Dtk_Oriented2dBBox& Dtk_OLEObject::GetPlacement

(

)

Returns the position and orientation of the OLE Object in space.

GetPlacement() [2/2]

const Dtk_Oriented2dBBox& Dtk_OLEObject::GetPlacement

(

)

const

Returns the position and orientation of the OLE Object in space.

GetScale()

Dtk_Double64 Dtk_OLEObject::GetScale

(

)

const

Returns the scale that is applied to the OLE Object.

GetSize()

virtual Dtk_Size_t Dtk_Object::GetSize ( ) const

virtualinherited

Reimplemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_mesh_face, Dtk_mesh, Dtk_TransformedSurface, Dtk_FilletSurface, Dtk_OffsetSurface, Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_ConicalSurface, Dtk_CylindricalSurface, Dtk_RuledSurface, Dtk_LinearExtrusionSurface, Dtk_StandardRevolutionSurface, Dtk_RevolutionSurface, Dtk_PlaneSurface, Dtk_NurbsSurface, Dtk_Surface, Dtk_Hyperbola, Dtk_Parabola, Dtk_Ellipse, Dtk_Conic, Dtk_Line, Dtk_Polyline, Dtk_NurbsCurve, Dtk_Curve, Dtk_Point, Dtk_Entity, and Dtk_Info.

GetViewingAspect()

Dtk_OLEObjectViewingAspect Dtk_OLEObject::GetViewingAspect

(

)

const

Returns the way the OLE Object should be displayed at screen.

operator=()

Dtk_OLEObject& Dtk_OLEObject::operator=

(

const Dtk_OLEObject &

in

)

Copy assignment operator.

Parameters

in	Object to copy from.

SetBinaryContent()

void Dtk_OLEObject::SetBinaryContent	(	const Dtk_Char8 *const	inNewContent,
		const Dtk_Size_t	inNewContentSize
	)

Set the OLE Object data.

Parameters

inNewContent	The OLE Object data.
inNewContentSize	The OLE Object data size.

SetPlacement()

void Dtk_OLEObject::SetPlacement

(

const Dtk_Oriented2dBBox &

inNewPlacement

)

Set the position and orientation of the OLE Object in space.

SetScale()

void Dtk_OLEObject::SetScale

(

const Dtk_Double64 &

inNewScale

)

Set the scale that is applied to the OLE Object.

SetViewingAspect()

void Dtk_OLEObject::SetViewingAspect

(

const Dtk_OLEObjectViewingAspect &

inNewAspect

)

Set the way the OLE Object should be displayed at screen.

Transform()

Dtk_ErrorStatus Dtk_OLEObject::Transform

(

const Dtk_transfo &

inTransfo

)

Applies a transformation matrix to the entity. //!

Parameters

inTransfo

The transformation matrix to apply.

Field Documentation

_Private

Dtk_Handle* Dtk_OLEObject::_Private

protected

count_

unsigned long Dtk_Object::count_

protectedinherited