BBjStatusBar::getSegments

Description

Returns the segments of the BBjStatusBar control.

Syntax

Return Value

Method

BBjVector

getSegments()

Parameters

None.

Return Value

Returns a vector in which the number of elements in the vector is equal to the number of segments in the status bar. The value of each element in the vector is the ending position of each segment.

Remarks

None.

Example

rem 'Get the segments of a status bar control

rem 'Obtain the instance of the BBjAPI object
let myAPI! = BBjAPI()

rem 'Open the SysGui device
SYSGUI = UNT
OPEN (SYSGUI) "X0"

rem 'Obtain the instance of the BBjSysGui object
let mySysGui! = myAPI!.getSysGui()

rem 'Set addWindow param values
X = 10
Y = 10
WIDTH = 200
HEIGHT = 200
TITLE$ = "BBj Window"

rem 'Set the current context
mySysGui!.setContext(0)

rem 'Create a window
myWindow! = mySysGui!.addWindow(X,Y,WIDTH,HEIGHT,TITLE$)

rem 'Add a status bar on the window
myStatusBar! = myWindow!.addStatusBar(1)

rem 'Create a vector of segments
mySegmentVector! = myApi!.makeVector()

rem 'Create two segments for the status bar and set a value for the ending point
rem 'for each of the segments
mySegmentVector!.addItem(100)
mySegmentVector!.addItem(200)

rem 'Set the segments of the status bar
myStatusBar!.setSegments(mySegmentVector!)

rem 'Set the text of the two status bar segments
myStatusBar!.setTextAt(0, "Segment1")
myStatusBar!.setTextAt(1, "Segment2")

rem 'Get the segments of the status bar, this will return 2 elements in the
rem 'vector, whose values will begin 100 and 200 respectively.
myVector! = myStatusBar!.getSegments()

rem 'Register the CALLBACK routines
CALLBACK(ON_CLOSE,APP_CLOSE,mySysGui!.getContext())

rem 'Process Events
process_events

rem 'Callback routine called when the user closes the application window
APP_CLOSE:
release

See Also

BBjAPI

BBjSysGui

BBjControl

BBjWindow

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.