dtk_oleobject.hpp

Go to the documentation of this file.

#ifndef __UTIL_DTK_OLE_OBJECT_HPP__
#define __UTIL_DTK_OLE_OBJECT_HPP__
 
#include "def/define.h"
#include "util/BaseTypes/dtk_object.hpp"
#include "util/BaseTypes/dtk_string.hpp"
#include "util/BaseTypes/dtk_transfo.hpp"
#include "util/error_dtk.hpp"
#include "util/util_ptr_dtk.hpp"
#include <memory>
 
class Dtk_Oriented2dBBox;
 
#define DTK_OLE_OBJECT_INFO_KEY_FROM_OLE_OBJECT "Dtk_FromOLEObject"
 
//! \class Dtk_OLEObject 
//! \brief This is the Dtk_OLEObject Class.\n
//! The Dtk_OLEObject object is used to store any informations about Object Linking and Embedding items.
//! \SmartPtr{Dtk_OLEObjectPtr}
 
class Dtk_OLEObject : public Dtk_Object
{
public:
     enum Dtk_OLEObjectViewingAspect
     {
          OLE_ASPECT_UNKNOWN = 0,
          OLE_ASPECT_CONTENT,
          // OLE_ASPECT_DOCPRINT,
          OLE_ASPECT_ICON,
          // OLE_ASPECT_THUMBNAIL
     };
 
     static Dtk_string Dtk_OLEObjectViewingAspectToString( const Dtk_OLEObjectViewingAspect & inEnum )
     {
          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";
          }
     }
 
protected:
     struct Dtk_Handle; // Not defined here
     std::unique_ptr<Dtk_Handle> _Private; // Handle
     enum
     {
          _typeID = DTK_TYPE_OLE_OBJECT
     };
     //! \brief Base Constructor
     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 );
 
     Dtk_OLEObject( const Dtk_OLEObject & );
     Dtk_OLEObject( Dtk_OLEObject && ) DTK_NOEXCEPT;
 
     //! \BaseDestructor
     ~Dtk_OLEObject();
 
     inline virtual Dtk_Object* Clone(){     return new Dtk_OLEObject( *this ); }
 
private:
     friend class Dtk_SmartPtr<Dtk_OLEObject>;
public:
 
     //! \DtkDynamicType
     Dtk_Int32 DtkDynamicType( const Dtk_Int32 &inId );
 
     Dtk_InfoPtr get_info() const;
     Dtk_InfoPtr& info();
 
     //! \DtkDynamicCast
     static Dtk_OLEObject* DtkDynamicCast( Dtk_Object *o );
 
     //! \brief Create a Dtk_OLEObjectPtr.
     //! \param binaryContent The OLE Object data.
     //! \param binaryContentSize The OLE Object data size.
     //! \param positioning Position and orientation of the OLE Object in space.
     //! \param viewingAspect The way the OLE Object should be displayed at screen.
     //! \param scale The scale that is applied to the OLE Object.
     //! \return The constructed Dtk_OLEObjectPtr.
     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 );
 
     //! \CreateCopy{in}
     static Dtk_OLEObjectPtr Create( const Dtk_OLEObject &in );
 
     type_detk get_type_detk() const
     {
          return DTK_TYPE_OLE_OBJECT;
     }
 
     //! \Transform{inTransfo}
     Dtk_ErrorStatus Transform( const Dtk_transfo &inTransfo );
 
     //! \brief Returns the OLE Object data.
     const Dtk_Size_t GetBinaryContentSize() const;
     //! \brief Returns the OLE Object data size.
     const Dtk_Char8 *const GetBinaryContent() const;
 
     //! \brief Returns the way the OLE Object should be displayed at screen.
     Dtk_OLEObjectViewingAspect GetViewingAspect() const;
 
     //! \brief Returns the position and orientation of the OLE Object in space.
     Dtk_Oriented2dBBox & GetPlacement();
     //! \brief Returns the position and orientation of the OLE Object in space.
     const Dtk_Oriented2dBBox & GetPlacement() const;
 
     //! \brief Returns the scale that is applied to the OLE Object.
     Dtk_Double64 GetScale() const;
 
     //! \brief Set the OLE Object data.
     //! \param inNewContent The OLE Object data.
     //! \param inNewContentSize The OLE Object data size.
     void SetBinaryContent( const Dtk_Char8 *const inNewContent,
                                 const Dtk_Size_t inNewContentSize );
 
     //! \brief Set the way the OLE Object should be displayed at screen.
     void SetViewingAspect( const Dtk_OLEObjectViewingAspect & inNewAspect );
 
     //! \brief Set the position and orientation of the OLE Object in space.
     void SetPlacement( const Dtk_Oriented2dBBox & inNewPlacement );
 
     //! \brief Set the scale that is applied to the OLE Object.
     void SetScale( const Dtk_Double64 & inNewScale );
 
     //! \brief Extract the currently displayed picture from the OLE Object.
     //! \return dtkNoError if OK.
     Dtk_ErrorStatus ExtractPreviewPicture( Dtk_picturePtr & outPreviewPicture ) const;
};
 
#endif