Function Keys Screen [ HP ALLBASE/4GL Developer Reference Manual Vol. 1 ] MPE/iX 5.0 Documentation
HP ALLBASE/4GL Developer Reference Manual Vol. 1
Function Keys Screen
This screen allows you to name a function key set and define the actions
performed by the keys.
Screen Image
Field Descriptions
Function Keys
Enter the name of the function key set (up to 16 characters). If you
haven't previously defined the name, HP ALLBASE/4GL assumes you're
defining a new function key set and displays the default function key
set. (Refer to Additional Information.)
Action Enter the code of the action to be carried out by HP ALLBASE/4GL
when the user presses the function key. The available action codes and
their meanings are:
Code Action Type
B- Background process
D- Data screen or menu
F- Function logic block
H- Help screen
I- Internal action
K- Call another function key
set
P- Process logic block
R- Report
X- External program
blank No action performed
To specify an action, enter the action code followed by a hyphen and the
action name. For example, D-emp_details displays the screen emp_details.
Label Text Enter the screen label text for the function key. The label
can use two lines of text, each containing up to eight characters.
Switch Number Optional. Enter a number from 1 to 8, representing one
of the HP ALLBASE/4GL user switches.
If you enter a switch number in this field, HP ALLBASE/4GL displays an
asterisk in the function key label on the application screen at run-time
while the switch is on. If the key label has one line of text, the
asterisk is placed in column 8 in the top line of text. If the label has
two lines of text, the asterisk is placed in the bottom line of the
label. The asterisk is not displayed while the switch is off.
Typically you would use this feature to provide the end user with a
visual indication of the status of a function. For example, you could
use a function associated with the function key to toggle a particular
operating mode (such as an add mode, modify mode, or delete mode) on or
off. By setting a switch on or off in the function, you can provide the
end user with a visual indication of the current operating mode.
Function Keys
f1 Screen Header Cancels the current screen and displays the
screen header screen.
f2 Screen Painter Cancels the current screen and runs the screen
painter program.
f3 Field Details Cancels the current screen and displays the
screen fields detail screen.
Additional Information
Function Key Display Logic.
HP ALLBASE/4GL displays function key sets on application screens
according to the following rules:
* If the current screen has a set of function keys defined for it,
these keys are displayed when the screen is executed.
* If the current screen has a window displayed on it, and the window
has its own set of function keys, the function keys for the window
are displayed. If the window does not have its own set of
function keys, the function keys for the main screen (if defined)
are displayed.
* If the current screen does not have a set of function keys defined
for it, HP ALLBASE/4GL displays the function key set default_keys
from the local application, or if these don't exist, the function
key set default_keys from the administrator application.
If HP ALLBASE/4GL cannot find a set of function keys defined for a screen
or window, it searches for a set of function keys with the same name in
the administrator application. If no other keys can be found, HP
ALLBASE/4GL displays the default_keys function key set from the
administrator application.
If HP ALLBASE/4GL cannot read a set of function keys called by a K-
action from a function key, it searches for a set of function keys with
the same name in the administrator application. If no other keys can be
found, HP ALLBASE/4GL displays the default_keys function keys from the
administrator application.
HP ALLBASE/4GL Internal Routines
You can use function keys on application screens to initiate any HP
ALLBASE/4GL internal routine. To assign an internal routine to an
application screen function key, enter I-followed by the internal routine
name in the action field on the function keys definition screen. The
internal routines are described in the following paragraphs.
I-BACKTAB The I-BACKTAB internal routine moves the screen cursor as if
the Shift + Tab keys and then the Return key sequence have been pressed.
This provides faster reverse tabbing for end-users when they use one of
the function keys to call I-Backtab.
I-CLEAR This routine clears all input and display-only fields on the
current screen.
I-COMMIT The I-COMMIT internal routine terminates all current screen
processing. Typically, you provide the user with a Commit Data
function key to invoke the I-COMMIT internal routine. The user can press
the function key to indicate that data entry on the screen has been
completed. By default, HP ALLBASE/4GL assigns this internal routine to
function key number 6 in a new set of function keys.
On a data screen or window, HP ALLBASE/4GL executes the I-COMMIT internal
routine immediately if the current screen field has been processed. If
the current field has not been processed, HP ALLBASE/4GL processes this
field and then executes the I-COMMIT internal routine.
After the I-COMMIT internal routine, HP ALLBASE/4GL resumes running the
application in one of three possible ways, depending on how the screen
was displayed.
* If the screen was displayed by a SCREEN command in a logic block,
control returns to the command immediately following the SCREEN
command.
* If the screen was displayed directly from a menu, control returns
to the menu.
* If the screen was displayed from a function called from a field on
another screen, or a function key on another screen, HP
ALLBASE/4GL firstly returns to the function and executes the
remaining commands. Control then returns to the logic block or
menu that displayed the original screen.
On a menu, the I-COMMIT internal routine immediately executes the
selected item.
I-EXIT The I-EXIT internal routine terminates execution of HP
ALLBASE/4GL and returns to the original MPE/iX operating system level.
I-HELP The I-HELP internal routine displays the help screen associated
with the current message, field, or screen. By default, HP ALLBASE/4GL
assigns this action to function key number 7 in a new function key set.
I-hpqm_call This routine temporarily suspends execution of HP
ALLBASE/4GL and starts HP ALLBASE/QUERY. The normal HP ALLBASE/QUERY
welcome screen is bypassed, and the user is automatically connected to
the application's HP ALLBASE/SQL database. When the user exits from HP
ALLBASE/QUERY, normal HP ALLBASE/4GL processing is resumed.
If the current application has an open SQL transaction when the user
presses a function key that calls this action, HP ALLBASE/4GL displays a
warning message, and allows the user to complete or reverse the
transaction before starting HP ALLBASE/QUERY.
I-image_dbchg_call This routine suspends HP ALLBASE/4GL processing and
invokes the HP TurboIMAGE DBchange/XL program. When the user exits from
the HP TurboIMAGE DBchange/XL program, HP ALLBASE/4GL processing resumes
at the point where the I-image_dbchg_call routine was called.
I-image_dbutl_call This routine suspends HP ALLBASE/4GL processing and
invokes the HP TurboIMAGE DBUTIL program. When the user exits from HP
TurboIMAGE DBUTIL, HP ALLBASE/4GL processing resumes at the point where
the I-image_dbutl_call routine was called.
I-image_query_call This routine suspends HP ALLBASE/4GL processing and
invokes the HP QUERY/XL program, if it is on your system. When the user
exits from HP QUERY/XL, HP ALLBASE/4GL processing resumes at the point
where the I-image_query_call routine was called.
I-isql_call Suspends HP ALLBASE/4GL processing and invokes the HP ISQL
program. When the user exits from HP ISQL, HP ALLBASE/4GL processing
resumes at the point where the I-isql_call routine was called.
I-logon The I-logon internal routine immediately terminates the current
application and displays the HP ALLBASE/4GL sign-on screen. (Note that
this routine name is in lowercase letters.)
Typically, you would use this internal routine to provide the end-user
with a Sign-on Screen function key.
I-MAINMENU The I-MAINMENU internal routine displays the application
main menu. This is either the initial action specified for the
application on the administrator application definition screen (Refer to
the HP ALLBASE/4GL Developer Administration Manual), or the first menu
displayed by the application if the application's initial action is a
process. If no menu has been displayed, the application is terminated.
The I-MAINMENU internal routine terminates the current screen and logic
block immediately.
I-PREVKEYS Replaces the function keys on the application screen with
the previous set of function keys.
I-PREVMENU If HP ALLBASE/4GL is displaying a menu, the internal routine
I-PREVMENU immediately returns control to the previous menu.
If HP ALLBASE/4GL is displaying a data screen, but the user has not
entered any data on the screen, the I-PREVMENU internal routine returns
control to the last menu displayed by the system. The I-PREVMENU routine
immediately terminates any current process, function or decision table.
If the user has started entering data on the data screen, the I-PREVMENU
internal routine initially displays a message informing the user that the
screen has not been committed. A second I-PREVMENU internal routine
returns control to the last menu displayed by the system without
committing any data entered so far. Any current module, process,
function or decision table is terminated immediately.
By default, HP ALLBASE/4GL assigns the I-PREVMENU internal routine to
function key number 8 in a new function key set.
I-PRINT Prints the screen and the contents of all fields. The
destination printer is determined by the HP-UX variable HP4SCREEN_PRINT.
If HP4SCREEN_PRINT is undefined, HP ALLBASE/4GL writes the screen image
to the formal file designator HP4REP.
If HP4SCREEN_PRINT exists, but is null (that is, its value is the empty
string "") HP ALLBASE/4GL attempts to print the screen image on a slave
printer attached to the user's terminal.
If HP4SCREEN_PRINT exists and contains a non-null value, screen printing
is inhibited.
I-REFRESH Repaints the screen and the contents of all fields.
I-RESET Performs a terminal soft reset sequence.
I-SHELL Suspends HP ALLBASE/4GL processing and invokes the MPE/iX
command interpreter. When the user exits from the MPE/iX command
interpreter, HP ALLBASE/4GL processing resumes at the point where the
SHELL command was issued.
Users can execute a specific a command interpreter by setting the SHELL
variable. MPE/iX executes the command interpreter defined by this
variable. If the SHELL variable is not defined, this internal routine
calls the command interpreter program CI.PUB.SYS by default. The system
administrator can change this default.
I-SLAVE_PRINT Prints an image of the current screen on a slave printer
attached to the user's terminal. If no slave printer is attached to the
terminal, this command times out after about five seconds and HP
ALLBASE/4GL issues a message asking the user to either retry or abort the
command.
I-TAB The I-TAB internal routine moves the screen cursor as if the Tab
key has been pressed. This internal routine is provided to accompany the
I-BACKTAB internal routine.
I-TRACEMODE Toggles the HP ALLBASE/4GL trace mode on or off. When
trace is active, HP ALLBASE/4GL displays the current logic block and step
for about three seconds, and then proceeds to the next step. Refer to
chapter 14 for more information on trace mode.
I-TRAIN Toggles the HP ALLBASE/4GL training mode on or off. If the
system administrator has set the application user into training mode,
this internal action does not disable the mode. In this case, the
training mode can only be disabled by the system administrator.
Default Function Key Definitions
When you're defining a new function key set, HP ALLBASE/4GL supplies a
number of default function key definitions automatically.
You can set up your own default function key set in the application
you're developing by a defining a function key set called default_keys.
Each time you create a new set of function keys, HP ALLBASE/4GL will
display this set of default key actions and labels. You can type over
the defaults if they don't suit the screen you are working on. Note that
if you define a set of default keys in your application, these keys will
be displayed on an application screen unless you specify a different set
of function keys on the screen header for the application screen.
If you don't define a function key set called default_keys in your
application, HP ALLBASE/4GL displays the function key set default_keys
from the administrator application as the default each time you create a
new function key set in your application.
If you are in test mode, you may see a different set of default keys than
you see when accessing other developer screens. The following tables
list the default function keys for developer screens and test mode.
The first table lists the administrator application default function
keys. These keys are available in both developer screens and in test
mode.
Key Action Key Label Text
5 K-global_keys_1 System Keys
6 I-COMMIT Commit Data
7 K-HELP Help
8 I-PREVMENU Previous Menu
The function key set global_keys_1 from the administrator application
supplies the definitions for the System Keys function keys to function
key number 5. These keys are available in both developer screens and in
test mode.
The actions and key labels for these keys are as follows:
Key Action Key Label Text
1 I-MAINMENU Main Menu
2 K- print_scrn_keys Screen Printing
3 I-CLEAR Clear Screen
4 I-REFRESH Refresh Screen
5 I-PREVKEYS Previous Keys
6 K- global_keys_2 More Keys
7 I-HELP Help
8 I-PREVMENU Previous Menu
The K- global_keys_2 action assigns the key set global_keys_2 from the
administrator application to the More Keys function key in the System
Keys function key set. These keys are available only on the developer
screen; they are not available in test mode.
The actions and key labels for this function key set are:
Key Action Key Label Text
2 I-SHELL Op. System
3 I-isql_call ISQL
4 I-hpqm_call ALLBASE QUERY
5 I-PREVKEYS Previous Keys
6 K-global_keys_3 More Keys
7 I-HELP Help
8 I-EXIT Exit
The K- global_keys_2 action in test mode assigns the following key set
global_keys_2 to the More Keys function key in the System Keys
function key set. These keys are available only in test mode.
The actions and key labels for this function key set are:
Key Action Key Label Text
2 I-SHELL Op. System
3 I-TRAIN Training Mode
4 I-TRACEMODE Trace Mode
5 I-PREVKEYS Previous Keys
7 I-HELP Help
8 I-EXIT Exit
The K- global_keys_3 action assigns the key set global_keys_3 from the
administrator application to the More Keys function key in the More
Keys function key set. These keys are available only in the developer
screens.
The actions and key labels for this function key set are:
Key Action Key Label Text
1 I-image_dbutl_call T'IMAGE DBUTIL
2 I-image_query_call T'IMAGE QUERY
3 I-image_dbchg_call T'IMAGE DBCHANGE
5 I-PREVKEYS Previous Keys
7 I-HELP Help
8 I-EXIT Exit
The K-print_scrn_keys action in the global_keys_1 function key set
assigns the function key set print_scrn_keys from the administrator
application to function key number 2 in the System Keys function keys.
These keys are available in the developer screens and in test mode.
The actions and key labels for the print_scrn_keys function key set are:
Key Action Key Label Text
3 I-PRINT To System
4 I-SLAVE_PRINT To Local
5 I-PREVKEYS Previous Keys
In test mode you can override the four system function key sets,
global_keys_1, global_keys_2, global_keys_3, and print_scrn_keys, for a
particular application by defining function key sets with the same names
in your application.
MPE/iX 5.0 Documentation