IEndnoteSettings.h

//========================================================================================
// 
// $File$
// 
// Owner: Susmita Singh
// 
// $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 __IEndnoteSettings__
#define __IEndnoteSettings__

#define kMinStartingFootnoteNumber 1

#define kMaxStartingFootnoteNumber 100000

#ifndef __ODFRC__ // when used for core resource compilation, provide just the parameter range constants

#include "IPMUnknown.h"
#include "TextID.h"
#include "CTextEnum.h"
#include "ITextAttrStrokeType.h"
#include "IWorkspace.h"
#include "ISwatchList.h"
#include "IStyleNameTable.h"
#include "IEndnoteSettings.h"
#include "IStyleGroupManager.h"
#include "UIDRef.h"
#include "PMReal.h"
#include "WideString.h"

#include "ILayoutUIUtils.h"
#include "LocaleSetting.h"

#include "TextID.h"
#include "InstStrokeFillID.h"

enum EndnotePageScope {
 kAtEndOfStory = 0, 
 kAtEndOfSection, 
 kAtEndOfDocument, 
 kAtEndOfBook, 
};

class IEndnoteSettings : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IENDNOTESETTINGS };

 typedef enum { kContinuous, kRestartEveryStory, kUnknown } RestartNumberingOptions;

 typedef enum {kStory, kDocument} Scope;

 typedef enum {kPlacegun, kNewPage} Place;

 typedef enum { kPrefixSuffixNone, kPrefixSuffixReference, kPrefixSuffixMarker, kPrefixSuffixBoth } SuffixPrefixUsageOptions;

 typedef enum { kPositionNormal, kPositionSuperscript, kPositionSubscript, kPositionRuby } MarkerPositionOptions;

 virtual WideString GetTitle() const = 0;

 virtual void SetTitle(WideString title) = 0;

 virtual UID GetHeaderParaStyle() const = 0;

 virtual void SetHeaderParaStyle(UID styleID) = 0;

 virtual RestartNumberingOptions GetRestartOption() const = 0;
 virtual void SetRestartOption(RestartNumberingOptions option) = 0;

 virtual int32 GetStartingNumber() const = 0;
 virtual void SetStartingNumber(int32 n) = 0;

 virtual ClassID GetNumberingMethod() const = 0;
 virtual void SetNumberingMethod(ClassID whichMethod) = 0;

 virtual MarkerPositionOptions GetMarkerPositioning() const = 0;

 virtual void SetMarkerPositioning(MarkerPositionOptions option) = 0;

 virtual UID GetMarkerStyle() const = 0;

 virtual void SetMarkerStyle(UID styleID) = 0;

 virtual UID GetEndnoteParagraphStyle() const = 0;
 virtual void SetEndnoteParagraphStyle(UID s) = 0;

 virtual const WideString& GetEndnoteSeparator() const = 0;
 virtual void SetEndnoteSeparator(const WideString& sep) = 0;

 virtual Scope GetScope() const = 0;
 virtual void SetScope(Scope scope) = 0;

 virtual Place GetPlace() const = 0;
 virtual void SetPlace(Place place) = 0;

 virtual const WideString& GetMarkerPrefix() const = 0;
 virtual void SetMarkerPrefix(const WideString& pre) = 0;

 virtual const WideString& GetMarkerSuffix() const = 0;
 virtual void SetMarkerSuffix(const WideString& suf) = 0;

 virtual SuffixPrefixUsageOptions GetPrefixSuffixUsage() const = 0;
 virtual void SetPrefixSuffixUsage(SuffixPrefixUsageOptions option) = 0;

 virtual void CopyFrom(IEndnoteSettings* settings) = 0;

 virtual const UIDRef& GetDocument() = 0;

 virtual bool16 GetHasSettings() const = 0;

 struct EndnotePrefs {
 EndnotePrefs() {
 bool16 isCCJK = (LocaleSetting::GetLocale().GetLanguageFS() == kJapaneseLanguageFS);
 bool16 isCCKOnly = (isCCJK && (LocaleSetting::GetLocale().GetUserInterfaceId() == k_zhCN // simplified
 || LocaleSetting::GetLocale().GetUserInterfaceId() == k_zhTW // traditional
 || LocaleSetting::GetLocale().GetUserInterfaceId() == k_koKR)); // Korean

 PMString titleText("ES Title Text", PMString::kTranslateDuringCall);
 fTitle = WideString(titleText);
 fHeaderStyle = kInvalidUID;
 fNumberingMethod = kArabicFootnoteNumberingBoss;
 fStartingNumber = 1;
 fRestartOption = IEndnoteSettings::kContinuous; 
 fMarkerPositioning = (!isCCJK || isCCKOnly) ? IEndnoteSettings::kPositionSuperscript: IEndnoteSettings::kPositionRuby;
 fMarkerStyle = kInvalidUID;
 fEndnoteStyle = kInvalidUID;
 fSeparator = WideString("");
 fSeparator.Append(isCCJK ? kTextChar_IdeographicSpace : kTextChar_Tab);
 fScope = IEndnoteSettings::kDocument;
 fPlace = IEndnoteSettings::kNewPage;
 fPrefixSuffixUsage = IEndnoteSettings::kPrefixSuffixNone;
 fMarkerPrefix = WideString("");
 fMarkerSuffix = WideString("");
 }
 EndnotePrefs(const EndnotePrefs &other) {
 fTitle = other.fTitle;
 fHeaderStyle = other.fHeaderStyle;
 fNumberingMethod = other.fNumberingMethod;
 fStartingNumber = other.fStartingNumber;
 fRestartOption = other.fRestartOption;
 fMarkerPositioning = other.fMarkerPositioning;
 fMarkerStyle = other.fMarkerStyle;
 fEndnoteStyle = other.fEndnoteStyle;
 fSeparator = other.fSeparator;
 fScope = other.fScope;
 fPlace = other.fPlace;
 fPrefixSuffixUsage = other.fPrefixSuffixUsage;
 fMarkerPrefix = other.fMarkerPrefix;
 fMarkerSuffix = other.fMarkerSuffix;
 }
 EndnotePrefs(IEndnoteSettings * settings) {
 fTitle = settings->GetTitle();
 fHeaderStyle = settings->GetHeaderParaStyle();
 fNumberingMethod = settings->GetNumberingMethod();
 fStartingNumber = settings->GetStartingNumber();
 fRestartOption = settings->GetRestartOption();
 fMarkerPositioning = settings->GetMarkerPositioning();
 fMarkerStyle = settings->GetMarkerStyle();
 fEndnoteStyle = settings->GetEndnoteParagraphStyle();
 fSeparator = settings->GetEndnoteSeparator();
 fScope = settings->GetScope();
 fPlace = settings->GetPlace();
 fPrefixSuffixUsage = settings->GetPrefixSuffixUsage();
 fMarkerPrefix = settings->GetMarkerPrefix();
 fMarkerSuffix = settings->GetMarkerSuffix();
 }

 void InitializeStyles(IWorkspace* workspace)
 {
 // Para style - go find the "NormalParagraphStyle"
 InterfacePtr<IStyleGroupManager> paraStyleNameTable(workspace, IID_IPARASTYLEGROUPMANAGER);
 UID defaultStyleUID = paraStyleNameTable->FindByName("NormalParagraphStyle");
 if (defaultStyleUID == kInvalidUID)
 defaultStyleUID = paraStyleNameTable->GetDefaultStyleUID();

 fHeaderStyle = defaultStyleUID;
 fEndnoteStyle = defaultStyleUID;

 // Char style - get the default (root) style.
 InterfacePtr<IStyleGroupManager> charStyleNameTable(workspace, IID_ICHARSTYLEGROUPMANAGER);
 defaultStyleUID = charStyleNameTable->GetRootStyleUID();

 fMarkerStyle = defaultStyleUID;
 }

 WideString fTitle;
 UID fHeaderStyle; //Paragraph style
 ClassID fNumberingMethod;
 int32 fStartingNumber;
 IEndnoteSettings::RestartNumberingOptions fRestartOption;
 IEndnoteSettings::MarkerPositionOptions fMarkerPositioning;
 UID fMarkerStyle; //Character style
 UID fEndnoteStyle; //Paragraph style
 WideString fSeparator;
 IEndnoteSettings::Scope fScope;
 IEndnoteSettings::Place fPlace;
 IEndnoteSettings::SuffixPrefixUsageOptions fPrefixSuffixUsage;
 WideString fMarkerSuffix, fMarkerPrefix;
 };

 virtual void Set(const EndnotePrefs* prefs, const UIDRef& doc) = 0;
};

#endif // __ODFRC__

#endif
// __IEndnoteSettings__