Brief Index      Full Index      I.M. Reference

Show_Text_Font


Functions

void Show_Text_Font (char *options)
void QShow_Text_Font (const char *segment, char *options)
void Show_Net_Text_Font (char *options)
void PShow_Net_Text_Font (int keycount, HC_KEY *pathkeys, char *options)
void QShow_Net_Text_Font (const char *segment, char *options)
void Show_One_Text_Font (const char *type, char *value)
void QShow_One_Text_Font (const char *segment, const char *type, char *value)
void Show_One_Net_Text_Font (const char *type, char *value)
void PShow_One_Net_Text_Font (int count, HC_KEY *keys, const char *type, char *value)
void QShow_One_Net_Text_Font (const char *segment, const char *type, char *value)

Function Documentation

void Show_Text_Font ( char *  options  ) 

Returns the font settings that have been made on the currrently open segment.

Parameters:
options A string of name = value options.
Options Returned:
bold, extra space, greeking limit, greeking mode, italic, line spacing, name, overline, preference, renderer, rotation, size, size tolerance, slant, strikethrough, transforms, underline, width scale,

DETAILS

No additional details. See Set_Text_Font()

NOTES

The Show_Text_Font routines return the actual attribute values stored in the particular segment at hand. The Show_Net_Text_Font routines return the effective attribute value for the specified segment. The distinction is that there may or may not be an "actual" stored value for an attribute for a given segment, but there is guaranteed always to be an effective value for every attribute for every segment. Also, "Show Net" will return the cumulative effects of those attributes that concatenate as you go up and down the segment tree (Modelling Matrices and Windows).

When the value being passed back is a string, be sure you've declared your string variable to be long enough.

In C, "passed by reference" means that you have to allocate an appropriate variable, either statically or off the stack, and pass a pointer to that variable to the HOOPS routine. To generate a pointer to a variable C, you prefix the variable with a "&". In other languages you normally don't have to do anything different from usual.

The Show_Text_Font routines will complain if they're called and the attribute is not actually set in the segment. Use Show_Existence() to avoid this, if necessary.

void QShow_Text_Font ( const char *  segment,
char *  options 
)

Similar to Show_Text_Font() but operates on a given segment rather than the currently open one.

Parameters:
segment The segment to query.
options A string of name = value options.

DETAILS

No additional details. See Set_Text_Font()

void Show_Net_Text_Font ( char *  options  ) 

Similar to Show_Text_Font(), but returns the net effective settings rather than the local ones.

Parameters:
options A string of name = value options.

DETAILS

No additional details. See Set_Text_Font()

void PShow_Net_Text_Font ( int  keycount,
HC_KEY *  pathkeys,
char *  options 
)

Similar to Show_Net_Text_Font(), but returns the net effective settings along a discrete segment path.

Parameters:
keycount The size of pathkeys
pathkeys An array of HC_KEY's delineating a path of segments.
options A string of name = value options.

DETAILS

As with all PShow_Net_* routines, pathkeys[0] represents the lowest (a.k.a the "most local" or "leaf"), and pathkeys[keycount-1] represents the highest segment. If the path is incomplete, missing segments are filled in if possible. Missing segments must be part of the same direct ancestry in order to be filled in. If the desired path contains an include link, the shortest unambiguous set of pathkeys would be [leaf, includelink, root], where includelink is the return value from KInclude_Segment(). For other details, see Show_Net_Text_Font()

void QShow_Net_Text_Font ( const char *  segment,
char *  options 
)

Similar to Show_Net_Text_Font() but operates on a given segment rather than the currently open one.

Parameters:
segment The segment to query.
options A string of name = value options.

DETAILS

No additional details. See Set_Text_Font()

void Show_One_Text_Font ( const char *  type,
char *  value 
)

Similar to Show_Text_Font() but returns a single setting, rather than the entire set.

Parameters:
type The type in type = value.
value The value of type. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Text_Font()

void QShow_One_Text_Font ( const char *  segment,
const char *  type,
char *  value 
)

Similar to Show_One_Text_Font() but operates on a given segment rather than the currently open one.

Parameters:
segment The segment to query.
type The type in type = value.
value The value of type. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Text_Font()

void Show_One_Net_Text_Font ( const char *  type,
char *  value 
)

Similar to Show_One_Text_Font() but returns the net effective setting rather than the local one.

Parameters:
type The type in type = value.
value The value of type. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Text_Font()

void PShow_One_Net_Text_Font ( int  count,
HC_KEY *  keys,
const char *  type,
char *  value 
)

Similar to Show_One_Net_Text_Font() but returns the net settings along a discrete path.

Parameters:
count The size of keys
keys An array of HC_KEY's delineating a path of segments.
type The type in type = value.
value The value of type. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Text_Font()

void QShow_One_Net_Text_Font ( const char *  segment,
const char *  type,
char *  value 
)

Similar to Show_One_Net_Text_Font() but operates on a given segment rather than the currently open one.

Parameters:
segment The segment to query.
type The type in type = value.
value The value of type. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Text_Font()

Main Index
Brief Index      Full Index      I.M. Functions