vfoGRGetQueuePointer

vfoGRGetQueuePointer(
t_qName
)
=> t_qPointer

Description

Returns the pointer corresponding to the name of the queue of the customized Create Guard Ring form.

In the Create Guard Ring form, there are multiple global lists that enable you to add various form components. The global list (also called queue) defines the set of form components that are displayed on all four tabs (Wrap, Path, Rect, and Polygon) of this form.

In addition, the following five queues exist in the Create Guard Ring form where you can add your own fields during form customization: Common, Wrap, Path, Rect, and Polygon.

Any field added in the common queue is visible in all the tabs of the Create Guard Ring form. To add a GUI component to only a specific tab of the Create Guard Ring form, use one the following lists, as needed:

• vfoGRAddFieldsInPathTabQ (use for the Path tab)
• vfoGRAddFieldsInRectTabQ (use for the Rect tab)
• vfoGRAddFieldsInPolygonTabQ (use for the Polygon tab)
• vfoGRAddFieldsInWrapTabQ (use for the Wrap tab)
• vfoGRAddFieldsInCommonQ (use for making a field visible in all tabs)

Arguments

t_qName

A single string argument that can have any one of the following values: "commonQ", "wrapTabQ", "pathTabQ", "rectTabQ", or "polygonTabQ".

Value Returned

t_qPointer

The queue pointer in form of a string that needs to be evaluated before using.

Example

qPtr = evalstring(eval(vfoGRGetQueuePointer("wrapTabQ")))

     qPtr~>grWrapCommon~>value //returns the value of Wrap Common field

     qPtr->grPathWidth->value //returns the value of the Path Width field.

Here, qPtr has been used to retrieve the value of Wrap Common and Path Width fields that exist on the Wrap tab. It will also get the other properties, such as whether the field is in visible or invisible state, or it is an editable or non-editable field.

Return to top