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).
As well as providing shortcut icons for applications, pinboard also provides the default Iconiser. The Iconiser is used when a window is closed by the user with shift-Select over the close tool, or explicitly clicking the iconise tool.
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.
Iconiser icons, as used by Pinboard, should be of a similar size as the filetype icons. Icons are prefixed by ic_ followed by the application name as given to taskmanager (unless an icon name is supplied by the iconised application.
Iconiser icons should be based on the ic_? sprite.
This protocol is not available in RISC OS 2.
When the iconise tool is clicked, the Wimp broadcasts a Message_Iconise. This facility is only available on WindowManager 4.15 and above.
If Shift is held down when the Close icon of a window is clicked, the Wimp does not close the window, but instead follows the same protocol as the iconise tool.
If no iconiser is loaded nothing happens.
If an iconiser is loaded:
If the application is an old RISC OS 2 one, it will ignore the above message.
The iconiser gets acknowledgement back and uses the information in the first Message_Iconise to iconise the window.
If the application is a new RISC OS 3 application it should react as follows:
If it wants to help it should reply with a Message_WindowInfo. The iconiser will then use this information to iconise the window.
This enables applications such as Edit to give a different icon depending on the file type of the file being edited in the window.
Whenever a window is closed the Wimp broadcasts the message Message_WindowClosed.
The iconiser then removes the icon.
The iconiser spots the Message_TaskQuit and remove all the icons for that task.
It broadcasts a Message_WindowInfo with a window handle of 0.
An iconiser receiving this message should reopen all iconised windows.
All applications should ignore such a message.
| Offset | Contents |
|---|---|
| R1+20 | window handle |
| R1+24 | task handle for task which owns the window |
| R1+28 | 20 bytes of title string (last part of first word) |
This message is broadcast by the WindowManager to request that the current Iconiser iconise the window cited. The Iconiser is expected to acknowledge the message and send Message_WindowInfo to the task owning the window.
This message is not available in RISC OS 2.
| Offset | Contents |
|---|---|
| R1+20 | window handle |
This message is broadcast by the WindowManager when a window is closed. It is expected that the current Iconiser will remove any iconisations of the window in question.
This message is not available in RISC OS 2.
| Offset | Contents |
|---|---|
| R1+20 | window handle |
| R1+24 | reserved, must be 0 |
| R1+28 | <string> giving trailing part of sprite name to use, null terminated - sprite name used is ic_<string> |
| R1+28 | string giving title to use, null terminated; this should be as short as possible, and may be truncated by the iconiser (eg Pinboard truncates at a space or at the 10th character, whichever is shorter) |
This message is send by the Iconiser when a window is to be iconised. Applications will either respond with a modified Message_WindowInfo if they wish to provide specific iconisation information, or acknowledge the message if the wish to handle the iconisation themselves. It is not recommended that applications handle the iconisation themselves.
This message is not available in RISC OS 2.
| Offset | Contents | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| R1+20 | flags :
| ||||||||||||||||||
This message is sent by applications wishing to control the position of the backdrop window. After the operation being performed, the message will be replied to, filling in the new state in the operation field.
This message is not available before RISC OS 4.20.
*AddTinyDir
[<object>]
<object> | - | a valid pathname specifying a file, application or directory |
*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.
*AddTinyDir ADFS::MHardy.$.!System
*BackDrop
[-Centre | -Scale | -Tile]
[<filename>]
-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 |
*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.
*BackDrop ADFS::Disc4.$.Sprites.desert
*Pin
<object>
<x>
<y>
<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 |
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.
*Pin ADFS::MHardy.$.!System 200 200
*Pinboard
[-Grid]
-Grid | - | Turn on grid locking (off by default) |
*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.
*Pinboard -Grid
*PinboardOptions
[-Grid]
[-IconiseTo<Location>]
[-IconiseStackVertical]
[-TidyTo<Location>]
[-TidyStackVertical]
-Grid | - | Turn on grid locking (off by default) |
-IconiseTo<Location> | - |
Specifies the location windows are iconised to. This may be one of the following:
Without the switch, windows are iconised to the pointer. |
-IconiseStackVertical | - | Specifies vertical stacking of iconised window icons. If the switch is not specified, icons are stacked horizontally. |
-TidyTo<Location> | - | Specify the location file icons are tidied to. This may be any of the options listed above for IconiseTo. By default, icons are tidied to the top left. |
-TidyStackVertical | - | Specify vertical stacking of file icons. If the switch is not specified, icons are stacked horizontally. |
*PinboardOptions allows you to configure the Pinboard. It is intended for use solely in the !Boot sequence and by !Configure, and should not be used under normal circumstances by the user. This command is present in RISC OS 4 onwards, and switches may vary between versions.
*PinboardOptions -IconiseToTopRight -TidyStackVertical
-TidyToTopLeft -TidyStackVertical
*RemoveTinyDir
[<object>]
<object> | - | a valid pathname specifying a file, application or directory |
*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.
*RemoveTinyDir ADFS::MHardy.$.!System
*XPin
<object>
<x>
<y>
<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 |
XPin 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.) XPin, unlike its sister command *Pin, ignores any errors it encounters.
There is no equivalent command to remove the icon; to do so, you must choose Remove icon from the Pinboard menu.
*XPin ADFS::MHardy.$.!System 200 200
| Maintainer(s): | RISCOS Ltd <developer@riscos.com> | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| History: |
| ||||||||
| Disclaimer: |
Copyright © Pace Micro Technolgy plc, 2002. |