TabStop Class Reference

#include <TabStop.h>

Public Types
enum	{ kMaximumLeaderCount = 8 }
enum	TabAlignment { kTabAlignLeft, kTabAlignCenter, kTabAlignRight, kTabAlignChar }
typedef base_type	data_type

Public Member Functions
void	Reset ()
void	SetPosition (const PMReal &pos)
void	SetAlignment (TabAlignment align)
void	SetAlignment (TabAlignment align, UTF32TextChar c)
void	SetLeader (const WideString *leaders=nil)
void	ClearLeader ()
const textchar *	GetLeaders () const
int16	GetLeaderCount () const
PMReal	GetPosition () const
TabAlignment	GetAlignment () const
UTF32TextChar	GetAlignToChar () const
void	ReadWrite (IPMStream *stream)
bool16	operator== (const TabStop &other) const
bool16	operator> (const TabStop &other) const
bool16	operator< (const TabStop &other) const
bool16	IsDefaultTab () const
void	SetDefaultTab (bool16 toDefault=kTrue)

Detailed Description

The object representing a tab stop.

Member Enumeration Documentation

anonymous enum

The maximum length of a set of tab leader characters.

enum TabStop::TabAlignment

How to align text after the tab.

Member Function Documentation

bool16 TabStop::IsDefaultTab ( ) const

inline

Return whether or not this is a default tab (a tab stop not set by the user, but governed by the default tab interval)

See Also

ITabSettings

bool16 TabStop::operator< ( const TabStop &  other ) const

inline

Note

performs the operation based strictly on the location of the tabstop

bool16 TabStop::operator== ( const TabStop &  other ) const

inline

Note

performs the operation based strictly on the location of the tabstop

bool16 TabStop::operator> ( const TabStop &  other ) const

inline

Note

performs the operation based strictly on the location of the tabstop

void TabStop::Reset ( void  )

inline

Reset the tab location and leader. (Alignment remains intact)

void TabStop::SetAlignment ( TabAlignment  align, UTF32TextChar  c  )

inline

Property Accessor for the kTabAlignChar alignment option

void TabStop::SetDefaultTab ( bool16  toDefault = kTrue )

inline

Set whether or not this is a default tab.

void TabStop::SetLeader

(

const WideString *

leaders = nil

)

Note

Leaders can be any string up to kMaximumLeaderCount in length.

A leader that consists of space(s) is ignored. (But spaces may be included with other characters).