Main Page   Modules   Compound List   File List   Compound Members   File Members  

Graphics environment methods


Functions

STStatus STGraphicsNewEmpty (STGraphics *oGraphics)
 Creates a new graphics environment. More...

STStatus STGraphicsNew (STGraphics *oGraphics, STGraphicsMask iMask, STDevice iDevice, STOutputMode iOutputMode, STRGBAColor iTextFG, STRGBAColor iHighlightFG, STRGBAColor iHighlightBG, STRGBAColor iStrikeThrough, STRGBAColor iHLStrikeThrough, STRGBAColor iUnderline1, STRGBAColor iHLUnderline1, STRGBAColor iUnderline2, STRGBAColor iHLUnderline2)
 Creates a new graphics environment and assigns an output device and rendering parameters to it. More...

STStatus STGraphicsNewCopy (STGraphics *oGraphics, STGraphics iOldGraphics)
 Graphics environment copy constructor. More...

STStatus STGraphicsDispose (STGraphics iGraphics)
 Graphics environment destructor. More...

STStatus STGraphicsSetDevice (STGraphics iGraphics, STDevice iDevice, STOutputMode iOutputMode)
 Sets device and the output mode. More...

STStatus STGraphicsGetDevice (STGraphics iGraphics, STDevice *oDevice, STOutputMode *oOutputMode)
 Queries previously set device and the output mode. More...

STStatus STGraphicsSetColors (STGraphics iGraphics, STGraphicsMask iMask, STRGBAColor iTextFG, STRGBAColor iHighLightFG, STRGBAColor iHighLightBG, STRGBAColor iStrikeThrough, STRGBAColor iHLStrikeThrough, STRGBAColor iUnderline1, STRGBAColor iHLUnderline1, STRGBAColor iUnderline2, STRGBAColor iHLUnderline2)
 Sets graphics colors. More...

STStatus STGraphicsGetColors (STGraphics iGraphics, STGraphicsMask *oMask, STRGBAColor *oTextFG, STRGBAColor *oHighLightFG, STRGBAColor *oHighLightBG, STRGBAColor *oStrikeThrough, STRGBAColor *oHLStrikeThrough, STRGBAColor *oUnderline1, STRGBAColor *oHLUnderline1, STRGBAColor *oUnderline2, STRGBAColor *oHLUnderline2)
 Queries graphics colors. More...

STStatus STDeviceGetMatrix (STDevice iDevice, STMatrix *oMatrix)
 Returns the current transformation matrix of an STDevice object. More...

STStatus STDeviceSetMatrix (STDevice iDevice, STMatrix iMatrix)
 Replaces the current transformation matrix with a new one. More...

STStatus STDeviceConcatMatrix (STDevice iDevice, STMatrix iMatrix)
 Concatenates the current transformation matrix with the new one. More...

STStatus STDeviceTranslate (STDevice iDevice, double tx, double ty)
 Concatenates the current transformation matrix with a translate transform. More...

STStatus STDeviceScale (STDevice iDevice, double sx, double sy)
 Concatenates the current transformation matrix with a scale transform. More...

STStatus STDeviceRotate (STDevice iDevice, double theta)
 Concatenates the current transformation matrix with a rotate transform. More...

STStatus STDeviceShear (STDevice iDevice, double shx, double shy)
 Concatenates the current transformation matrix with a shear transform. More...

Function Documentation

STStatus STDeviceConcatMatrix (  STDevice    iDevice,
STMatrix    iMatrix
) 
 

Concatenates the current transformation matrix with the new one.

Parameters:
iDevice  STDevice object
iMatrix  transformation matrix
Returns:
STStatus

STStatus STDeviceGetMatrix (  STDevice    iDevice,
STMatrix *    oMatrix
) 
 

Returns the current transformation matrix of an STDevice object.

Parameters:
iDevice  STDevice object
oMatrix  transformation matrix is stored there
Returns:
STStatus

STStatus STDeviceRotate (  STDevice    iDevice,
double    theta
) 
 

Concatenates the current transformation matrix with a rotate transform.

Parameters:
iDevice  STDevice object
theta  the rotation angle in radians
Returns:
STStatus

STStatus STDeviceScale (  STDevice    iDevice,
double    sx,
double    sy
) 
 

Concatenates the current transformation matrix with a scale transform.

Parameters:
iDevice  STDevice object
sx  x scale factor
sy  y scale factor
Returns:
STStatus

STStatus STDeviceSetMatrix (  STDevice    iDevice,
STMatrix    iMatrix
) 
 

Replaces the current transformation matrix with a new one.

Parameters:
iDevice  STDevice object
iMatrix  new transformation matrix
Returns:
STStatus

STStatus STDeviceShear (  STDevice    iDevice,
double    shx,
double    shy
) 
 

Concatenates the current transformation matrix with a shear transform.

Parameters:
iDevice  STDevice object
shx  x shear factor
shy  y shear factor
Returns:
STStatus

STStatus STDeviceTranslate (  STDevice    iDevice,
double    tx,
double    ty
) 
 

Concatenates the current transformation matrix with a translate transform.

Parameters:
iDevice  STDevice object
tx  x offset
ty  y offset
Returns:
STStatus

STStatus STGraphicsDispose (  STGraphics    iGraphics ) 
 

Graphics environment destructor.

Parameters:
iGraphics  STGraphics object
Returns:
STStatus

STStatus STGraphicsGetColors (  STGraphics    iGraphics,
STGraphicsMask *    oMask,
STRGBAColor *    oTextFG,
STRGBAColor *    oHighLightFG,
STRGBAColor *    oHighLightBG,
STRGBAColor *    oStrikeThrough,
STRGBAColor *    oHLStrikeThrough,
STRGBAColor *    oUnderline1,
STRGBAColor *    oHLUnderline1,
STRGBAColor *    oUnderline2,
STRGBAColor *    oHLUnderline2
) 
 

Queries graphics colors.

Parameters:
iGraphics  STGraphics object
oMask  Pointer to bitmask which will be set to the OR'ed together bitflags indicating which fields in the STGraphics object have been set by the client application
oTextFG  text color
oHighlightFG  foreground color of highlighted text area
oHighlightBG  background color of highlighted text area
oStrikeThrough  strike through color
oHLStrikeThrough  highlighted strike through color
oUnderline1  color of the first underline
oHLUnderline1  color of the highlighted first underline
oUnderline2  color of the second underline
oHLUnderline2  color of the highlighted second underline
Returns:
STStatus

STStatus STGraphicsGetDevice (  STGraphics    iGraphics,
STDevice *    oDevice,
STOutputMode *    oOutputMode
) 
 

Queries previously set device and the output mode.

Parameters:
iGraphics  STGraphics object
iDevice  STDevice object
iOutputMode  specifies rendering mode
Returns:
STStatus

STStatus STGraphicsNew (  STGraphics *    oGraphics,
STGraphicsMask    iMask,
STDevice    iDevice,
STOutputMode    iOutputMode,
STRGBAColor    iTextFG,
STRGBAColor    iHighlightFG,
STRGBAColor    iHighlightBG,
STRGBAColor    iStrikeThrough,
STRGBAColor    iHLStrikeThrough,
STRGBAColor    iUnderline1,
STRGBAColor    iHLUnderline1,
STRGBAColor    iUnderline2,
STRGBAColor    iHLUnderline2
) 
 

Creates a new graphics environment and assigns an output device and rendering parameters to it.

Parameters:
oGraphics  STGraphics object
iMask  set of bitflags OR'ed together to indicate which fields in the STGraphics object are to be set to the values of the following parameters
iDevice  STDevice object
iOutputMode  specifies an output mode of this graphics environment
iTextFG  text color
iHighlightFG  foreground color of highlighted text area
iHighlightBG  background color of highlighted text area
iStrikeThrough  strike through color
iHLStrikeThrough  highlighted strike through color
iUnderline1  color of the first underline
iHLUnderline1  color of the highlighted first underline
iUnderline2  color of the second underline
iHLUnderline2  color of the highlighted second underline
Returns:
STStatus

STStatus STGraphicsNewCopy (  STGraphics *    oGraphics,
STGraphics    iOldGraphics
) 
 

Graphics environment copy constructor.

Parameters:
oGraphics  STGraphics object
iOldGraphics  graphics environment being cloned
Returns:
STStatus

STStatus STGraphicsNewEmpty (  STGraphics *    oGraphics ) 
 

Creates a new graphics environment.

A graphics environment contains an output device and rendering parameters.

Parameters:
oGraphics  STGraphics object

STStatus STGraphicsSetColors (  STGraphics    iGraphics,
STGraphicsMask    iMask,
STRGBAColor    iTextFG,
STRGBAColor    iHighLightFG,
STRGBAColor    iHighLightBG,
STRGBAColor    iStrikeThrough,
STRGBAColor    iHLStrikeThrough,
STRGBAColor    iUnderline1,
STRGBAColor    iHLUnderline1,
STRGBAColor    iUnderline2,
STRGBAColor    iHLUnderline2
) 
 

Sets graphics colors.

Parameters:
iGraphics  STGraphics object
iMask  set of bitflags OR'ed together to indicate which fields in the STGraphics object are to be set to the values of the following parameters
iTextFG  text color
iHighlightFG  foreground color of highlighted text area
iHighlightBG  background color of highlighted text area
iStrikeThrough  strike through color
iHLStrikeThrough  highlighted strike through color
iUnderline1  color of the first underline
iHLUnderline1  color of the highlighted first underline
iUnderline2  color of the second underline
iHLUnderline2  color of the highlighted second underline
Returns:
STStatus

STStatus STGraphicsSetDevice (  STGraphics    iGraphics,
STDevice    iDevice,
STOutputMode    iOutputMode
) 
 

Sets device and the output mode.

Parameters:
iGraphics  STGraphics object
iDevice  STDevice object
iOutputMode  specifies rendering mode
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