EasyTab_GetBounds

int EasyTab_GetBounds (int panel, int tabControl, int whichBounds, Rect *bounds);

Purpose

This function gets the size and location of a Tab control.

Parameters

Input
Name Type Description
panel integer The specifier for a particular panel that is currently in memory.

This handle will have been returned by the LoadPanel, NewPanel, or DuplicatePanel function.
tabControl integer The ID returned by the EasyTab_Create or EasyTab_ConvertFromCanvas function.
whichBounds integer Specifies whether to retrieve the size and position of

  • the interior panel area, excluding the tabs and frame, or
  • the entire control, including the tabs and the frame.

If VAL_EASY_TAB_INTERIOR_BOUNDS is specified, the size and position of the panel area (excluding the tabs and frame) is returned.

If VAL_EASY_TAB_EXTERIOR_BOUNDS is specified, the size and position of the tab control exterior bounding rectangle (including the tabs and frame) is returned.
Output
Name Type Description
bounds Rect * The Rect structure that is set to the location and size of the Tab control.

The Rect structure is defined (in userint.h) as follows:

typedef struct
{
   int top;
   int left;
   int height;
   int width;
} Rect;

Return Value

Name Type Description
status integer Return value indicating whether the function was successful. A negative number indicates that an error occurred.

The possible negative error codes are:
Return Values: 0   Success
–1 to –999 A User Interface Library error code. (constants are available in userint.h)
–5000 to –5499 A Toolbox instrument driver error code. (Constants are available in toolbox.h.)

A description of any of these error codes can be obtained using the GetGeneralErrorString function in the toolbox.fp instrument driver.