IFootnoteFacade.h

//========================================================================================
// 
// $File$
// 
// Owner: David Stephens
// 
// $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 __IFootnoteFacade__
#define __IFootnoteFacade__

#include "IPMUnknown.h"

#include "IFootnoteOptionsSuite.h"

class IFootnoteFacade : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IFOOTNOTEFACADE };

 virtual IFootnoteSettings::MarkerPositionOptions GetMarkerPositioning(IFootnoteSettings* target) const = 0;
 virtual void SetMarkerPositioning(IFootnoteSettings* target, IFootnoteSettings::MarkerPositionOptions positioning) = 0;

 virtual IFootnoteSettings::RestartNumberingOptions GetRestartOption(IFootnoteSettings* target) const = 0;
 virtual void SetRestartOption(IFootnoteSettings* target, IFootnoteSettings::RestartNumberingOptions option) = 0;

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

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

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

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

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

 virtual UID GetFootnoteMarkerStyle(IFootnoteSettings* target) const = 0;
 virtual void SetFootnoteMarkerStyle(IFootnoteSettings* target, UID s) = 0;

 virtual UID GetFootnoteParagraphStyle(IFootnoteSettings* target) const = 0;
 virtual void SetFootnoteParagraphStyle(IFootnoteSettings* target, UID s) = 0;

 virtual const WideString& GetFootnoteSeparator(IFootnoteSettings* target) const = 0;
 virtual void SetFootnoteSeparator(IFootnoteSettings* target, const WideString& sep) = 0;

 // The space between footnote parcels
 virtual PMReal GetSpaceBetween(IFootnoteSettings* target) const = 0;
 virtual void SetSpaceBetween(IFootnoteSettings* target, PMReal g) = 0;

 virtual PMReal GetSpacerHeight(IFootnoteSettings* target) const = 0;
 virtual void SetSpacerHeight(IFootnoteSettings* target, PMReal g) = 0;

 virtual Text::FirstLineOffsetMetric GetFirstLineOffset(IFootnoteSettings* target) const = 0;
 virtual void SetFirstLineOffset(IFootnoteSettings* target, Text::FirstLineOffsetMetric flo) = 0;

 virtual PMReal GetMinFirstLineOffset(IFootnoteSettings* target) const = 0;
 virtual void SetMinFirstLineOffset(IFootnoteSettings* target, PMReal g) = 0;

 virtual bool16 GetEndOfStoryPlacement(IFootnoteSettings* target) const = 0;
 virtual void SetEndOfStoryPlacement(IFootnoteSettings* target, bool16 b) = 0;

 virtual bool16 GetNoSplitting(IFootnoteSettings* target) const = 0;
 virtual void SetNoSplitting(IFootnoteSettings* target, bool16 b) = 0;

 virtual bool16 GetStraddlingInfo(IFootnoteSettings* target) const = 0;
 virtual void SetStraddlingInfo(IFootnoteSettings* target, bool16 b) = 0;

 virtual bool16 GetSeparatorLineOn(IFootnoteSettings* target, IFootnoteSettings::FootnoteRuleKind k) const = 0;
 virtual void SetSeparatorLineOn(IFootnoteSettings* target, IFootnoteSettings::FootnoteRuleKind k, bool16 b) = 0;

 virtual PMReal GetWeightStroke(IFootnoteSettings* target, IFootnoteSettings::FootnoteRuleKind k) const = 0;
 virtual void SetWeightStroke(IFootnoteSettings* target, IFootnoteSettings::FootnoteRuleKind k, PMReal g) = 0;

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

 virtual PMReal GetIndentLeft(IFootnoteSettings* target, IFootnoteSettings::FootnoteRuleKind k) const = 0;
 virtual void SetIndentLeft(IFootnoteSettings* target, IFootnoteSettings::FootnoteRuleKind k, PMReal g) = 0;

 virtual PMReal GetWidth(IFootnoteSettings* target, IFootnoteSettings::FootnoteRuleKind k) const = 0;
 virtual void SetWidth(IFootnoteSettings* target, IFootnoteSettings::FootnoteRuleKind k, PMReal g) = 0;

 virtual PMReal GetOffset(IFootnoteSettings* target, IFootnoteSettings::FootnoteRuleKind k) const = 0;
 virtual void SetOffset(IFootnoteSettings* target, IFootnoteSettings::FootnoteRuleKind k, PMReal g) = 0;

 virtual UID GetColorStroke(IFootnoteSettings* target, IFootnoteSettings::FootnoteRuleKind k) const = 0;
 virtual void SetColorStroke(IFootnoteSettings* target, IFootnoteSettings::FootnoteRuleKind k, UID s) = 0;

 virtual PMReal GetTintStroke(IFootnoteSettings* target, IFootnoteSettings::FootnoteRuleKind k) const = 0;
 virtual void SetTintStroke(IFootnoteSettings* target, IFootnoteSettings::FootnoteRuleKind k, PMReal g) = 0;

 virtual bool16 GetOverprintStroke(IFootnoteSettings* target, IFootnoteSettings::FootnoteRuleKind k) const = 0;
 virtual void SetOverprintStroke(IFootnoteSettings* target, IFootnoteSettings::FootnoteRuleKind k, bool16 b) = 0;

 virtual UID GetColorGap(IFootnoteSettings* target, IFootnoteSettings::FootnoteRuleKind k) const = 0;
 virtual void SetColorGap(IFootnoteSettings* target, IFootnoteSettings::FootnoteRuleKind k, UID s) = 0;

 virtual PMReal GetTintGap(IFootnoteSettings* target, IFootnoteSettings::FootnoteRuleKind k) const = 0;
 virtual void SetTintGap(IFootnoteSettings* target, IFootnoteSettings::FootnoteRuleKind k, PMReal g) = 0;

 virtual bool16 GetOverprintGap(IFootnoteSettings* target, IFootnoteSettings::FootnoteRuleKind k) const = 0;
 virtual void SetOverprintGap(IFootnoteSettings* target, IFootnoteSettings::FootnoteRuleKind k, bool16 b) = 0;

 virtual void SetAllSettings(IFootnoteSettings* target, const IFootnoteSettingsCmdData::FootnotePrefs* settings,
 const IFootnoteSettingsCmdData::FootnoteLinePrefs* separator,
 const IFootnoteSettingsCmdData::FootnoteLinePrefs* continuing) = 0;
};

#endif // __IFootnoteFacade__