IPaletteWorkspace.h

//========================================================================================
// 
// $File$
// 
// Owner: Matt Joss
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IPaletteWorkspace__
#define __IPaletteWorkspace__

#include "AppUIID.h"

class ISAXAttributes;


class IPaletteWorkspace : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPALETTEWORKSPACE };
 
 // -----------------------------------------------------------

 typedef enum { kUserWorkspace, kDefaultWorkspace } WorkspaceArea;
 virtual int32 GetWorkspaceCount( WorkspaceArea area = kUserWorkspace ) const = 0;

 virtual PMString GetNthWorkspaceName( int32 n, WorkspaceArea area = kUserWorkspace ) const = 0;

 typedef enum { kNameValid, kNameInvalid, kNameDuplicate } ValidationCode;
 virtual ValidationCode ValidateWorkspaceName( const PMString& name, PMString* errorString ) const = 0; 

 typedef enum { kCurrentVersion, kOriginalVersion } WorkspaceVersion; // TODO kWorkingVersion

 virtual void SaveWorkspace(const PMString& name, bool16 includePalettes, bool16 includeMenus, WorkspaceVersion = kOriginalVersion ) const = 0;

 virtual bool16 LoadWorkspace( const PMString& name, WorkspaceArea area = kUserWorkspace, WorkspaceVersion = kCurrentVersion) const = 0;

 virtual bool16 DeleteWorkspace( const PMString& name, WorkspaceVersion version = kOriginalVersion ) const = 0;


 // -----------------------------------------------------------

 virtual void SaveWorkspace(IDFile workspaceName, bool16 includePalettes, bool16 includeMenus ) const = 0;

 virtual bool16 LoadWorkspace(IDFile workspaceFile) const = 0;

 // -----------------------------------------------------------

 virtual void SaveActiveWorkspace() const = 0;

 virtual bool16 LoadActiveWorkspace() const = 0;

 virtual PMString GetActiveWorkspaceName() const = 0;

 virtual void SetActiveWorkspaceName(const PMString& name) const = 0;

 // -----------------------------------------------------------

 virtual bool16 LoadStartupWorkspace(bool16 resetMenus = kTrue) const = 0;

 // -----------------------------------------------------------

 virtual bool16 LoadingWorkspace() const = 0;

 // -----------------------------------------------------------

 typedef struct
 {
 ISAXAttributes* fAttrs;
 WidgetID fOldPanelWidgetID;
 WidgetID fNewPanelWidgetID;
 } DynamicPanelCreationData;

 virtual PMString MakeCurrentVersionName(const PMString& originalVersionName) const = 0;

 virtual PMString MakeOriginalVersionName(const PMString& currentVersionName) const = 0;

 virtual void Initialize() const = 0;

 virtual bool16 RenameEssentialsWorkspacePrefs() const = 0;

 // INTERNAL USE ONLY. Return if the New Essentials workspace FTUE is shown once.
 virtual bool16 IsNewEssentialsWorkspaceShown() const = 0;

};

#endif //__IPaletteWorkspace__