InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ITextAttrBulletCharacter Class Referenceabstract

#include <ITextAttrBulletCharacter.h>

Inheritance diagram for ITextAttrBulletCharacter:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITEXTATTRBULLETCHARACTER }
 
enum  BulletCharacterType { kUnicodeOnly, kUnicodeWithFont, kGlyphWithFont }
 

Public Member Functions

virtual void SetBulletCharacterType (const BulletCharacterType bcType)=0
 
virtual void SetBulletCharacterValue (const int32 bcValue)=0
 
virtual const BulletCharacterType GetBulletCharacterType () const =0
 
virtual const int32 GetBulletCharacterValue () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Represents the bullet character text attribute.

Member Enumeration Documentation

Bullet Type
Enumerator
kUnicodeOnly 

Bullet represented by a unicode character

kUnicodeWithFont 

Bullet represented by a unicode character from a specific font

kGlyphWithFont 

Bullet represented by a glyph id from a specific font

Member Function Documentation

virtual const BulletCharacterType ITextAttrBulletCharacter::GetBulletCharacterType () const
pure virtual

Get the bullet character type from this text attribute

Returns
BulletCharacterType
virtual const int32 ITextAttrBulletCharacter::GetBulletCharacterValue () const
pure virtual

Get the bullet character value from this text attribute. For bullets of type kUnicodeOnly and kUnicodeWithFont, this is a unicode character value. For bullets of type kGlyphWithFont, this is a glyph id.

Returns
int32
virtual void ITextAttrBulletCharacter::SetBulletCharacterType (const BulletCharacterType bcType)
pure virtual

Set the bullet character type in this text attribute

Parameters
bcTypeThe bullet character type to set
virtual void ITextAttrBulletCharacter::SetBulletCharacterValue (const int32 bcValue)
pure virtual

Set the bullet character value in this text attribute. For bullets of type kUnicodeOnly and kUnicodeWithFont, this is a unicode character value. For bullets of type kGlyphWithFont, this is a glyph id.

Parameters
bcValueThe bullet character value to set