The Best of Mecomp Multimedia 2/MECOMP-CD-II.iso/amiga/tools/workbench/uniview/docs/dtwindowrexx.hguide

Text File | 1998-02-04 | 16.2 KB | 655 lines

@hyperguide DTWindowRexx.hguide
@author Stefan Ruppert
@annotation dtwindow.class is part of the HTDS-Shareware licence
@$VER: DTWindowRexx.guide 40.3 (04.02.98)
@copyright (C) 1996-1998 by Stefan Ruppert
@smartwrap
@macro m_name "@{pari -3}@{lindent 6}@{par}@{sectfont}@{b}$1@{ub}@{deffont}@{line}@{pari 0}"
@listindent 6
@node Main "DTWindow Class ARexx Documentation"

@{settabs 30 60 90 120 150}
@{m_name "ARexx commands"}
The following ARexx commands are available for the dtwindow.class objects.
Many of these commands are identical to the MultiView commands.


@{"ABOUT"          Link ABOUT}@{tab}
@{"ACTIVATEWINDOW" Link ACTIVATEWINDOW}@{tab}
@{"BACKDROP"       Link BACKDROP}@{tab}
@{"BEEPSCREEN"     Link BEEPSCREEN}@{tab}
@{"CHANGEWINDOW"   Link CHANGEWINDOW}@{tab}
@{"CLEARSELECTED"  Link CLEARSELECTED}@{tab}
@{"CLOSE"          Link CLOSE}@{tab}
@{"COPY"           Link COPY}@{tab}
@{"GETATTR"        Link GETATTR}@{tab}
@{"GETCURRENTDIR"  Link GETCURRENTDIR}@{tab}
@{"GETFILEINFO"    Link GETFILEINFO}@{tab}
@{"GETOBJECTINFO"  Link GETOBJECTINFO}@{tab}
@{"MARK"           Link MARK}@{tab}
@{"MAXIMUMSIZE"    Link MAXIMUMSIZE}@{tab}
@{"MINIMUMSIZE"    Link MINIMUMSIZE}@{tab}
@{"MOVEWINDOW"     Link MOVEWINDOW}@{tab}
@{"NORMALSIZE"     Link NORMALSIZE}@{tab}
@{"NUMPAD"         Link NUMPAD}@{tab}
@{"OPEN"           Link OPEN}@{tab}
@{"PRINT"          Link PRINT}@{tab}
@{"QUIT"           Link QUIT}@{tab}
@{"RELOAD"         Link RELOAD}@{tab}
@{"RX"             Link RX}@{tab}
@{"SAVEAS"         Link SAVEAS}@{tab}
@{"SCREEN"         Link SCREEN}@{tab}
@{"SCREENTOBACK"   Link SCREENTOBACK}@{tab}
@{"SCREENTOFRONT"  Link SCREENTOFRONT}@{tab}
@{"SCROLL"         Link SCROLL}@{tab}
@{"SIZEWINDOW"     Link SIZEWINDOW}@{tab}
@{"SNAPSHOT"       Link SNAPSHOT}@{tab}
@{"UNZOOMWINDOW"   Link UNZOOMWINDOW}@{tab}
@{"WINDOW"         Link WINDOW}@{tab}
@{"WINDOWTOBACK"   Link WINDOWTOBACK}@{tab}
@{"WINDOWTOFRONT"  Link WINDOWTOFRONT}@{tab}
@{"ZOOMWINDOW"     Link ZOOMWINDOW}@{tab}

@endnode
@node ABOUT "DTWindow Class/ARexx/ABOUT"

@{m_name NAME}
ABOUT -- show information about program,object and user

@{m_name TEMPLATE}
PROGRAM/S,OBJECT/S,USER/S

@{m_name COMMAND}
This command opens a requester and show informations about the specified
section. The PROGRAM section show the version of the program opened the
DTWindow and the version of the dtwindow.class.


The OBJECT section gives information about the current object and object
datatype.


The USER section shows the address of the registered user or that it is
unregistered.

@{m_name "SEE ALSO"}
@endnode
@node ACTIVATEWINDOW "DTWindow Class/ARexx/ACTIVATEWINDOW"

@{m_name NAME}
ACTIVATEWINDOW -- activate the window

@{m_name TEMPLATE}
,

@{m_name COMMAND}
This command activates the datatype window.

@{m_name "SEE ALSO"}
@{"WINDOW" link WINDOW}
@endnode
@node BACKDROP "DTWindow Class/ARexx/BACKDROP"

@{m_name NAME}
BACKDROP -- toggle backdrop flag

@{m_name TEMPLATE}
,

@{m_name COMMAND}
This command is used to switch between normal and backdrop window. If the window
is in normal mode, it reopens the window in backdrop mode and vice versa. In this
mode the @{"WINDOWTOBACK" link WINDOWTOBACK} and @{"WINDOWTOFRONT" link WINDOWTOFRONT}
commands can't be used.

@{m_name "SEE ALSO"}
@{"WINDOWTOBACK" link WINDOWTOBACK},
@{"WINDOWTOFRONT" link WINDOWTOFRONT}
@endnode
@node BEEPSCREEN "DTWindow Class/ARexx/BEEPSCREEN"

@{m_name NAME}
BEEPSCREEN -- perform a display beep

@{m_name TEMPLATE}
,

@{m_name COMMAND}
This command perform a display beep.

@{m_name "SEE ALSO"}
@endnode
@node CHANGEWINDOW "DTWindow Class/ARexx/CHANGEWINDOW"

@{m_name NAME}
CHANGEWINDOW -- change the size and position of the window

@{m_name TEMPLATE}
LEFTEDGE/N,TOPEDGE/N,WIDTH/N,HEIGHT/N

@{m_name COMMAND}
The command tries to change the position and/or the dimension of the
window. A value of -1 lets the specified value unchanged.

@{m_name "SEE ALSO"}
@{"WINDOW" link WINDOW}
@endnode
@node CLOSE "DTWindow Class/ARexx/CLOSE"

@{m_name NAME}
CLOSE -- closes the window

@{m_name TEMPLATE}
,

@{m_name COMMAND}
This command closes the window.

@{m_name "SEE ALSO"}
@{"QUIT" link QUIT}
@endnode
@node COPY "DTWindow Class/ARexx/COPY"

@{m_name NAME}
COPY -- copy the contents of the current object to clipboard

@{m_name TEMPLATE}
,

@{m_name COMMAND}
This command copies the contents of the current object to the clipboard. Its only
available if the current object is able to use the clipboard.

@{m_name "SEE ALSO"}
@{"MARK" link MARK}
@endnode
@node GETATTR "DTWindow Class/ARexx/GETATTR"

@{m_name NAME}
GETATTR -- returns information about various subjects of the DTWindow

@{m_name TEMPLATE}
OBJECT/A,NAME,FIELD,VAR/K

@{m_name COMMAND}
This command returns information about the specified object and field
in the RESULT variable or the specified ARexx variable.
There are three object type for which you can get information. This are :

@{itemize}
@{item}APPLCATION
@{line}@{line}The following field names can be used for this typ :@{line}
@{definition}
@{defterm}SCREEN   @{defdata}the name of the public screen of the window
@{defterm}VERSION  @{defdata}the name and version of the application
@{enddefinition}
@{item}WINDOW
@{line}@{line}The following field names can be used for this typ :@{line}
@{definition}
@{defterm}LEFT    @{defdata}left edge of the window
@{defterm}TOP     @{defdata}top edge of the window
@{defterm}WIDTH   @{defdata}width of the window
@{defterm}HEIGHT  @{defdata}height of the window
@{defterm}TITLE   @{defdata}title of the window
@{enddefinition}
@{item}OBJECT
@{line}@{line}The following field names can be used for this typ :@{line}
@{definition}
@{defterm}TITLE     @{defdata}title of the object
@{defterm}PATH      @{defdata}full file path of the object
@{defterm}NODENAME  @{defdata}nodename of the current viewed node
@{enddefinition}
@{enditemize}

@{m_name "SEE ALSO"}
@{"GETCURRENTDIR" link GETCURRENTDIR},
@{"GETFILEINFO" link GETFILEINFO},
@{"GETOBJECTINFO" link GETOBJECTINFO}
@endnode
@node GETCURRENTDIR "DTWindow Class/ARexx/GETCURRENTDIR"

@{m_name NAME}
GETCURRENTDIR -- returns the directory of the current object

@{m_name TEMPLATE}
,

@{m_name COMMAND}
This command returns in the RESULT variable the directory, in which
current object resides.

@{m_name "SEE ALSO"}
@{"GETATTR" link GETATTR}
@endnode
@node GETFILEINFO "DTWindow Class/ARexx/GETFILEINFO"

@{m_name NAME}
GETFILEINFO -- returns the filename of the current object

@{m_name TEMPLATE}
,

@{m_name COMMAND}
This command returns the filename of the current object. This name is a fully
qualified pathname.

@{m_name "SEE ALSO"}
@{"GETATTR" link GETATTR}
@endnode
@node GETOBJECTINFO "DTWindow Class/ARexx/GETOBJECTINFO"

@{m_name NAME}
GETOBJECTINFO -- returns information about the current object

@{m_name TEMPLATE}
VAR/K,STEM/K

@{m_name COMMAND}
This command returns information about the current object. If the
STEM options is specified the following variables are set :

@{definition}
@{defterm}STEM.FILENAME  @{defdata}filename of the object
@{defterm}STEM.NAME      @{defdata}datatype name of the object
@{defterm}STEM.BASENAME  @{defdata}base datatype name of the object
@{defterm}STEM.GROUP     @{defdata}name of the group for the object
@{defterm}STEM.ID        @{defdata}ID of the object
@{enddefinition}

If the VAR option is specified or the RESULT variable is used, this
command returns a string, which contains the following informations
separated by a comma : NAME, BASENAME, GROUP, ID.

@{m_name "SEE ALSO"}
@{"GETATTR" link GETATTR}
@endnode
@node MARK "DTWindow Class/ARexx/MARK"

@{m_name NAME}
MARK -- enters the mark mode

@{m_name TEMPLATE}
,

@{m_name COMMAND}
This command is used to enter the mark mode within the datatype
window. This enables the user to select a dedicate region of the
object for later clipboard use. This command is only available if
the current object is able to let the user select a region of the
object.

@{m_name "SEE ALSO"}
@{"COPY" link COPY}
@endnode
@node MAXIMUMSIZE "DTWindow Class/ARexx/MAXIMUMSIZE"

@{m_name NAME}
MAXIMUMSIZE -- maximize the size of the window

@{m_name TEMPLATE}
,

@{m_name COMMAND}
This command increase the size of the window to its maximum.

@{m_name "SEE ALSO"}
@{"MINIMUMSIZE" link MINIMUMSIZE},
@{"NORMALSIZE" link NORMALSIZE},
@{"WINDOW" link WINDOW}
@endnode
@node MINIMUMSIZE "DTWindow Class/ARexx/MINIMUMSIZE"

@{m_name NAME}
MINIMUMSIZE -- minimize the size of the window

@{m_name TEMPLATE}
,

@{m_name COMMAND}
This command decrease the size of the window to its minimum.

@{m_name "SEE ALSO"}
@{"MAXIMUMSIZE" link MAXIMUMSIZE},
@{"NORMALSIZE" link NORMALSIZE},
@{"WINDOW" link WINDOW}
@endnode
@node MOVEWINDOW "DTWindow Class/ARexx/MOVEWINDOW"

@{m_name NAME}
MOVEWINDOW -- move the window

@{m_name TEMPLATE}
LEFTEDGE/N,TOPEDGE/N

@{m_name COMMAND}
This command moves the window to the specified coordinates.

@{m_name "SEE ALSO"}
@{"WINDOW" link WINDOW}
@endnode
@node NORMALSIZE "DTWindow Class/ARexx/NORMALSIZE"

@{m_name NAME}
NORMALSIZE -- normalize the size of the window

@{m_name TEMPLATE}
,

@{m_name COMMAND}
This command resets the size of the window to its normal values.

@{m_name "SEE ALSO"}
@{"NAXIMUMSIZE" link MAXIMUMSIZE},
@{"MINIMUMSIZE" link MINIMUMSIZE},
@{"WINDOW" link WINDOW}
@endnode
@node NUMPAD "DTWindow Class/ARexx/NUMPAD"

@{m_name NAME}
NUMPAD -- toggle numeric pad mode

@{m_name TEMPLATE}
,

@{m_name COMMAND}
This command toggle the numeric pad mode. If the mode is active
the numeric pad can be used to scroll the object.

@{m_name "SEE ALSO"}
@{"GETATTR" link GETATTR}

@endnode
@node OPEN "DTWindow Class/ARexx/OPEN"

@{m_name NAME}
OPEN -- open a file

@{m_name TEMPLATE}
FILE,NODE/K

@{m_name COMMAND}
This command tries to open the specified file and/or node. If the current
object supports the DTM_GOTO datatype method, this is used to load the
file. So the user can access the old object by using the retrace function.

@{m_name "SEE ALSO"}
@{"RELOAD" link RELOAD}

@endnode
@node PRINT "DTWindow Class/ARexx/PRINT"

@{m_name NAME}
PRINT -- print the contents of the current object

@{m_name TEMPLATE}
,

@{m_name COMMAND}
This command starts the printing job for the current object.

@{m_name "SEE ALSO"}
@endnode
@node QUIT "DTWindow Class/ARexx/QUIT"

@{m_name NAME}
QUIT -- quit the window

@{m_name TEMPLATE}
,

@{m_name COMMAND}
This command quits the window.

@{m_name "SEE ALSO"}
@{"CLOSE" link CLOSE}

@endnode
@node RELOAD "DTWindow Class/ARexx/RELOAD"

@{m_name NAME}
RELOAD -- reload the current object

@{m_name TEMPLATE}
,

@{m_name COMMAND}
This command close and reopens the current object.

@{m_name "SEE ALSO"}
@{"OPEN" link OPEN}

@endnode
@node RX "DTWindow Class/ARexx/RX"

@{m_name NAME}
RX -- execute an ARexx script

@{m_name TEMPLATE}
COMMAND/F

@{m_name COMMAND}
This command tries to execute the specified arexx script.

@{m_name NOTE}
Only available in the registered version.

@{m_name "SEE ALSO"}
@endnode
@node SAVEAS "DTWindow Class/ARexx/SAVEAS"

@{m_name NAME}
SAVEAS -- save the contents of the current object to a file

@{m_name TEMPLATE}
FILE

@{m_name COMMAND}
This command saves the current object to the specified file.

@{m_name "SEE ALSO"}
@{"OPEN" link OPEN}

@endnode
@node SCREEN "DTWindow Class/ARexx/SCREEN"

@{m_name NAME}
SCREEN -- toggle screen mode

@{m_name TEMPLATE}
,

@{m_name COMMAND}
This command toggles the screen mode. If this mode is set
the window is opened on an own public screen.

@{m_name "SEE ALSO"}
@{"GETATTR" link GETATTR}

@endnode
@node SCREENTOBACK "DTWindow Class/ARexx/SCREENTOBACK"

@{m_name NAME}
SCREENTOBACK -- bring the screen of the window to back

@{m_name TEMPLATE}
,

@{m_name COMMAND}
This command brings the screen of the window behind all other screens.

@{m_name "SEE ALSO"}
@{"SCREENTOFRONT" link SCREENTOFRONT}

@endnode
@node SCREENTOFRONT "DTWindow Class/ARexx/SCREENTOFRONT"

@{m_name NAME}
SCREENTOFRONT -- bring the screen of the window to front

@{m_name TEMPLATE}
,

@{m_name COMMAND}
This command brings the screen of the window to the front.

@{m_name "SEE ALSO"}
@{"SCREENTOBACK" link SCREENTOBACK}

@endnode
@node SCROLL "DTWindow Class/ARexx/SCROLL"

@{m_name NAME}
SCROLL -- scroll in the current object

@{m_name TEMPLATE}
VIEW/S,DOCUMENT/S,UP/S,DOWN/S,LEFT/S,RIGHT/S

@{m_name COMMAND}
This command is used to scroll within the object. The following
options defines the direction to scroll :

@{definition}
@{defterm}UP    @{defdata}The object should be scrolled upwards.
@{defterm}DOWN  @{defdata}The object should be scrolled downwards.
@{defterm}LEFT  @{defdata}The object should be scrolled to the left.
@{defterm}RIGHT @{defdata}The object should be scrolled to the right.
@{enddefinition}

The options VIEW and DOCUMENT controls how much should be scrolled.
If both are omitted the unit of the scroll to perform is a line or
a row. If the VIEW option is specified the unit is the visible lines
or rows. If the DOCUMENT option is used it jumps to the end of each
direction.

@{m_name "SEE ALSO"}
@{"GETATTR" link GETATTR}

@endnode
@node SIZEWINDOW "DTWindow Class/ARexx/SIZEWINDOW"

@{m_name NAME}
SIZEWINDOW -- change the size of the window

@{m_name TEMPLATE}
WIDTH/N,HEIGHT/N

@{m_name COMMAND}
This command is used to change the size of the window. If a value of -1
is given the width or height is unchanged.

@{m_name "SEE ALSO"}
@{"CHANGEWINDOW" link CHANGEWINDOW},
@{"MOVEWINDOW" link MOVEWINDOW},
@{"WINDOW" link WINDOW}
@endnode
@node SNAPSHOT "DTWindow Class/ARexx/SNAPSHOT"

@{m_name NAME}
SNAPSHOT -- save current state to a preference file

@{m_name TEMPLATE}
FILE

@{m_name COMMAND}
This command is used to write the current values to the specified file.
If no file is specified, the current values are saved as default values.

@{m_name "SEE ALSO"}

@endnode
@node UNZOOMWINDOW "DTWindow Class/ARexx/UNZOOMWINDOW"

@{m_name NAME}
UNZOOMWINDOW -- unshrink window

@{m_name TEMPLATE}
,

@{m_name COMMAND}
This command is used to restore the windows size to its normal values.

@{m_name "SEE ALSO"}
@{"WINDOW" link WINDOW},
@{"ZOOMWINDOW" link UNZOOMWINDOW}
@endnode
@node WINDOW "DTWindow Class/ARexx/WINDOW"

@{m_name NAME}
WINDOW -- manipulate the window

@{m_name TEMPLATE}
MIN/S,MAX/S,NORM/S,ACTIVATE/S,FRONT/S,BACK/S,ZOOM/S,UNZOOM/S

@{m_name COMMAND}
This command manipulates the window in differant ways. It combines
most window related commands together. The following switches can be used :

@{definition}
@{defterm}MIN      @{defdata}Minimizes the window. Same as @{"MINIMUMSIZE" link MINIMUMSIZE} command.
@{defterm}MAX      @{defdata}Maximizes the window. Same as @{"MAXIMUMSIZE" link MAXIMUMSIZE} command.
@{defterm}NORM     @{defdata}Reset the window to its normal size. Same as @{"NORMALSIZE" link NORMALSIZE} command.
@{defterm}ACTIVATE @{defdata}Activate the window. Same as @{"ACTIVATEWINDOW" link ACTIVATEWINDOW} command.
@{defterm}FRONT    @{defdata}Brings the window in front of all other windows. Same as @{"WINDOWTOFRONT" link WINDOWTOFRONT} commad.
@{defterm}BACK     @{defdata}Brings the window behind all other windows. Same as @{"WINDOWTOBACK" link WINDOWTOBACK} command.
@{defterm}ZOOM     @{defdata}Changes the window to its minimal size state. Same as @{"ZOOMWINDOW" link ZOOMWINDOW} command.
@{defterm}UNZOOM   @{defdata}Changes the window to its normal size state. Same as @{"UNZOOMWINDOW" link UNZOOMWINDOW} command.
@{enddefinition}

@{m_name "SEE ALSO"}
@{"ACTIVATEWINDOW" link ACTIVATEWINDOW},
@{"MAXIMUMSIZE" link MAXIMUMSIZE},
@{"MINIMUMSIZE" link MINIMUMSIZE},
@{"NORMALSIZE" link NORMALSIZE},
@{"UNZOOMWINDOW" link UNZOOMWINDOW},
@{"WINDOWTOBACK" link WINDOWTOBACK},
@{"WINDOWTOFRONT" link WINDOWTOFRONT},
@{"ZOOMWINDOW" link ZOOMWINDOW}
@endnode
@node WINDOWTOBACK "DTWindow Class/ARexx/WINDOWTOBACK"

@{m_name NAME}
WINDOWTOBACK -- bring the window to back

@{m_name TEMPLATE}
,

@{m_name COMMAND}
The datatype window will be send behind other windows.

@{m_name "SEE ALSO"}
@{"WINDOW" link WINDOW},
@{"WINDOWTOFRONT" link WINDOWTOBACK}
@endnode
@node WINDOWTOFRONT "DTWindow Class/ARexx/WINDOWTOFRONT"

@{m_name NAME}
WINDOWTOFRONT -- bring the window to front

@{m_name TEMPLATE}
,

@{m_name COMMAND}
The datatype window will be brought to the front.

@{m_name "SEE ALSO"}
@{"WINDOW" link WINDOW},
@{"WINDOWTOBACK" link WINDOWTOBACK}

@endnode
@node ZOOMWINDOW "DTWindow Class/ARexx/ZOOMWINDOW"

@{m_name NAME}
ZOOMWINDOW -- shrink the window

@{m_name TEMPLATE}
,

@{m_name COMMAND}
This command is used to make the window small.

@{m_name "SEE ALSO"}
@{"UNZOOMWINDOW" link UNZOOMWINDOW},
@{"WINDOW" link WINDOW}
@endnode