VID file structure¶

• Table of contents
• VID file structure

VID file is describing the outlook of application, i.e. which windows (later on OBJECTS) in what sequence will be located in a main window of application (MAIN FRAME).

It is not possible to put OBJECT directly to MAIN FRAME.

What is possible is to put a SPLITTER to MAIN FRAME (SPLITTER is a table with a certain number of lines and columns).

You must put a VIEW in each cell of a SPLITTER and after that put an OBJECT to VIEW. VIEW stands for a tabulator or a array of OBJECTS, or just a container for one OBJECT.

Such a procedure is described in the whole in VID file.

CREATE_OBJ_
You have to create an OBJECT before using it. For that purpose you have to use a set of commands with CREATE_OBJ_ prefix.

Example:
CREATE_OBJ_BROW OBJ_ID
Is creating file browser, OBJ_ID - is an OBJECT identifier (a unique number).

CREATE_OBJ_PLAYLIST - schedule browser
CREATE_OBJ_DB - external DB browser
CREATE_OBJ_BROW_DB - DB browser
CREATE_OBJ_PLAIR - double player
CREATE_OBJ_JNGL - Jingle machine
CREATE_OBJ_BOOK - Categories
CREATE_OBJ_PLIST - Single Player
CREATE_OBJ_SBJ - subjects browser
CREATE_OBJ_TIME - time indicator
CREATE_OBJ_LOG - logger channel
CREATE_OBJ_PLAY_X - new player (X-player)
etc.

CREATE_SPLIT_BASE
create SPLITTER

Example:
CREATE_SPLIT_BASE SPLITTER_ID n_rows n_cols
Creates SPLITTER with lines number = n_cols, Rows number = n_cols and puts it to a MAIN FRAME SPLITTER_ID - identifier of a SPLITTER

Example:
CREATE_SPLIT_BASE SPLITTER_ID n_rows n_cols
PARENT_SPLITTER_ID parent_splitter_row parent_splitter_col
creates SPLITTER with lines number = n_cols and puts it to SPLITTER with identifier PARENT_SPLITTER_ID into the cell (parent_splitter_row,parent_splitter_col)

CREATE_VIEW_
Commands with CREATE_VIEW_ prefix are used for creation of various types of VIEWs.

Example:
CREATE_VIEW_SINGLE VIEW_ID SPLITTER_ID splitter_row
splitter_col view_width view_height
Creates VIEW with VIEW_ID identifier and puts it to the cell (splitter_row, splitter_col) with SPLITTER_ID identifier. Thus one OBJECT can be placed in one VIEW.

view_width and view_height are desirable width and height of VIEW.

Example:
CREATE_VIEW_TAB VIEW_ID SPLITTER_ID splitter_row
splitter_col view_width view_height
Creates VIEW with VIEW_ID identifier and puts it to SPLITTER with SPLITTER_ID identifier in the cell (splitter_row, splitter_col). You can put any quantity of OBJECTS to the VIEW created by described method. VIEW will look like a tabulator with a possibility to switch between the OBJECTS.

Example:
CREATE_VIEW_ARRAY VIEW_ID SPLITTER_ID splitter_row
splitter_col view_width view_height ojects_count objects_in_row

Creates VIEW with VIEW_ID identifier and puts to a SPLITTER with SPLITTER_ID identifier in the cell (splitter_row, splitter_col). You can put ojects_count OBJECTs to the VIEW created by the described method. All of them will be located in the form of a table with (objects_in_row) number of OBJECTs in a line.

SET_VIEW_SINGLE_OBJ VIEW_ID OBJ_ID
Puts OBJECT with OBJ_ID identifier to a VIEW with VIEW_ID identifier. VIEW should be created before with the help of CREATE_VIEW_SINGLE.

SET_VIEW_ARRAY_OBJ VIEW_ID NUMBER OBJ_ID
Puts OBJECT with OBJ_ID identifier to a VIEW with VIEW_ID identifier to the cell with NUMBER VIEW number which should be created before with the help of CREATE_VIEW_ARRAY.

SET_VIEW_TAB_OBJ VIEW_ID OBJ_ID NAME
Puts OBJECT with OBJ_ID identifier to a VIEW with VIEW_ID VIEW identifier creted before with the help of CREATE_VIEW_TAB NAME - the name of tabulator bookmark.

#define XXX YYY
After this text will be met in the VID file, text XXX will be replaced by text YYY. Usually this is used for setting of numeric identifiers of OBJECTs, SPLITTERs etc.

#include "filename.ext"
While file analysis the contents of "filename.ext" file will be inserted to that place.

#disable XXX
All strings with XXX will be ommited during analysis

SET_OBJ_BASE OBJ_ID x1 x2 x3 … Xn
Additional setting for OBLECT with OBJECT_ID identifier created earlier. Parameters x1 x2 x3 … Xn will be given to an OBJECT and it will try to understand what do they mean. What commands to which OBJECT can be given will be described later. It will take long time to dig into that.

To use "space" as an operand you have to limit it with quotation marks.

SET_SPLIT_X SPLITTER_ID x1 x2 x3 … xi … xn
SET_SPLIT_Y SPLITTER_ID y1 y2 y3 … yi … yn
Describes how to make initial scaling of SPLITTER with SPLITTER_ID identifier. Width of a cell with number "i" can be found like that (the width of the whole SPLITTER is eferred as splitter_width): wi = (splitter_width * xi) / (x1 + x2 + x3 + … + xi + … + xn). The same is valid for the height.