VCOM:VectorWorks:UI:IIcon

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

Description

namespace VectorWorks::UI

This interface loads 32-bit RGBA PNG icons or legacy Macintosh resource icons in a uniform way.

Interface

// ----------------------------------------------------------------------------------------------------
// {7E8C933D-CC09-4202-B14F-EFFB04FA4423}
static const VWIID IID_Icon = { 0x7E8C933D, 0xCC09, 0x4202, { 0xB1, 0x4F, 0xEF, 0xFB, 0x04, 0xFA, 0x44, 0x23 } };

class IIcon : public IVWUnknown
{
public:
  virtual VCOMError VCOM_CALLTYPE IsSet(bool& outResult) = 0;
  virtual VCOMError VCOM_CALLTYPE GetDimensions(Sint16& outWidth, Sint16& outHeight) = 0;

  virtual VCOMError VCOM_CALLTYPE Deprecated3(Sint16 inResId, Sint16 inWidth, Sint16 inHeight) = 0;
  virtual VCOMError VCOM_CALLTYPE SetFromPngData(const void* inPngData, size_t inPngDataSize) = 0;
  virtual VCOMError VCOM_CALLTYPE GetPngData(void* outPngData, size_t& inOutPngDataSize) = 0;

  virtual VCOMError VCOM_CALLTYPE GetNativeIcon(void*& handle) = 0;
  virtual VCOMError VCOM_CALLTYPE SetFromResourceSpecifier(const TXString& imageSpecifier, Sint16 width = 0, Sint16 height = 0) = 0;
};

Members

IsSet		Determine if there is an icon set in this instance.
GetDimensions		Obtain the dimensions of this icon.
SetFromPngData		Loads in the instance icon from PNG data.
GetPngData		Obtain the PNG data from this icon instance.
GetNativeIcon		Get OS native icon representation.
SetFromResourceSpecifier		Loads in the instance icon from resource.

Remarks

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

typedef VCOMPtr<IIcon>  IIconPtr;

Version

Available from: VectorWorks 12

See Also

VCOM:VCOMPtr

[[VCOM:VCOMPtr]]