VCOM:VectorWorks:IDocumentColorTable

.SDK|SDK ..SDK:Types|SDK Types ..VCOM:VCOM (Vectorworks Component Object Model)|VCOM Basics ..VCOM:Class Reference|VCOM Class Reference

Description

namespace VectorWorks

Interface

// ----------------------------------------------------------------------------------------------------
// {2d13c2d0-7c96-11db-9fe1-0800200c9a66}
static const VWIID IID_DocumentColorTable = { 0x2d13c2d0, 0x7c96, 0x11db, { 0x9f, 0xe1, 0x08, 0x00, 0x20, 0x0c, 0x9a, 0x66 } };

class IDocumentColorTable : public IVWUnknown
{
public:
  virtual VCOMError VCOM_CALLTYPE LoadDocumentColorTableFromDisk(IFileIdentifier *inFileID, IColorRecordReceiver* inpRecReceiver) = 0;

  virtual VCOMError VCOM_CALLTYPE InsertColor(const SColorRecord& inColorRecord, ColorRef& outColorRef) = 0;			
  virtual VCOMError VCOM_CALLTYPE GetColorRecord(const ColorRef& inColorRef, SColorRecord& outColorRec) = 0;
  virtual VCOMError VCOM_CALLTYPE GetNumColorRecords(Uint32& outNumRecords) = 0;
  virtual VCOMError VCOM_CALLTYPE PurgeUnusedColors() = 0;
};

Members

LoadDocumentColorTableFromDisk		no info
InsertColor		no info
GetColorRecord		no info
GetNumColorRecords		no info
PurgeUnusedColors		no info

Remarks

There is predefined type for smart VCOM pointer VCOMPtr to IDocumentColorTable interface:

typedef VCOMPtr<IDocumentColorTable>  IDocumentColorTablePtr;

struct SColorRecord {
  float       fCyan;
  float       fMagenta;
  float       fYellow;
  float       fKey;
  TXString    fColorName;
  Bool8       fbUserColor;
};

Version

Available from: VectorWorks 12

See Also

VCOM:VCOMPtr

[[VCOM:VCOMPtr]]