PANORAMIC: USER's GUIDE

FOR THE VERSION 0.9.27

PART 2 - SYSTEM OBJECTS

MAIN PAGE / DOCUMENTATION


1 - CREATION OF SYSTEM OBJECTS

2 COMMANDS ON CREATED SYSTEM OBJECTS


1 - CREATION OF SYSTEM OBJECTS

A system object is an object created by the Operating System (Microsoft Windows).

There are 2 kinds of system objects: visible and invisible objects.

A system object is designated by a number from 1 to 9999.

to the top

1.1 Creation of classical system objects

ALPHA N

Creates an object ALPHA and gives it number N as reference.

An object ALPHA is used to display a static text that the user cannot change (with command CAPTION).

Specific command on an ALPHA:

- Displays a text: CAPTION
- Reads the displayed text: CAPTION$()
- Executes something when it is clicked: ON_CLICK
- Executes something when it is double-clicked: ON_DOUBLE_CLICK
- Executes something when a key of mouse is pressed: ON_MOUSE_DOWN
- Executes something when a key of mouse is released: ON_MOUSE_UP
- Executes something when the mouse is moved: ON_MOUSE_MOVE

BUTTON N

Creates an object BUTTON and gives it number N as reference.

An object BUTTON is used to initiate commands (with command ON_CLICK or with the function CLICKED) when it is clicked.

Specific command on a BUTTON:

- Displays a text: CAPTION
- Reads the displayed text: CAPTION$()
- Executes something when it is clicked: ON_CLICK
- Executes something when a key is pressed: ON_KEY_DOWN
- Executes something when a key is released: ON_KEY_UP
- Executes something when a key of mouse is pressed: ON_MOUSE_DOWN
- Executes something when a key of mouse is released: ON_MOUSE_UP
- Executes something when the mouse is moved: ON_MOUSE_MOVE

FORM N

Creates an object FORM and gives it number N as reference.

An object FORM is used to display a window with components (other system objects).

Specific commands on a FORM:

- Displays a text: CAPTION
- Reads the displayed text: CAPTION$()
- Modifies the border: BORDER_HIDE, BORDER_SMALL, BORDER_NORMAL
- Executes something when it is clicked: ON_CLICK
- Executes something when it is double-clicked: ON_DOUBLE_CLICK
- Executes something when a key is pressed: ON_KEY_DOWN
- Executes something when a key is released: ON_KEY_UP
- Executes something when a key of mouse is pressed: ON_MOUSE_DOWN
- Executes something when a key of mouse is released: ON_MOUSE_UP
- Executes something when the mouse is moved: ON_MOUSE_MOVE

- Executes something when it is closed: ON_CLOSE
- Executes something when it is moved: ON_MOVE
- Executes something when it is resized: ON_RESIZE

GRID N

Creates an object GRID and gives it number N as reference.

An object GRID is a table of cells organized in row and colums.

Specific commands on a GRID:

- Reads a value: GRID_READ$()
- Writes a value: GRID_WRITE
- Set the column number: GRID_COLUMN
- Set the column width: GRID_COLUMN_WIDTH

- Set one column width: GRID_ONE_COLUMN_WIDTH
- The columns can be manually resized: GRID_COLUMN_SIZING_ON
- The columns cannot be manually resized: GRID_COLUMN_SIZING_OFF
- Set the fixed column number: GRID_COLUMN_FIXED
- Set the row number
: GRID_ROW
- Set the line height: GRID_ROW_HEIGHT
- Set one line height: GRID_ONE_ROW_HEIGHT
- The rows can be manually resized: GRID_COLUMN_SIZING_ON
- The rows cannot be manually resized: GRID_COLUMN_SIZING_OFF

-
Set the fixed row number: GRID_ROW_FIXED
- Changes the fixed part color : GRID_FIXED_COLOR
- Executes something when it is clicked: ON_CLICK
- Executes something when it is double-clicked: ON_DOUBLE_CLICK
- Executes something when a key of mouse is pressed: ON_MOUSE_DOWN
- Executes something when a key of mouse is released: ON_MOUSE_UP
- Executes something when the mouse is moved: ON_MOUSE_MOVE

MEMO N

Creates an object MEMO and gives it number N as reference.

An object MEMO is used to display an area where the user can enter or modify multiple lines of text.

Specific commands on a MEMO:

- Get the number of items: COUNT()
- Adds an item: ITEM ADD
- Adds a file: FILE_ADD
- Loads a file: FILE_LOAD
- Saves items to a file: FILE_SAVE
- Inserts an item: ITEM_INSERT
- Deletes an item: ITEM_DELETE
- Reads an item: ITEM_READ$()
- Assigns an horizontal scroll bar: BAR_HORIZONTAL
- Assigns a vertical scroll bar: BAR_VERTICAL
- Assigns horizontal and vertical scroll bars: BAR_BOTH
- Removes all the scroll bars: BAR_NONE
- Makes the text secret : SECRET_ON
- Makes the text readable : SECRET_OFF
- Selects a text : SELECT_TEXT
- Reads the selected text : SELECT_READ$
- Place the caret : CARET_POSITION
- Executes something when it is clicked: ON_CLICK
- Executes something when it is double-clicked: ON_DOUBLE_CLICK
- Executes something when it is changed: ON_CHANGE
- Executes something when a key is pressed: ON_KEY_DOWN
- Executes something when a key is released: ON_KEY_UP
- Executes something when a key of mouse is pressed: ON_MOUSE_DOWN
- Executes something when a key of mouse is released: ON_MOUSE_UP
- Executes something when the mouse is moved: ON_MOUSE_MOVE

SPIN N

Creates an object SPIN and gives it number N as reference.

An object SPIN is used to display an integer value and to provide a mean to quickly increment or decrement this value.

Specific commands on a SPIN:

- Reads the value: POSITION()
- Set a value: POSITION
- Set the minimum value: MIN
- Set the maximum value: MAX
- Selects a text : SELECT_TEXT
- Reads the selected text : SELECT_READ$
- Place the caret : CARET_POSITION

- Executes something when it is clicked: ON_CLICK
- Executes something when it is double-clicked: ON_DOUBLE_CLICK
- Executes something when a key of mouse is pressed: ON_MOUSE_DOWN
- Executes something when a key of mouse is released: ON_MOUSE_UP
- Executes something when the mouse is moved: ON_MOUSE_MOVE

to the top

1.2 - Creation of List system objects

COMBO N

Creates an object COMBO and gives it number N as reference.

An object COMBO is used to combine features of EDIT and LIST: a list of choices is displayed, the user can type a text or select an item of the list.

Specific commands on a COMBO:

- Displays a text: TEXT
- Reads the text entered by user: TEXT$()
- Get the number of items: COUNT()
- Adds a text file: FILE_ADD
- Loads a text file: FILE_LOAD
- Saves items to a text file: FILE_SAVE
- Adds an item: ITEM ADD
- Inserts an item: ITEM_INSERT
- Deletes an item: ITEM_DELETE
- Reads an item: ITEM_READ$()
- Reads the item selected by user: ITEM_INDEX$()
- Reads the idex of item selected by user: ITEM_INDEX()
- Clears all: CLEAR
- Adds the list of available fonts: FONT_NAMES_ADD
- Loads the list of available fonts: FONT_NAMES_LOAD
- Selects a text : SELECT_TEXT
- Reads the selected text : SELECT_READ$
- Place the caret : CARET_POSITION

- Executes something when it is clicked: ON_CLICK
- Executes something when it is double-clicked: ON_DOUBLE_CLICK
- Executes something when it is changed: ON_CHANGE
- Executes something when a key is pressed: ON_KEY_DOWN
- Executes something when a key is released: ON_KEY_UP

DLIST N

Creates an object DLIST and gives it number N as reference.

An object DLIST object is not visible. It is used to treat a list of items (strings).

Specific commands on a DLIST:

- Get the number of items: COUNT()
- Adds a text file: FILE_ADD
- Loads a text file: FILE_LOAD
- Saves items to a text file: FILE_SAVE
- Adds an item: ITEM ADD
- Inserts an item: ITEM_INSERT
- Deletes an item: ITEM_DELETE
- Reads an item: ITEM_READ$()
- Clears all: CLEAR
- Adds the list of available fonts: FONT_NAMES_ADD
- Loads the list of available fonts: FONT_NAMES_LOAD

EDIT N

Creates an object EDIT and gives it number N as reference.

An object EDIT is used to display an area where the user can enter or modify a single line of text.

Specific commands on an EDIT:

- Displays a text: TEXT
- Reads the text entered by user: TEXT$()
- Clears all: CLEAR
- Adds the list of available fonts: FONT_NAMES_ADD
- Loads the list of available fonts: FONT_NAMES_LOAD
- Selects a text : SELECT_TEXT
- Reads the selected text : SELECT_READ$
- Place the caret : CARET_POSITION

- Executes something when it is clicked: ON_CLICK
- Executes something when it is double-clicked: ON_DOUBLE_CLICK
- Executes something when it is changed: ON_CHANGE
- Executes something when a key is pressed: ON_KEY_DOWN
- Executes something when a key is released: ON_KEY_UP
- Executes something when a key of mouse is pressed: ON_MOUSE_DOWN
- Executes something when a key of mouse is released: ON_MOUSE_UP
- Executes something when the mouse is moved: ON_MOUSE_MOVE

LIST N

Creates an object LIST and gives it number N as reference.

An object LIST is used to display a list of choices from which the user can select one item.

Specific commands on a LIST:

- Get the number of items: COUNT()
- Adds a text file: FILE_ADD
- Loads a text file: FILE_LOAD
- Saves items to a text file: FILE_SAVE
- Adds an item: ITEM ADD
- Inserts an item: ITEM_INSERT
- Deletes an item: ITEM_DELETE
- Reads an item: ITEM_READ$()
- Reads the item selected by user: ITEM_INDEX$()
- Reads the index of item selected by user: ITEM_INDEX()
- Clears all: CLEAR
- Adds the list of available fonts: FONT_NAMES_ADD
- Loads the list of available fonts: FONT_NAMES_LOAD
- Executes something when it is clicked: ON_CLICK
- Executes something when it is double-clicked: ON_DOUBLE_CLICK
- Executes something when a key is pressed: ON_KEY_DOWN
- Executes something when a key is released: ON_KEY_UP
- Executes something when a key of mouse is pressed: ON_MOUSE_DOWN
- Executes something when a key of mouse is released: ON_MOUSE_UP
- Executes something when the mouse is moved: ON_MOUSE_MOVE

to the top

1.3 - Creation of system objects SCENE2D and SCENE3D

SCENE2D N

Creates an object SCENE2D and gives it number N as reference.

An object SCENE2D is used to display a picture used as background for SPRITEs.

Specific commands on a SCENE2D:

- Reads mouse position: MOUSE_X_POSITION(), MOUSE_Y_POSITION()
- to make it "target" of SPRITEs: SPRITE_TARGET_IS
- Executes something when it is clicked: ON_CLICK
- Executes something when a key of mouse is pressed: ON_MOUSE_DOWN
- Executes something when a key of mouse is released: ON_MOUSE_UP
- Executes something when the mouse is moved: ON_MOUSE_MOVE

SCENE3D N

Creates an object SCENE3D and gives it number N as reference.

An object SCENE3D is used to handle a 3D world with a light, a camera, and 3D objects which can be animated, moved, rotated, scaled, colored, textured, deleted, hidden, showed, ...

Specific commands on a SCENE3D:

- Hides or shows the 3D axes: AXES_HIDE, AXES_SHOW
- Reads mouse position: MOUSE_X_POSITION(), MOUSE_Y_POSITION()
- Executes something when it is clicked: ON_CLICK
- Executes something when it is double-clicked: ON_DOUBLE_CLICK
- Executes something when a key of mouse is pressed: ON_MOUSE_DOWN
- Executes something when a key of mouse is released: ON_MOUSE_UP
- Executes something when the mouse is moved: ON_MOUSE_MOVE

to the top

1.4 - Creation of Multimedia system objects

HVIEWER N

Creates an object HVIEWER and gives it number N as reference.

An object HVIEWER is used to display a HTML formatted file (with command FILE_LOAD).

Specific commands on a HVIEWER:

- Loads a file: FILE_LOAD

IMAGE N

Creates an object IMAGE and gives it number N as reference.

An object MOVIE is used to play a multimedia video.

Specific commands on a MOVIE:

- Loads a file: FILE_LOAD
- Grabs a part of screen: 2D_IMAGE_COPY
- Pastes on the screen: 2D_IMAGE_PASTE
- Uses as
SPRITE picture : SPRITE_IMAGE_LOAD
- Uses as texture of 3D object: 3D_IMAGE_TEXTURE

MOVIE N

Creates an object MOVIE and gives it number N as reference.

An object MOVIE is used to play a multimedia video.

Specific commands on a MOVIE:

- Loads a file: FILE_LOAD
- Plays the movie: PLAY

PICTURE N

Creates an object PICTURE and gives it number N as reference.

An object PICTURE is used to display a bitmap file BMP or JPG (with command FILE_LOAD).

Specific commands on a PICTURE:

- Loads a file: FILE_LOAD
- Reads mouse position: MOUSE_X_POSITION(), MOUSE_Y_POSITION()
- Executes something when it is clicked: ON_CLICK
- Executes something when it is double-clicked: ON_DOUBLE_CLICK
- Executes something when a key of mouse is pressed: ON_MOUSE_DOWN
- Executes something when a key of mouse is released: ON_MOUSE_UP
- Executes something when the mouse is moved: ON_MOUSE_MOVE

SOUND N

Creates an object SOUND and gives it number N as reference.

An object SOUND is used to play a sound file (WAV, MP3)

A SOUND is a non-visible object.

Specific commands on a SOUND:

- Loads a file: FILE_LOAD
- Plays the sound: PLAY

to the top

1.5 Creation of Choice system objets

CHECK N

Creates an object CHECK and gives it number N as reference.

An object CHECK is used to present a binary choice to the user (Yes/No, True,/False, On/Off, ...).

Specific commands on a CHECK:

- Displays a text: CAPTION
- Reads the displayed text: CAPTION$()
- Reads the state: CHECKED()
- Checks it: MARK_ON
- Unchecks it: MARK_OFF
- Executes something when it is clicked: ON_CLICK
- Executes something when a key is pressed: ON_KEY_DOWN
- Executes something when a key is released: ON_KEY_UP
- Executes something when a key of mouse is pressed: ON_MOUSE_DOWN
- Executes something when a key of mouse is released: ON_MOUSE_UP
- Executes something when the mouse is moved: ON_MOUSE_MOVE

OPTION N

Creates an object OPTION and gives it number N as reference.

An object OPTION is used to display a choice with other Options where only one is available (only one OPTION is valid at any time).

Specific commands on an OPTION:

- Displays a text: CAPTION
- Reads the displayed text: CAPTION$()
- Reads the state: CHECKED()
- Checks it: MARK_ON
- Unchecks it: MARK_OFF
- Executes something when it is clicked: ON_CLICK
- Executes something when it is double-clicked: ON_DOUBLE_CLICK
- Executes something when a key is pressed: ON_KEY_DOWN
- Executes something when a key is released: ON_KEY_UP
- Executes something when a key of mouse is pressed:
ON_MOUSE_DOWN
- Executes something when a key of mouse is released: ON_MOUSE_UP
- Executes something when the mouse is moved: ON_MOUSE_MOVE

to the top

1.6 - Creation of Menu system objects

MAIN_MENU N

Creates a MAIN_MENU invisible object and gives it number N as reference.

An object MAIN_MENU is used to design a menu bar and its accompanying drop-down menus (with command SUB_MENU) on a form.

SUB_MENU N

Creates an object SUB_MENU and gives it number N as reference.

An object SUB_MENU is used to design the derivate drop-down menus of a MAIN_MENU on a FORM.

Specific commands on a SUB_MENU:

- Displays a text: CAPTION
- Reads the displayed text: CAPTION$()
- Executes something when it is clicked: ON_CLICK

to the top

1.7 Creation of Bar system objects

PROGRESS_BAR N

Creates an object PROGRESS_BAR and gives it number N as reference.

An object PROGRESS_BAR is used to display a progress indicator through a range.

Specific commands on a PROGRESS_BAR:

- Reads the bar position: POSITION()
- Set the position: POSITION
- Set the minimum value: MIN
- Set the maximum value: MAX
- Put it vertically or horizontally: VERTICAL, HORIZONTAL
- Executes something when a key of mouse is pressed: ON_MOUSE_DOWN
- Executes something when a key of mouse is released: ON_MOUSE_UP
- Executes something when the mouse is moved: ON_MOUSE_MOVE

SCROLL_BAR N

Creates an object SCROLL_BAR and gives it number N as reference.

An object SCROLL_BAR is used to move a value by increments through a range defined by MIN and MAX, with a square cursor.

Specific commands on a SCROLL_BAR:

- Reads the bar position: POSITION()
- Set the position: POSITION
- Set the minimum value: MIN
- Set the maximum value: MAX
- Put it vertically or horizontally: VERTICAL, HORIZONTAL
- Executes something when it is changed: ON_CHANGE

TRACK_BAR N

Creates an object TRACK_BAR and gives it number N as reference.

An object TRACK_BAR is used to move a value by increments through a range defined by MIN and MAX.

Specific commands on a TRACK_BAR:

- Reads the bar position: POSITION()
- Set the position: POSITION
- Set the minimum value: MIN
- Set the maximum value: MAX
- Put it vertically or horizontally: VERTICAL, HORIZONTAL
- Executes something when it is changed: ON_CHANGE

to the top

1.8 Creation of Dialog system objects

These objects are not visible.

OPEN_DIALOG N

Creates an object OPEN_DIALOG and gives it number N as reference.

An object OPEN_DIALOG is used to open a file loading box, which allows to choose a file name with the function FILE_NAME$().

Specific command on an OPEN_DIALOG:

- Reads the name of the file chosen by user: FILE_NAME$()

Remark: calling the function FILE_NAME$ is the only mean to launch an OPEN_DIALOG.

SAVE_DIALOG N

Creates an object SAVE_DIALOG and gives it number N as reference.

An object SAVE_DIALOG is used to open a file saving box, which allows to choose a file name with function FILE_NAME$().

Specific command on a SAVE_DIALOG:

- Reads the name of the file chosen by user: FILE_NAME$()

Remark: calling the function FILE_NAME$ is the only mean to launch a SAVE_DIALOG.

to the top

1.9 Creation of a Timer

This object is not visible.

TIMER N

Creates an object TIMER and gives it number N as reference.

An object TIMER is used to execute periodically a subroutine.

Specific command on a TIMER:

- Executes a subroutine when it triggers: ON_TIMER
-
Makes it active: TIMER_ON
- Makes it inactive: TIMER_OFF
- Makes all the TIMERs inactive: TIMER_OFF_ALL
- Changes the triggering period: TIMER_INTERVAL

to the top

1.10 Creation of Container system objects

CONTAINER N

Creates an object CONTAINER and gives it number N as reference.

An object CONTAINER is used to contain system objects. It has a line as border.

Specific command on a CONTAINER:

- Include a system object: PARENT
- Displays a text:
CAPTION
- Reads the displayed text: CAPTION$()
- Executes something when it is clicked: ON_CLICK
- Executes something when it is double-clicked: ON_DOUBLE_CLICK
- Executes something when a key of mouse is pressed: ON_MOUSE_DOWN
- Executes something when a key of mouse is released: ON_MOUSE_UP
- Executes something when the mouse is moved: ON_MOUSE_MOVE

CONTAINER_OPTION N

Creates an object CONTAINER_OPTION and gives it number N as reference.

An object CONTAINER_OPTION contains only OPTIONs. These OPTIONs are then automatically grouped: when the user checks an OPTION, all other OPTIONs become unchecked. Two OPTIONs cannot be checked at the same time. An OPTION belongs to a CONTAINER_OPTION through the command PARENT.

Specific commands on a CONTAINER_OPTION:

- Displays a text: CAPTION
- Reads the displayed text: CAPTION$()
- Executes something when it is clicked: ON_CLICK
- Executes something when it is double-clicked: ON_DOUBLE_CLICK

PANEL N

Creates an object PANEL and gives it number N as reference.

An object PANEL can contain system objects. It has no border.

Specific command on a PANEL:

- Displays a text: CAPTION
- Reads the displayed text: CAPTION$()
- Executes something when it is clicked: ON_CLICK
- Executes something when it is double-clicked: ON_DOUBLE_CLICK
- Executes something when a key of mouse is pressed: ON_MOUSE_DOWN
- Executes something when a key of mouse is released: ON_MOUSE_UP
- Executes something when the mouse is moved: ON_MOUSE_MOVE

CONTAINER_TAB N

Creates an object CONTAINER_TAB and gives it number N as reference.

An object CONTAINER_TAB is used to contain only TABs.

Specific command on a CONTAINER_TAB:

- Include a system object TAB : PARENT
- Executes something when a key of mouse is pressed: ON_MOUSE_DOWN
- Executes something when a key of mouse is released: ON_MOUSE_UP
- Executes something when the mouse is moved: ON_MOUSE_MOVE

TAB N

Creates an object TAB and gives it number N as reference.

An object TAB belongs to a CONTAINER_TAB.

Specific command on a TAB:

- Include a system object: PARENT
- Displays a text:
CAPTION
- Displays a TAB of CONTAINER_TAB : MARK_ON
- Reads the displayed text: CAPTION$()
- Check if a TAB is displayed or not: CHECKED()
- Number of displayed TAB : NUMBER_SHOW
- Executes something when it is shown: ON_SHOW
- Executes something when a key of mouse is pressed: ON_MOUSE_DOWN
- Executes something when a key of mouse is released: ON_MOUSE_UP
- Executes something when the mouse is moved: ON_MOUSE_MOVE

to the top

1.11 - Size of created system objects

When it is created, a visible system object takes a standard size:

OBJECT WIDTH HEIGHT
ALPHA
65
17
BUTTON
75
25
CHECK
97
17
COMBO
145
21
CONTAINER
185
105
CONTAINER_OPTION
185
105
CONTAINER_TAB
289
193
EDIT
121
21
FORM
320
240
GRID
320
120
HVIEWER
185
105
LIST
121
97
MEMO
185
89
MOVIE
100
80
OPTION
113
17
PANEL
185
105
PICTURE
105
105
PROGRESS_BAR
150
17
SCENE2D
200
200
SCENE3D
200
200
SCROLL_BAR
121
17
SPIN
121
22
TRACK_BAR
150
45

Remark: the size of a system object can be modified by commands WIDTH and HEIGHT

to the top

1.12 - Parameters of created Bar objects

When it is created, a bar has standard parameters:

BAR OBJECT MIN MAX POSITION
PROGRESS_BAR
0
100
0
SCROLL_BAR
0
100
0
TRACK_BAR
0
10
0

 Remark: the parameters can be modified by commands MIN, MAX and POSITION

to the top

1.13 - Number of system objects

NUMBER_OBJECTS Returns the number of system objects.

to the top

1.14 - Number of particular system objects

NUMBER_PRINT_TARGET

Returns the system object number which is the print "target".

NUMBER_2D_TARGET

Returns the system object number which is the 2D commands "target".

NUMBER_COMMAND_TARGET

Returns the system object number which is the commands "target".

NUMBER_INPUT_SOURCE

Returns the system object number which is the input "source".

NUMBER_SPRITE_TARGET

Returns the system object number which is the SPRITE commands "target".

NUMBER_3D_TARGET

Returns the system object number which is the 3D commands "target".

NUMBER_ACTIVATE

Returns the system object number (FORM) which is activated.

NUMBER_SHOW

Returns the system object number (FORM) which is shown.

OBJECT_INTERNAL(N)

Returns the internal number of the system object number N.

to the top


2 COMMANDS ON CREATED SYSTEM OBJECTS

Most of the commands use the associated number of an object.

2.1 - Common commands

2.1.1 - Position

TOP N, V Positions top edge of the object number N at V pixels from its parent (the container).
LEFT N, V Positions left edge of the object number N at V pixels from its parent (the container).

to the top

2.1.2 - Size

HEIGHT N, V Set height of the object number N to V pixels.
WIDTH N, V Set width of the object number N to V pixels.

to the top

2.1.3 - Activity

ACTIVE N Makes object number N active.
INACTIVE N Makes object number N inactive.

to the top

2.1.4 - Visibility

HIDE N Makes object number N invisible.
SHOW N Makes object number N visible.
HIDE_ALL Makes all the objects invisible.
SHOW_ALL Makes all the objects visible.
SHOW_MODAL N Displays the FORM number N and makes it modal.
CREATE_HIDE The created objects will be invisible.
CREATE_SHOW The created objects will be visible.

to the top

2.1.5 - Hint

HINT N, T Enables hint text T of the object number N.
HINT_HIDE N Disables hint text of the object number N.

to the top

2.1.6 Various commands

COLOR N, R, G, B Set color (by combining values of Red, Green, Blue) of the object number N.
DELETE N Deletes the object number N.
DELETE_ALL Deletes all the objects.
FULL_SPACE N Object number N takes all the available space.
PARENT N, M Links the object number M as father of the object number N.

to the top

2.1.7 - Events

An event is an alteration done on a system object, per example when the user clicks on a button.
In the case an event occurs, a part of the program may be executed automatically.
The part of the program to be executed must begin by a LABEL and must end by the keyword RETURN.

Event activation

ON_ACTIVATE N,L Executes the program from label L when the system object number N (FORM) is activated.
ON_CLICK N,L Executes the program from label L when the system object number N is clicked.
ON_CLOSE N,L Executes the program from label L when the system object number N (FORM) is closed.
ON_CHANGE N,L Executes the program from label L when the system object number N is changed.
ON_DOUBLE_CLICK N,L Executes the program from label L when the system object number N is double-clicked.
ON_KEY_DOWN N,L Executes from L when the user presses any key, system object number N being focused.
ON_KEY_UP N,L Executes from L when the user releases any key, system object number N being focused.
ON_SHOW N,L Executes the program from label L when the system object number N (FORM) is shown.
ON_TIMER N,L Executes the program from label L when the system object TIMER number N is triggered.
ON_MOUSE_DOWN N,L Executes the program from label L when the user presses a key of the mouse on the system object number N.
ON_MOUSE_UP N,L Executes the program from label L when the user releases a key of the mouse on the system object number N.
ON_MOUSE_MOVE N,L Executes the program from label L when the user moves the mouse on the system object number N.
ON_MOVE N,L Executes the program from label L when the user moves the system object number N (FORM).
ON_RESIZE N, Executes the program from label L when the user resizes the system object number N (FORM).
ON_USER_EVENT L Executes the program from label L when a user event is triggered.
USER_EVENT_LPARAM Data "long" associated to a user event.
USER_EVENT_WPARAM Data "word" associated to a user event.

Event deactivation

OFF_ACTIVATE N Ignores the event "activate" when the system object number N (FORM) is activated.
OFF_CLICK N Ignores the event "click" when the system object number N is clicked.
OFF_CLOSE N Ignores the event "close" when the system object number N (FORM) is closed.
OFF_CHANGE N Ignores the event "change" when the system object number N is changed.
OFF_DOUBLE_CLICK N Ignores the event "double_click" when the system object number N is double-clicked.
OFF_KEY_DOWN N Ignores the event "key_down" when the user presses any key, system object number N being focused.
OFF_KEY_UP N Ignores the event "key_up" when the user releases any key, system object number N being focused.
OFF_SHOW N Ignores the event "show" when the system object number N (FORM) is shown.
OFF_MOUSE_DOWN N Ignores the event "mouse_down" when the user presses a key of the mouse on the system object number N.
OFF_MOUSE_UP N Ignores the event "mouse_up" when the user releases a key of the mouse on the system object number N.
OFF_MOUSE_MOVE N Ignores the event "mouse_move" when the user moves the mouse on the system object number N.
OFF_MOVE N Ignores the event "move" when the user moves the system object number N (FORM).
OFF_RESIZE N

Ignores the event "resize" when the user resizes the system object number N (FORM).

OFF_USER_EVENT Ignores the user events.

Misc

CLICKED(N) Returns 1 if the system object number N has been clicked, 0 otherwise.
DOUBLE_CLICKED(N) Returns 1 if the system object number N has been double-clicked, 0 otherwise.
KEY_DOWN_CODE Returns the code of the key the user is pressing.
KEY_UP_CODE Returns the code of the key the user is releasing.
KEY_DOWN_SPECIAL Returns the code of the special key (CTRL, SHIFT or ALT) the user is pressing.
KEY_UP_SPECIAL Returns the code of the special key (CTRL, SHIFT or ALT) the user is releasing.
NUMBER_CLICK System variable, number of the last clicked object (-1 when initiated).
NUMBER_DOUBLE_CLICK System variable, number of the last double-clicked object (-1 when initiated).
NUMBER_CHANGE System variable, number of the last changed object (-1 when initiated).
NUMBER_KEY_UP System variable, number of the last object on which a key is released (-1 when initiated).
NUMBER_KEY_DOWN System variable, number of the last object on which a key is pressed (-1 when initiated).
NUMBER_EVENTS Returns the number of events in the event waiting list.

to the top

2.1.8 - Font

It is possible to choose the font, the size, the color and the style of the characters displayed by a system object.
(Style = combination of characteristics: bold, italic, underlined, stroke).
The list of fonts installed in your system can be loaded in an object of type "list" MEMO, COMBO, LIST.

FONT_NAME N, F Set the font for the characters displayed by the object number N, by the name F of the font.
FONT_SIZE N, S Set the size of the characters displayed by the object number N.
FONT_COLOR N, R, G, B Set the color (by the primary components Red, Green, Blue) of the characters displayed by the object number N.
FONT_NAMES_ADD N Adds the list of the available fonts to the object number N.
FONT_NAMES_LOAD N Fills the object number N with the list of the available fonts.
FONT_BOLD N Adds the style "bold" to the style of the object number N.
FONT_BOLD_OFF N Removes the style "bold" to the style of the object number N.
FONT_ITALIC N Adds the style "italic" to the style of the object number N.
FONT_ITALIC_OFF N Removes the style "italic" to the style of the object number N.
FONT_UNDERLINE N Adds the style "underlined" to the style of the object number N.
FONT_UNDERLINE_OFF N Removes the style "underlined" to the style of the object number N.
FONT_STRIKE N Adds the style "stroke" to the style of the object number N.
FONT_STRIKE_OFF N Removes the style "stroke" to the style of the object number N.

to the top

2.1.9 - Cursor

It is possible to change or to hide the cursor on a system object.
The cursor is driven by the mouse.

CURSOR_ARROW N Displays an arrow-shaped cursor on the object number N.
CURSOR_BEAM N Displays a capital I-shaped cursor on the object number N.
CURSOR_CROSS N Displays a cross-shaped cursor on the object number N.
CURSOR_DEFAULT N Displays the cursor by default on the object number N.
CURSOR_HELP N Displays an interrogation mark-shaped cursor on the object number N.
CURSOR_HIDE N Hides the cursor on the object number N.
CURSOR_HOURGLASS N Displays an hourglass-shaped cursor on the object number N.
CURSOR_NOPARKING N Displays a no parking sign-shaped cursor on the object number N.
CURSOR_POINT N Displays an hand-shaped cursor on the object number N.

to the top

2.2 Specific commands on the created system objects

Most of the commands use the associated number of an object.

2.2.1 Axes and command target: SCENE3D

AXES_HIDE Makes invisible 3D axes of object receiving the "3D" commands.
AXES_SHOW Makes visible 3D axes of object receiving the "3D" commands.
3D_TARGET_IS N Designates the SCENE3D number N as the receiver of "3D" commands.

to the top

2.2.2 Specific commands for an object FORM

BORDER_HIDE N Hides the border of the object number N.
BORDER_NORMAL N Shows the normal border of the object number N.
BORDER_SMALL N Shows the border of the object number N with a reduced size.
COMMAND_TARGET_IS N Designates the FORM N as receiver of all the commands.
TO_BACKGROUND N Sends the FORM number N to background.
TO_FOREGROUND N Brings the FORM number N to foreground.
MINIMIZE N

Minimizes the size of the FORM number N.

MAXIMIZE N

Maximizes the size of the FORM number N.

NORMAL N

Comes back to the size of the FORM number N before a command MINIMIZE or MAXIMIZE.

to the top

2.2.3 Specific commands for a Bar object: TRACK_BAR, SCROLL_BAR, PROGRESS_BAR

HORIZONTAL N Put the bar object number N in horizontal position.
VERTICAL N Put the bar object number N in vertical position.
MAX N, V Set the maximum value V of the object number N.
MIN N, V Set the minimum value V of the object number N.
POSITION N, V Set the position of the cursor of the bar object number N.

to the top

2.2.4 Specific commands for a SPIN object:

MAX N, V Set the maximum value V of the object number N.
MIN N, V Set the minimum value V of the object number N.
POSITION N, V Set the value of the object number N.

to the top

2.2.5 Specific commands for a Dialog object: OPEN_DIALOG, SAVE_DIALOG

FILTER N, T Set a filter (T=type of File and comment) to object number N.
DIR_DIALOG N, D The current directory of the system object number N becomes the directory D.

to the top

2.2.6 Playing a Media object: SOUND, MOVIE

PLAY N Plays the object number N (sound or movie).
PLAY_WAIT N Plays the object number N (sound or movie) and waits for the end.

to the top

2.2.7 Manage the content of a List object: MEMO, COMBO, LIST, DLIST

CLEAR N Clears the content of the object number N.
FILE_ADD N, F Adds the content of the file F to the object number N.
ITEM_ADD N, T Adds the item T to the object number N.
ITEM_DELETE N,L Deletes the item at line L of the object number N.
ITEM_INSERT N, L,T Inserts the item T after the line L in the object number N.
ITEM_SELECT N,L Selects the item L of the object number N.

to the top

2.2.8 Command target to draw: FORM, PICTURE

2D_TARGET_IS N Designates the object number N as receiver of all the "2D" commands.

to the top

2.2.9 Text to be displayed: EDIT, COMBO

TEXT N, T Set the text T to be displayed by the object number N.

to the top

2.2.10 Caption of BUTTON, ALPHA, FORM, CHECK, OPTION, SUB_MENU

CAPTION N, T Set the text T as caption of object number N

to the top

2.2.11 Load a file: MEMO, COMBO, LIST, PICTURE, SOUND, MOVIE

FILE_LOAD N, F Loads the file F to the object number N

to the top

2.2.12 Save to a file: MEMO, COMBO, LIST, DLIST, PICTURE, IMAGE, SCENE2D

FILE_SAVE N, F Saves the content of object number N to the file F.

to the top

2.2.13 Input source: EDIT, COMBO, FORM

An object can be used as input for the Basic command: "INPUT Variable", instead of the keyboard.
In this case, Variable contents data already displayed by the objects.

INPUT_SOURCE_IS N Designates the object number N as source of data for an INPUT command.

to the top

2.2.14 PRINT target: SCENE3D, EDIT, MEMO, COMBO, FORM, LIST, PICTURE

An object can be used as output for the Basic command: "PRINT", instead of the screen.
In this case, the object contents the result of the PRINT command.

PRINT_TARGET_IS N Designates the object number N as receiver of the "PRINT" commands.

to the top

2.2.15 SPRITE command target: SCENE2D

SPRITE_TARGET_IS N Designates the SCENE2D number N as the receiver of "SPRITE" commands.

The SCENE2D designated as "target" will receive all the new SPRITEs (the old ones are not affected by this command).
This command is useless if there is only one SCENE2D. On the other hand, in the case where there are several SCENE2Ds, it allows to create SPRITEs in several SCENE2Ds.

to the top

2.2.16 Sorting a List object: COMBO, LIST, DLIST

SORT N Sorts in ascending order all the items of the system object number N.
SORT_ON N Starts the automatic sorting of the system object number N.
SORT_OFF N Stops the automatic sorting of the system object number N.

to the top

2.2.17 Resizing the displayed picture: PICTURE and SCENE2D

STRETCH_ON N Resizes automatically the picture displayed by the system object number N to the shape of this object.
STRETCH_OFF N Stops the automatic resizing of the picture displayed by the system object number N. The displayed picture takes its own shape.

to the top

2.2.18 - Input focus

SET_FOCUS N Gives the input focus to the system object number N.

to the top

2.2.19 - Scroll bars to a MEMO

A MEMO can have horizontal and vertical scrollbars

BAR_HORIZONTAL N Assigns an horizontal scroll bar to the system object number N.
BAR_VERTICAL N Assigns a vertical scroll bar to the system object number N.
BAR_BOTH N Assigns horizontal and vertical scroll bars to the system object number N.
BAR_NONE N Removes all the scroll bars of the system object number N.

to the top

2.2.20 - System clipboard

The text of a MEMO or the bitmap of a PICTURE or an IMAGE can be exchanged with the content of the operating system clipboard.

CLIPBOARD_COPY N Copy to the clipboard the selected text or the bitmap from the system object number N: text from a MEMO or bitmap from a PICTURE or from an IMAGE.
CLIPBOARD_PASTE N Paste the text or the bitmap from the clipboard to the system object number N: text to a MEMO, bitmap to a PICTURE or to an IMAGE.
CLIPBOARD_CUT N Copy to the clipboard then clear the selected text (MEMO) of the system object number N.

Remark : the command CLIPBOARD_CUT is only for a MEMO.

to the top

2.2.21 - Set CHECK and OPTION

The state of a CHECK or an OPTION can be set.

MARK_ON N Checks the object number N.
MARK_OFF N Unchecks the object number N.

to the top

2.2.22 - Image processing on a PICTURE

BRIGHTNESS N, V Changes the brightness of the PICTURE number N.
CONTRAST N, V Changes the contrast of the PICTURE number N.
GAMMA N, V Changes the gamma of the PICTURE number N.

For the 3 commands, V must be between -128 and 127
Every time a command is executed:
- if V=0, the picture remains unchanged,
- if V<0, its brightness or contrast or gamma decreases,
- if V>0, its brightness or contrast or gamma increases.

to the top

2.2.23 - Make secret the text of an EDIT

The text of an EDIT can be replaced by stars.

SECRET_ON N Displays as stars the characters of the EDIT number N.
SECRET_OFF N Displays clearly the characters of the EDIT number N.

to the top

2.2.24 - Select the text of an EDIT, a MEMO, a COMBO, a SPIN

In an EDIT, a MEMO, a COMBO, a SPIN, the text can be selected, and the caret can be placed.

SELECT_TEXT N, C, P Selects C characters from position P in the system object number N.
CARET_POSITION N, P Places the caret after the P-th character in the system object number N.

to the top

2.2.25 - Specific commands for a GRID

The presentation of a GRID can be modified, and we can write into a cell.

GRID_COLUMN N, C Set the number of columns of the GRID number N.
GRID_COLUMN_FIXED N, F Set the number of fixed columns of the GRID number N.
GRID_COLUMN_WIDTH N, W Set the column width of the GRID number N.
GRID_COLUMN_SIZING_ON N The columns of the GRID number N can be manually resized.
GRID_COLUMN_SIZING_OFF N The columns of the GRID number N cannot be manually resized.
GRID_ROW N, R Set the number of rows of the GRID number N.
GRID_ROW_HEIGHT N, H Set the row height of the GRID number N.
GRID_ROW_FIXED N, F Set the number of fixed rows of the GRID number N.
GRID_ROW_SIZING_ON N The rows of the GRID number N can be manually resized.
GRID_ROW_SIZING_OFF N The rows of the GRID number N cannot be manually resized.
GRID_FIXED_COLOR N, R, G, B Set the fixed part color (R,G,B) of the GRID number N.
GRID_WRITE N, R, C, S Writes the value of S into the cell (R,C) of the GRID number N.
GRID_ONE_COLUMN_WIDTH N,C,V Set the width of the column number C at V pixels in GRID number N.
GRID_ONE_ROW_HEIGHT N,R,V Set the height of the row number R at V pixels in GRID number N.
GRID_COLUMN_INSERT N,C

Inserts a column in position C in the GRID number N.

GRID_ROW_INSERT N,R

Inserts a row in position R in the GRID number N.

GRID_ROW_DELETE N,R

Deletes row R in GRID number N.

GRID_COLUMN_DELETE N,C

Deletes column C in GRID number N.

GRID_LOAD N,F

Loads the file F into the GRID number N.

GRID_SAVE N,R,C,F

Saves the GRID number N into the file F, from row 1 to R and from column 1 to C.

GRID_CLEAR N,R,C

Clears cells of GRID number N from row 1 to R and from column 1 to C.

to the top

2.2.26 - Management of TIMER

The activity of a TIMER can be managed.

TIMER_INTERVAL N,T Changes the triggering period T (in millisecond) of the object number N.
TIMER_ON N Makes active the object number N.
TIMER_OFF N Makes inactive the object number N.
TIMER_OFF_ALL Makes inactive all the TIMERs objects.

to the top

2.2.27 - Snapshot

The objects PICTURE, IMAGE, SCENE2D can be saved as snapshot.

SNAPSHOT N ,F Save the content of object number N into the file F.

to the top

2.3 Functions on the created system objects

All the functions use the associated number of a system object.

2.3.1 - Position

For objects: SCENE3D, BUTTON, EDIT, MEMO, COMBO, ALPHA, FORM, LIST, PICTURE, CHECK, OPTION, MOVIE, TRACK_BAR, SCROLL_BAR, PROGRESS_BAR

TOP(N) Returns the number of pixels between top edge of object number N and its parent (the container).
LEFT(N) Returns the number of pixels between left edge of object number N and its parent (the container).

to the top

2.3.2 - Size

For objects: SCENE3D, BUTTON, EDIT, MEMO, COMBO, ALPHA, FORM, LIST, PICTURE, CHECK, OPTION, MOVIE, TRACK_BAR, SCROLL_BAR, PROGRESS_BAR

WIDTH(N) Returns the width of object number N in pixels.
HEIGHT(N) Returns the height of object number N in pixels.
WIDTH_CLIENT(N) Returns the client's width of object number N in pixels.
HEIGHT_CLIENT(N) Returns the client's height of object number N in pixels.

to the top

2.3.3 For a List object: MEMO, COMBO, LIST, DLIST

COUNT(N) Returns the number of items of the object number N.
ITEM_READ$(N, L) Returns the item number L of the object number N.

to the top

2.3.4 Position of cursor: TRACK_BAR, SCROLL_BAR, PROGRESS_BAR

POSITION(N) Returns the position of the cursor of the object number N.

to the top

2.3.5 Value of a SPIN

POSITION(N) Returns the value of the object SPIN number N.

to the top

2.3.6 Chosen File: OPEN_DIALOG, SAVE_DIALOG

FILE_NAME$(N) Returns the file name chosen by the user of the object number N.

to the top

2.3.7 State: CHECK, OPTION

CHECKED(N) Returns the state of the object number N.

to the top

2.3.8 Selected item: COMBO, LIST

ITEM_INDEX$(N) Returns the selected item of the object number N.
ITEM_INDEX(N) Returns the index of selected item of the object number N.

to the top

2.3.9 Displayed text: EDIT, MEMO, COMBO

TEXT$(N)

Returns the text of the object number N.

to the top

2.3.10 Clicked object: (SCENE3D, BUTTON, EDIT, MEMO, COMBO, ALPHA, FORM, LIST, PICTURE, CHECK, OPTION, SUB_MENU)

CLICKED(N) Returns 1 if the system object number N has been clicked, 0 otherwise.

to the top

2.3.11 - Caption: BUTTON, ALPHA, FORM, CHECK, OPTION, SUB_MENU

CAPTION$(N) Returns the caption of the object number N.

to the top

2.3.12 - Color of a pixel in a PICTURE

COLOR_PIXEL_BLUE(N, X, Y) Returns the blue primary component of the pixel (X,Y) in the PICTURE number N.
COLOR_PIXEL_GREEN(N, X, Y) Returns the green primary component of the pixel (X,Y) in the PICTURE number N.
COLOR_PIXEL_RED(N, X, Y) Returns the red primary component of the pixel (X,Y) in the PICTURE number N.

to the top

2.3.13 - Selected text in an EDIT, a MEMO, a COMBO, a SPIN

In an EDIT, a MEMO, a COMBO, a SPIN, the text selected by the user or by software can be read.

SELECT_READ$(N) Returns the selected text in the object number N.

to the top

2.3.14 - Visibility

For all the system objects except: MAIN_MENU, SOUND, OPEN_DIALOG, SAVE_DIALOG, DLIST, TIMER.

SHOW(N) Returns 1 if the system object number N is visible, 0 otherwise.
HIDE(N) Returns 1 if the system object number N is hidden, 0 otherwise.

to the top

2.3.15 - Activity

For all the system objects except: MAIN_MENU, SOUND, OPEN_DIALOG, SAVE_DIALOG, DLIST.

ACTIVE(N) Returns 1 if the system object number N is active, 0 otherwise.
INACTIVE(N) Returns 1 if the system object number N is inactive, 0 otherwise.

to the top

2.3.16 - Object GRID

GRID_READ$(N, R, C) Returns the content of the cell (R,C) of the GRID number N.
GRID_X_TO_COLUMN(N,X)

Returns the column number of the GRID number N from the coordinate X.

GRID_Y_TO_ROW(N,Y)

Returns the row number of the GRID number N from the coordinate Y.

to the top

2.3.17 -Caret position

CARET_POSITION(N) Returns the caret position of EDIT number N.

to the top

2.3.18 - Object

OBJECT_EXISTS(N) Returns 1 if the system object number N exists, 0 otherwise.
OBJECT_PARENT(N) Returns the parent number of the system object number N.
OBJECT_TYPE(N) Returns the type of the system object number N.

The type of a system objet is coded as follows:

1=SCENE3D
2=BUTTON
3=EDIT
4=MEMO
5=COMBO
6=ALPHA
7=FORM
8=LIST
9=PICTURE
10=CHECK
11=OPTION
12=MAIN_MENU
13=SUB_MENU
14=SOUND
15=MOVIE
16=TRACK_BAR
17=OPEN_DIALOG
18=SAVE_DIALOG
19=SCROLL_BAR
20=PROGRESS_BAR
21=SPIN
22=GRID
23=CONTAINER
26=DLIST
27=SCENE2D
28=TIMER
29=PANEL
32=CONTAINER_OPTION
36=HVIEWER

41=IMAGE
42=CONTAINER_TAB
43=TAB

to the top


2.3.19 - Test size

TEXT_HEIGHT(T, N)

Returns the height of the text T if it is displayed by the system object number N.

TEXT_WIDTH(T, N)

Returns the width of the text T if it is displayed by the system object number N.

These functions are for objects: FORM, COMBO, ALPHA, LIST, PICTURE, GRID.

to the top


Last update: January 22, 2017