Functions of the User Interface

This Chapter consists the descriptions of all functions in the modules wdg, mas, fld, men, but and mes.


Module wdg

dal_wdg_act_vir activate widget in virtual mode
dal_wdg_set_vir activate and deactivate widget virtual mode
dal_wdg_ret_vir return widget virtual mode
dal_wdg_set_lst activates the last was activated widget
dal_wdg_cre_wdg create widget of the mask
dal_wdg_set_act activate widget
dal_wdg_map_wdg position and activate widget
dal_wdg_del_wdg delete widget and mask from local memory
dal_wdg_chk_wdg check existence of widget in local memory
dal_wdg_mov_wdg move widget
dal_wdg_mod_siz change widget size
dal_wdg_ret_act return Id of the active widget
dal_wdg_ret_lst returns Id of previous active widget
dal_wdg_ret_wdg return Id of widget for mask
dal_wdg_fnc_drp set function for Pre-DROP trigger
dal_wdg_set_dst set Id of target widget for DRAG+DROP operations
dal_wdg_ret_dst return Id of the target widget for copying
dal_wdg_ret_nxt return Id of the next widget in the widget stack (no nested calls)
dal_wdg_get_nxt return Id of the next widget in the widget stack (nested calls allowed)
dal_wdg_ret_tra return Id of the trash-basket widget
dal_wdg_ret_mas return Id of the mask of the widget
dal_wdg_set_typ set widget type
dal_wdg_ret_typ return widget type
dal_wdg_set_en1 set Id of the entity-1 of the widget
dal_wdg_ret_en1 return Id of the entity-1 of the widget
dal_wdg_set_en2 set Id of the entity-2 of the widget
dal_wdg_ret_en2 return Id of the entity-2 of the widget
dal_wdg_set_rel set Id of the relation of the widget
dal_wdg_ret_rel return Id of the relation of the widget
dal_wdg_set_ide set Id of the relation parent of the widget
dal_wdg_ret_ide return Id of the parent element of the widget
dal_wdg_set_elm set name of the relation parent of the widget
dal_wdg_ret_elm return name of the parent element of the widget
dal_wdg_set_tbo set name of the original table of the widget
dal_wdg_ret_tbo return name of the original table of the widget
dal_wdg_set_tbj set name of the join table of the widget
dal_wdg_ret_tbj return name of the join table of the widget
dal_wdg_set_buf fill widget buffer
dal_wdg_ret_buf return widget buffer entry
dal_wdg_ret_fat return parent widget Id of the combination widget
dal_wdg_chk_fat check combination widget for child widgets
dal_wdg_nxt_son return Id of the child widgets of a combination widget (no nested calls)
dal_wdg_get_son return Id of the child widgets of a combination widget (nested calls allowed)
dal_wdg_ret_mod return widget mode
dal_wdg_set_sng set widget selection mode
dal_wdg_ret_sng return widget selection mode
dal_wdg_del_sel deselect records in the current widget
dal_wdg_set_row set row position in the current list widget
dal_wdg_max_siz maximize widget size
dal_wdg_set_fnc_del set widget-delete-listener function
dal_wdg_ret_fnc_del return widget-delete-listener function


Module mas

dal_mas_cre_mas create mask
dal_mas_cop_mas copy mask
dal_mas_del_mas delete mask from local memory
dal_mas_chk_mas check mask existence in local memory
dal_mas_hid_mas remove mask from screen
dal_mas_map_mas position mask on screen
dal_mas_mov_mas move mask on screen
dal_mas_pop_mas pops mask to highest screen position
dal_mas_siz_mas change mask size
dal_mas_clr_mas delete field contents in mask
dal_mas_cre_bar create scroll bar for mask
dal_mas_cre_fld create field for mask
dal_mas_cop_fld copy field
dal_mas_del_fld delete field from local memory
dal_mas_chk_fld check field existence in local memory
dal_mas_mov_fld move field in mask
dal_mas_siz_fld change field size
dal_mas_ins_fld insert field in mask
dal_mas_tit_fld set field title
dal_mas_wri_fld write field content
dal_mas_chk_sig_fld Return the field's significance
dal_mas_rea_fld read field content
dal_mas_clr_fld delete field content
dal_mas_set_fld activate field and position cursor
dal_mas_get_siz_sel return size of field query buffer
dal_mas_set_max_sel temporarily set size of field query buffer
dal_mas_wri_sel write search term in field query buffer
dal_mas_rea_sel read search term from field query buffer
dal_mas_clr_sel delete field query buffer
dal_mas_cre_rec insert record in mask
dal_mas_cop_rec copy record in target mask
dal_mas_del_rec delete record
dal_mas_clr_rec delete record content
dal_mas_res_rec set column record buffer to original value
dal_mas_act_lis activate mask (set mask edit state)
dal_mas_dal_exi_act deactivate mask (leave mask edit state)
dal_mas_chk_mdt check mandatory field for field contents
dal_mas_upd_row execute edit_action-trigger for update mode
dal_mas_ins_row insert record in mask (with trigger and defaults)
dal_mas_cop_row copy record in target mask (with trigger and defaults)
dal_mas_del_row delete record in mask (with trigger and defaults)
dal_mas_get_cur return field cursor position
dal_mas_ret_mas return Id of the mask for the mask name
dal_mas_ret_fld return Id of the field for the field name
dal_mas_get_pos_mas return mask position
dal_mas_get_siz_mas return mask size
dal_mas_get_pos_fld return field position in the mask
dal_mas_get_siz_fld return field size
dal_mas_get_tit_fld return field title
dal_mas_get_pos_tit access the relative position of a field title in the mask
dal_mas_get_siz_tit access the size of a field title
dal_mas_set_wrk_mod set work mode in mask edit state
dal_mas_ret_wrk_mod return work mode in mask edit state
dal_mas_set_act_mas activate mask
dal_mas_ret_act_mas return Id of the active mask
dal_mas_set_act_fld activate field
dal_mas_ret_act_fld return Id of the active field
dal_mas_ret_act_row return active record row position
dal_mas_ret_nxt_mas return Id of the next mask in the mask stack (no nested calls)
dal_mas_get_nxt_mas return Id of the next mask in the mask stack (nested calls allowed)
dal_mas_ret_type_mas return mask type of the mask
dal_mas_ret_bar_mas return scroll bar of the mask
dal_mas_set_dsc_mas set mask name of the mask Id
dal_mas_ret_dsc_mas return mask name of the mask Id
dal_mas_set_tit_mas set mask title of the mask
dal_mas_ret_tit_mas return mask title of the mask
dal_mas_set_sig_mas set number of significant fields of the mask
dal_mas_ret_sig_mas return number of significant fields of the mask
dal_mas_set_exs_mas set Id of the Select menu of the mask
dal_mas_ret_exs_mas return Id of the Select menu of the mask
dal_mas_set_exn_mas set Id of the NoSelect menu of the mask
dal_mas_ret_exn_mas return Id of the NoSelect menu of the mask
dal_mas_set_dal_men_edt set Id of the Edit menu of the mask
dal_mas_ret_dal_men_edt return Id of the Edit menu of the mask
dal_mas_set_dal_but_nos set NoSelect button area for mask
dal_mas_ret_dal_but_nos return Id of the NoSelect button area for mask
dal_mas_set_dal_but_sel set Select button area for mask
dal_mas_ret_dal_but_sel return Id of the Select button area for mask
dal_mas_set_dal_but_edt set edit button area for mask
dal_mas_ret_dal_but_edt return Id of the edit button area for mask
dal_mas_cal_dal_usx_mas call userexit at the mask trigger
dal_mas_set_xbm_mas set pre_mask-userexit
dal_mas_ret_xbm_mas return name of the pre_mask-userexit
dal_mas_set_xam_mas set post_mask-userexit
dal_mas_ret_xam_mas return name of the post_mask-userexit
dal_mas_set_xba_mas set pre_action-userexit
dal_mas_ret_xba_mas return name of the pre_action-userexit
dal_mas_set_xaa_mas set post_action-userexit
dal_mas_ret_xaa_mas return name of the post_action-userexit
dal_mas_set_xea_mas set edit_action-userexit
dal_mas_ret_xea_mas return name of the edit_action-userexit
dal_mas_set_xsl_mas set Sel_Action userexit
dal_mas_ret_dal_usx_mas return Id of the current userexit mask
dal_mas_set_buf_mas fill mask buffer
dal_mas_ret_buf_mas return mask buffer entry
dal_mas_set_joi_mas set join condition of the mask
dal_mas_ret_joi_mas return join condition of the mask
dal_mas_set_drt_rec set record-dirty flag
dal_mas_ret_drt_rec return record-dirty flag
dal_mas_ret_flg_rec return record-dirty flag with all variations
dal_mas_set_max_rec set maximum number of records in the mask
dal_mas_ret_max_rec return maximum number of records in the mask
dal_mas_ret_len_rec return current number of records in the mask
dal_mas_ret_nxt_fld return Id of the next field (no nested calls)
dal_mas_get_nxt_fld return Id of the next field (nested calls allowed)
dal_mas_set_dsc_fld set field name of the field Id
dal_mas_ret_dsc_fld return field name of the field Id
dal_mas_set_tit_fld set field title relatively to the field
dal_mas_ret_tit_fld return title entry for field
dal_mas_fnc_bmp add function to bitmap trigger stack
dal_mas_set_typ_fld set data type of the field
dal_mas_ret_typ_fld return data type of the field
dal_mas_set_drt_fld set field-dirty flag
dal_mas_ret_drt_fld return field-dirty flag
dal_mas_set_acc_fld set access Id of the field
dal_mas_ret_acc_fld return access Id of the field
dal_mas_set_ord_fld set sort Id of the field
dal_mas_ret_ord_fld return sort Id of the field
dal_mas_set_qmd_fld Set the local search mode for a table field
dal_mas_ret_qmd_fld return the local search mode for a table field
dal_mas_set_vid_fld set video attribute of the field
dal_mas_ret_vid_fld return video attribute of the field
dal_mas_ret_vid_tit return the video attribute of a field title
dal_mas_set_mty_fld set selection tool type at field
dal_mas_ret_mty_fld return selection tool type at field
dal_mas_set_mds_fld set name of the field selection tool for the field
dal_mas_ret_mds_fld return name of the field selection tool for the field
dal_mas_set_dal_men_fld set selection menu of the field
dal_mas_ret_dal_men_fld return Id of the selection menu of the field
dal_mas_fnc_men add new function to menu trigger stack
dal_mas_set_fmt_fld set format string of the field
dal_mas_ret_fmt_fld return format string of the field
dal_mas_set_chk_fld set check string of the field
dal_mas_ret_chk_fld return check string of the field
dal_mas_set_def_fld set default value of the field
dal_mas_ret_def_fld return default value of the field
dal_mas_set_dal_hlp_fld set full description of the field
dal_mas_ret_dal_hlp_fld return full description of the field
dal_mas_cal_dal_usx_fld return userexit at the field trigger
dal_mas_set_xbf_fld set pre_field-userexit
dal_mas_ret_xbf_fld return name of the pre_field-userexits
dal_mas_set_xaf_fld set post_field-userexit
dal_mas_ret_xaf_fld return name of the post_field-userexit
dal_mas_set_xhf_fld set Hyper_Field Userexit
dal_mas_ret_xhf_fld returns a Hyper_Field Userexit
dal_mas_set_buf_fld fill field buffer
dal_mas_ret_buf_fld return field buffer entry
dal_mas_set_col_cur set cursor to column position in the field
dal_mas_ret_col_cur return cursor column position in the field
dal_mas_ret_dal_mas_fld return mask Id of the field
dal_mas_set_tch_fld set field touch flag
dal_mas_ret_tch_fld return field touch flag
dal_mas_set_acm_fld set field access Id mode specifically
dal_mas_ret_acm_fld return mode specific access Id
dal_mas_set_ltx_fld set long string for Longtext field
dal_mas_ret_ltx_fld return long string for Longtext field
dal_mas_chk_ltx_fld return virtual width for Longtext field
dal_mas_chk_val_ltx identify string as longtext string
dal_mas_set_mlf_fld Set multilingual flag
dal_mas_ret_mlf_fld Return multilingual flag
dal_mas_set_lay_fnc set mask-listener function
dal_mas_ret_lay_fnc return pointer to mask-listener function
dal_mas_set_dal_fld_map set access mechanism for mask fields
dal_mas_dup_mas copy mask with or without data
dal_mas_set_lxk_mas set Longtext-Keep flag for mask
dal_mas_ret_lxk_mas return Longtext-Keep flag for mask
dal_mas_ret_dal_dfv_fld return original default value for the field


Module fld

dal_fld_ret_mlf return Id of the field for the field name (for multilingual fields)
dal_fld_ret_fld return Id of the field for the field name (with error message)
dal_fld_ret_ptr returns pointer of the field buffer for the field id
dal_fld_rea_str read field contents as string (without memory allocation)
dal_fld_rea_dyn read field contents as string (with memory allocation)
dal_fld_rea_log read field contents as boolean value
dal_fld_rea_int read field contents as integer
dal_fld_rea_flo read field contents as float number
dal_fld_rea_mon read field contents as money value
dal_fld_rea_dbl read field contents as float number (double)
dal_fld_rea_fld read field contents type dependently
dal_fld_wri_str write field contents as string
dal_fld_wri_log write field contents as boolean value
dal_fld_wri_int write field contents as integer
dal_fld_wri_flo write field contents as float number
dal_fld_wri_mon write field contents as money value
dal_fld_wri_dbl write field contents as float number (double)
dal_fld_wri_fld write field contents type dependently
dal_fld_wri_sel_str write search term as string in query buffer
dal_fld_wri_sel_log write search term as boolean value in query buffer
dal_fld_wri_sel_int write search term as integer in Query buffer
dal_fld_wri_sel_flo write search term as float number in query buffer
dal_fld_wri_sel_mon write search term as mony value in query buffer


Module men

dal_men_cre_men create menu
dal_men_res_men remove items from menu
dal_men_clr_men unlock items
dal_men_del_men remove menu from local memory
dal_men_chk_men check menu existence in local memory
dal_men_map_men position menu on screen
dal_men_srt_men sort item entries alphabetically
dal_men_wri_row enter item in menu
dal_men_rea_row read item entry
dal_men_loc_row lock item
dal_men_fre_loc unlock item
dal_men_chk_loc check item for locking
dal_men_del_row delete item
dal_men_ret_act return Id of the last active menu
dal_men_ret_men return Id of the menu of the menu name
dal_men_ret_siz Return number of selections in a menu
dal_men_ret_sel return row position of the active item
dal_men_ret_dsc return menu name of the menu Id
dal_men_set_buf fill menu buffer
dal_men_ret_buf return menu buffer entry
dal_men_set_nam fill menu selection buffer with item name
dal_men_ret_nam return item name
dal_men_set_tit fill the menu selection buffer with the selection text
dal_men_ret_tit Return selection text
dal_men_ret_usx return userexit name of the item (C-type only)
dal_men_ret_usn return userexit name of the item (all types)
dal_men_ret_par return userexit parameters of the item
dal_men_ret_nxt return Id of the next menu in the menu stack (no nested calls)
dal_men_get_nxt return Id of the next menu in the menu stack (nested calls allowed)
dal_men_dra_lin create separator line in the menu
dal_men_ret_son return sub menu
dal_men_set_sel_chk Set callback check function for selections
dal_men_clr_sel_chk remove callback function for selections from callback queue
dal_men_ret_sel_chk return pointer to callback check function for selections
dal_men_sel_chk checks whether the selection is to be added to the menu
dal_men_set_lfp_men set menu-listener function
dal_men_ret_lfp_men return pointer to menu-listener function


Module but

dal_but_cre_but create button area
dal_but_res_but remove buttons from button area
dal_but_del_but delete button area from local memory
dal_but_rfr_but update button area on graphical client
dal_but_chk_but check for existence of button area in local memory
dal_but_usx outpot button-area on screen (without title)
dal_but_map_but output button area on screen (with title)
dal_but_hid_but make button area invisible in mask
dal_but_pop_but make button area visible in mask
dal_but_cre_sel create button in button area
dal_but_del_sel delete button from button area
dal_but_loc_sel lock button
dal_but_fre_loc unlock button
dal_but_chk_loc check button locking
dal_but_fix_but fix button area
dal_but_ret_but return Id of button area for area name
dal_but_ret_dsc return button area name for area Id
dal_but_ret_cnt return number of buttons in button area
dal_but_set_geo set geometric button parameters
dal_but_get_geo get geometric button parameters
dal_but_set_nam fill button buffer with button name
dal_but_ret_nam return button name
dal_but_set_tit fill button buffer with button text
dal_but_ret_tit return button text
dal_but_set_par fill button buffer with userexit parameter
dal_but_ret_par return userexit parameter
dal_but_set_hlp fill button buffer with help text
dal_but_ret_hlp return help text
dal_but_set_usx fill button buffer with userexit name
dal_but_ret_usx return userexit name (C-type only)
dal_but_ret_uxn return userexit name (all types)
dal_but_set_buf fill button buffer
dal_but_ret_buf return button buffer entry
dal_but_ret_nxt return Id of next button area in area stack (no nested calls)
dal_but_get_nxt return Id of next button area in area stack (nested calls allowed)
dal_but_set_pos set button position
dal_but_ret_pos return position of button used last
dal_but_set_act set Id of current button externally
dal_but_ret_act return Id of the button used last
dal_but_set_men set menu to follow a button
dal_but_ret_men return menu to follow a button
dal_but_set_lab set toolbar title
dal_but_ret_lab return the toolbar title
dal_but_set_sel_chk callback check function for buttons
dal_but_clr_sel_chk remove callback check function for buttons from callback queue
dal_but_ret_sel_chk return pointer to callback check function for buttons
dal_but_sel_chk checks whether button can be added to button area
dal_but_set_lfp set button-listener function
dal_but_ret_lfp return pointer to button-listener function


Module mes

dal_mes_fre delete messages in local memory
dal_mes_set set length of the message window
dal_mes_wri write message
dal_mes_rea read message
dal_mes_upd update message
dal_mes_del delete message from message window
dal_mes_inp write message and request user input
dal_mes_prm write message (with user request)
dal_mes_xof deactivate message output
dal_mes_xon activate message output
dal_mes_fpt pass file pointer for log file
dal_mes_fnc set message-trap function