IFootnoteSettingsCmdData Class Reference

#include <IFootnoteSettingsCmdData.h>

Inheritance diagram for IFootnoteSettingsCmdData:

Classes
struct	FootnoteLinePrefs
struct	FootnotePrefs

Public Types
enum	{ kDefaultIID = IID_IFOOTNOTESETTINGSCMDDATA }

Public Member Functions
virtual void	GetWhichSettings (bool16 *settings, bool16 *separator, bool16 *continuing) const =0
virtual IFootnoteSettings::MarkerPositionOptions	GetMarkerPositioning () const =0
virtual IFootnoteSettings::SuffixPrefixUsageOptions	GetPrefixSuffixUsage () const =0
virtual IFootnoteSettings::RestartNumberingOptions	GetRestartOption () const =0
virtual int32	GetStartingNumber () const =0
virtual ClassID	GetNumberingMethod () const =0
virtual UID	GetFootnoteMarkerStyle () const =0
virtual UID	GetFootnoteParagraphStyle () const =0
virtual PMReal	GetSpaceBetween () const =0
virtual PMReal	GetSpacerHeight () const =0
virtual Text::FirstLineOffsetMetric	GetFirstLineOffset () const =0
virtual PMReal	GetMinFirstLineOffset () const =0
virtual bool16	GetEndOfStoryPlacement () const =0
virtual bool16	GetNoSplitting () const =0
virtual const WideString &	GetMarkerPrefix () const =0
virtual const WideString &	GetMarkerSuffix () const =0
virtual const WideString &	GetFootnoteSeparator () const =0
virtual bool16	GetSeparatorLineOn (IFootnoteSettings::FootnoteRuleKind k) const =0
virtual PMReal	GetWeightStroke (IFootnoteSettings::FootnoteRuleKind k) const =0
virtual ICompositionStyle::StrokeType	GetStrokeType (IFootnoteSettings::FootnoteRuleKind k) const =0
virtual PMReal	GetIndentLeft (IFootnoteSettings::FootnoteRuleKind k) const =0
virtual PMReal	GetWidth (IFootnoteSettings::FootnoteRuleKind k) const =0
virtual PMReal	GetOffset (IFootnoteSettings::FootnoteRuleKind k) const =0
virtual UID	GetColorStroke (IFootnoteSettings::FootnoteRuleKind k) const =0
virtual PMReal	GetTintStroke (IFootnoteSettings::FootnoteRuleKind k) const =0
virtual bool16	GetOverprintStroke (IFootnoteSettings::FootnoteRuleKind k) const =0
virtual UID	GetColorGap (IFootnoteSettings::FootnoteRuleKind k) const =0
virtual PMReal	GetTintGap (IFootnoteSettings::FootnoteRuleKind k) const =0
virtual bool16	GetOverprintGap (IFootnoteSettings::FootnoteRuleKind k) const =0
virtual const UIDRef &	GetDocument ()=0
virtual bool16	GetStraddlingInfo () const =0
virtual void	Set (const IFootnoteSettingsCmdData::FootnotePrefs *settings, const IFootnoteSettingsCmdData::FootnoteLinePrefs *separator, const IFootnoteSettingsCmdData::FootnoteLinePrefs *continuing, const UIDRef &doc)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Note

See IFootnoteSettings for descriptions of some of these methods as this is a mirror interface to a lot of that.

Member Function Documentation

virtual UID IFootnoteSettingsCmdData::GetColorGap ( IFootnoteSettings::FootnoteRuleKind  k ) const

pure virtual

See IFootnoteSettings

virtual UID IFootnoteSettingsCmdData::GetColorStroke ( IFootnoteSettings::FootnoteRuleKind  k ) const

pure virtual

See IFootnoteSettings

virtual const UIDRef& IFootnoteSettingsCmdData::GetDocument ( )

pure virtual

Get the document associated to these changes (i.e. the document of the selection). Returns nil, if no document.

virtual bool16 IFootnoteSettingsCmdData::GetEndOfStoryPlacement ( ) const

pure virtual

See IFootnoteSettings

virtual Text::FirstLineOffsetMetric IFootnoteSettingsCmdData::GetFirstLineOffset ( ) const

pure virtual

See IFootnoteSettings

virtual UID IFootnoteSettingsCmdData::GetFootnoteMarkerStyle ( ) const

pure virtual

See IFootnoteSettings

virtual UID IFootnoteSettingsCmdData::GetFootnoteParagraphStyle ( ) const

pure virtual

See IFootnoteSettings

virtual const WideString& IFootnoteSettingsCmdData::GetFootnoteSeparator ( ) const

pure virtual

See IFootnoteSettings

virtual PMReal IFootnoteSettingsCmdData::GetIndentLeft ( IFootnoteSettings::FootnoteRuleKind  k ) const

pure virtual

See IFootnoteSettings

virtual IFootnoteSettings::MarkerPositionOptions IFootnoteSettingsCmdData::GetMarkerPositioning ( ) const

pure virtual

See IFootnoteSettings

virtual const WideString& IFootnoteSettingsCmdData::GetMarkerPrefix ( ) const

pure virtual

See IFootnoteSettings

virtual const WideString& IFootnoteSettingsCmdData::GetMarkerSuffix ( ) const

pure virtual

See IFootnoteSettings

virtual PMReal IFootnoteSettingsCmdData::GetMinFirstLineOffset ( ) const

pure virtual

See IFootnoteSettings

virtual bool16 IFootnoteSettingsCmdData::GetNoSplitting ( ) const

pure virtual

See IFootnoteSettings

virtual ClassID IFootnoteSettingsCmdData::GetNumberingMethod ( ) const

pure virtual

See IFootnoteSettings

virtual PMReal IFootnoteSettingsCmdData::GetOffset ( IFootnoteSettings::FootnoteRuleKind  k ) const

pure virtual

See IFootnoteSettings

virtual bool16 IFootnoteSettingsCmdData::GetOverprintGap ( IFootnoteSettings::FootnoteRuleKind  k ) const

pure virtual

See IFootnoteSettings

virtual bool16 IFootnoteSettingsCmdData::GetOverprintStroke ( IFootnoteSettings::FootnoteRuleKind  k ) const

pure virtual

See IFootnoteSettings

virtual IFootnoteSettings::SuffixPrefixUsageOptions IFootnoteSettingsCmdData::GetPrefixSuffixUsage ( ) const

pure virtual

See IFootnoteSettings

virtual IFootnoteSettings::RestartNumberingOptions IFootnoteSettingsCmdData::GetRestartOption ( ) const

pure virtual

See IFootnoteSettings

virtual bool16 IFootnoteSettingsCmdData::GetSeparatorLineOn ( IFootnoteSettings::FootnoteRuleKind  k ) const

pure virtual

See IFootnoteSettings

virtual PMReal IFootnoteSettingsCmdData::GetSpaceBetween ( ) const

pure virtual

See IFootnoteSettings

virtual PMReal IFootnoteSettingsCmdData::GetSpacerHeight ( ) const

pure virtual

See IFootnoteSettings

virtual int32 IFootnoteSettingsCmdData::GetStartingNumber ( ) const

pure virtual

See IFootnoteSettings

virtual bool16 IFootnoteSettingsCmdData::GetStraddlingInfo ( ) const

pure virtual

Get the straddling information associated with the document

virtual ICompositionStyle::StrokeType IFootnoteSettingsCmdData::GetStrokeType ( IFootnoteSettings::FootnoteRuleKind  k ) const

pure virtual

See IFootnoteSettings

virtual PMReal IFootnoteSettingsCmdData::GetTintGap ( IFootnoteSettings::FootnoteRuleKind  k ) const

pure virtual

See IFootnoteSettings

virtual PMReal IFootnoteSettingsCmdData::GetTintStroke ( IFootnoteSettings::FootnoteRuleKind  k ) const

pure virtual

See IFootnoteSettings

virtual PMReal IFootnoteSettingsCmdData::GetWeightStroke ( IFootnoteSettings::FootnoteRuleKind  k ) const

pure virtual

See IFootnoteSettings

virtual void IFootnoteSettingsCmdData::GetWhichSettings ( bool16 *  settings, bool16 *  separator, bool16 *  continuing  ) const

pure virtual

Return which sets of settings have been changed.

virtual PMReal IFootnoteSettingsCmdData::GetWidth ( IFootnoteSettings::FootnoteRuleKind  k ) const

pure virtual

See IFootnoteSettings

virtual void IFootnoteSettingsCmdData::Set ( const IFootnoteSettingsCmdData::FootnotePrefs *  settings, const IFootnoteSettingsCmdData::FootnoteLinePrefs *  separator, const IFootnoteSettingsCmdData::FootnoteLinePrefs *  continuing, const UIDRef &  doc  )

pure virtual

Initialize the data.

Note

Any of the settings parameters can be nil. Non-nil settings will have all the individual settings changed.