BBjSysGui

Description

A BBjSysGui object is an object that represents a SYSGUI channel, which is used to facilitate the creation and manipulation of custom graphical windows and controls in a GUI application.

Creation

BBjAPI > BBjSysGui

The BBjSysGui object is created through the following BBjAPI object method:

Return Value	Method
BBjSysGui	getSysGui()
BBjSysGui	openSysGui()

Methods of BBjSysGui

Return Value	Method
void	addImageList(int id, int width, BBjImage image)
BBjPopupMenu	addPopupMenu()
BBjTopLevelWindow	addWindow(int context, int x, int y, int width, int height, string title) addWindow(int context, int x, int y, int width, int height, string title, string flags) addWindow(int context, int x, int y, int width, int height, string title, string flags, string event_mask) addWindow(int x, int y, int width, int height, string title) addWindow(int x, int y, int width, int height, string title, string flags) addWindow(int x, int y, int width, int height, string title, string flags, string event_mask)
void	beep()
void	bufferWrites()
BBjPopupMenu	createPopupMenu(int resHandle, int popupMenuID)
BBjWindow	createTopLevelWindow(int resHandle, int windowID)
Object	executeScript(string script)
void	flushEvents()
void	flushWrites()
int	getActiveContext()
BBjWindow	getActiveWindow()
int	getAvailableContext()
int	getChannel()
int	getContext()
int	getDefaultScrollWheelBehavior()
BBjGeolocation	getGeolocation()
BBjImageManager	getImageManager()
BBjEvent	getLastEvent()
string	getLastEventString()
int	getMeasure()
BBjVector	getMeasures(BBjVector vector)
BBjBatch	getMessageBatch()
BBjPopupMenu	getPopupMenu(int ID)
int	getRepaintEnabled()
number	getScaleX()
number	getScaleY()
BBjSystemMetrics	getSystemMetrics()
BBjWindow	getWindow(int contextID) getWindow(string name)
void	injectScript(string script) injectScript(string script, boolean top)
BBjColor	makeColor(int colorNum) makeColor(int red, int green, int blue) makeColor(int red, int green, int blue, int alpha) makeColor(string colorName)
BBjFont	makeFont(string name, int size, int style)
void	playSoundData(string bytes) playSoundData(string bytes, boolean loop) playSoundData(string bytes, boolean loop, string mime)
void	playSoundFile(string filename) playSoundFile(string filename, boolean loop) playSoundFile(string filename, boolean loop, string mime)
void	playSoundUrl(string url) playSoundUrl(string url, boolean loop) playSoundUrl(string url, boolean loop, string mime)
void	removeImageList(int id)
void	resClose(int handle)
int	resOpen(string filename)
void	setContext(int context)
void	setDefaultScrollWheelBehavior(int mode)
void	setLookAndFeel(string lookAndFeel) –deprecated in BBj 5.0. Use the LF option documented in Running BBj from the Command Line
void	setRepaintEnabled(int mode)
void	setScale(number x, number y)

Events

Callback Code	Object-oriented Event	Read Record Event	Code
ON_ACTIVATE	BBjActivateEvent	Activation	A
ON_BUTTON_PUSH	BBjButtonPushEvent	Push Button	B
ON_CHECK_OFF	BBjCheckOffEvent	Check/Uncheck	c
ON_CHECK_ON	BBjCheckOnEvent	Check/Uncheck	c
ON_CLOSE	BBjCloseEvent	Window Close Box	X
ON_DOUBLE_CLICK	BBjDoubleClickEvent	Mouse Double-Click	2
ON_EDIT_KEYPRESS	BBjEditKeypressEvent	Edit Control Notify	N (Notify code 1)
ON_EDIT_MODIFY	BBjEditModifyEvent	Edit Control Modify Event	e
ON_GAINED_FOCUS	BBjGainedFocusEvent	Control Focus Gained/Lost	f
ON_KEYPRESS	BBjKeypressEvent	Keypress	t
ON_LIST_DOUBLE_CLICK	BBjListDoubleClickEvent	List Item Click	l (lower case L)
ON_MENU_ITEM_SELECT	BBjMenuItemSelect	Menu Selection	C
ON_MOUSE_DOWN	BBjMouseDownEvent	Mouse Button Down	d
ON_MOUSE_MOVE	BBjMouseMoveEvent	Mouse Move	m
ON_MOUSE_SCROLL	BBjScrollWheelEvent	Mouse Scroll Wheel	w
ON_MOUSE_UP	BBjMouseUpEvent	Mouse Button Up	u
ON_TOOL_BUTTON_PUSH	BBjToolButtonPushEvent	Tool Button Push	b
ON_WINDOW_GAINED_FOCUS	BBjWindowGainedFocusEvent	Window Focus Gained/Lost	F
ON_WINDOW_SCROLL	BBjWindowScrollEvent	Scrollbar Move	p

Remarks

The SYSGUI channel must be open before the getSysGui method will function properly.

Constants

Control Constants:
-1	UNKNOWN_CONTROL
0	WINDOW
1	MAIN_WINDOW
2	CHILD_WINDOW
3	MENU
4	SPECIAL_CONTROL
5	NATIVE_CONTROL
11	PUSHBUTTON_CONTROL
12	RADIOBUTTON_CONTROL
13	CHECKBOX_CONTROL
14	HSCROLL_CONTROL
15	VSCROLL_CONTROL
16	EDIT_CONTROL
17	TEXT_CONTROL
18	LISTBOX_CONTROL
19	LISTBUTTON_CONTROL
20	LISTEDIT_CONTROL
21	GROUPBOX_CONTROL
22	CEDIT_CONTROL
24	LINECHART_CONTROL
25	BARCHART_CONTROL
26	PIECHART_CONTROL
27	HTMLVIEW_CONTROL
28	MENUBUTTON_CONTROL
29	PRINTPREVIEW_CONTROL
30	GENERICCHART_CONTROL
31	WRAPPED_JCOMPONENT_CONTROL
100	MENUITEM_CONTROL
101	CHECKABLE_MENUITEM_CONTROL
102	STATUSBAR_CONTROL
103	TOOLBUTTON_CONTROL
104	INPUTE_CONTROL
105	INPUTN_CONTROL
106	TAB_CONTROL
107	GRID_CONTROL
108	IMAGE_CONTROL
109	TREE_CONTROL
110	DATAAWARE_GRID_CONTROL
112	PROGRESS_CONTROL
113	NAVIGATOR_CONTROL
114	INPUTD_CONTROL
115	NAMESPACE_CONTROL
116	GRID_HEADER_CONTROL
117	HSLIDER_CONTROL
118	VSLIDER_CONTROL
119	FILECHOOSER_CONTROL
120	COLORCHOOSER_CONTROL
121	FONTCHOOSER_CONTROL
122	DATABOUND_GRID_CONTROL
123	INPUTD_SPINNER_CONTROL
124	INPUTE_SPINNER_CONTROL
125	INPUTN_SPINNER_CONTROL
126	EDIT_SPINNER_CONTROL

Alignment Constants:
	ALIGN_LEFT
	ALIGN_RIGHT
	ALIGN_CENTER
Orientation Constants:
	HORIZONTAL
	VERTICAL
Menu Cut/Copy/Paste Constants:
32027	CUT
32028	COPY
32029	PASTE
Color Constants:
0	BLACK
1	BLUE
2	RED
3	MAGENTA
4	GREEN
5	CYAN
6	YELLOW
7	WHITE
8	DKGRAY
9	GRAY
10	LTGRAY
Scroll Behavior Constants:
0	DEFAULT
1	NEVER
2	FOCUS
3	MOUSE_OVER
4	FOCUS_AND_MOUSE_OVER
5	MOUSE_THEN_FOCUS
6	FOCUS_THEN_MOUSE

Example

Copy

BBjSysGui Example

REM Obtain the instance of the BBjSysGui object

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()