MSet_Character_Attributes

Functions

void MSet_Character_Attributes (HC_KEY key, int offset, int count, const char *options)
 Allows Developers to set text attributes on a per-character basis within a text string. More...
 
void MUnSet_Character_Attributes (HC_KEY key, int offset, int count, const char *options)
 Un-sets text attributes established in a previous call to MSet_Character_Attributes. More...
 

Detailed Description

Function Documentation

◆ MSet_Character_Attributes()

void MSet_Character_Attributes ( HC_KEY  key,
int  offset,
int  count,
const char *  options 
)

Allows Developers to set text attributes on a per-character basis within a text string.

Parameters
key- Key to the text string on which to set per-character attributes.
offset- The index within the text string on which to start applying the text attributes.
count- The number of characters immediately after offset to which the character attributes should be applied.
options- A comma-separated list of attributes to be applied to the characters in the specified range.

DETAILS

Through this function, developers can define a subset of characters within a string that are allowed to have attributes different from the other characters. Attributes that are defined within a string via MSet_Character_Attributes have precedence over those defined in the local segment.

The supported attributes are as follows:

color = color_spec

A string defining the color you would like applied to the specified characters as described in Set_Color().

horizontal offset = x

The number of units in the horizontal direction the specified characters should be offset.

invisible = on/off

If set, the characters are not drawn but still contribute to the spacing of the other characters in the string.

name = value

Specifies the font name. This name can be a generic font name such as "roman", "sans serif", "typewriter" or "stroked", a truetype font name such as "MS Gothic" or a system dependent name such as "arial-GDI-VECTOR".

omitted = on/off

If set, the characters are not drawn and do not contribute to the spacing of the other characters in the string.

size = ddd

The size of the characters, specified in oru (object relative units), sru (subscreen relative units), wru (window relative units), pt (points), px (pixels), or % (percent of primary text size).

[no] slant [= angle]

The angle by which the character is slanted, from -75 degrees to +75 degrees.

[no] rotation [= angle [fixed]]

The angle by which the character is rotated, in addition to any existing rotation. If 'fixed' is specified, then the rotation value disregards any rotation that may be the result of other text rotation attributes. These attributes include text path, and generic text font settings. "no rotation" is the equivalent of "no rotation fixed".

vertical offset = y

This is how many units in the vertical direction the character should be offset.

See also
MShow_Character_Attributes, Show_One_Character_Attribute, Show_Character_Attribute_Count

◆ MUnSet_Character_Attributes()

void MUnSet_Character_Attributes ( HC_KEY  key,
int  offset,
int  count,
const char *  options 
)

Un-sets text attributes established in a previous call to MSet_Character_Attributes.

Parameters
key- Key to the text string on which to un-set per-character attributes.
offset- The index within the text string on which to start un-setting the text attributes.
count- The number of characters immediately after offset to which the operation should be applied.
options- A comma-separated list of attributes to be un-set on the characters in the specified range.

DETAILS

No additional details. See MSet_Character_Attributes().