RISCOS.com

www.riscos.com Technical Support:
Programmer's Reference Manual

 

Pinboard


Introduction and overview

The Pinboard module provides facilities for representing files, applications and directories outside the Filer, by positioning icons either on the icon bar or on the desktop background (the 'pinboard' that gives this module its title).

It also provides a * Command to change the desktop background from the default grey to any sprite of your own choice.

The Pinboard module is not available in RISC OS 2.

* Commands


*AddTinyDir

Adds a file, application or directory icon to the icon bar

Syntax

*AddTinyDir [object]

Parameters

object - a valid pathname specifying a file, application or directory

Use

*AddTinyDir adds a file, application or directory to the icon bar. If no pathname is given, it adds a blank directory icon to the icon bar. You can then later install a file, application or directory on the icon bar by dragging it to the blank icon.

Example

*AddTinyDir ADFS::MHardy.$.!System

Related commands

*Pin, *RemoveTinyDir

Related SWIs

None

Related vectors

None


*BackDrop

Puts a sprite on the desktop background

Syntax

*BackDrop [-Centre|-Scale|-Tile] [filename]

Parameters

-centre - centre sprite on background
-tile - tile sprite over background
-scale - scale sprite to fill background (the default)
filename - a valid pathname, specifying a sprite file

Use

*BackDrop puts the first sprite in the given sprite file on the desktop background. The sprite is scaled to fill the background unless you specify otherwise.

If no filename is specified, the current backdrop's placing is altered.

Example

*BackDrop ADFS::Disc4.$.Sprites.desert

Related commands

None

Related SWIs

None

Related vectors

None


*Pin

Adds a file, application or directory to the desktop pinboard

Syntax

*Pin object x y

Parameters

object - a valid pathname specifying a file, application or directory
x - the x-coordinate at which to pin the object's icon, given in OS units
y - the y-coordinate at which to pin the object's icon, given in OS units

Use

*Pin adds a file, application or directory to the desktop pinboard, positioning its icon at the given coordinates. The coordinates specify the top-left corner of the icon's bounding box (ie the box drawn around the icon when it is selected for a drag), not of the icon itself. To use a negative coordinate you need to specify it as 0-x or 0-y, to avoid the - sign being interpreted as the start of a flag. (You may sometimes see this when Pinboard saves its state to a desktop boot file.)

There is no equivalent command to remove the icon; to do so, you must choose Remove icon from the Pinboard menu.

Example

*Pin ADFS::MHardy.$.!System 200 200

Related commands

*AddTinyDir

Related SWIs

None

Related vectors

None


*Pinboard

Starts the pinboard

Syntax

*Pinboard [-Grid]

Parameters

-Grid - Turn on grid locking (off by default)

Use

*Pinboard initialises the pinboard, removing any existing pinned icons and backdrop. Grid locking is off by default, but you may turn it on by passing the -Grid option to this command, or by choosing Grid lock from the Pinboard menu.

Related commands

None

Related SWIs

None

Related vectors

None


*RemoveTinyDir

Removes a file, application or directory icon from the icon bar

Syntax

*RemoveTinyDir [object]

Parameters

object - a valid pathname specifying a file, application or directory

Use

*RemoveTinyDir removes a file, application or directory icon that was previously placed on the icon bar by a *AddTinyDir command. If no pathname is given, all such icons are removed from the icon bar.

Example

*RemoveTinyDir ADFS::MHardy.$.!System

Related commands

*AddTinyDir, *Pin

Related SWIs

None

Related vectors

None

This edition Copyright © 3QD Developments Ltd 2015
Last Edit: Tue,03 Nov 2015