IFootnoteSettings.h

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

#ifndef __IFootnoteSettings__
#define __IFootnoteSettings__

#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"

class PMString;

class IFootnoteSettings : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IFOOTNOTESETTINGS };

 typedef enum { kDontRestart, kPageRestart, kSpreadRestart, kSectionRestart, kUnknown } RestartNumberingOptions;

 typedef enum { kNew, kContinuing } FootnoteRuleKind;

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

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

 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 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 options) = 0;

 virtual UID GetFootnoteMarkerStyle() const = 0;
 virtual void SetFootnoteMarkerStyle(UID s) = 0;

 virtual MarkerPositionOptions GetMarkerPositioning() const = 0;
 virtual void SetMarkerPositioning(MarkerPositionOptions positioning) = 0;

 virtual UID GetFootnoteParagraphStyle() const = 0;
 virtual void SetFootnoteParagraphStyle(UID s) = 0;

 virtual const WideString& GetFootnoteSeparator() const = 0;
 virtual void SetFootnoteSeparator(const WideString& sep) = 0;

 virtual PMReal GetSpaceBetween() const = 0;
 virtual void SetSpaceBetween(PMReal g) = 0;

 virtual PMReal GetSpacerHeight() const = 0;
 virtual void SetSpacerHeight(PMReal g) = 0;

 virtual Text::FirstLineOffsetMetric GetFirstLineOffset() const = 0;
 virtual void SetFirstLineOffset(Text::FirstLineOffsetMetric flo) = 0;

 virtual PMReal GetMinFirstLineOffset() const = 0;
 virtual void SetMinFirstLineOffset(PMReal g) = 0;

 virtual bool16 GetEndOfStoryPlacement() const = 0;
 virtual void SetEndOfStoryPlacement(bool16 b) = 0;

 virtual bool16 GetNoSplitting() const = 0;
 virtual void SetNoSplitting(bool16 b) = 0;

 virtual bool16 GetStraddlingInfo() const = 0;
 virtual void SetStraddlingInfo(bool16 b) = 0;

 virtual bool16 GetSeparatorLineOn(FootnoteRuleKind k) const = 0;
 virtual void SetSeparatorLineOn(FootnoteRuleKind k, bool16 b) = 0;

 virtual PMReal GetWeightStroke(FootnoteRuleKind k) const = 0;
 virtual void SetWeightStroke(FootnoteRuleKind k, PMReal g) = 0;

 virtual ICompositionStyle::StrokeType GetStrokeType(FootnoteRuleKind k) const = 0;
 virtual void SetStrokeType(FootnoteRuleKind k, ICompositionStyle::StrokeType s) = 0;

 virtual PMReal GetIndentLeft(FootnoteRuleKind k) const = 0;
 virtual void SetIndentLeft(FootnoteRuleKind k, PMReal g) = 0;

 virtual PMReal GetWidth(FootnoteRuleKind k) const = 0;
 virtual void SetWidth(FootnoteRuleKind k, PMReal g) = 0;

 virtual PMReal GetOffset(FootnoteRuleKind k) const = 0;
 virtual void SetOffset(FootnoteRuleKind k, PMReal g) = 0;

 virtual UID GetColorStroke(FootnoteRuleKind k) const = 0;
 virtual void SetColorStroke(FootnoteRuleKind k, UID s) = 0;

 virtual PMReal GetTintStroke(FootnoteRuleKind k) const = 0;
 virtual void SetTintStroke(FootnoteRuleKind k, PMReal g) = 0;

 virtual bool16 GetOverprintStroke(FootnoteRuleKind k) const = 0;
 virtual void SetOverprintStroke(FootnoteRuleKind k, bool16 b) = 0;

 virtual UID GetColorGap(FootnoteRuleKind k) const = 0;
 virtual void SetColorGap(FootnoteRuleKind k, UID s) = 0;

 virtual PMReal GetTintGap(FootnoteRuleKind k) const = 0;
 virtual void SetTintGap(FootnoteRuleKind k, PMReal g) = 0;

 virtual bool16 GetOverprintGap(FootnoteRuleKind k) const = 0;
 virtual void SetOverprintGap(FootnoteRuleKind k, bool16 b) = 0;
};
#endif // __ODFRC__

#endif
 // __IFootnoteSettings__