ITabStop
ITabStop - Member Functions and Data by Group
Constructors & Destructor
Use these constructors and destructor to create and destroy objects of class ITabStop.
- ~ITabStop
public:
virtual ~ITabStop()
- Destroys the ITabStop object.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- ITabStop
- These constructors create objects of class ITabStop.
Overload 1
- Creates a tab stop at position 0 of type kLeft.
public:
ITabStop()
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
Overload 2
- Initializes a tab stop based on the passed-in parameters.
public:
ITabStop(GCoord position, ETabStopKind type)
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
Overload 3
- Replaces this, the current, ITabStop object with the given one.
public:
ITabStop(const ITabStop& source)
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
Assignment Operator
Use this operator to replace the current ITabStop object with the given one.
- operator =
public:
ITabStop& operator =(const ITabStop& source)
- Assignment operator.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
Obtaining a Tab Stop's Type or Position
Use these functions to get the type of a tab stop or its position in global coordinates.
- position
public:
GCoord position() const
- Returns the position of the tab stop in its global coordinates.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- type
public:
ETabStopKind type() const
- Returns the type of tab stop. The type is identified by one of the constants defined by the ETabStopKind enumerator.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
Streaming the Object In and Out
Use these functions to read the ITabStop object in from a specified stream or write it out to one.
- readFromStream
public:
virtual void readFromStream(IDataStream& fromWhere)
- Reads the ITabStop object in from the specified data stream.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- writeToStream
public:
virtual void writeToStream(IDataStream& toWhere) const
- Writes the ITabStop object out to the specified data stream.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
Testing Two ITabStop Objects for Equality or Inequality
Use these functions to test two ITabStop objects to determine if their contents are the same or different.
- operator !=
public:
bool operator !=(const ITabStop& other) const
- Compares the given ITabStop object against the current one to determine if their contents are different.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- operator ==
public:
bool operator ==(const ITabStop& other) const
- Compares the given ITabStop object against the current one to determine if their contents are equal.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- ETabStopKind
enum ETabStopKind { kLeft,
kCenter,
kRight,
kDecimal,
kAuto }
- Identifies the type of tab stop:
- kLeft - Text is left-justified at the tab stop position.
- kCenter - Text is centered at the tab stop position.
- kRight - Text is right-justified at the tab stop position.
- kDecimal - The first decimal-point character in the text is aligned to the tab stop position.
- kAuto - An automatically-generated tab stop, instead of one set by the client.
Works the same as kLeft.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
ITabStop - Inherited Member Functions and Data
Inherited Public Functions
Inherited Public Data
Inherited Protected Functions
Inherited Protected Data