IVerticalColumnRuleData Class Reference

Inheritance diagram for IVerticalColumnRuleData:

Public Types
enum	{ kDefaultIID = IID_IVERTICALCOLUMNRULEDATA }
enum	VerticalRuleHeightMode { kFlag_VerticalRuleHeightDefault = 0, kFlag_VerticalRuleHeightAscToDesc, kFlag_VerticalRuleHeightEmBoxToEmBox }

Public Member Functions
virtual bool16	GetUseVerticalRule () const =0
virtual void	SetUseVerticalRule (bool16 useVerticalRule)=0
virtual PMReal	GetVerticalRuleOffset () const =0
virtual void	SetVerticalRuleOffset (PMReal offset)=0
virtual PMReal	GetVerticalRuleTopInset () const =0
virtual void	SetVerticalRuleTopInset (PMReal inset)=0
virtual bool16	GetVerticalRuleInsetChain () const =0
virtual void	SetVerticalRuleInsetChain (bool16 isChained)=0
virtual PMReal	GetVerticalRuleBottomInset () const =0
virtual void	SetVerticalRuleBottomInset (PMReal inset)=0
virtual PMReal	GetVerticalRuleStrokeWidth () const =0
virtual void	SetVerticalRuleStrokeWidth (PMReal width)=0
virtual UID	GetVerticalRuleStrokeColor () const =0
virtual void	SetVerticalRuleStrokeColor (UID colorUID)=0
virtual ICompositionStyle::StrokeType	GetVerticalRuleStrokeType () const =0
virtual void	SetVerticalRuleStrokeType (ICompositionStyle::StrokeType strokeType)=0
virtual PMReal	GetVerticalRuleTint () const =0
virtual void	SetVerticalRuleTint (PMReal tint)=0
virtual bool16	GetVerticalRuleOverprint () const =0
virtual void	SetVerticalRuleOverprint (bool16 isOverprint)=0
virtual VerticalRuleHeightMode	GetVerticalRuleHeightMode () const =0
virtual void	SetVerticalRuleHeightMode ()=0
virtual void	CopyFrom (const IVerticalColumnRuleData *verticalColumnRuleData)=0
virtual void	CopyFrom (const ITextFrameOptionsData *tfoData)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Member Enumeration Documentation

enum IVerticalColumnRuleData::VerticalRuleHeightMode

VerticalRuleHeightMode defines height mode of vertical rules for different locales. For Roman locales: kFlag_VerticalRuleHeightAscToDesc For Japanese locales: kFlag_VerticalRuleHeightEmBoxToEmBox

Member Function Documentation

virtual void IVerticalColumnRuleData::CopyFrom ( const IVerticalColumnRuleData *  verticalColumnRuleData )

pure virtual

CopyFrom copies from the source to this IVerticalColumnRuleData.

Parameters

source

IN The IVerticalColumnRuleData to copy.

virtual void IVerticalColumnRuleData::CopyFrom ( const ITextFrameOptionsData *  tfoData )

pure virtual

CopyFrom copies from the ITextFrameOptionsData to this IVerticalColumnRuleData.

Parameters

source

IN The ITextFrameOptionsData to copy.

virtual bool16 IVerticalColumnRuleData::GetUseVerticalRule ( ) const

pure virtual

Get is vertical rule applied on multi column frame flag

Returns

bool16

virtual PMReal IVerticalColumnRuleData::GetVerticalRuleBottomInset ( ) const

pure virtual

Get the vertical rule Bottom inset of multi column frame

Returns

PMReal bottom inset

virtual VerticalRuleHeightMode IVerticalColumnRuleData::GetVerticalRuleHeightMode ( ) const

pure virtual

Get the Vertical rule height mode of multi column frame

Returns

VerticalRuleHeightMode

virtual bool16 IVerticalColumnRuleData::GetVerticalRuleInsetChain ( ) const

pure virtual

Get the vertical rule inset chain of multi column frame

Returns

kTrue if inset chain is on otherwise kFalse

virtual PMReal IVerticalColumnRuleData::GetVerticalRuleOffset ( ) const

pure virtual

Get the Vertical rule offset of multi column frame

Returns

offset value

virtual bool16 IVerticalColumnRuleData::GetVerticalRuleOverprint ( ) const

pure virtual

Get the vertical rule stroke overprint of multi column frame

Returns

kTrue if overprint is on otherwise kFalse

virtual UID IVerticalColumnRuleData::GetVerticalRuleStrokeColor ( ) const

pure virtual

Get the vertical rule stroke color of multi column frame.

Returns

color UID

virtual ICompositionStyle::StrokeType IVerticalColumnRuleData::GetVerticalRuleStrokeType ( ) const

pure virtual

Get the column rule stroke type of multi column frame.

Returns

vertical applied on column rules

virtual PMReal IVerticalColumnRuleData::GetVerticalRuleStrokeWidth ( ) const

pure virtual

Get the vertical rule stroke width of multi column frame

Returns

PMReal stroke width value

virtual PMReal IVerticalColumnRuleData::GetVerticalRuleTint ( ) const

pure virtual

Get the vertical rule stroke tint of multi column frame.

Returns

PMReal tint value

virtual PMReal IVerticalColumnRuleData::GetVerticalRuleTopInset ( ) const

pure virtual

Get the Vertical rule top inset of multi column frame

Returns

top inset value

virtual void IVerticalColumnRuleData::SetUseVerticalRule ( bool16  useVerticalRule )

pure virtual

Set the use vertical rule flag of multi column frame

Parameters

bool16

to turn on/off vertical rule

virtual void IVerticalColumnRuleData::SetVerticalRuleBottomInset ( PMReal  inset )

pure virtual

Set the vertical rule Bottom inset of multi column frame

Parameters

bottom

inset value

virtual void IVerticalColumnRuleData::SetVerticalRuleHeightMode ( )

pure virtual

for internal use only Set the vertical rule height mode of multi column frame

virtual void IVerticalColumnRuleData::SetVerticalRuleInsetChain ( bool16  isChained )

pure virtual

Set the vertical rule inset chain of multi column frame

Parameters

offset

Value

virtual void IVerticalColumnRuleData::SetVerticalRuleOffset ( PMReal  offset )

pure virtual

Set the vertical rule offset of multi column frame

Parameters

offset

value

virtual void IVerticalColumnRuleData::SetVerticalRuleOverprint ( bool16  isOverprint )

pure virtual

Set the vertical rule stroke overprint of multi column frame

Parameters

stroke

overprint Value to set

virtual void IVerticalColumnRuleData::SetVerticalRuleStrokeColor ( UID  colorUID )

pure virtual

Set the vertical rule stroke color of multi column frame

Parameters

stroke

color UID Value to set

virtual void IVerticalColumnRuleData::SetVerticalRuleStrokeType ( ICompositionStyle::StrokeType  strokeType )

pure virtual

Set the vertical rule stroke type of multi column frame

Parameters

StrokeType

value

virtual void IVerticalColumnRuleData::SetVerticalRuleStrokeWidth ( PMReal  width )

pure virtual

Set the vertical rule stroke width of multi column frame

Parameters

stroke

width value to set

virtual void IVerticalColumnRuleData::SetVerticalRuleTint ( PMReal  tint )

pure virtual

Set the vertical rule stroke tint of multi column frame

Parameters

stroke

tint Value to set

virtual void IVerticalColumnRuleData::SetVerticalRuleTopInset ( PMReal  inset )

pure virtual

Set the vertical rule top inset of multi column frame

Parameters

top	inset value to set