|
|
|
|
| ClearWindow | ClipForm | FadeInForm | MoveForm |
| ScatterForm | ScatterWindow | SetColor | SwitchColors |
procedure ClearWindow
(row1 : in ModSys.S_Natural;
row2 : in ModSys.S_Natural;
col1 : in ModSys.S_Natural;
col2 : in ModSys.S_Natural);
--*
-- ClearWindow - Clear a portion of the screen to the current color.
--
--
-- This procedure clears the portion of the screen defined by the rows and
-- columns to the current color.
--
-- CALLING SEQUENCE -
--
-- ClearWindow (row1, row2, col1, col2)
--
-- ENTRY -
--
-- row1 : ModSys.S_natural
-- The top row of the area (1..25).
--
-- row2 : ModSys.S_natural
-- The bottom row of the area (row1..25).
--
-- col1 : ModSys.S_natural
-- The left column of the area (1..80).
--
-- col2 : ModSys.S_natural
-- The right column of the area (col1..80).
--
-- EXAMPLE -
--
-- with FX;
--
-- procedure FXDemo1 is
--
-- -- This demo will clear the portion of the screen starting at row 3,
-- -- column 20 and ending at row 5, column 30.
--
-- begin
--
-- FX.ClearWindow (row1 => 3,
-- row2 => 5,
-- col1 => 20,
-- col2 => 30);
-- end FXDemo1;
--
procedure ClipForm
(FormName : in string;
topRow : in ModSys.S_Natural;
bottomRow : in ModSys.S_Natural;
leftCol : in ModSys.S_Natural;
rightCol : in ModSys.S_Natural;
startRow : in ModSys.S_Natural;
startCol : in ModSys.S_Natural;
endRow : in ModSys.S_Natural;
endCol : in ModSys.S_Natural;
millisec : in ModSys.S_Natural;
trace : in boolean);
--*
-- ClipForm - Display and optionally move a portion of a form.
--
--
-- This procedure displays and optionally moves the portion of a form
-- defined by its boundary rows and columns.
--
-- CALLING SEQUENCE -
--
-- ClipForm (formName, topRow, bottomRow, leftCol, rightCol, startRow,
-- startCol, endRow, endCol, millisec, trace)
--
-- ENTRY -
--
-- formName : string
-- Name of form to be used
--
-- topRow : ModSys.S_natural
-- Top row of defined area (1..24).
--
-- bottomRow : ModSys.S_natural
-- Bottom row of defined area (topRow..24)
--
-- leftCol : ModSys.S_natural
-- Left column of defined area (1..80)
--
-- rightCol : ModSys.S_natural
-- Right column of defined area (leftCol..80)
--
-- startRow : ModSys.S_natural
-- Optional new location (if other than topRow,leftCol) where the clipped
-- area should be displayed. Set to 0 if the location is not different.
--
-- startCol : ModSys.S_natural
-- Optional new location where area should be displayed. Set to zero if
-- non-moving form is desired.
--
-- endRow : ModSys.S_natural
-- Optional final location if a moving display is desired. Set to zero
-- if non-moving form is desired.
--
-- endCol : ModSys.S_natural
-- Optional final location if a moving display if desired. Set to zero
-- if non-moving form is desired.
--
-- millisec : ModSys.S_natural
-- The time desired to move the area from start to final location.
--
-- trace : boolean
-- Display a trace of the moving area (TRUE).
--
-- EXIT -
--
-- Sage.SageError : ModSys.S_natural
-- Errors in the operation.
--
-- EXAMPLE -
--
-- with FX;
--
-- procedure FXDemo2 is
--
-- -- Suppose we want to move a portion of a form across the screen. This
-- -- demo will clip part of a form and move it to row 17, column 46,
-- -- showing a trace of each move. The trace will start at row 11, col 17.
--
-- begin
--
-- -- We assume that OpenSystem has already been called and that the
-- -- form 'CLIPFORM' is contained in the DFL. The portion of the form
-- -- that we want to move starts at (2,7) and ends at (8,16).
--
-- FX.ClipForm (formName => "CLIPFORM",
-- topRow => 2,
-- bottomRow => 8,
-- leftCol => 7,
-- rightCol => 16,
-- startRow => 11,
-- startCol => 17,
-- endRow => 17,
-- endCol => 46,
-- millisec => 2000,
-- trace => True);
-- end FXDemo2;
--
procedure FadeInForm
(FormName : in string);
--*
-- FadeInForm - Fade in a form.
--
--
-- This procedure fades in a form. The display of the form follows the
-- rules of Display.DisplayBackground.
--
-- CALLING SEQUENCE -
--
-- FadeInForm (formName);
--
-- ENTRY -
--
-- formName : string
-- Name of form to fade in.
--
-- EXIT -
--
-- Sage.SageError : ModSys.S_natural
-- Errors in the operation.
--
-- EXAMPLE -
--
-- with FX;
--
-- procedure FXDemo8 is
--
-- -- Fade in the form 'FULLSCRN'.
--
-- begin
--
-- -- We assume that OpenSystem has already been called and that
-- -- the form 'FULLSCRN' is contained in the DFL.
--
-- FX.FadeInForm (formName => "FULLSCRN");
-- end FXDemo8;
--
procedure MoveForm
(FormName : in string;
startRow : in ModSys.S_Natural;
startCol : in ModSys.S_Natural;
endRow : in ModSys.S_Natural;
endCol : in ModSys.S_Natural;
millisec : in ModSys.S_Natural;
trace : in boolean);
--*
-- MoveForm - Display and optionally move a form.
--
--
-- This procedure displays and optionally moves a form. The display of
-- the form follows the rules of Display.DisplayBackground. The form
-- must be a portion of the full screen size in order to move it to a
-- different location on the screen.
--
-- CALLING SEQUENCE -
--
-- MoveForm (formName, startRow, startCol, endRow, endCol, millisec,
-- trace)
--
-- ENTRY -
--
-- formName : string
-- Name of form to be used
--
-- startRow : ModSys.S_natural
-- Location to begin move from
--
-- startCol : ModSys.S_natural
-- Location to begin move from.
--
-- endRow : ModSys.S_natural
-- Final location of the moving display.
--
-- endCol : ModSys.S_natural
-- Final location of the moving display.
--
-- millisec : ModSys.S_natural
-- The time desired to move the form from start to final location.
--
-- trace : boolean
-- Display a trace of the moving form (TRUE).
--
-- EXIT -
--
-- Sage.SageError : ModSys.S_natural
-- Errors in the operation.
--
-- EXAMPLE -
--
-- with FX;
--
-- procedure FXDemo3 is
--
-- -- Suppose we want to move a form down the screen. This demo will move
-- -- a form down the screen, showing a trace of each move. The trace
-- -- will start at row 1, column 1 and end at row 5, column 1.
--
-- begin
-- -- We assume that OpenSystem has already been called and that
-- -- the form 'CLIPFORM' is contained in the DFL.
--
-- FX.MoveForm (formName => "CLIPFORM",
-- startRow => 1,
-- startCol => 1,
-- endRow => 5,
-- endCol => 1,
-- millisec => 2000,
-- trace => True);
-- end FXDemo3;
--
procedure ScatterForm
(FormName : in string);
--*
-- ScatterForm - Scatter and reconstruct the indicated form.
--
--
-- This procedure scatters and then reconstructs the specified form. The
-- display of the form follows the rules of Display.DisplayBackground.
--
-- CALLING SEQUENCE -
--
-- ScatterForm (formName);
--
-- ENTRY -
--
-- formName : string
-- Name of form to reconstruct from a scattered appearance.
--
-- EXIT -
--
-- Sage.SageError : ModSys.S_natural
-- Errors in the operation.
--
-- EXAMPLE -
--
-- with FX;
--
-- procedure FXDemo7 is
--
-- -- Scatter then reconstruct the form 'FULLSCRN'.
--
-- begin
--
-- -- We assume that OpenSystem has already been called and that
-- -- the form 'FULLSCRN' is contained in the DFL.
--
-- FX.ScatterForm (formName => "FULLSCRN");
--
-- end FXDemo7;
--
procedure ScatterWindow
(row1 : in ModSys.S_Natural;
row2 : in ModSys.S_Natural;
col1 : in ModSys.S_Natural;
col2 : in ModSys.S_Natural);
--*
-- ScatterWindow - Scatter and reconstruct the indicated window.
--
--
-- This procedure scatters and then reconstructs the window defined by
-- the rows and columns. The scatter occurs almost instantaneously, but
-- the reconstruction is a longer event to give the appropriate effect.
--
-- CALLING SEQUENCE -
--
-- ScatterWindow (row1, row2, col1, col2)
--
-- ENTRY -
--
-- row1 : ModSys.S_natural
-- The top row of the area (1..25).
--
-- row2 : ModSys.S_natural
-- The bottom row of the area (row1..25).
--
-- col1 : ModSys.S_natural
-- The left column of the area (1..80).
--
-- col2 : ModSys.S_natural
-- The right column of the area (col1..80).
--
-- EXAMPLE -
--
-- with FX;
--
-- procedure FXDemo6 is
--
-- -- Scatter then reconstruct a portion of the screen starting at
-- -- row 5, column 10 and ending at row 20, column 70.
--
-- begin
--
-- FX.ScatterWindow (row1 => 5,
-- row2 => 20,
-- col1 => 10,
-- col2 => 70);
-- end FXDemo6;
--
procedure SetColor
(foreGround : in string;
backGround : in string;
intensity : in boolean;
blink : in boolean);
--*
-- SetColor - Set the color of the screen.
--
--
-- This procedure allows the setting of the current screen color. The
-- foreground and background colors, as well as the foreground intensity
-- and blinking attributes may be specified.
--
-- CALLING SEQUENCE -
--
-- SetColor (foreGround, backGround, intensity, blink)
--
-- ENTRY -
--
-- foreGround : string
-- Foreground color to use.
-- BLACK, BLUE, GREEN, CYAN, RED, MAGENTA, YELLOW, WHITE
--
-- backGround : string
-- Background color to use.
-- BLACK, BLUE, GREEN, CYAN, RED, MAGENTA, YELLOW, WHITE
--
-- intensity : boolean
-- Set the foreground intensity to high (TRUE) or low (FALSE).
--
-- blink : boolean
-- Blink the foreground (TRUE).
--
-- EXAMPLE -
--
-- with FX;
--
-- procedure FXDemo4 is
-- -- Suppose we want to set the color of the screen for writing the
-- -- next few lines of text. This demo will change the screen color
-- -- to yellow on blue. Everything typed on the screen after this
-- -- will be yellow on blue.
--
-- begin
-- -- Set the color of the screen to high intensity yellow on blue
--
-- FX.SetColor (foreGround => "YELLOW",
-- backGround => "BLUE",
-- intensity => True,
-- blink => False);
-- end FXDemo4;
--
procedure SwitchColors
(oldColor : in ModSys.S_Natural;
newColor : in ModSys.S_Natural;
millisec : in ModSys.S_Natural;
topRow : in ModSys.S_Natural;
bottomRow : in ModSys.S_Natural;
leftCol : in ModSys.S_Natural;
rightCol : in ModSys.S_Natural);
--*
-- SwitchColors - Switch colors on the screen.
--
--
-- This procedure switches the indicated color on the screen to the new
-- color in a top to bottom sweep. The time in milliseconds may be
-- specified to complete the sweep. If the sweep time is very small, the
-- switch will appear to happen suddenly.
--
-- CALLING SEQUENCE -
--
-- SwitchColors (oldColor, newColor, millisec, topRow, bottomRow, leftCol,
-- rightCol)
--
-- ENTRY -
--
-- oldColor : ModSys.S_natural
-- The old color to switch from.
--
-- color # foreground background
-- ------- ---------- ----------
-- 0 black black
-- 1 blue black
-- 2 green black
-- 3 cyan black
-- 4 red black
-- 5 magenta black
-- 6 brown black
-- 7 white black
-- 8 gray black
-- 9 light blue black
-- 10 light green black
-- 11 light cyan black
-- 12 light red black
-- 13 light magenta black
-- 14 yellow black
-- 15 light white black
-- 16..31 (same as 0..15) blue
-- 32..47 (same as 0..15) green
-- 48..63 (same as 0..15) cyan
-- 64..79 (same as 0..15) red
-- 80..95 (same as 0..15) magenta
-- 96..111 (same as 0..15) brown
-- 112..127 (same as 0..15) white
-- 128..255 (same as 0..127 except blink foreground)
--
-- newColor : ModSys.S_natural
-- The new color to switch to.
--
-- millisec : ModSys.S_natural
-- The number of milliseconds to take to switch colors.
--
-- topRow : ModSys.S_natural
-- The first row to begin the switch (1..n).
--
-- bottomRow : ModSys.S_natural
-- The last row to switch (topRow..n).
--
-- leftCol : ModSys.S_natural
-- The left most column to switch (1..n).
--
-- rightCol : ModSys.S_natural
-- The right most column to switch (leftCol..n).
--
-- EXAMPLE -
--
-- with FX;
--
-- procedure FXDemo5 is
-- -- Assume we wanted a portion of the current screen (form) to
-- -- change to a different color. This demo switches the current
-- -- color (light cyan on green) to yellow on blue beginning at row
-- -- 1, column 30 and ending at row 24, column 50.
--
-- begin
--
-- -- old color is light cyan on green, new color is yellow on blue.
--
-- FX.SwitchColors (oldColor => 43,
-- newColor => 30,
-- millisec => 2000,
-- topRow => 1,
-- bottomRow => 24,
-- leftCol => 30,
-- rightCol => 50);
-- end FXDemo5;
--
Send mail to
warren.merrill@inl.gov
with questions or comments about this web site.
Copyright © 1989-2006 Battelle Energy Alliance