IGalleySettings Class Reference

#include <IGalleySettings.h>

Inheritance diagram for IGalleySettings:

Public Types
enum	{ kDefaultIID = IID_IGALLEYSETTINGS }
enum	CursorType { kNormalCursor = 0, kThickCursor, kBarbellCursor, kBlockCursor }
enum	OversetDisplayType {   kNone = 0, kDividerColor, kDividerBackground, kColorOnly,   kBackgroundOnly, kMarginIndicator }
enum	TextAntiAliasType { kStandardGrayDDR = 0, kColorDDR, kPreview }

Public Member Functions
virtual bool16	GetSmoothText () const =0
virtual void	SetSmoothText (bool16 smoothText)=0
virtual bool16	GetShowParagraphStyleNames ()=0
virtual void	SetShowParagraphStyleNames (bool16 showStyleNames)=0
virtual bool16	GetShowParagraphBreakMarks ()=0
virtual void	SetShowParagraphBreakMarks (bool16 showBreakMarks)=0
virtual PMReal	GetParagraphIndentMultiplier ()=0
virtual void	SetParagraphIndentMultiplier (const PMReal indentMultiplier)=0
virtual bool16	GetShowLineNumbers ()=0
virtual void	SetShowLineNumbers (bool16 showLineNumbers)=0
virtual bool16	GetIsGalleyAle ()=0
virtual void	SetGalleyAle (bool16 isAle)=0
virtual RealAGMColor &	GetTextColor ()=0
virtual void	SetTextColor (RealAGMColor &color)=0
virtual RealAGMColor &	GetBackgroundColor ()=0
virtual void	SetBackgroundColor (RealAGMColor &color)=0
virtual PMReal	GetLeadingValue () const =0
virtual void	SetLeadingValue (PMReal leadingValue)=0
virtual int32	GetOverrideCount ()=0
virtual const PMString &	GetNthFontOverrideName (int32 n)=0
virtual void	SetNthFontOverrideName (int32 n, const PMString &name)=0
virtual void	DeleteNthFontOverrideName (int32 n)=0
virtual void	AppendFontOverrideName (const PMString &name)=0
virtual bool16	IsAnOverrideFont (PMString fontFamilyName, IPMFont *font=nil)=0
virtual IGalleySettings::CursorType	GetCursorType ()=0
virtual void	SetCursorType (CursorType type)=0
virtual PMString	GetDisplayFont ()=0
virtual void	SetDisplayFont (PMString displayFont)=0
virtual bool16	GetBlinkCursor ()=0
virtual void	SetBlinkCursor (bool16 blinkOn)=0
virtual void	SetUseUserFontOverride (bool16 useUserOverride)=0
virtual bool16	GetUseUserFontOverride ()=0
virtual void	SetDisplayFontSize (const PMReal &fontSize)=0
virtual PMReal	GetDisplayFontSize ()=0
virtual void	SetUseDisplayFont (bool16 useDisplayFont)=0
virtual bool16	GetUseDisplayFont ()=0
virtual void	SetInfoColumnWidth (PMReal width)=0
virtual PMReal	GetInfoColumnWidth ()=0
virtual void	SetInfoColumnHidden (bool16 hidden)=0
virtual bool16	GetInfoColumnHidden ()=0
virtual void	SetOversetDisplayType (OversetDisplayType oversetType)=0
virtual OversetDisplayType	GetOversetDisplayType ()=0
virtual void	SetOversetBackgroundColor (const RealAGMColor &color)=0
virtual RealAGMColor	GetOversetBackgroundColor ()=0
virtual void	SetShowDepthRuler (bool16 showRuler)=0
virtual bool16	GetShowDepthRuler ()=0
virtual void	SetTextAntiAliasStyle (TextAntiAliasType aliasType)=0
virtual TextAntiAliasType	GetTextAntiAliasStyle ()=0
virtual void	SetShowFootnotes (bool16 showFootnotes)=0
virtual bool16	GetShowFootnotes ()=0
virtual void	SetFootnoteDisplayColor (const RealAGMColor &color)=0
virtual RealAGMColor &	GetFootnoteDisplayColor ()=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

Setters and Getters for the various Galley properties

Member Enumeration Documentation

enum IGalleySettings::CursorType

The type of cursor that should be shown in the galley

Enumerator
kNormalCursor	Use a normal thin straight line
kThickCursor	Use a thick straight line
kBarbellCursor	typical i-beam insertion point
kBlockCursor	Insertion point is a block that covers the current letter

enum IGalleySettings::OversetDisplayType

Enumerator
kNone	Overset text is display just like any other text in the story
kDividerColor	A divider precedes the overset text and the text itself is displayed in a different color
kDividerBackground	A divider precedes the overset text and the text background is displayed in a different color
kColorOnly	No divider but the overset text is displayed in a different color
kBackgroundOnly	No divider but the overset background is display in a different color
kMarginIndicator	No divider a vertical bar is drawn on the side and a stair step line is draw though point where overset begins

enum IGalleySettings::TextAntiAliasType

Used to describe the style of view antialiasing to use in the story and galley views

Enumerator
kStandardGrayDDR	Default type is grayddr same as layout
kColorDDR	ColorDDR use shades of color rather than shades of grey to anti-alias
kPreview	use preview mode

Member Function Documentation

virtual void IGalleySettings::AppendFontOverrideName ( const PMString &  name )

pure virtual

Add a font override to the list

Parameters

&name

- The name to append

virtual void IGalleySettings::DeleteNthFontOverrideName ( int32  n )

pure virtual

Remove a font from the list of overrides

Parameters

n	- The font to remove from the list

virtual RealAGMColor& IGalleySettings::GetBackgroundColor ( )

pure virtual

Get the color for the galley background

Returns

- The color to use for the galley background

virtual bool16 IGalleySettings::GetBlinkCursor ( )

pure virtual

Get whether text cursor should blink or not

Returns

- whether text cursor should blink or not

virtual IGalleySettings::CursorType IGalleySettings::GetCursorType ( )

pure virtual

Get the cursor type to use for this galley view

Returns

- The type of the cursor to use

virtual PMString IGalleySettings::GetDisplayFont ( )

pure virtual

Get the display font preference to use for this galley view

Returns

- The display font to use

virtual PMReal IGalleySettings::GetDisplayFontSize ( )

pure virtual

Get the font size to use for this galley view

Returns

- The font size to use

virtual RealAGMColor& IGalleySettings::GetFootnoteDisplayColor ( )

pure virtual

Get the color to display the bookends for footnotes

Returns

color the footnote bookends are being displayed in.

virtual bool16 IGalleySettings::GetInfoColumnHidden ( )

pure virtual

Get the hidden state of the info column. Only used in InCopy.

Returns

- Is the info column hidden or visible

virtual PMReal IGalleySettings::GetInfoColumnWidth ( )

pure virtual

Get the width preference for the info column

Returns

- The width preference for the info column

virtual bool16 IGalleySettings::GetIsGalleyAle ( )

pure virtual

Is the galley ALE (accurate line endings) or ILE (inaccurate line ending)

Returns

- kTrue == Using ALE

virtual PMReal IGalleySettings::GetLeadingValue ( ) const

pure virtual

Get the amount of leading to use for the text

Returns

- Value to use for the leading

virtual const PMString& IGalleySettings::GetNthFontOverrideName ( int32  n )

pure virtual

Get the name of a particular font override

Parameters

n	- The item in the list that you want the name of

Returns

- The name of the selected font

virtual int32 IGalleySettings::GetOverrideCount ( )

pure virtual

List of Font Overrides (font that display in their true type instead of as the galley display font)Get the override count

Returns

- Number of overrides

virtual RealAGMColor IGalleySettings::GetOversetBackgroundColor ( )

pure virtual

Get the background color of overset text.

Parameters

color

value of background overset text.

virtual OversetDisplayType IGalleySettings::GetOversetDisplayType ( )

pure virtual

Get the value setting for the way overset text is display in story view.

Parameters

oversetType

see enum values.

virtual PMReal IGalleySettings::GetParagraphIndentMultiplier ( )

pure virtual

Get the paragraph indent multiplier

Returns

- Value for the paragraph indent multiplier

See Also

SetParagraphIndentMultiplier

virtual bool16 IGalleySettings::GetShowDepthRuler ( )

pure virtual

Get the show state of the depth ruler.

Returns

kTrue if the ruler is shown otherwise it's hidden

virtual bool16 IGalleySettings::GetShowFootnotes ( )

pure virtual

Get the show state footnotes in galley and story view.

Returns

kTrue if the ruler is shown otherwise it's hidden

virtual bool16 IGalleySettings::GetShowLineNumbers ( )

pure virtual

Should we show line numbers or not

Returns

- kTrue == Show the line numbers

virtual bool16 IGalleySettings::GetShowParagraphBreakMarks ( )

pure virtual

Should we show paragraph break marks or not

Returns

- kTrue == Show the paragraph break marks

virtual bool16 IGalleySettings::GetShowParagraphStyleNames ( )

pure virtual

Should we show paragraph style names or not

Returns

- kTrue == Show the style names

virtual bool16 IGalleySettings::GetSmoothText ( ) const

pure virtual

Should the text be drawn antialiased

Returns

- kTrue == Draw the text antialias

virtual TextAntiAliasType IGalleySettings::GetTextAntiAliasStyle ( )

pure virtual

Get style of text anti-aliasing used to render text.

Returns

style of anti-aliasing being used

virtual RealAGMColor& IGalleySettings::GetTextColor ( )

pure virtual

Get the color to show the galley text in

Returns

- The color to show the text in

virtual bool16 IGalleySettings::GetUseDisplayFont ( )

pure virtual

Get the whether or not to use the display font for this galley view.

Returns

- The use the display font or not

virtual bool16 IGalleySettings::GetUseUserFontOverride ( )

pure virtual

Get whether the user font display font override setting will do anything in galley. Note that the hard coded overrides will always apply no matter what the setting.

Returns

- Use the override or not

virtual bool16 IGalleySettings::IsAnOverrideFont ( PMString  fontFamilyName, IPMFont *  font = nil  )

pure virtual

Is a given font in the override list

Parameters

fontFamilyName	- The family name of the font you are checking for
*font	- The font you are looking for

Returns

- kTrue means that the font was in the list and is overridden

virtual void IGalleySettings::SetBackgroundColor ( RealAGMColor &  color )

pure virtual

Set the color for the galley background

Parameters

color

- The background color to show in the galley

virtual void IGalleySettings::SetBlinkCursor ( bool16  blinkOn )

pure virtual

Set whether text cursor should blink or not

Parameters

blinkOn

- whether text cursor should blink or not

virtual void IGalleySettings::SetCursorType ( CursorType  type )

pure virtual

Set the cursor type to use for this galley view

Parameters

type	- The type of the cursor to use

virtual void IGalleySettings::SetDisplayFont ( PMString  displayFont )

pure virtual

Set the display font preference to use for this galley view

Parameters

displayFont

- The display font preference to use

virtual void IGalleySettings::SetDisplayFontSize ( const PMReal &  fontSize )

pure virtual

Set the font size to use for this galley view

Parameters

&fontsize

- The font size to use

virtual void IGalleySettings::SetFootnoteDisplayColor ( const RealAGMColor &  color )

pure virtual

Set the color to display the bookends for footnotes

Parameters

color

- color to display the footnotes in

virtual void IGalleySettings::SetGalleyAle ( bool16  isAle )

pure virtual

Set whether galley is ALE (accurate line endings) or ILE (inaccurate line ending)

Parameters

isAle

- kTrue will use ALE

virtual void IGalleySettings::SetInfoColumnHidden ( bool16  hidden )

pure virtual

Set the hidden state of the info column. Only used in InCopy.

Parameters

hidden

- Is the info column hidden or visible

virtual void IGalleySettings::SetInfoColumnWidth ( PMReal  width )

pure virtual

Set the width preference for the info column

Parameters

width

- The width preference for the info column

virtual void IGalleySettings::SetLeadingValue ( PMReal  leadingValue )

pure virtual

Set the amount of leading to use for the text

Parameters

leadingValue

- Value to use for the leading

virtual void IGalleySettings::SetNthFontOverrideName ( int32  n, const PMString &  name  )

pure virtual

Set the name of a particular font override

Parameters

n	- The item in the list that you want to set the name of
&name	- The name of the selected font

virtual void IGalleySettings::SetOversetBackgroundColor ( const RealAGMColor &  color )

pure virtual

Set the color of the background for overset text.

Parameters

color

value to display overset text background

virtual void IGalleySettings::SetOversetDisplayType ( OversetDisplayType  oversetType )

pure virtual

Allows control of the way overset text is display in the story view.

Parameters

oversetType

see enum values.

virtual void IGalleySettings::SetParagraphIndentMultiplier ( const PMReal  indentMultiplier )

pure virtual

Allow control of the distance that paragraphs are indented. A value of 1.0 for the multiplier will give an indent of 1X the width of the paragraph glyph (kTextChar_PilchrowSign) at the currently selected display font size. Using the font for show invisible characters ("AdobeSansMM"). 2.0 is 2X, 2.1 is 2.1X etc... Negative numbers while allowed are not tested.

Parameters

indentMultiplier

- Value for the paragraph indent multiplier

virtual void IGalleySettings::SetShowDepthRuler ( bool16  showRuler )

pure virtual

Set the show state of the depth ruler.

Parameters

hidden

- kTrue the the ruler will be shown

Returns

none

virtual void IGalleySettings::SetShowFootnotes ( bool16  showFootnotes )

pure virtual

Set the show state of footnotes in galley and story view.

Parameters

show	- kTrue to show footnotes

virtual void IGalleySettings::SetShowLineNumbers ( bool16  showLineNumbers )

pure virtual

Set whether or not to show line numbers

Parameters

showLineNumbers

- kTrue will Show the line numbers

virtual void IGalleySettings::SetShowParagraphBreakMarks ( bool16  showBreakMarks )

pure virtual

Set whether or not to show paragraph break marks

Parameters

showBreakMarks

- kTrue will Show the paragraph break marks

virtual void IGalleySettings::SetShowParagraphStyleNames ( bool16  showStyleNames )

pure virtual

Set whether or not to show paragraph style names

Parameters

showStyleNames

- kTrue will Show the style names

virtual void IGalleySettings::SetSmoothText ( bool16  smoothText )

pure virtual

Set whether or not the text shoudl be antialiased

Parameters

smoothText

- kTrue will draw the text antialiased

virtual void IGalleySettings::SetTextAntiAliasStyle ( TextAntiAliasType  aliasType )

pure virtual

Set style of text anti-aliasing to use for galley/story text.

Parameters

aliasType

- type of anti-alias to use

Returns

none

virtual void IGalleySettings::SetTextColor ( RealAGMColor &  color )

pure virtual

Set color to show the galley text in

Parameters

color

- The text color to show the text in

virtual void IGalleySettings::SetUseDisplayFont ( bool16  useDisplayFont )

pure virtual

Set the whether or not to use the display font for this galley view. Not persistant right now but can be set on a session basis. This can be used to cause the story/galley views to use the actual text model font to display text rather than the display font. Currently, this is not part of the regular product (ie. we always display text in the display font except for exceptions stored in the override font list.

Parameters

useDisplayFont

- The use the display font or not

virtual void IGalleySettings::SetUseUserFontOverride ( bool16  useUserOverride )

pure virtual

Set whether the user font display font override setting will do anything in galley. Note that the hard coded overrides will always apply no matter what the setting.

Parameters

useUserOverride

- Use the override or not