VCOM:VectorWorks:PluginSupport:IWidgetsEditProvider

From Vectorworks Developer
Jump to: navigation, search

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

Description

namespace VectorWorks::PluginSupport

Inherit IWidgetsProvider.

Provides widget editing capabilities for SDK:Parametric Custom Shape Pane support.

This interface is obtained using interface VCOM:VectorWorks:PluginSupport:IExtendedProps from function IExtendedProps::GetObjComponentTypeWidgets.

Interface

class IWidgetsEditProvider : public IWidgetsProvider
{
public:
  virtual void AddWidget(Sint32 widgetID, const TXString& paramName) = 0;
  virtual void AddWidget(Sint32 widgetID, const TXString& paramName, const TXString& localizedName) = 0;
  virtual void AddWidget(Sint32 widgetID, EWidgetType widgetType, const TXString& paramName, const TXString& localizedName) = 0;
  virtual void AddWidget(Sint32 widgetID, EWidgetType widgetType, const TXString& localizedName) = 0;

  virtual void InsertWidget(size_t beforeIndex, Sint32 widgetID, const TXString& paramName) = 0;
  virtual void InsertWidget(size_t beforeIndex, Sint32 widgetID, const TXString& paramName, const TXString& localizedName) = 0;
  virtual void InsertWidget(size_t beforeIndex, Sint32 widgetID, EWidgetType widgetType, const TXString& paramName, const TXString& localizedName) = 0;
  virtual void InsertWidget(size_t beforeIndex, Sint32 widgetID, EWidgetType widgetType, const TXString& localizedName) = 0;

  virtual bool SetWidget(size_t index, Sint32 widgetID, EWidgetType widgetType, const TXString& localizedName) = 0;

  virtual void ClearWidgets() = 0;
  virtual bool DeleteWidget(size_t index) = 0;

  virtual bool FindWidgetIndex(Sint32 widgetID, size_t& outIndex) const = 0;
};

Members

AddWidget Add a new widget to the instance.
InsertWidget Insert a new widget.
SetWidget Set widget data.
ClearWidgets Clear all widgets from the instance.
DeleteWidget Delete specified widget.
FindWidgetIndex Find the index of the specified widget in this instance's widgets list.

Remarks

See SDK:SWidgetDefinition#Remarks for detailed information on widget types.

Version

Available from: VectorWorks 2009

See Also

VCOM:VCOMPtr | VCOM:VectorWorks:PluginSupport:IExtendedProps | SDK:SWidgetDefinition
[[VCOM:VCOMPtr]] | [[VCOM:VectorWorks:PluginSupport:IExtendedProps]] | [[SDK:SWidgetDefinition]]
Personal tools
NamespacesFFFF

Variants
Actions
Advanced Search
See Also
Navigation
Toolbox