VCOM:VectorWorks:Workspaces:IWorkspaceMenuItem

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

Description

namespace VectorWorks::Workspaces

A menu item can be one of two types:

• A menu item with a shortcut key and modifier (empty values are possible).
• A menu item that has a submenu

Interface

class IWorkspaceMenuItem : public IVWUnknown
{
public:
  virtual VCOMError VCOM_CALLTYPE GetIdentifier(TXString& outIdentifier) = 0;
  virtual VCOMError VCOM_CALLTYPE SetUniversalName(const TXString& inName) = 0;
  virtual VCOMError VCOM_CALLTYPE GetUniversalName(TXString& outName) = 0;
  virtual VCOMError VCOM_CALLTYPE SetResourceManagerID(Sint16 inResourceID) = 0;
  virtual VCOMError VCOM_CALLTYPE GetResourceManagerID(Sint16& outResourceManagerID) = 0;
  virtual VCOMError VCOM_CALLTYPE SetShortcutKeyInfo(char inShortcutKey, Uint32 inShortcutKeyModifiers) = 0;
  virtual VCOMError VCOM_CALLTYPE GetShortcutKeyInfo(char& outShortcutKey, Uint32& outShortcutKeyModifiers) = 0; 
  virtual VCOMError VCOM_CALLTYPE SetSubMenu(IWorkspaceMenu* inSubMenu) = 0;
  virtual VCOMError VCOM_CALLTYPE GetSubMenu(IWorkspaceMenu** outSubMenu) = 0;
  virtual VCOMError VCOM_CALLTYPE GetLastError(EWorkspacesError& outError) = 0;
};

Members

GetIdentifier		Gets the workspace identifier for the menu item.
SetUniversalName		Sets the universal name for the tool.
GetUniversalName		Gets the universal name for the menu item.
SetResourceManagerID		Sets the Resource Manager ID for this item.
GetResourceManagerID		Gets the Resource Manager ID if there is one.
SetShortcutKeyInfo		Set the shortcut key information for this menu item.
GetShortcutKeyInfo		Set the shortcut key information for this menu item.
SetSubMenu		Sets the sub menu for this menu item.
GetSubMenu		Gets the sub menu for this menu item.
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]]