Paper and Page Management


Functions

Boolean_t TecUtilPageCreateNew (void)
  Creates a new page.
void TecUtilPageSetCurrentToNext (void)
  Changes the current page to the next one in the internal linked list of pages.
void TecUtilPageSetCurrentToPrev (void)
  Changes the current page to the previous one in the internal linked list of pages.
Boolean_t TecUtilPageSetCurrentByName (const char *PageName)
  Sets the current page to one matching the passed name.
Boolean_t TecUtilPageSetCurrentByUniqueID (UniqueID_t UniqueID)
  Sets the current page to one matching the passed unique ID.
void TecUtilPageDelete (void)
  Deletes the current page.
void TecUtilPageClear (void)
  Deletes all frames in the current page.
void TecUtilPaperGetDimensions (double *Width, double *Height)
  Get the dimensions of the currently defined paper in the Tecplot workspace.
LgIndex_t TecUtilPageGetCount (void)
  Returns the number of pages managed by Tecplot.
Boolean_t TecUtilPageGetName (char **PageName)
  Get the name of the current page.
UniqueID_t TecUtilPageGetUniqueID (void)
  Gets the unique ID for the current page.
LgIndex_t TecUtilPageGetPosByUniqueID (UniqueID_t UniqueID)
  Gets the position of the page specified by the unique ID relative to the current page.
SetValueReturnCode_e TecUtilPageSetName (const char *Name)
  Set the name for the current page.

Function Documentation

void TecUtilPageClear ( void   ) 

Deletes all frames in the current page.

Precondition:
Must have one or more pages.
Fortran Syntax:
    SUBROUTINE TecUtilPageClear()

Python Syntax:

  Results = TecUtil.PageClear()

  Output:
    Results[0]    ReturnVal            NONE

Since:
11.0-5-014

Boolean_t TecUtilPageCreateNew ( void   ) 

Creates a new page.

Returns:
TRUE is pages created successfully. Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilPageCreateNew()
Python Syntax:
  Results = TecUtil.PageCreateNew()

  Output:
    Results[0]    ReturnVal            boolean

Since:
11.0-5-014

void TecUtilPageDelete ( void   ) 

Deletes the current page.

Will set the next page from the internal linked list to be current.

Precondition:
Must have one or more pages.
Fortran Syntax:
    SUBROUTINE TecUtilPageDelete()

Python Syntax:

  Results = TecUtil.PageDelete()

  Output:
    Results[0]    ReturnVal            NONE

Since:
11.0-5-014

LgIndex_t TecUtilPageGetCount ( void   ) 

Returns the number of pages managed by Tecplot.

Since:
11.0-5-013
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilPageGetCount()

Python Syntax:

  Results = TecUtil.PageGetCount()

  Output:
    Results[0]    ReturnVal            int

Returns:
Number of pages managed by Tecplot.

Boolean_t TecUtilPageGetName ( char **  PageName  ) 

Get the name of the current page.

Parameters:
PageName Receives the name of the current page. You must free the returned string with TecUtilStringDealloc().
Returns:
TRUE if successful, FALSE if not.
Precondition:
Must have one or more pages.

PageName Pointer must be a valid address and non-NULL.

Fortran Syntax:
    INTEGER*4 FUNCTION TecUtili(
   &                   PageName,
   &                   PageNameLength)
    CHARACTER*(*)   PageName
    INTEGER*4       PageNameLength

Python Syntax:

  Results = TecUtil.PageGetName()

  Output:
    Results[0]    ReturnVal            boolean
    Results[1]    PageName             string

LgIndex_t TecUtilPageGetPosByUniqueID ( UniqueID_t  UniqueID  ) 

Gets the position of the page specified by the unique ID relative to the current page.

The page positions are 1 based positions relative to the current page where the current page has a position value of 1, the next page 2, the page after that 3, and so on. This function is Thread Safe.

Since:
11.3.28.867
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilPageGetPosByUniqueID(UniqueID)
    INTEGER*4 UniqueID

Python Syntax:

  Results = TecUtil.PageGetPosByUniqueID(UniqueID)

  Input:
                  UniqueID             long
  Output:
    Results[0]    ReturnVal            int

Returns:
The 1-based position of the page specified by the unique ID relative to the current page. Zero is returned if no page exists for the supplied unique ID.
See also:
For an example of its use see TecUtilSaveLayoutX().

UniqueID_t TecUtilPageGetUniqueID ( void   ) 

Gets the unique ID for the current page.

A unique ID is an integer value unique to a page during the Tecplot session. Using the unique ID a page can be compared to other pages and manipulated via TecUtil calls that take unique IDs. This function is Thread Safe.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPageGetUniqueID()

Python Syntax:

  Results = TecUtil.PageGetUniqueID()

  Output:
    Results[0]    ReturnVal            long

Returns:
The unique ID for the current page.
Precondition:
Must have one or more pages.

Boolean_t TecUtilPageSetCurrentByName ( const char *  PageName  ) 

Sets the current page to one matching the passed name.

Parameters:
PageName the name of the page to be set as the current.
Returns:
TRUE is a page was found for the passed name.
Precondition:
PageName String must have a valid address and non-zero length.
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilPageSetCurrentByName(PageName)
    CHARACTER*(*) PageName

Python Syntax:

  Results = TecUtil.PageSetCurrentByName(PageName)

  Input:
                  PageName             string
  Output:
    Results[0]    ReturnVal            boolean

Since:
11.0-5-014

Boolean_t TecUtilPageSetCurrentByUniqueID ( UniqueID_t  UniqueID  ) 

Sets the current page to one matching the passed unique ID.

Parameters:
UniqueID ID of the page to be set as the current.
Returns:
TRUE is a page was found for the passed ID.
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilPageSetCurrentByUniqueID(UniqueID)
    POINTER         (ValuePtr, UniqueID)

Python Syntax:

  Results = TecUtil.PageSetCurrentByUniqueID(UniqueID)

  Input:
                  UniqueID             long
  Output:
    Results[0]    ReturnVal            boolean

Since:
11.0-5-014

void TecUtilPageSetCurrentToNext ( void   ) 

Changes the current page to the next one in the internal linked list of pages.

Precondition:
Must have one or more pages.
Fortran Syntax:
    SUBROUTINE TecUtilPageSetCurrentToNext()

Python Syntax:

  Results = TecUtil.PageSetCurrentToNext()

  Output:
    Results[0]    ReturnVal            NONE

Since:
11.0-5-014

void TecUtilPageSetCurrentToPrev ( void   ) 

Changes the current page to the previous one in the internal linked list of pages.

Precondition:
Must have one or more pages.
Fortran Syntax:
    SUBROUTINE TecUtilPageSetCurrentToPrev()

Python Syntax:

  Results = TecUtil.PageSetCurrentToPrev()

  Output:
    Results[0]    ReturnVal            NONE

Since:
11.0-5-014

SetValueReturnCode_e TecUtilPageSetName ( const char *  Name  ) 

Set the name for the current page.

Parameters:
Name Name to assign to the current page.
Returns:
The setvalue return code (of type SetValueReturnCode_e).
Precondition:
Name Pointer must be a valid address and non-NULL.
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilPageSetName(Name)
    CHARACTER*(*) Name

Python Syntax:

  Results = TecUtil.PageSetName(Name)

  Input:
                  Name                 string
  Output:
    Results[0]    ReturnVal            SetValueReturnCode_e  (defined in TecVals.py)

Since:
11.0-5-014

void TecUtilPaperGetDimensions ( double *  Width,
double *  Height 
)

Get the dimensions of the currently defined paper in the Tecplot workspace.

Parameters:
Width Width of the paper (in inches).
Height Height of the paper (in inches).
Precondition:
Width Pointer must be a valid address and non-NULL.

Height Pointer must be a valid address and non-NULL.

Fortran Syntax:
    SUBROUTINE TecUtilPaperGetDimensions(
   &           Width,
   &           Height)
    REAL*8          Width
    REAL*8          Height

Python Syntax:

  Results = TecUtil.PaperGetDimensions()

  Output:
    Results[0]    Width                double
    Results[1]    Height               double

Get the current paper's position and size:

   double width, height;
   TecUtilPaperGetDimensions(&width, &height);

Generated on Tue Mar 12 02:24:42 2013 for Tecplot by  doxygen 1.5.5