MoreDesk: Command Line Interface

logo

<-  prev | index | next ->

MoreDesk provides some CLI commands which can be used to drive it from the command line. In RISC OS 5, for example, you could assign these commands to one of the hotkeys using the !Configure Keyboard plug-in, so pressing the left ‘Windows’ key (for example) could return you to your ‘home’ desktop.


*MoreDesk_ReadInfo

Outputs the current dimensions of the total desk space, along with the co-ordinates of the current desktop. For example:


   *moredesk_readinfo
   Desk space is 5 columns of 3 rows
   Current desktop is -2,1

The ‘home’ desktop is 0,0 (i.e. at the centre of the desk space).

*MoreDesk_SetDesktop <num>,<num>

Select the specified desktop, given as an x (across) and y (up) co-ordinate. The ‘home’ desktop is 0,0. The desktop to the left is -1,0; to the right is 1,0; above is 0,1 and below is -1,0.

If the specified desktop doesn't exist, the nearest available one is selected. If the current desktop is specified, no action is taken.

*MoreDesk_ScrollDesktop <num>,<num>

Move the specified number of desktops across and up, relative to the current desktop. For example, to move two desktops to the left, you would use:


   *MoreDesk_ScrollDesktop -2,0

If the specified desktop doesn't exist, the nearest available one is selected. If 0,0 is specified, no action is taken.

*MoreDesk_Flash ...

Syntax:


  *MoreDesk_Flash “window title” [-Duration <seconds>] [-Autoclear]

This command raises an alert for the specified window. If multiple windows are open that match (case-insensitive) the window title given, then the top-most window in the window stack is selected.

The duration is specified in seconds and defaults to ten seconds if not present. A duration of zero will clear the alert state on the specified window.

If the -autoclear switch is present, the alert state is cleared automatically by MoreDesk once the required flash duration has been reached.

Note: windows in the current desktop cannot be made to raise an alert via this command. You should use the SWI call instead.

*MoreDesk_Fetch <title> [<task>] [<switches>]

Syntax:


  *MoreDesk_Fetch <title> [<task>] [-toP] [-Focus]

This command is reserved for internal use only.

*MoreDesk_Open <dir> [<pos>] [<switches>]

Syntax:


  *MoreDesk_Open <dir> [<x> <y> [<width> <height>]] ...
           ... [-Close]  [-LI | -SI | -FI]  [-SN | -ST | -SD | -SS]

This command is reserved for internal use only.

*MoreDesk_Run <dir> <task> [<switches>]

Syntax:


  *MoreDesk_Run <dir> <task> [-Multi] [-Quit]

This command is reserved for internal use only.

*MoreDesk_Load <file> [<switches>]

Syntax:


  *MoreDesk_Load <file> [<x> <y> [<width> <height>]] ...
           ... [-Reload] [-Close]

This command is reserved for internal use only.


<-  prev | index | next ->

Copyright © 2013, 7th software