IBNDrawingStyle Class Reference

#include <IBNDrawingStyle.h>

Inheritance diagram for IBNDrawingStyle:

Public Types
enum	{ kDefaultIID = IID_IBNDRAWINGSTYLE }
enum	ListAlignment { kAlignLeft, kAlignCenter, kAlignRight }

Public Member Functions
virtual void	SetListType (ITextAttrListType::ListType listType)=0
virtual ITextAttrListType::ListType	GetListType () const =0
virtual bool16	IsBulletOrNumberingApplied () const =0
virtual void	SetBulletFontUID (UID u)=0
virtual UID	GetBulletFontUID () const =0
virtual void	SetBulletFontStyleName (const PMString &name)=0
virtual const PMString &	GetBulletFontStyleName () const =0
virtual void	SetBulletCharacterStyleUID (UID u)=0
virtual UID	GetBulletCharacterStyleUID () const =0
virtual void	SetBulletAlignment (ListAlignment val)=0
virtual ListAlignment	GetBulletAlignment () const =0
virtual void	SetNumberingCharacterStyleUID (UID u)=0
virtual UID	GetNumberingCharacterStyleUID () const =0
virtual void	SetNumberingAlignment (ListAlignment val)=0
virtual ListAlignment	GetNumberingAlignment () const =0
virtual UID	GetUsedColorUID () const =0
virtual UID	GetUsedFontUIDFromCharacterStyle () const =0
virtual PMString	GetUsedFontStyleNameFromCharacterStyle () const =0
virtual void	SetBulletCharacterType (ITextAttrBulletCharacter::BulletCharacterType bulType)=0
virtual ITextAttrBulletCharacter::BulletCharacterType	GetBulletCharacterType () const =0
virtual void	SetBulletCharacterValue (int32 value)=0
virtual int32	GetBulletCharacterValue () const =0
virtual void	SetBulletFontMMAxes (int32 numAxes, const Fixed *axes)=0
virtual int32	GetBulletFontMMAxes (Fixed *axes) const =0
virtual void	SetNumberingSeparator (int32 i)=0
virtual int32	GetNumberingSeparator () const =0
virtual void	SetNumberingStyle (ClassID c)=0
virtual ClassID	GetNumberingStyle () const =0
virtual void	SetNumberStartAt (int32 i)=0
virtual int32	GetNumberStartAt () const =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

IBNDrawingStyle is the collection of summary information for attributes related to Bullets and Numbering. The information in this collection is set by the actual text attributes themselves.

See Also

IDrawingStyle

Member Enumeration Documentation

enum IBNDrawingStyle::ListAlignment

List Alignment

Enumerator
kAlignLeft	Left align
kAlignCenter	Center align
kAlignRight	Right align

Member Function Documentation

virtual ListAlignment IBNDrawingStyle::GetBulletAlignment ( ) const

pure virtual

Gets the alignment for bullets.

Returns

The actually applied alignment type.

virtual UID IBNDrawingStyle::GetBulletCharacterStyleUID ( ) const

pure virtual

Gets the character style for bullets and text after.

Returns

The actually applied character style.

virtual const PMString& IBNDrawingStyle::GetBulletFontStyleName ( ) const

pure virtual

Gets the bullet font style name.

Returns

The actually used bullet font style name.

virtual UID IBNDrawingStyle::GetBulletFontUID ( ) const

pure virtual

Gets the bullet font family UID.

Returns

The actually used bullet font family UID. The value may also be kInvalidUID.

virtual ITextAttrListType::ListType IBNDrawingStyle::GetListType ( ) const

pure virtual

Get the list type as bulleted, numbered or none.

Returns

The actually used list type. It may be ITextAttrListType::kNone for no list, ITextAttrListType::kBulletedList for bullets and ITextAttrListType::kNumberedList for numbering.

virtual ListAlignment IBNDrawingStyle::GetNumberingAlignment ( ) const

pure virtual

Gets the alignment for numbers.

Returns

The actually applied alignment type.

virtual UID IBNDrawingStyle::GetNumberingCharacterStyleUID ( ) const

pure virtual

Gets the character style for numbers.

Returns

The actually applied character style.

virtual UID IBNDrawingStyle::GetUsedColorUID ( ) const

pure virtual

Gets the UID for applied color to bullet or number.

Returns

The actually applied color UID from the character style. The value may also be kInvalidUID.

virtual PMString IBNDrawingStyle::GetUsedFontStyleNameFromCharacterStyle ( ) const

pure virtual

Gets the font style name from applied character style to bullet or number.

Returns

The font style name.

virtual UID IBNDrawingStyle::GetUsedFontUIDFromCharacterStyle ( ) const

pure virtual

Gets the font family UID from applied character style to bullet or number.

Returns

The font family UID. The value may also be kInvalidUID.

virtual bool16 IBNDrawingStyle::IsBulletOrNumberingApplied ( ) const

pure virtual

Checks if bullets or numbering is on.

Returns

true if bullet or numbering is on, false otherwise.

virtual void IBNDrawingStyle::SetBulletAlignment ( ListAlignment  val )

pure virtual

Sets the alignment for bullets.

Parameters

val	is the type of alignment.

virtual void IBNDrawingStyle::SetBulletCharacterStyleUID ( UID  u )

pure virtual

Sets the character style for bullets and text after.

Parameters

u	is the UID of an existing character style.

virtual void IBNDrawingStyle::SetBulletFontStyleName ( const PMString &  name )

pure virtual

Sets the bullet font style name.

Parameters

name	is the bullet font style name.

virtual void IBNDrawingStyle::SetBulletFontUID ( UID  u )

pure virtual

Sets the bullet font family UID.

Parameters

u	is the bullet font family UID.

virtual void IBNDrawingStyle::SetListType ( ITextAttrListType::ListType  listType )

pure virtual

Set the list type to bullets, numbering or none.

Parameters

listType

specifies the list type to set to. It may be ITextAttrListType::kNone for no list, ITextAttrListType::kBulletedList for bullets and ITextAttrListType::kNumberedList for numbering.

virtual void IBNDrawingStyle::SetNumberingAlignment ( ListAlignment  val )

pure virtual

Sets the alignment for numbers.

Parameters

val	is the type of alignment.

virtual void IBNDrawingStyle::SetNumberingCharacterStyleUID ( UID  u )

pure virtual

Sets the character style for numbers.

Parameters

u	is the UID of an existing character style.