ICapitalizeTopicEntryCmdData.h

//========================================================================================
// 
// $File$
// 
// Owner: Bertrand Lechevalier
// 
// $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.
// 
// 
// Purpose: Command data interface for capitalizing a topic entry
// 
//========================================================================================

#ifndef __ICapitalizeTopicEntryCmdData__
#define __ICapitalizeTopicEntryCmdData__

#include "IPMUnknown.h"
#include "IndexingID.h"
#include "UIDRef.h"

class IndexTopicEntry;

class ICapitalizeTopicEntryCmdData : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ICAPITALIZETOPICENTRYCMDDATA };

 enum CapitalizeOption { kSelected, kSelectedAndChildren, kAllLevel1, kAll };

 virtual const CapitalizeOption& GetCapitalizeOption() const = 0;

 virtual void SetCapitalizeOption(const CapitalizeOption& capitalizeOption) = 0;

 virtual const UIDRef& GetTopicListUIDRef() const = 0;

 virtual void SetTopicListUIDRef(const UIDRef& topicListUIDRef) = 0;

 virtual const UIDRef& GetSelectedTopicSectionUIDRef() const = 0;

 virtual void SetSelectedTopicSectionUIDRef(const UIDRef& selectedTopicSectionUIDRef) = 0;

 virtual const int32 GetSelectedTopicId() const = 0;

 virtual void SetSelectedTopicId(const int32 selectedTopicId) = 0;
};

#endif // __ICapitalizeTopicEntryCmdData__