OleItemHandler.h

Go to the documentation of this file.

// Copyright (C) 2002-2017, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Teigha(R) software pursuant to a license 
//   agreement with Open Design Alliance.
//   Teigha(R) Copyright (C) 2002-2017 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef _ODOLEITEMHANDLER_INCLUDED_
#define _ODOLEITEMHANDLER_INCLUDED_
 
#include "RxObject.h"
#include "OdErrorContext.h"
#include "Gi/GiViewportGeometry.h"
#include "RxModule.h"
#include "OdStreamBuf.h"
 
#include "TD_PackPush.h"
 
class COleClientItem;
 
class DBROOT_EXPORT OdOleItemInitStream : public OdStreamBuf
{
public:
  ODRX_DECLARE_MEMBERS(OdOleItemInitStream);
 
  virtual OdDbStub* frameId() const = 0;
};
typedef OdSmartPtr<OdOleItemInitStream> OdOleItemInitStreamPtr;
 
class OdOleItemHandler;
class OdDbObjectId;
typedef OdSmartPtr<OdOleItemHandler> OdOleItemHandlerPtr;
 
class DBROOT_EXPORT OdOleItemHandler : public OdGiSelfGdiDrawable
{
public:
  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;
 
  enum Type
  {
    kUnknown     = 0,
    kLink        = 1,
    kEmbedded    = 2,
    kStatic      = 3
  };
  virtual Type type() const = 0;
 
  enum DvAspect
  {
    kContent    = 1,
    kThumbnail  = 2,
    kIcon       = 4,
    kDocPrint   = 8
  };
 
  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;
 
  enum PlotQuality
  {
    kMonochrome   = 0,  // e.g., spreadsheet
    kLowGraphics  = 1,  // e.g., color text & pie charts
    kHighGraphics = 2,  // e.g., photograph 
    kAutomatic    = 3   // Automatic dependent on document type
  };
 
  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;
};
 
#include "TD_PackPop.h"
 
#endif // _ODOLEITEMHANDLER_INCLUDED_