Copyright (c) Hyperion Entertainment and contributors.

Difference between revisions of "MultiView"

From AmigaOS Documentation Wiki
Jump to navigation Jump to search
(Created page with "= Introduction = Multiview can read any file for which there is a descriptor file in Devs:Datatypes. These tell Multiview (and any other programs written to take advantage of...")
 
 
(10 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
Multiview can read any file for which there is a descriptor file in Devs:Datatypes. These tell Multiview (and any other programs written to take advantage of datatypes) how to load the various types of files.
  
Multiview can read any file for which there is a descriptor file in Devs:Datatypes. These tell Multiview (and any other programs written to take advantage of datatypes) how to load the various types of files.
   
  +
= Command line arguments =
−
== ARexx Commands ==
  
   
  +
; FILE
−
OPEN
  
  +
: Name of the file you want to be displayed/played by Multiview. Alternatively you can specify a volume or directory name that will be used by Multiview as the current directory when it opens its requester.
  +
: Note: this argument is optional as Multiview can be used to display the content of a clipboard unit instead of a file.
   
−
NAME/K,CLIPBOARD/S,CLIPUNIT/K/N
 +
; CLIPBOARD/S
−
Open a file, or the contents of the specified clipboard unit.
 +
: Argument that will make Multiview display the content of the clipboard unit specified with the CLIPUNIT argument.
   
  +
; CLIPUNIT/K/N
−
RELOAD
  
  +
: Clipboard unit you want to display with Multiview. Default is 0.
−
,
  
−
Reload the current object.
  
   
  +
; SCREEN/S
−
SAVEAS
  
  +
: Arguments that will make Multiview open its view window on its own screen.
  +
  +
; PUBSCREEN/K
  +
: Name of a public screen you want Multiview to open its window on.
  +
: Note: usage of the SCREEN switch is implicit so it is not needed. If you quit the program which is owner of the public screen while Multiview is still opened the application will probably crash as it is not necessarily aware of an alien windows opened on its screen.
  +
  +
; REQUESTER/S
  +
  +
; BOOKMARK/S
  +
: Reads file ENV:MultiView.bookmark
  +
  +
; FONTNAME/K
  +
: Name of the font Multiview will use to display text and AmigaGuide files. If none is specified here Multiview will use the default system font.
  +
  +
; FONTSIZE/K/N
  +
: Size of the font Multiview will use to display text and AmigaGuide files. If none is specified here Multiview will use the default system font.
  +
  +
; CHARSET/K
  +
: Charset to use to display text and AmigaGuide files.
  +
  +
; BACKDROP/S
  +
: When this argument is used Multiview will open its display window in backdrop mode.
  +
  +
; WINDOW/S
  +
: By default when running Multiview with no arguments, it will open a requester the user can use to select a file to load. With the WINDOW switch Multiview will open with a blank window and no loaded file. The user will have to select Open in the Project menu to select a file to load in Multiview.
  +
  +
; PORTNAME/K
  +
: Name of the AREXX port to create. By default the port name is MULTIVIEW.n with "n" being an incremental number starting from 1. It is incremented for each started Multiview instance.
  +
  +
; IMMEDIATE/S
  +
: Indicate whether the object should immediately begin playing. Defaults to FALSE.
  +
  +
; REPEAT/S
  +
: Indicate that the object should repeat playing. Defaults to FALSE.
  +
  +
; PRTUNIT/K/N
  +
: Printer unit to use when printing on "printer.device". Defaults to 0.
  +
  +
; WINDOWLEFT/K/N,WINDOWTOP/K/N,WINDOWWIDTH/K/N,WINDOWHEIGHT/K/N
  +
: WINDOWLEFT is the number of pixels the Multiview window should open from the left screen border. Defaults to 0.
  +
: WINDOWTOP is the number of pixels the Multiview window should open from the top screen border. Defaults to screen titlebar height so that Multiview window opens right below the titlebar.
  +
: WINDOWWIDTH is the number of pixels wide the Multiview window should be. Defaults to the screen width.
  +
: WINDOWHEIGHT is the number of pixels height the Multiview window should be. Defaults to the screen height.
  +
  +
; AUTORESIZE/S
  +
  +
= Command line examples =
  +
  +
Multiview S:Startup-sequence screen windowleft 50 windowtop 90 windowwidth 200 windowheight 200
  +
  +
Displays the file S:Startup-sequence in a window which has the size of 200x200 opened at 50 pixels from the left of the screen and at 90 pixels from the top of the screen. The window is opened on its own screen.
  +
  +
= ARexx Commands =
  +
  +
== OPEN ==
  +
  +
NAME/K,CLIPBOARD/S,CLIPUNIT/K/N
  +
  +
Open a file, or the contents of the specified clipboard unit.
  +
  +
== RELOAD ==
  +
  +
Reload the current object.
  +
  +
== SAVEAS ==
   
 
NAME/K,IFF/S
  
NAME/K,IFF/S
−
Save the current object to disk. The IFF switch is used to force the
  
−
save to be IFF instead of RAW (local format).
  
   
  +
Save the current object to disk. The IFF switch is used to force the save to be IFF instead of RAW (local format).
−
PRINT
  
  +
−
,
  
  +
== PRINT ==
−
Print the current object.
  
  +
  +
Print the current object.
  +
  +
== ABOUT ==
  +
  +
Display a requester with information about the current object.
  +
  +
== QUIT ==
  +
  +
Quit MultiView.
  +
  +
== MARK ==
  +
  +
Start Mark mode.
  +
  +
== COPY ==
  +
  +
Copy the currently selected block (or the whole object if no selected block exists) to the clipboard.
  +
  +
== PASTE ==
  +
  +
UNIT/N
  +
  +
Open the contents of the specified clipboard unit. PASTE <n> is a shortcut for OPEN CLIPBOARD CLIPUNIT <n>.
  +
  +
== CLEARSELECTED ==
  +
  +
Deselect the currently selected block, if one exists.
  +
  +
== GETTRIGGERINFO ==
  +
  +
VAR/S,STEM/K
  +
  +
Provide a list of trigger methods that the current object supports.
  +
  +
VAR causes the information to be returned in RESULT.
  +
  +
STEM causes the information to be returned in the named stem variable.
  +
  +
The following values are supported:
  +
  +
stem.count number of elements in the array.
  +
stem.n.label label
  +
stem.n.command command
  +
stem.n.method method
  +
  +
== DOTRIGGERMETHOD ==
  +
  +
METHOD/A
  +
  +
Perform a trigger method on the current object.
  +
  +
== SCREEN ==
   
  +
TRUE/S,FALSE/S
−
ABOUT
  
−
,
  
−
Display a requester with information about the current object.
  
   
  +
Cause the object to be displayed on an own screen or not.
−
QUIT
  
−
,
  
−
Quit MultiView.
  
   
  +
== PUBSCREEN ==
−
MARK
  
−
,
  
−
Start Mark mode.
  
   
  +
NAME/A
−
COPY
  
−
,
  
−
Copy the currently selected block (or the whole object if no
  
−
selected block exists) to the clipboard.
  
   
  +
Cause the object to be displayed on the specified public screen.
−
PASTE
  
   
  +
== SNAPSHOT ==
−
UNIT/N
  
−
Open the contents of the specified clipboard unit. PASTE <n> is a
  
−
shortcut for OPEN CLIPBOARD CLIPUNIT <n>.
  
   
  +
Save the current window position to ENVARC:MultiView/<screen name>.
−
CLEARSELECTED
  
−
,
  
−
Deselect the currently selected block, if one exists.
  
   
  +
== GETCURRENTDIR ==
−
GETTRIGGERINFO
  
   
  +
Return the current directory for the current object.
−
VAR/S,STEM/K
  
−
Provide a list of trigger methods that the current object supports.
  
   
  +
== GETFILEINFO ==
−
VAR causes the information to be returned in RESULT.
  
   
−
STEM causes the information to be returned in the named stem variable.
 +
Get the file information for the current object.
−
The following values are supported:
  
   
  +
== GETOBJECTINFO ==
−
stem.count number of elements in the array.
  
−
stem.n.label label
  
−
stem.n.command command
  
−
stem.n.method method
  
   
  +
VAR/S,STEM/K
−
DOTRIGGERMETHOD
  
   
  +
Return information about the current object.
−
METHOD/A
  
−
Perform a trigger method on the current object.
  
   
  +
VAR causes the information to be returned in RESULT.
−
SCREEN
  
   
  +
"name","basename","group","id"
−
TRUE/S,FALSE/S
  
−
Cause the object to be displayed on an own screen or not.
  
   
  +
STEM causes the information to be returned in the named stem variable.
−
PUBSCREEN
  
   
  +
stem.filename file name of the current object.
−
NAME/A
  
  +
stem.name object type name.
−
Cause the object to be displayed on the specified public screen.
  
  +
stem.basename object type basename.
  +
stem.group object type group.
  +
stem.id object type id.
   
  +
== MINIMUMSIZE ==
−
SNAPSHOT
  
−
,
  
−
Save the current window position to ENVARC:MultiView/<screen name>.
  
   
  +
Resize the object's window to its minimum size.
−
GETCURRENTDIR
  
−
,
  
−
Return the current directory for the current object.
  
   
  +
== NORMALSIZE ==
−
GETFILEINFO
  
−
,
  
−
Get the file information for the current object.
  
   
  +
Resize the object's window to its nominal size.
−
GETOBJECTINFO
  
   
  +
== MAXIMUMSIZE ==
−
VAR/S,STEM/K
  
−
Return information about the current object.
  
   
  +
Resize the object's window to its maximum size.
−
VAR causes the information to be returned in RESULT.
  
   
  +
== WINDOWTOFRONT ==
−
"name","basename","group","id"
  
   
  +
Bring the object's window to front.
−
STEM causes the information to be returned in the named stem variable.
  
   
  +
== WINDOWTOBACK ==
−
stem.filename file name of the current object.
  
−
stem.name object type name.
  
−
stem.basename object type basename.
  
−
stem.group object type group.
  
−
stem.id object type id.
  
   
  +
Send the object's window to back.
−
MINIMUMSIZE
  
−
,
  
−
Resize the object's window to its minimum size.
  
   
  +
== ACTIVATEWINDOW ==
−
NORMALSIZE
  
−
,
  
−
Resize the object's window to its nominal size.
  
   
  +
Activate the object's window.
−
MAXIMUMSIZE
  
−
,
  
−
Resize the object's window to its maximum size.
  
   
  +
== SCREENTOFRONT ==
−
WINDOWTOFRONT
  
−
,
  
−
Bring the object's window to front.
  
   
  +
Bring the object's screen to front.
−
WINDOWTOBACK
  
−
,
  
−
Send the object's window to back.
  
   
  +
== SCREENTOBACK ==
−
ACTIVATEWINDOW
  
−
,
  
−
Activate the object's window.
  
   
  +
Send the object's screen to back.
−
SCREENTOFRONT
  
−
,
  
−
Bring the object's screen to front.
  
   
  +
== BEEPSCREEN ==
−
SCREENTOBACK
  
−
,
  
−
Send the object's screen to back.
  
   
  +
Cause a display beep on the object's screen.
−
BEEPSCREEN
  
−
,
  
−
Cause a display beep on the object's screen.
  
   
−
NEXT
 +
== NEXT ==
   
−
Note: only when viewing an Amigaguide file.
 +
{{Note|text=Only when viewing an Amigaguide file.}}
   
−
Jumps to the next node in the guide.
 +
Jumps to the next node in the guide.
   
−
PREVIOUS
 +
== PREVIOUS ==
   
−
Note: only when viewing an Amigaguide file.
 +
{{Note|text=Only when viewing an Amigaguide file.}}
   
−
Jumps to the previous node in the guide.
 +
Jumps to the previous node in the guide.

Latest revision as of 21:27, 5 May 2014

Introduction

Multiview can read any file for which there is a descriptor file in Devs:Datatypes. These tell Multiview (and any other programs written to take advantage of datatypes) how to load the various types of files.

Command line arguments

FILE
Name of the file you want to be displayed/played by Multiview. Alternatively you can specify a volume or directory name that will be used by Multiview as the current directory when it opens its requester.
Note: this argument is optional as Multiview can be used to display the content of a clipboard unit instead of a file.
CLIPBOARD/S
Argument that will make Multiview display the content of the clipboard unit specified with the CLIPUNIT argument.
CLIPUNIT/K/N
Clipboard unit you want to display with Multiview. Default is 0.
SCREEN/S
Arguments that will make Multiview open its view window on its own screen.
PUBSCREEN/K
Name of a public screen you want Multiview to open its window on.
Note: usage of the SCREEN switch is implicit so it is not needed. If you quit the program which is owner of the public screen while Multiview is still opened the application will probably crash as it is not necessarily aware of an alien windows opened on its screen.
REQUESTER/S
BOOKMARK/S
Reads file ENV:MultiView.bookmark
FONTNAME/K
Name of the font Multiview will use to display text and AmigaGuide files. If none is specified here Multiview will use the default system font.
FONTSIZE/K/N
Size of the font Multiview will use to display text and AmigaGuide files. If none is specified here Multiview will use the default system font.
CHARSET/K
Charset to use to display text and AmigaGuide files.
BACKDROP/S
When this argument is used Multiview will open its display window in backdrop mode.
WINDOW/S
By default when running Multiview with no arguments, it will open a requester the user can use to select a file to load. With the WINDOW switch Multiview will open with a blank window and no loaded file. The user will have to select Open in the Project menu to select a file to load in Multiview.
PORTNAME/K
Name of the AREXX port to create. By default the port name is MULTIVIEW.n with "n" being an incremental number starting from 1. It is incremented for each started Multiview instance.
IMMEDIATE/S
Indicate whether the object should immediately begin playing. Defaults to FALSE.
REPEAT/S
Indicate that the object should repeat playing. Defaults to FALSE.
PRTUNIT/K/N
Printer unit to use when printing on "printer.device". Defaults to 0.
WINDOWLEFT/K/N,WINDOWTOP/K/N,WINDOWWIDTH/K/N,WINDOWHEIGHT/K/N
WINDOWLEFT is the number of pixels the Multiview window should open from the left screen border. Defaults to 0.
WINDOWTOP is the number of pixels the Multiview window should open from the top screen border. Defaults to screen titlebar height so that Multiview window opens right below the titlebar.
WINDOWWIDTH is the number of pixels wide the Multiview window should be. Defaults to the screen width.
WINDOWHEIGHT is the number of pixels height the Multiview window should be. Defaults to the screen height.
AUTORESIZE/S

Command line examples

Multiview S:Startup-sequence screen windowleft 50 windowtop 90 windowwidth 200 windowheight 200

Displays the file S:Startup-sequence in a window which has the size of 200x200 opened at 50 pixels from the left of the screen and at 90 pixels from the top of the screen. The window is opened on its own screen.

ARexx Commands

OPEN

NAME/K,CLIPBOARD/S,CLIPUNIT/K/N

Open a file, or the contents of the specified clipboard unit.

RELOAD

Reload the current object.

SAVEAS

 NAME/K,IFF/S

Save the current object to disk. The IFF switch is used to force the save to be IFF instead of RAW (local format).

PRINT

Print the current object.

ABOUT

Display a requester with information about the current object.

QUIT

Quit MultiView.

MARK

Start Mark mode.

COPY

Copy the currently selected block (or the whole object if no selected block exists) to the clipboard.

PASTE

UNIT/N

Open the contents of the specified clipboard unit. PASTE <n> is a shortcut for OPEN CLIPBOARD CLIPUNIT <n>.

CLEARSELECTED

Deselect the currently selected block, if one exists.

GETTRIGGERINFO

VAR/S,STEM/K

Provide a list of trigger methods that the current object supports.

VAR causes the information to be returned in RESULT.

STEM causes the information to be returned in the named stem variable.

The following values are supported: 

stem.count        number of elements in the array.
stem.n.label      label
stem.n.command    command
stem.n.method     method

DOTRIGGERMETHOD

METHOD/A

Perform a trigger method on the current object.

SCREEN

TRUE/S,FALSE/S

Cause the object to be displayed on an own screen or not.

PUBSCREEN

NAME/A

Cause the object to be displayed on the specified public screen.

SNAPSHOT

Save the current window position to ENVARC:MultiView/<screen name>.

GETCURRENTDIR

Return the current directory for the current object.

GETFILEINFO

Get the file information for the current object.

GETOBJECTINFO

VAR/S,STEM/K

Return information about the current object.

VAR causes the information to be returned in RESULT. 

"name","basename","group","id"

STEM causes the information to be returned in the named stem variable. 

stem.filename    file name of the current object.
stem.name        object type name.
stem.basename    object type basename.
stem.group       object type group.
stem.id          object type id.

MINIMUMSIZE

Resize the object's window to its minimum size.

NORMALSIZE

Resize the object's window to its nominal size.

MAXIMUMSIZE

Resize the object's window to its maximum size.

WINDOWTOFRONT

Bring the object's window to front.

WINDOWTOBACK

Send the object's window to back.

ACTIVATEWINDOW

Activate the object's window.

SCREENTOFRONT

Bring the object's screen to front.

SCREENTOBACK

Send the object's screen to back.

BEEPSCREEN

Cause a display beep on the object's screen.

NEXT

Note
Only when viewing an Amigaguide file.

Jumps to the next node in the guide.

PREVIOUS

Note
Only when viewing an Amigaguide file.

Jumps to the previous node in the guide.

Retrieved from "http://wiki.amigaos.net/w/index.php?title=MultiView&oldid=7671"