IStoryLabel.h

//========================================================================================
// 
// $File$
// 
// Owner: Scott Binns
// 
// $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.
// 
//========================================================================================

#include "IPMUnknown.h"
#include "WideString.h"
#include "InCopySharedID.h"

#ifndef __IStoryLabel__
#define __IStoryLabel__

class IStoryLabel : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ISTORYLABEL }; 
 
 //----------------------------------------------------------------------------------------
 // GetLabel
 //
 // Try to get the label from the story metadata (XMP data)
 // else
 // use the filename from the datalink
 // else
 // use "Untitled Story" + story list index (if more than one user accessible story).
 //
 // Returns a non-empty string.
 //----------------------------------------------------------------------------------------
 virtual PMString GetLabel() = 0;

 //----------------------------------------------------------------------------------------
 // SetLabel
 //
 // Uses commands to set the title field in story metadata (XMP data), creates a new 
 // metadata structure if story metadata does not exist.
 //----------------------------------------------------------------------------------------
 virtual ErrorCode SetLabel(
 const PMString& label
 ) = 0;

 virtual void ReadWrite(
 IPMStream *s,
 ImplementationID prop
 ) = 0; 
};

#endif //__IStoryLabel__