Main Page   Modules   Compound List   File List   Compound Members   File Members  

Style methods


Functions

STStatus STStyleNewEmpty (STStyle *oStyle, STTypeEnv iEnv)
 Creates a new empty Style. More...

STStatus STStyleNewDefault (STStyle *oStyle, STTypeEnv iEnv)
 Creates a new Style with the attributes set to default values. More...

STStatus STStyleNewCopy (STStyle *oNewStyle, STStyle iOldStyle)
 Creates a copy of iOldStyle. More...

STStatus STStyleDispose (STStyle iStyle)
 A Style destructor. More...

STStatus STStyleCompare (STStyle iLhs, STStyleMask iMask, STStyle iRhs, STStyleComparison *oResult)
 Compare two STStyle objects. More...

STStatus STStyleIsEmpty (STStyle iStyle, STBoolean *oResult)
 Checks if a Style is empty, i.e. More...

STStatus STStyleClear (STStyle iStyle, STStyleMask iMask)
 Removes specified attributes from a Style. More...

STStatus STStyleSerialize (STStyle iStyle, int iFileDes)
 Serializes a Style object to an XML stream. More...

STStatus STStyleDeserialize (STStyle *oStyle, int iFileDes)
 Reads in an XML stream and deserializes a Style object from it. More...

STStatus STStyleSetFont (STStyle iStyle, STStyleMask iMask, STFont iFont, double iSize, STLanguage iLanguage, STBaselineFlag iBaseline)
 Sets font-related attributes of the STStyle. More...

STStatus STStyleGetFont (STStyle iStyle, STStyleMask *oMask, STFont *oFont, double *oSize, STLanguage *oLanguage, STBaselineFlag *oBaseline)
 Retrieves font-related attributes from the STStyle object. More...

STStatus STStyleSetScaler (STStyle iStyle, STStyleMask iMask, STScaler iScaler, STHintingMode iHints, STSbitsMode iSbits)
 Sets scaler and its parameters for the STStyle object. More...

STStatus STStyleGetScaler (STStyle iStyle, STStyleMask *oMask, STScaler *oScaler, STHintingMode *oHints, STSbitsMode *oSbits)
 Retrieves scaler and its parameters from the STStyle object. More...

STStatus STStyleSetLayoutEngine (STStyle iStyle, STStyleMask iMask, STLayoutEngine iLayoutEngine)
 XXX NOT FOR THE ARC Sets the layout engine for the style. More...

STStatus STStyleGetLayoutEngine (STStyle iStyle, STStyleMask *oMask, STLayoutEngine *oLayoutEngine)
 XXX NOT FOR THE ARC Retrieves the layout engine of the style. More...

STStatus STStyleScalerControl (STStyle iStyle, void *iToScaler, STSize iToByteCount, void **oFromScaler, STSize *oFromByteCount)
 Scaler ioctl - exchange control information with the scaler. More...

STStatus STStyleSetEffects (STStyle iStyle, STStyleMask iMask, STStyleEffects iStyleEffects, STStrikeThrough iStrikeThrough, STUnderline iUnderline)
 Sets some effects-related attributes for the STStyle object. More...

STStatus STStyleSetOptions (STStyle iStyle, STStyleMask iMask, int iImposeWidth, int iBeforeWithStreamShift, int iAfterWithStreamShift, int iCrossStreamShift, int iHangingInhibitFactor, int iKerningInhibitFactor, int iDecompositionInhibitFactor)
 Sets additional style options. More...

STStatus STStyleGetOptions (STStyle iStyle, STStyleMask *oMask, int *oImposeWidth, int *oBeforeWithStreamShift, int *oAfterWithStreamShift, int *oCrossStreamShift, int *oTracking, int *oHangingInhibitFactor, int *oKerningInhibitFactor, int *oDecompositionInhibitFactor)
 Retrieves additional style options. More...

STStatus STStyleGetEffects (STStyle iStyle, STStyleMask *oMask, STStyleEffects *oStyleEffects, STStrikeThrough *oStrikeThrough, STUnderline *oUnderline)
 Retrieves previously set effects-related attributes. More...

STStatus STStyleResetAttributes (STStyle iStyle, STStyleMask iMask)
 Resets all Style attributes to their default values. More...

STStatus STStyleCopyAttributes (STStyle iToStyle, STStyleMask iMask, STStyle iFromStyle)
 Copies attributes set in the source Style object to the destination Style object. More...

STStatus STStyleOverwriteAttributes (STStyle iToStyle, STStyleMask iMask, STStyle iFromStyle)
 Copies only those attributes from the source style object that are also set in the destination Style object. More...

STStatus STStyleUnderwriteAttributes (STStyle iToStyle, STStyleMask iMask, STStyle iFromStyle)
 Copies only those attributes from the source Style object that are not set in the destination Style object. More...

STStatus STStyleGetBaselines (STStyle iStyle, STBaselineFlag iBaseline, STBaselines *oBaselines)
 Retrieves baselines position for a style. More...

STStatus STStyleGetDesignMetrics (STStyle iStyle, STLineMetrics *oMetrics)
 Retrieves design metrics for the style based on scaled font design metrics. More...

STStatus STStyleSetPrivateData (STStyle iStyle, STPointer iData)
 Sets a client private value into the Style data space. More...

STStatus STStyleGetPrivateData (STStyle iStyle, STPointer *oData)
 Gets the client private value into the Style data space. More...

Function Documentation

STStatus STStyleClear (  STStyle    iStyle,
STStyleMask    iMask
) 
 

Removes specified attributes from a Style.

Parameters:
iStyle  a Style object
iMask  a set of STStyleBitmasks values, or'ed together or stsAllMask to clear all values
Returns:
STStatus

STStatus STStyleCompare (  STStyle    iLhs,
STStyleMask    iMask,
STStyle    iRhs,
STStyleComparison *    oResult
) 
 

Compare two STStyle objects.

Parameters:
iLhs  a left hand side of the comparison
iMask  mask of attributes to include in comparsion
iRhs  a right hand side of the comparison
oResult  the result of the comparison is stored here
Returns:
STStatus

STStatus STStyleCopyAttributes (  STStyle    iToStyle,
STStyleMask    iMask,
STStyle    iFromStyle
) 
 

Copies attributes set in the source Style object to the destination Style object.

Attributes not set in the source object are unset in the destination object.

Parameters:
iToStyle  destination style object
iMask  bitmask of attributes to copy
iFromStyle  source style object
Returns:
STStatus

STStatus STStyleDeserialize (  STStyle *    oStyle,
int    iFileDes
) 
 

Reads in an XML stream and deserializes a Style object from it.

Parameters:
oStyle  pointer to a created STStyle object is stored there.
iFileDes  an file descriptor of an input file
Returns:
STStatus

STStatus STStyleDispose (  STStyle    iStyle ) 
 

A Style destructor.

Parameters:
iStyle  Style object being deallocated
Returns:
STStatus

STStatus STStyleGetBaselines (  STStyle    iStyle,
STBaselineFlag    iBaseline,
STBaselines *    oBaselines
) 
 

Retrieves baselines position for a style.

Baseline positions are measured as offsets from the baseline specified by iBaseline. This function modifies the STBaselines structure pointed to by oBaselines, the caller is responsible for freeing

Parameters:
iStyle  Style object
iBaseline  baseline from which offsets are measured
oBaselines  pointer to the array where the result is stored
Returns:
STStatus

STStatus STStyleGetDesignMetrics (  STStyle    iStyle,
STLineMetrics *    oMetrics
) 
 

Retrieves design metrics for the style based on scaled font design metrics.

Returned metrics is in user space.

Parameters:
iStyle  Style object
oMetrics  style metrics is stored there
Returns:
STStatus

STStatus STStyleGetEffects (  STStyle    iStyle,
STStyleMask *    oMask,
STStyleEffects *    oStyleEffects,
STStrikeThrough *    oStrikeThrough,
STUnderline *    oUnderline
) 
 

Retrieves previously set effects-related attributes.

If a caller wants to query only some of the attributes, the other parameters may be set to NULL.

Parameters:
iStyle  an STStyle object
oMask  Pointer to bitmask which will be set to the OR'ed together bitflags indicating which fields in the STStyle object have been set by the client application
oStyleEffects  an ORed mask of STStyleEffects values or fStyleEffectsNotSet constant
oStrikeThroughEffects  an ORed mask of STStrikeThroughEffects values or fStrikeThroughEffectsNotSet constant
oUnderlineEffects  an ORed mask of STUnderlineEffects values or fUnderlineEffectsNotSet constant
Returns:
STStatus

STStatus STStyleGetFont (  STStyle    iStyle,
STStyleMask *    oMask,
STFont *    oFont,
double *    oSize,
STLanguage *    oLanguage,
STBaselineFlag *    oBaseline
) 
 

Retrieves font-related attributes from the STStyle object.

If some of the attributes are of no interest to the caller, a NULL pointer may be passed instead of an address of a variable.

Parameters:
iStyle  an STStyle object
oMask  Pointer to bitmask which will be set to the OR'ed together bit flags indicating which fields in the STStyle object have been set by the client application
oFont  a font ID or CFontNotSet
oSize  font size measured in typographic points or fSizeNotSet
oLanguage  language of the style
oBaseline  a dominant baseline for this style or fBaselineFlagNotSet.
Returns:
STStatus

STStatus STStyleGetLayoutEngine (  STStyle    iStyle,
STStyleMask *    oMask,
STLayoutEngine *    oLayoutEngine
) 
 

XXX NOT FOR THE ARC Retrieves the layout engine of the style.

Parameters:
iStyle  the style object
oMask  bitmask that indicates whether the layout engine was set for this style previously
oLayoutEngine  layout engine ID

STStatus STStyleGetOptions (  STStyle    iStyle,
STStyleMask *    oMask,
int *    oImposeWidth,
int *    oBeforeWithStreamShift,
int *    oAfterWithStreamShift,
int *    oCrossStreamShift,
int *    oTracking,
int *    oHangingInhibitFactor,
int *    oKerningInhibitFactor,
int *    oDecompositionInhibitFactor
) 
 

Retrieves additional style options.

Parameters:
iStyle  a style object
oMask  set of bitflags OR'ed together to indicate which fields in the STStyle object are to be set to the values of the following parameters
oImposeWidth  weight factor for font-defined glyph widths
oBeforeWithStreamShift  weight factor for with-stream shift applied before each glyph
oAfterWithStreamShift  weight factor for with-stream shift applied after each glyph
oCrossStreamShift  cross-stream shift weight factor
oHangingInhibitFactor  hanging glyph weight factor
oKerningInhibitFactor  kerning weight factor
oDecompositionInhibitFactor  ligature decomposition weight factor
Returns:
STStatus

STStatus STStyleGetPrivateData (  STStyle    iStyle,
STPointer *    oData
) 
 

Gets the client private value into the Style data space.

Parameters:
iStyle  Style object
oData  client private data returned
Returns:
STStatus

STStatus STStyleGetScaler (  STStyle    iStyle,
STStyleMask *    oMask,
STScaler *    oScaler,
STHintingMode *    oHints,
STSbitsMode *    oSbits
) 
 

Retrieves scaler and its parameters from the STStyle object.

Parameters:
oStyle  STStyle object
oMask  Pointer to bitmask which will be set to the OR'ed together bitflags indicating which fields in the STStyle object have been set by the client application
oScaler  STScaler object
oHints  specifies if the scaler should use hints
oSbits  specifies if the scaler should use embedded bitmaps
Returns:
STStatus

STStatus STStyleIsEmpty (  STStyle    iStyle,
STBoolean *    oResult
) 
 

Checks if a Style is empty, i.e.

no attributes were assigned to it.

Parameters:
iStyle  a Style object
oResult  the result is stored there
Returns:
STStatus

STStatus STStyleNewCopy (  STStyle *    oNewStyle,
STStyle    iOldStyle
) 
 

Creates a copy of iOldStyle.

Parameters:
oNewStyle  pointer to the newly created Style is stored here
iOldStyle  a Style that is duplicated
Returns:
STStatus

STStatus STStyleNewDefault (  STStyle *    oStyle,
STTypeEnv    iEnv
) 
 

Creates a new Style with the attributes set to default values.

Parameters:
oStyle  pointer to the newly created Style is stored here
iEnv  a pointer to the TypeEnv
Returns:
STStatus

STStatus STStyleNewEmpty (  STStyle *    oStyle,
STTypeEnv    iEnv
) 
 

Creates a new empty Style.

Style is a unit of formatting information applied to a sequence of characters in an STText object. It has several attributes that can be set and copied from one Style to another.

Parameters:
oStyle  pointer to the newly created Style is stored here
iEnv  a pointer to the TypeEnv
Returns:
STStatus

STStatus STStyleOverwriteAttributes (  STStyle    iToStyle,
STStyleMask    iMask,
STStyle    iFromStyle
) 
 

Copies only those attributes from the source style object that are also set in the destination Style object.

Parameters:
iToStyle  destination Style object
iMask  bitmask of attributes to copy
iFromStyle  source style object
Returns:
STStatus

STStatus STStyleResetAttributes (  STStyle    iStyle,
STStyleMask    iMask
) 
 

Resets all Style attributes to their default values.

Parameters:
iStyle  a Style object
iMask  set of bitflags OR'ed together to indicate which fields in the STStyle object are to be reset
Returns:
STStatus

STStatus STStyleScalerControl (  STStyle    iStyle,
void *    iToScaler,
STSize    iToByteCount,
void **    oFromScaler,
STSize *    oFromByteCount
) 
 

Scaler ioctl - exchange control information with the scaler.

Parameters:
iStyle  STStyle object
iToScaler  this data is sent to the scaler
iToByteCount  number of bytes in iToScaler
oFromScaler  if scaler returns any data the pointer to an allocated buffer that holds this data is stored here
oFromByteCount  number of bytes returned from the scaler
Returns:
STStatus

STStatus STStyleSerialize (  STStyle    iStyle,
int    iFileDes
) 
 

Serializes a Style object to an XML stream.

Used mainly for debugging.

Parameters:
iStyle  a Style object
iFileDes  a file descriptor of an output file
Returns:
STStatus

STStatus STStyleSetEffects (  STStyle    iStyle,
STStyleMask    iMask,
STStyleEffects    iStyleEffects,
STStrikeThrough    iStrikeThrough,
STUnderline    iUnderline
) 
 

Sets some effects-related attributes for the STStyle object.

Parameters:
iStyle  an STStyle object
iMask  set of bitflags OR'ed together to indicate which fields in the STStyle object are to be set to the values of the following parameters
iStyleEffects  an ORed mask of STStyleEffects values or fStyleEffectsNotSet constant
iStrikeThrough  an ORed mask of STStrikeThrough values
iUnderline  an ORed mask of STUnderline values
Returns:
STStatus

STStatus STStyleSetFont (  STStyle    iStyle,
STStyleMask    iMask,
STFont    iFont,
double    iSize,
STLanguage    iLanguage,
STBaselineFlag    iBaseline
) 
 

Sets font-related attributes of the STStyle.

If some of the attributes set by this function are not to be changed, a special value of the corresponding parameter is used.

Parameters:
iStyle  a STSTyle object
iMask  set of bitflags OR'ed together to indicate which fields in the STStyle object are to be set to the values of the following parameters
iFont  font ID or CFontNotSet
iSize  font size measured in typographic points or fSizeNotSet
iLanguage  language of the style
iBaseline  the dominant baseline for this style or fBaselineFlagNotSet.
Returns:
STStatus

STStatus STStyleSetLayoutEngine (  STStyle    iStyle,
STStyleMask    iMask,
STLayoutEngine    iLayoutEngine
) 
 

XXX NOT FOR THE ARC Sets the layout engine for the style.

Parameters:
iStyle  the style object
iMask  bitmask iwth ST_SM_LAYOUTENGINE bit set
iLayoutEngine  layout engine ID
Returns:
STStatus

STStatus STStyleSetOptions (  STStyle    iStyle,
STStyleMask    iMask,
int    iImposeWidth,
int    iBeforeWithStreamShift,
int    iAfterWithStreamShift,
int    iCrossStreamShift,
int    iHangingInhibitFactor,
int    iKerningInhibitFactor,
int    iDecompositionInhibitFactor
) 
 

Sets additional style options.

Parameters:
iStyle  a style object
iMask  set of bitflags OR'ed together to indicate which fields in the STStyle object are to be set to the values of the following parameters
iImposeWidth  weight factor for font-defined glyph widths
iBeforeWithStreamShift  weight factor for with-stream shift applied before each glyph
iAfterWithStreamShift  weight factor for with-stream shift applied after each glyph
iCrossStreamShift  cross-stream shift weight factor
iHangingInhibitFactor  hanging glyph weight factor
iKerningInhibitFactor  kerning weight factor
iDecompositionInhibitFactor  ligature decomposition weight factor
Returns:
STStatus

STStatus STStyleSetPrivateData (  STStyle    iStyle,
STPointer    iData
) 
 

Sets a client private value into the Style data space.

Parameters:
iStyle  Style object
iData  client private data to set
Returns:
STStatus

STStatus STStyleSetScaler (  STStyle    iStyle,
STStyleMask    iMask,
STScaler    iScaler,
STHintingMode    iHints,
STSbitsMode    iSbits
) 
 

Sets scaler and its parameters for the STStyle object.

Parameters:
iStyle  STStyle object
iScaler  STScaler object
iHints  specifies if the scaler should use hints
iSbits  specifies if the scaler should use embedded bitmaps
Returns:
STStatus

STStatus STStyleUnderwriteAttributes (  STStyle    iToStyle,
STStyleMask    iMask,
STStyle    iFromStyle
) 
 

Copies only those attributes from the source Style object that are not set in the destination Style object.

Parameters:
iToStyle  destination Style object
iMask  bitmask of attributes to copy
iFromStyle  source Style object
Returns:
STStatus

Generated on Thu Mar 20 23:35:53 2003 for Standard Type Services by doxygen1.2.13.1 written by Dimitri van Heesch, © 1997-2001