Stylesheets

Functions
Boolean_t	TecUtilReadStylesheet (const char *FName, Boolean_t IncludePlotStyle, Boolean_t IncludeText, Boolean_t IncludeGeom, Boolean_t IncludeStreamPositions, Boolean_t IncludeContourLevels, Boolean_t MergeStyle, Boolean_t IncludeFrameSizeAndPosition)
	Read a stylesheet file into the current frame.
Boolean_t	TecUtilWriteStylesheetX (ArgList_pa ArgList)
	Write the style for the current frame to a file.
Boolean_t	TecUtilWriteStylesheet (const char *FName, Boolean_t IncludePlotStyle, Boolean_t IncludeText, Boolean_t IncludeGeom, Boolean_t IncludeStreamPositions, Boolean_t IncludeContourLevels, Boolean_t IncludeFactoryDefaults)
	Write the style for the current frame to a file.

---

Function Documentation

Boolean_t TecUtilReadStylesheet	(	const char *	FName,
		Boolean_t	IncludePlotStyle,
		Boolean_t	IncludeText,
		Boolean_t	IncludeGeom,
		Boolean_t	IncludeStreamPositions,
		Boolean_t	IncludeContourLevels,
		Boolean_t	MergeStyle,
		Boolean_t	IncludeFrameSizeAndPosition
	)

Read a stylesheet file into the current frame.

Parameters:

	FName	The name of the stylesheet file to read
	IncludePlotStyle	Set to TRUE to process commands related to the style of the plot (that is, mesh color, vector type, etc.)
	IncludeText	Set to TRUE to load any text in the stylesheet
	IncludeGeom	Set to TRUE to load any geometries in the stylesheet
	IncludeStreamPositions	Set to TRUE to load any streamtrace starting positions in the stylesheet
	IncludeContourLevels	Set to TRUE to load any contour level information in the stylesheet.
	MergeStyle	Set to TRUE to merge the current frame style with the new stylesheet. Set to FALSE to reset the style of the current frame back to factory defaults before reading in the stylesheet
	IncludeFrameSizeAndPosition	Set to TRUE to resize and position the current frame to the specifications of the stylesheet file. Set to FALSE to keep the current frame's size and position

Returns:

TRUE if the input parameters are valid and the specified style was successfully loaded, FALSE otherwise.

Precondition:

FName String must have a valid address and non-zero length.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilReadStylesheet(
   &                   FName,
   &                   IncludePlotStyle,
   &                   IncludeText,
   &                   IncludeGeom,
   &                   IncludeStreamPositions,
   &                   IncludeContourLevels,
   &                   MergeStyle,
   &                   IncludeFrameSizeAndPosition)
    CHARACTER*(*)   FName
    INTEGER*4       IncludePlotStyle
    INTEGER*4       IncludeText
    INTEGER*4       IncludeGeom
    INTEGER*4       IncludeStreamPositions
    INTEGER*4       IncludeContourLevels
    INTEGER*4       MergeStyle
    INTEGER*4       IncludeFrameSizeAndPosition

Python Syntax:

  Results = TecUtil.ReadStylesheet(FName, IncludePlotStyle, IncludeText, IncludeGeom, IncludeStreamPositions, IncludeContourLevels, MergeStyle, IncludeFrameSizeAndPosition)

  Input:
                  FName                string
                  IncludePlotStyle     boolean
                  IncludeText          boolean
                  IncludeGeom          boolean
                  IncludeStreamPositions boolean
                  IncludeContourLevels boolean
                  MergeStyle           boolean
                  IncludeFrameSizeAndPosition boolean
  Output:
    Results[0]    ReturnVal            boolean

Load in the stylesheet file1.sty, choosing to reset the style of the current frame back to factory defaults first. Next, load only text and geometries from the stylesheet file2.sty, adding them to the current style:

   Boolean_t IsOk;
   IsOk = TecUtilReadStylesheet("file1.sty", TRUE, TRUE, TRUE,
                                TRUE, TRUE, FALSE, TRUE);
   IsOk = TecUtilReadStylesheet("file2.sty", FALSE, TRUE, TRUE,
                                FALSE, FALSE, TRUE, FALSE);

Boolean_t TecUtilWriteStylesheet	(	const char *	FName,
		Boolean_t	IncludePlotStyle,
		Boolean_t	IncludeText,
		Boolean_t	IncludeGeom,
		Boolean_t	IncludeStreamPositions,
		Boolean_t	IncludeContourLevels,
		Boolean_t	IncludeFactoryDefaults
	)

Write the style for the current frame to a file.

Parameters:

	FName	File name. Must not be NULL
	IncludePlotStyle	Set to TRUE to include the plot style
	IncludeText	Set to TRUE to include text
	IncludeGeom	Set to TRUE to include geometries
	IncludeStreamPositions	Set to TRUE to include stream positions
	IncludeContourLevels	Set to TRUE to include contour levels
	IncludeFactoryDefaults	Set to TRUE to include factory defaults

Returns:

TRUE if successful, FALSE otherwise.

Precondition:

FName String must have a valid address and non-zero length.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilWriteStylesheet(
   &                   FName,
   &                   IncludePlotStyle,
   &                   IncludeText,
   &                   IncludeGeom,
   &                   IncludeStreamPositions,
   &                   IncludeContourLevels,
   &                   IncludeFactoryDefaults)
    CHARACTER*(*)   FName
    INTEGER*4       IncludePlotStyle
    INTEGER*4       IncludeText
    INTEGER*4       IncludeGeom
    INTEGER*4       IncludeStreamPositions
    INTEGER*4       IncludeContourLevels
    INTEGER*4       IncludeFactoryDefaults

Python Syntax:

  Results = TecUtil.WriteStylesheet(FName, IncludePlotStyle, IncludeText, IncludeGeom, IncludeStreamPositions, IncludeContourLevels, IncludeFactoryDefaults)

  Input:
                  FName                string
                  IncludePlotStyle     boolean
                  IncludeText          boolean
                  IncludeGeom          boolean
                  IncludeStreamPositions boolean
                  IncludeContourLevels boolean
                  IncludeFactoryDefaults boolean
  Output:
    Results[0]    ReturnVal            boolean

Write the style for the current frame to the file f1.sty:

   TecUtilWriteStylesheet("f1.sty",TRUE,TRUE,TRUE,TRUE,TRUE,TRUE);.

Boolean_t TecUtilWriteStylesheetX

(

ArgList_pa

ArgList

)

Write the style for the current frame to a file.

Parameters:

ArgList

Set of Arglist entries. This is built using calls to TecUtilArgListAppendXXXX functions. Arglist Values SV_FNAME Type: char * Arg Function: TecUtilArgListAppendString() Required: Yes Notes: File to write to. SV_INCLUDECONTOURLEVELS Type: Boolean_t Arg Function: TecUtilArgListAppendInt() Default: TRUE Required: No Notes: Set to TRUE to include contour levels SV_INCLUDETEXT Type: Boolean_t Arg Function: TecUtilArgListAppendInt() Default: TRUE Required: No Notes: Set to TRUE to include text SV_INCLUDEAUXDATA Type: Boolean_t Arg Function: TecUtilArgListAppendInt() Default: TRUE Required: No Notes: Set to TRUE to include auxiliary data SV_INCLUDEGEOM Type: Boolean_t Arg Function: TecUtilArgListAppendInt() Default: TRUE Required: No Notes: Set to TRUE to include geometries SV_INCLUDEPLOTSTYLE Type: Boolean_t Arg Function: TecUtilArgListAppendInt() Default: TRUE Required: No Notes: -------------------------- SV_COMPRESS Type: Boolean_t Arg Function: TecUtilArgListAppendInt() Default: FALSE Required: No Notes: Set to TRUE to compress the stylesheet file SV_INCLUDESTREAMPOSITIONS Type: Boolean_t Arg Function: TecUtilArgListAppendInt() Default: TRUE Required: No Notes: Set to TRUE to include stream positions SV_INCLUDEFACTORYDEFAULTS Type: Boolean_t Arg Function: TecUtilArgListAppendInt() Default: FALSE Required: No Notes: Set to TRUE to include factory defaults SV_USERELITIVEPATHS Type: Boolean_t Arg Function: TecUtilArgListAppendInt() Default: TRUE Required: No Notes: Set to TRUE to save with relative paths for any image geometries in the frame

Returns:

TRUE if successfully, FALSE otherwise.

Precondition:

ArgList Argument list must be valid.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilWriteStylesheetX(ArgListPtr)
    POINTER (ArgListPtr, ArgList)

Python Syntax:

  Results = TecUtil.WriteStylesheetX(ArgList)

  Input:
                  ArgList              dictionary
  Output:
    Results[0]    ReturnVal            boolean

Save a stylesheet "temp.sty" with no text objects included:

   TecUtilArgListClear(ArgList);
   TecUtilArgListAppendString(ArgList,SV_FNAME,"temp.sty");
   TecUtilArgListAppendString(ArgList,SV_INCLUDETEXT,FALSE);
   IsOk = TecUtilWriteStyleSheetX(ArgList);