GEMLIB
0.44.0
|
escapes functions More...
Macros | |
#define | v_curaddress vs_curaddress |
Functions | |
void | v_bit_image (VdiHdl, const char *filename, short aspect, short x_scale, short y_scale, short h_align, short v_align, short *pxy) |
void | v_clear_disp_list (VdiHdl) |
short | v_copies (VdiHdl, short count) |
void | v_dspcur (VdiHdl, short x, short y) |
void | v_form_adv (VdiHdl) |
void | v_hardcopy (VdiHdl) |
short | v_orient (VdiHdl, short orientation) |
void | v_output_window (VdiHdl, short *pxy) |
short | v_page_size (VdiHdl, short page_id) |
void | v_rmcur (VdiHdl) |
short | v_trays (VdiHdl, short input, short output, short *set_input, short *set_output) |
short | vq_calibrate (VdiHdl, short *flag) |
short | vq_page_name (VdiHdl, short page_id, char *page_name, long *page_width, long *page_height) |
void | vq_scan (VdiHdl, short *g_slice, short *g_page, short *a_slice, short *a_page, short *div_fac) |
short | vq_tabstatus (VdiHdl) |
short | vq_tray_names (VdiHdl, char *input_name, char *output_name, short *input, short *output) |
short | vs_calibrate (VdiHdl, short flag, short *rgb) |
short | vs_palette (VdiHdl, short palette) |
void | v_sound (VdiHdl, short freq, short duration) |
short | vs_mute (VdiHdl, short action) |
void | vq_tdimensions (VdiHdl, short *xdimension, short *ydimension) |
void | vt_alignment (VdiHdl, short dx, short dy) |
void | vt_axis (VdiHdl, short xres, short yres, short *xset, short *yset) |
void | vt_origin (VdiHdl, short xorigin, short yorigin) |
void | vt_resolution (VdiHdl, short xres, short yres, short *xset, short *yset) |
void | v_meta_extents (VdiHdl, short min_x, short min_y, short max_x, short max_y) |
void | v_write_meta (VdiHdl, short numvdi_intin, short *avdi_intin, short num_ptsin, short *a_ptsin) |
void | vm_coords (VdiHdl, short llx, short lly, short urx, short ury) |
void | vm_filename (VdiHdl, const char *filename) |
void | vm_pagesize (VdiHdl, short pgwidth, short pgheight) |
void | vsc_expose (VdiHdl, short state) |
void | vsp_film (VdiHdl, short color_idx, short lightness) |
short | vqp_filmname (VdiHdl, short _index, char *name) |
void | v_offset (VdiHdl, short offset) |
void | v_fontinit (VdiHdl, const void *font_header) |
void | v_escape2000 (VdiHdl, short times) |
void | v_alpha_text (VdiHdl, const char *str) |
void | v_alpha_text16n (VdiHdl, const short *wstr, short num) |
void | v_curdown (VdiHdl) |
void | v_curhome (VdiHdl) |
void | v_curleft (VdiHdl) |
void | v_curright (VdiHdl) |
void | v_curtext (VdiHdl, const char *str) |
void | v_curtext16n (VdiHdl, const short *wstr, short num) |
void | v_curup (VdiHdl) |
void | v_eeol (VdiHdl) |
void | v_eeos (VdiHdl) |
void | v_enter_cur (VdiHdl) |
void | v_exit_cur (VdiHdl) |
void | v_rvoff (VdiHdl) |
void | v_rvon (VdiHdl) |
void | vq_chcells (VdiHdl, short *n_rows, short *n_cols) |
void | vq_curaddress (VdiHdl, short *cur_row, short *cur_col) |
void | vs_curaddress (VdiHdl, short row, short col) |
escapes functions
todo: add description here
#define v_curaddress vs_curaddress |
alternative name for vs_curaddress
void v_alpha_text | ( | short | handle, |
const char * | str | ||
) |
handle | Device handle |
str |
References VDI_CNTRLMAX, VDI_INTINMAX, and vdi_str2array_n().
void v_alpha_text16n | ( | short | handle, |
const short * | wstr, | ||
short | num | ||
) |
void v_bit_image | ( | short | handle, |
const char * | filename, | ||
short | aspect, | ||
short | x_scale, | ||
short | y_scale, | ||
short | h_align, | ||
short | v_align, | ||
short * | pxy | ||
) |
This escape is required only for printers. It allows the application to request processing of a bit image file
handle | Device handle |
filename | |
aspect | Aspect ratio flag :
|
x_scale | Scaling for x-axis :
|
y_scale | Scaling for y-axis :
|
h_align | horizontal alignment :
|
v_align | vertical alignment :
|
pxy | output rectangle |
References VDI_CNTRLMAX, VDI_INTINMAX, and vdi_str2array_n().
void v_clear_disp_list | ( | short | handle | ) |
This function for printer or plotter drivers clears the printing buffer (and deletes all previous commands). In contrast to v_clrwk() it does not advance the page.
handle | Device handle |
This function should be called if the user interrupts printing while your application generates the page.
References VDI_CNTRLMAX.
short v_copies | ( | short | handle, |
short | count | ||
) |
Use v_copies() to set the number of copies of a page. If count
is -1, the number of copies is returned.
handle | Device handle |
count | number of copies (including the "original one"), or -1. |
References VDI_CNTRLMAX.
void v_curdown | ( | short | handle | ) |
moves the cursor down one row. If the cursor is already in the last row, nothing happens.
handle | Device handle |
References VDI_CNTRLMAX.
void v_curhome | ( | short | handle | ) |
This function moves the cursor to the upper left character cell
handle | Device handle |
References VDI_CNTRLMAX.
void v_curleft | ( | short | handle | ) |
The cursor is moved left. If it is already in the first column, nothing happens.
handle | Device handle |
References VDI_CNTRLMAX.
void v_curright | ( | short | handle | ) |
moves the cursor right. If the cursor is already in the last column, nothing happens.
handle | Device handle |
References VDI_CNTRLMAX.
void v_curtext | ( | short | handle, |
const char * | str | ||
) |
This function displays a string. The string starts at the current cursor position.
handle | Device handle |
str |
References VDI_CNTRLMAX, VDI_INTINMAX, and vdi_str2array_n().
void v_curtext16n | ( | short | handle, |
const short * | wstr, | ||
short | num | ||
) |
This function displays a string. The string starts at the current cursor position.
handle | Device handle |
wstr | |
num | string len |
References VDI_CNTRLMAX.
void v_curup | ( | short | handle | ) |
The cursor is moved up one row. If the cursor is already in the first row, nothing happens.
handle | Device handle |
References VDI_CNTRLMAX.
void v_dspcur | ( | short | handle, |
short | x, | ||
short | y | ||
) |
places a graphic cursor at the specified location
handle | Device handle |
x | x-coordinate of location to place cursor in current coordinate system |
y | y-coordinate of location to place cursor in current coordinate system. |
The cursor is usually a cross hair cursor and is of the same type as that used for Input Locator, Request Mode. If sample mode input is supported, the application can use this call to generate the cursor for Input Locator, Sample Mode. In memory-mapped devices, the cursor is drawn in XOR mode so GEM VDI can remove it.
References VDI_CNTRLMAX.
void v_eeol | ( | short | handle | ) |
This function erases the screen from the cursor position to the end of line
handle | Device handle |
References VDI_CNTRLMAX.
void v_eeos | ( | short | handle | ) |
The screen is erased from the cursor position to the end of the screen
handle | Device handle |
References VDI_CNTRLMAX.
void v_enter_cur | ( | short | handle | ) |
This function enables text mode. The screen is cleared and the text cursor is displayed in the upper left cell of the screen.
handle | Device handle |
References VDI_CNTRLMAX.
void v_escape2000 | ( | short | handle, |
short | times | ||
) |
In contrast to v_copies() this function sets the number of copies additional to the "original" page.
handle | Device handle |
times | number of additional copies |
References VDI_CNTRLMAX.
void v_exit_cur | ( | short | handle | ) |
"EXIT ALPHA MODE" switches back to graphics mode.
handle | Device handle |
References VDI_CNTRLMAX.
void v_fontinit | ( | short | handle, |
const void * | font_header | ||
) |
this escape install the given font as font system.
handle | Device handle |
font_header |
References VDI_CNTRLMAX.
void v_form_adv | ( | short | handle | ) |
is required only for printers. It advances the printer page. This escape can be used instead of invoking a Clear Workstation function if it is desirable to retain the current printer display list while advancing to the next page.
handle | Device handle |
References VDI_CNTRLMAX.
void v_hardcopy | ( | short | handle | ) |
The device generates a hard copy with this escape. The escape is device-specific and copies the physical screen to a printer or other attached hard copy device.
handle | Device handle |
References VDI_CNTRLMAX.
void v_meta_extents | ( | short | handle, |
short | min_x, | ||
short | min_y, | ||
short | max_x, | ||
short | max_y | ||
) |
updates the extent of the metafile graphic and saves it in the metafile header.
handle | Device handle |
min_x | |
min_y | |
max_x | |
max_y |
The extents information may be used by some applications to provide a quick indication of the minimum rectangle which will bound all primitives output to the metafile.
If the Update Metafile Extents escape is not used when outputting to the metafile, zeroes will be written in the extents information portion of the metafile header.
References VDI_CNTRLMAX.
void v_offset | ( | short | handle, |
short | offset | ||
) |
this function set the screen offset in raster lines from the begining of the logical screen.
handle | Device handle |
offset |
References VDI_CNTRLMAX.
short v_orient | ( | short | handle, |
short | orientation | ||
) |
This function is used for switching between portrait and landscape output of a page. If orientation
is -1, the current orientation is returned.
handle | Device handle |
orientation | requested orientation :
|
If there is not enough memory to change the orientation, v_orient returns -1. If that is the case you have to close the driver via v_clswk().
References VDI_CNTRLMAX.
void v_output_window | ( | short | handle, |
short * | pxy | ||
) |
This escape is required only for printers. It allows the application to request that a particular rectangular window of the picture be output to the printer. This escape is similar to the Update Workstation function, except that the rectangular area must be specified.
handle | Device handle |
pxy | window to be output |
Note that use of this function does not always guarantee that adjacent pictures will abut. Pictures will abut with a resolution of one printer head height.
References VDI_CNTRLMAX.
short v_page_size | ( | short | handle, |
short | page_id | ||
) |
sets the requested page size (if the page size is defined). If the requested size does not exist, the default setting will be used.
handle | Device handle |
page_id | requested page size as follow:
|
page_size
If the return value is -1, you have to close the driver because there is not enough memory.
References VDI_CNTRLMAX.
void v_rmcur | ( | short | handle | ) |
This escape removes the last graphic cursor placed on the screen
handle | Device handle |
References VDI_CNTRLMAX.
void v_rvoff | ( | short | handle | ) |
This call switches reverse text output off
handle | Device handle |
References VDI_CNTRLMAX.
void v_rvon | ( | short | handle | ) |
After calling this function text will be displayed reverse
handle | Device handle |
References VDI_CNTRLMAX.
void v_sound | ( | short | handle, |
short | freq, | ||
short | duration | ||
) |
This escape plays a sound with the given frequency and duration
handle | Device handle |
freq | |
duration |
References VDI_CNTRLMAX.
short v_trays | ( | short | handle, |
short | input, | ||
short | output, | ||
short * | set_input, | ||
short * | set_output | ||
) |
specify the paper trays. If the requested tray does not exist, the standard tray will be selected (input 0 and output 0).
handle | Device handle |
input | requested input tray
|
output | requested output tray
|
set_input | selected input tray [option CHECK_NULLPTR] set_input may be NULL |
set_output | selected output tray [option CHECK_NULLPTR] set_output may be NULL |
set_input
and set_output
will contain 0.References VDI_CNTRLMAX.
void v_write_meta | ( | short | handle, |
short | numvdi_intin, | ||
short * | avdi_intin, | ||
short | num_ptsin, | ||
short * | a_ptsin | ||
) |
allows you to save application specific opcodes in a metafile. Opcodes 0 to 100 are reserved, the range above it can be used.
handle | Device handle |
numvdi_intin | |
avdi_intin | |
num_ptsin | |
a_ptsin |
The opcode is stored in a_intin[0].
References VDI_CNTRLMAX.
void vm_coords | ( | short | handle, |
short | llx, | ||
short | lly, | ||
short | urx, | ||
short | ury | ||
) |
is a sub-opcode of WRITE METAFILE ITEM and sets the used coordinate system.
handle | Device handle |
llx | x-Koordinate links unten |
lly | y-Koordinate links unten |
urx | x-Koordinate rechts oben |
ury | y-Koordinate rechts oben |
References VDI_CNTRLMAX.
void vm_filename | ( | short | handle, |
const char * | filename | ||
) |
This function should be used to change the name of the metafile. The name filename
must be an absolute path like "E:\\PICS\\FLIWATT.GEM".
handle | Device handle |
filename |
The metafile in the current directory created by v_opnwk() ("GEMFILE.GEM") will be closed (and deleted by NVDI). Therefore vm_filename() should be called after v_opnwk().
Note: Old metafile driver may not delete the default file "GEMFILE.GEM" when you call vm_filename(). That means that you are on the safe side if you call Fdelete() after vm_filename() and try to delete GEMFILE.GEM.
References VDI_CNTRLMAX, VDI_INTINMAX, and vdi_str2array_n().
void vm_pagesize | ( | short | handle, |
short | pgwidth, | ||
short | pgheight | ||
) |
is a sub-opcode of WRITE METAFILE ITEM and sets the page size in 1/10 mm.
handle | Device handle |
pgwidth | width in 1/10 mm |
pgheight | height in 1/10 mm |
References VDI_CNTRLMAX.
short vq_calibrate | ( | short | handle, |
short * | flag | ||
) |
This function report back, if vs_calibrate() exists and if calibration is switched on.
handle | Device handle |
flag | calibration aus (0) or ein (1) |
References VDI_CNTRLMAX.
void vq_chcells | ( | short | handle, |
short * | n_rows, | ||
short * | n_cols | ||
) |
This call returns the number of columns and rows/lines of the text screen
handle | Device handle |
n_rows | number of lines [option CHECK_NULLPTR] n_rows may be NULL |
n_cols | number of columns [option CHECK_NULLPTR] n_cols may be NULL |
n_rows
and n_cols
are 0, the device does not support text mode.References VDI_CNTRLMAX.
void vq_curaddress | ( | short | handle, |
short * | cur_row, | ||
short * | cur_col | ||
) |
This call returns the current cursor position
handle | Device handle |
cur_row | (1 to the maximum number of rows) [option CHECK_NULLPTR] cur_row may be NULL |
cur_col | (1 to the maximum number of columns) [option CHECK_NULLPTR] cur_col may be NULL |
References VDI_CNTRLMAX.
short vq_page_name | ( | short | handle, |
short | page_id, | ||
char * | page_name, | ||
long * | page_width, | ||
long * | page_height | ||
) |
can be used to determine the name of a paper format and its physical size (height and width including the non-printable margins).
handle | Device handle |
page_id | paper format |
page_name | pointer to the name |
page_width | width in micro meters [option CHECK_NULLPTR] page_width may be NULL |
page_height | height in micro meters [option CHECK_NULLPTR] page_height may be NULL |
References VDI_CNTRLMAX.
void vq_scan | ( | short | handle, |
short * | g_slice, | ||
short * | g_page, | ||
short * | a_slice, | ||
short * | a_page, | ||
short * | div_fac | ||
) |
handle | Device handle |
g_slice | [option CHECK_NULLPTR] g_slice may be NULL |
g_page | [option CHECK_NULLPTR] g_page may be NULL |
a_slice | [option CHECK_NULLPTR] a_slice may be NULL |
a_page | [option CHECK_NULLPTR] a_page may be NULL |
div_fac | [option CHECK_NULLPTR] div_fac may be NULL |
References VDI_CNTRLMAX.
short vq_tabstatus | ( | short | handle | ) |
This escape returns the availability status of a graphics tablet, mouse, joystick, or other similar device.
handle | Device handle |
References VDI_CNTRLMAX.
void vq_tdimensions | ( | short | handle, |
short * | xdimension, | ||
short * | ydimension | ||
) |
handle | Device handle |
xdimension | [option CHECK_NULLPTR] xdimension may be NULL |
ydimension | [option CHECK_NULLPTR] ydimension may be NULL |
References VDI_CNTRLMAX.
short vq_tray_names | ( | short | handle, |
char * | input_name, | ||
char * | output_name, | ||
short * | input, | ||
short * | output | ||
) |
returns the names of the current input and output tray
handle | Device handle |
input_name | pointer to the name of the input tray or NULL |
output_name | pointer to the name of the output tray or NULL |
input | number of the input tray |
output | number of the output tray |
References VDI_CNTRLMAX.
short vqp_filmname | ( | short | handle, |
short | index, | ||
char * | name | ||
) |
this escape returns the name of a film.
handle | Device handle |
index | |
name |
References vdi_array2str(), VDI_CNTRLMAX, and VDI_INTOUTMAX.
short vs_calibrate | ( | short | handle, |
short | flag, | ||
short * | rgb | ||
) |
switcher color calibration on or off and can be used to set a calibration table. Before you call this function you should check if it exists (call vq_calibrate()).
handle | Device handle |
flag | requested calibration off (0) or on (1) |
rgb | pointer to calibration table or 0L |
References VDI_CNTRLMAX.
void vs_curaddress | ( | short | handle, |
short | row, | ||
short | col | ||
) |
moves the alpha cursor directly to the specified row and column address anywhere on the display surface. Addresses beyond the displayable range of the screen are set to the nearest value that is within the displayable range of the screen.
handle | Device handle |
row | Row number (1 to maximum number of rows) |
col | Column number (1 to maximum number of columns). |
References VDI_CNTRLMAX.
short vs_mute | ( | short | handle, |
short | action | ||
) |
This escape set/unset/return the tone mute flag
handle | Device handle |
action |
|
References VDI_CNTRLMAX.
short vs_palette | ( | short | handle, |
short | palette | ||
) |
This escape allows the selection of the palette on the IBM (Tm) medium-resolution color screen.
handle | Device handle |
palette | Color selection :
|
References VDI_CNTRLMAX.
void vsc_expose | ( | short | handle, |
short | state | ||
) |
void vsp_film | ( | short | handle, |
short | index, | ||
short | lightness | ||
) |
handle | Device handle |
index | |
lightness |
References VDI_CNTRLMAX.
void vt_alignment | ( | short | handle, |
short | dx, | ||
short | dy | ||
) |
void vt_axis | ( | short | handle, |
short | xres, | ||
short | yres, | ||
short * | xset, | ||
short * | yset | ||
) |
handle | Device handle |
xres | |
yres | |
xset | [option CHECK_NULLPTR] xset may be NULL |
yset | [option CHECK_NULLPTR] yset may be NULL |
References VDI_CNTRLMAX.
void vt_origin | ( | short | handle, |
short | xorigin, | ||
short | yorigin | ||
) |
void vt_resolution | ( | short | handle, |
short | xres, | ||
short | yres, | ||
short * | xset, | ||
short * | yset | ||
) |
handle | Device handle |
xres | |
yres | |
xset | [option CHECK_NULLPTR] xset may be NULL |
yset | [option CHECK_NULLPTR] yset may be NULL |
References VDI_CNTRLMAX.