VCOM:VectorWorks:Workspaces:IWorkspaceMenu

From Vectorworks Developer
Jump to navigation Jump to search

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

Description

namespace VectorWorks::Workspaces

Interface

class IWorkspaceMenu : public IVWUnknown
{
public:
  virtual VCOMError VCOM_CALLTYPE GetIdentifier(TXString& outIdentifier) = 0;
  virtual VCOMError VCOM_CALLTYPE SetResourceManagerID(Sint16 inResourceID) = 0;
  virtual VCOMError VCOM_CALLTYPE GetResourceManagerID(Sint16& outResourceManagerID) = 0;	

  virtual VCOMError VCOM_CALLTYPE SetDisplayName(const TXString& inDisplayName) = 0;
  virtual VCOMError VCOM_CALLTYPE GetDisplayName(TXString& outDisplayName) = 0;

  virtual VCOMError VCOM_CALLTYPE AddMenuItem(IVWUnknown* inMenuItem, EWorkspaceMenuChunkType inChunkType = eWorkspaceMenuChunkType_None) = 0;
  virtual VCOMError VCOM_CALLTYPE GetMenuItemCount(Sint16& outMenuItemCount) = 0;
  virtual VCOMError VCOM_CALLTYPE GetMenuItemAtIndex(Sint16 inMenuItemIndex, IVWUnknown** outMenuItem, EWorkspaceMenuChunkType& outChunkType) = 0;
  virtual VCOMError VCOM_CALLTYPE GetLastError(EWorkspacesError& outError) = 0;
};

Members

GetIdentifier Gets the identifier for the menu.
SetResourceManagerID Sets the Resource Manager ID for this item.
GetResourceManagerID Gets the Resource Manager ID if there is one.
SetDisplayName Sets the display name for the menu.
GetDisplayName Gets the display name for the menu.
AddMenuItem Adds a menu item to this menu.
GetMenuItemCount Gets the count of menu itemss in the menu.
GetMenuItemAtIndex Gets menu item at the given index.
GetLastError Gets the last error that was generated by the IWorkspaces interface.

Version

Available from: VectorWorks 12

See Also

VCOM:VCOMPtr | VCOM:VectorWorks:Workspaces:IWorkspaces

[[VCOM:VCOMPtr]] | [[VCOM:VectorWorks:Workspaces:IWorkspaces]]