BBjCEdit::getHorizontalScrollable

Description

Returns whether a horizontal scroll bar will appear when the text is too large to fit within the BBjCEdit control area.

Syntax

Return Value	Method
int	getHorizontalScrollable()

Parameters

None.

Return Value

Returns whether a horizontal scroll bar will appear when the text is too large to fit within the control area (0 = No Horizontal Scroll Bar, 1 = Horizontal Scroll Bar).

Remarks

By default, the BBjCEdit control is not horizontally scrollable.

Example

rem 'Determine if custom edit box is to be horizontally scrollable

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 CEDIT control on the window
myCEdit! = myWindow!.addCEdit(101,30,100,140,30,"")

rem 'Create a BBjVector store paragraphs
myVector! = myAPI!.makeVector()

rem 'Add paragraphs to the BBjVector
FOR I = 1 TO 4
    PARAGRAPH$ = "This is paragraph " + STR(I)
    myVector!.addItem(PARAGRAPH$)
NEXT I

rem 'Add the paragraphs stored in the vector at index 0 to the CEDIT control
myCEdit!.addParagraphs(0,myVector!)

rem 'Set a custom edit box to be vertically scrollable
myCEdit!.setHorizontalScrollable(mySysGui!.TRUE)

rem 'Determine if custom edit box is to be vertically scrollable, this will return true (1)
SCROLLABLE = myCEdit!.getHorizontalScrollable()
PRINT "Scrollable ",SCROLLABLE

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