@database DirScannerRexx.guide
@author Hynek Schlawack
@smartwrap
@tab 4

@node main "DirScanner - Rexx"

@{line}
	@{fg shine}@{b}Rexx@{ub}@{fg text}@{line}
@{line}
	Version 2 of DirScanner introduced an extensive Rexx port which enables
many possibilities. Beside of the standard MUI commands, he consists of
the following ones:@{par}
@{line}
	@{"GET" link rx_get}@{line}
	@{"SET" link rx_set}@{line}
	@{"TOGGLE" link rx_toggle}@{line}
@{line}
	@{"ABOUT" link rx_about}@{line}
	@{"REQUESTER" link rx_req}@{line}
	@{"START" link rx_start}@{line}
@{line}
	@{"ADDPATH" link rx_addp}@{line}
	@{"CLEARPATHS" link rx_clearp}@{line}
	@{"DELPATH" link rx_delp}@{line}
@{line}
	@{"CLIP" link rx_clip}@{line}
	@{"COPY" link rx_copy}@{line}
	@{"VIEW" link rx_view}@{line}
	@{"DELETE" link rx_delete}@{line}
@{line}
	@{"SELECT" link rx_select}@{line}
	@{"UNSELECT" link rx_unselect}@{line}
@{line}
@endnode

@node rx_get "DirScanner - GET"
@{line}
	@{fg shine}@{b}GET@{ub}@{fg text}@{line}
@{line}
	@{b}Template:@{ub} WHAT/A,VAL/A@{line}
@{line}
	Gets an attribute and returns it in the "result" variable. The possible
attributes are:@{par}
@{line}
	· PATTERN - The pattern (string).@{line}
	· MATCH_CURS - The active match (integer).@{line}
	· MATCH_AMM - The ammount of matches (integer).@{line}
	· MATCH_FILE - The full path of the current match (string).@{line}
				   From 2.3 on: GET MATCH_FILE <nr> is also supported.@{line}
	· PATH_CURS - The active path (-1 if none selected) (integer).@{line}
	· PATH_AMM - The ammount of paths (integer).@{line}
	· PATH - The active path (string).@{line}
	· MODE - The mode (Search By:) (string).@{line}
	· CONDITION - The Condition (string).@{line}
	· ICONIFY - Is DirScanner iconified (boolean)?@{line}
	· VERSION - Returns the version of DirScanner ("VERSION.REVISION").@{line}
	· LOCKGUI - Is the mainwindow locked (boolean)?@{line}
	· PUBSCREEN - The name of the current public screen (string).@{line}
@{line}
@endnode

@node rx_set "DirScanner - SET"
@{line}
	@{fg shine}@{b}SET@{ub}@{fg text}@{line}
@{line}
	@{b}Template:@{ub} WHAT/A,VAL/A@{line}
@{line}
	Sets an attribute. The possible attributes are:@{par}
@{line}
	· PATTERN - The pattern (string).@{line}
	· MATCH_CURS - The active match (integer).@{line}
	· PATH_CURS - The active path (integer).@{line}
	· MODE - The mode, please use the english Search By-Strings for it.@{line}
	· CONDITION - The condition, please use the english Mode-Strings for it.@{line}
	· ICONIFY - Iconify or uniconify DirScanner (boolean).@{line}
	· LOCKGUI - Lock the main window (boolean). Works nested! @{line}

@endnode

@node rx_toggle "DirScanner - TOGGLE"
@{line}
	@{fg shine}@{b}TOGGLE@{ub}@{fg text}@{line}
@{line}
	@{b}Template:@{ub} WHAT/A,HOW@{line}
@{line}
	Toggles an attribute. The possible attributes are:@{par}
@{line}
	· MATCH_CURS - Move the cursor in the matches listview ("UP" or "DOWN").@{line}
	· PATH_CURS - Move the cursor in the paths listview ("UP" or "DOWN").@{line}
	· MODE - Set the "NEXT" or "PREV" mode.@{line}
	· CONDITION - Set the "NEXT" or "PREV" condition.@{line}
	· ICONIFY - Iconify or uniconify. No "how" supported.@{line}
@endnode

@node rx_about "DirScanner - ABOUT"
@{line}
	@{fg shine}@{b}ABOUT@{ub}@{fg text}@{line}
@{line}
	Pops up the about requester.@{par}
@endnode

@node rx_req "DirScanner - REQUESTER"
@{line}
	@{fg shine}@{b}REQUESTER@{ub}@{fg text}@{line}
@{line}
	@{b}Template:@{ub} TEXT/A@{line}
@{line}
	Pops up a requester with the specified text.@{par}
@endnode

@node rx_start "DirScanner - START"
@{line}
	@{fg shine}@{b}START@{ub}@{fg text}@{line}
@{line}
	Starts the scan.@{par}
@endnode

@node rx_addp "DirScanner - ADDPATH"
@{line}
	@{fg shine}@{b}ADDPATH@{ub}@{fg text}@{line}
@{line}
	@{b}Template:@{ub} PATH@{line}
@{line}
	Adds a path. If no path is specified an asl-requester will ask for
him.@{par}
@endnode

@node rx_clearp "DirScanner - CLEARPATHS"
@{line}
	@{fg shine}@{b}CLEARPATHS@{ub}@{fg text}@{line}
@{line}
	Clears the list of paths.@{par}
@endnode

@node rx_delp "DirScanner - DELPATH"
@{line}
	@{fg shine}@{b}DELPATH@{ub}@{fg text}@{line}
@{line}
	Removes the active path from the paths list and all matches found in it
from the matches list.@{par}
@endnode

@node rx_clip "DirScanner - CLIP"
@{line}
	@{fg shine}@{b}CLIP@{ub}@{fg text}@{line}
@{line}
	Puts the path of the selected matches in the clipboard.@{par}
@endnode

@node rx_copy "DirScanner - COPY"
@{line}
	@{fg shine}@{b}COPY@{ub}@{fg text}@{line}
@{line}
	@{b}Template:@{ub} TO@{line}
@{line}
	Copies the selected matches either to "TO" or pops up an asl requester for
determinating the destination.@{par}
@endnode

@node rx_view "DirScanner - VIEW"
@{line}
	@{fg shine}@{b}VIEW@{ub}@{fg text}@{line}
@{line}
	Views the selected matches.@{par}
@endnode

@node rx_delete "DirScanner - DELETE"
@{line}
	@{fg shine}@{b}DELETE@{ub}@{fg text}@{line}
@{line}
	Deletes	the selected matches from disk and the matches list.@{par}
@endnode

@node rx_select "DirScanner - SELECT"
@{line}
	@{fg shine}@{b}SELECT@{ub}@{fg text}@{line}
@{line}
	@{b}Template:@{ub} WHAT/A@{line}

	Selects either a certain or "ALL" matches (you must enclose the command in
quotes!).@{par}
@endnode

@node rx_unselect "DirScanner - UNSELECT"
@{line}
	@{fg shine}@{b}UNSELECT@{ub}@{fg text}@{line}
@{line}
	@{b}Template:@{ub} WHAT/A@{line}

	Unselects either a certain or "ALL" matches.@{par}
@endnode