ITextStyle
- Class defining the protocol shared by all text-style classes.
This class defines the protocol shared by all text-style classes.
Do not derive your own classes from this class.
ITextStyle - Member Functions and Data by Group
Constructors & Destructor
Use the constructors and destructor in this group to destroy the ITextStyle object.
- ~ITextStyle
public:
virtual ~ITextStyle()
- Destroys the ITextStyle object.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- ITextStyle
- Constructs an object of class ITextStyle.
Overload 1
- Default constructor.
protected:
ITextStyle()
- Use this constructor to create an empty ITextStyle object.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
Overload 2
- Copy constructor.
protected:
ITextStyle(const ITextStyle&)
- Use this constructor to create an ITextStyleObject that is copied from the given one.
- ITextStyle
- A constant reference to the ITextStyle object that is copied.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
Assignment Operator
- operator =
protected:
ITextStyle& operator =(const ITextStyle&)
- Assignment operator.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
Determining if the Text Style Is Contained in the Current One
Use these functions to test whether the current ITextStyle object contains the given ITextStyleSet or value.
- isContainedInSet
protected:
virtual bool
isContainedInSet( const ITextStyleSet& set ) const = 0
- Tests to determine if the given ITextStyleSet is contained in this, the current, set.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- isValueContainedInSet
protected:
virtual bool
isValueContainedInSet( const ITextStyleSet& set ) const = 0
- Tests to determine if the value specified by the given ITextStyleSet is contained in this, the current, set.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
Getting, Setting, and Removing ITextStyle Values
- addToSet
protected:
virtual void addToSet(ITextStyleSet& set) const = 0
- Adds the given text style set to the current one.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- getValueFromSet
- Obtains the text style from the given set.
protected:
virtual void getValueFromSet(const ITextStyleSet& set) = 0
- Use these functions to get one or more style values from the set, add them to it, or remove them.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- removeFromSet
protected:
virtual void removeFromSet(ITextStyleSet& set) const = 0
- Removes the given text style from the current one.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
Obtaining the Propagation Type
This group consists of a pure, virtual function that gets the style's propagation type.
- propagates
- Returns the style's propagation type.
public:
virtual EStylePropagation propagates() const = 0
- (Pure virtual function in ITextStyle.)
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- EStylePropagation
enum EStylePropagation { kPropagateByCharacter,
kPropagateByParagraph,
kMaximumPropagation=127 }
- Enum defining the possible style-propagation types:
Use the constants defined by this enumeration to specify the type of style to propagate:
- kPropagateByCharacter - Styles with this propagation type can be applied to
any arbitrary range of text.
- kPropagateByParagraph - Styles with this propagation type can be applied only
to whole paragraphs. The addStyles() and removeStyles() calls expand their
ranges to whole paragraphs when used to apply or remove paragraph styles.
If a character operation results in a paragraph with more than one set
of paragraph styles in effect over its range, the "last" set of styles
(the ones in effect at the highest character offset in the paragraph)
have their ranges extended to cover the whole paragraph.
- kMaximumPropagation - This value is used in some IText functions that
retrieve style information to tell the function to match all
style propagation types.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
ITextStyle - Inherited Member Functions and Data
Inherited Public Functions
Inherited Public Data
Inherited Protected Functions
Inherited Protected Data