IEndnoteFacade.h

//========================================================================================
// 
// $File$
// 
// Owner: Abhishek Raj
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// ADOBE CONFIDENTIAL
// 
// Copyright 2017 Adobe 
// 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 __IEndnoteFacade__
#define __IEndnoteFacade__

#include "IPMUnknown.h"

#include "IEndnoteSettings.h"

namespace Facade
{
 class IEndnoteFacade : public IPMUnknown
 {
 public:
 enum { kDefaultIID = IID_IENDNOTEFACADE };

 virtual WideString GetTitle(IEndnoteSettings* target) const = 0;
 virtual void SetTitle(IEndnoteSettings* target, WideString title) = 0;

 virtual UID GetHeaderParaStyle(IEndnoteSettings* target) const = 0;
 virtual void SetHeaderParaStyle(IEndnoteSettings* target, UID styleID) = 0;
 
 virtual IEndnoteSettings::RestartNumberingOptions GetRestartOption(IEndnoteSettings* target) const = 0;
 virtual void SetRestartOption(IEndnoteSettings* target, IEndnoteSettings::RestartNumberingOptions option) = 0;

 virtual int32 GetStartingNumber(IEndnoteSettings* target) const = 0;
 virtual void SetStartingNumber(IEndnoteSettings* target, int32 n) = 0;

 virtual ClassID GetNumberingMethod(IEndnoteSettings* target) const = 0;
 virtual void SetNumberingMethod(IEndnoteSettings* target, ClassID whichMethod) = 0;

 virtual IEndnoteSettings::MarkerPositionOptions GetMarkerPositioning(IEndnoteSettings* target) const = 0;
 virtual void SetMarkerPositioning(IEndnoteSettings* target, IEndnoteSettings::MarkerPositionOptions option) = 0;

 virtual UID GetMarkerStyle(IEndnoteSettings* target) const = 0;
 virtual void SetMarkerStyle(IEndnoteSettings* target, UID styleID) = 0;

 virtual UID GetEndnoteParagraphStyle(IEndnoteSettings* target) const = 0;
 virtual void SetEndnoteParagraphStyle(IEndnoteSettings* target, UID s) = 0;

 virtual const WideString& GetEndnoteSeparator(IEndnoteSettings* target) const = 0;
 virtual void SetEndnoteSeparator(IEndnoteSettings* target, const WideString& sep) = 0;

 virtual IEndnoteSettings::Scope GetScope(IEndnoteSettings* target) const = 0;
 virtual void SetScope(IEndnoteSettings* target, IEndnoteSettings::Scope scope) = 0;

 virtual IEndnoteSettings::Place GetPlace(IEndnoteSettings* target) const = 0;
 virtual void SetPlace(IEndnoteSettings* target, IEndnoteSettings::Place place) = 0;

 virtual const WideString& GetMarkerPrefix(IEndnoteSettings* target) const = 0;
 virtual void SetMarkerPrefix(IEndnoteSettings* target, const WideString& pre) = 0;

 virtual const WideString& GetMarkerSuffix(IEndnoteSettings* target) const = 0;
 virtual void SetMarkerSuffix(IEndnoteSettings* target, const WideString& suf) = 0;

 virtual IEndnoteSettings::SuffixPrefixUsageOptions GetPrefixSuffixUsage(IEndnoteSettings* target) const = 0;
 virtual void SetPrefixSuffixUsage(IEndnoteSettings* target, IEndnoteSettings::SuffixPrefixUsageOptions options) = 0;

 virtual void SetAllSettings(IEndnoteSettings* target, const IEndnoteSettings::EndnotePrefs* settings) = 0;

 /* Returns endnote settings of a document */
 virtual IEndnoteSettings* QueryEndnoteSettings(IDataBase* db) const = 0;

 /* Returns if the passed story is an endnote story */
 virtual bool16 IsEndnoteStory(const UIDRef textModelRef) const = 0;

 virtual bool16 IsEndnoteTextRange(const TextIndex& startPosition, const TextIndex& endPosition, const ITextModel* textModel) const = 0;

 virtual bool16 IsEndnoteAnchor(TextIndex& position, const ITextModel* textModel) const = 0;

 virtual bool16 IsEndnoteTextRangeMarker(const TextIndex& position, ITextModel* textModel) const = 0;

 virtual void AppendEndnoteRelatedStories(const UIDRef& modelRef, UIDList& storiesList) const = 0;
 
 virtual bool16 IsEndnoteAnchorOrEndnoteStoryInAssignment(const UIDRef& storyRef) const = 0;

 virtual bool16 IsEndnoteAnchorOrEndnoteStory(const UIDRef& storyRef) const = 0;

 virtual UIDList GetEndnoteAnchorStories(UIDRef endnoteStoryRef) const = 0;

 virtual int32 GetEndnoteCount(UIDRef endnoteStoryRef) const = 0;

 virtual UIDRef GetEndnoteStoryRef(const ITextModel* textModel) const = 0;

 virtual bool16 IsSeparatorChar(const UIDRef textModelRef, const TextIndex index) const = 0;

 virtual void MoveEndnoteRange(const UIDRef& storyRef) = 0;

 virtual void DeleteEndnoteRangesInStory(ITextModel* model, TextIndex start, TextIndex end) const = 0;

 virtual void CopyEndnoteDataFromSourceStoryToDestStory(UIDRef sourceEndnoteStoryRef, UIDRef destEndnoteStoryRef) = 0;
};
} // namespace Facade

#endif // __IEndnoteFacade__