ILoadUserWorkspaceCmdData Class Reference

#include <ILoadUserWorkspaceCmdData.h>

Inheritance diagram for ILoadUserWorkspaceCmdData:

Public Types
enum	{ kDefaultIID = IID_ILOADUSERWORKSPACECMDDATA }

Public Member Functions
virtual void	SetWorkspaceToLoad (const PMString &name, IPaletteWorkspace::WorkspaceArea area=IPaletteWorkspace::kUserWorkspace, IPaletteWorkspace::WorkspaceVersion version=IPaletteWorkspace::kCurrentVersion)=0
virtual IPaletteWorkspace::WorkspaceArea	GetWorkspaceArea () const =0
virtual PMString	GetWorkspaceName () const =0
virtual IPaletteWorkspace::WorkspaceVersion	GetVersion () const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

This interface is used for accessing command data for loading workspaces. Workspaces may contain palette location data and/or menu customization data.

See Also

kLoadUserWorkspaceCmdBoss.

Member Function Documentation

virtual IPaletteWorkspace::WorkspaceVersion ILoadUserWorkspaceCmdData::GetVersion ( ) const

pure virtual

Return whether to load "current" version of a workspace (the one with _CurrentWorkspace appended on filename), or the file itself.

Returns

whether to load current version of workspace with given name (if present) or to reset to the original version of the workspace. Values are IPaletteWorkspace::kCurrentVersion or IPaletteWorkspace::kOriginalVersion

See Also

IPaletteWorkspace.h

virtual IPaletteWorkspace::WorkspaceArea ILoadUserWorkspaceCmdData::GetWorkspaceArea ( ) const

pure virtual

Get the location of the workspace file - either default folder or user folder.

Returns

enum indicating which area.

virtual PMString ILoadUserWorkspaceCmdData::GetWorkspaceName ( ) const

pure virtual

Get the workspace file name.

Returns

name of workspace file to load.

virtual void ILoadUserWorkspaceCmdData::SetWorkspaceToLoad ( const PMString &  name, IPaletteWorkspace::WorkspaceArea  area = IPaletteWorkspace::kUserWorkspace, IPaletteWorkspace::WorkspaceVersion  version = IPaletteWorkspace::kCurrentVersion  )

pure virtual

Set the data for which workspace file to load.

Parameters

name	- the name of the workspace file to load.
area	- indicates if the file to be loaded is expected to be in the user workspace location(usually in a user preferences folder), or the default workspace location(which is generally in the presets folder)
version	- indicates if the "current" version of the workspace should be loaded if present.