IAddNoteDataCmdData.h

//========================================================================================
// 
// $File$
// 
// Owner: Wai Cheuk
// 
// $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.
// 
// 
// Comments: 
// 
//========================================================================================

#ifndef IADDNOTEDATACMDDATA_H
#define IADDNOTEDATACMDDATA_H

#include "IPMUnknown.h"
#include "NoteID.h"
#include "WideString.h"

/* Data interface for kAddNoteDataCmdBoss. Sets the properties of Note to be added.
*/
class IAddNoteDataCmdData : public IPMUnknown {

public:
 enum { kDefaultIID = IID_IADDNOTEDATACMDDATA }; 

 // IMPORTANT NOTE!
 // SHOULD NEVER HAVE TO SET THE STORY REFERENCE VIA THIS INTERFACE 
 // SINCE IT CAN BE QUERIED DIRECTLY FROM THE NOTE OWNED ITEM INTERFACE.
 // CALLING THESE TWO METHODS WILL RESULT IN ASSERTS AND kInvalidUID 
 // WILL RETURN IN GETTEXTMODEL.

 virtual const UID GetTextModel() const = 0;

 virtual void SetTextModel(const UID textModelUID) = 0;


 virtual const WideString& GetAuthor() const = 0;

 virtual void SetAuthor(const WideString& author) = 0;


 virtual bool16 GetCollapse() const = 0;

 virtual void SetCollapse(bool16 collapsedState) = 0;
};

#endif // IADDNOTEDATACMDDATA_H