Documentation from baricon.h

ROV

Introduction

[top]

ROVLib - Easy applications from C

Copyright - © Jason Tribbeck / 7th ARM 1994-2001

Contributing authors - Jason Tribbeck

File - baricon.h

Type - subsystem

Description

The baricon subsystem maintains an icon on the icon bar. It is a much simpler system to use than the main icon system, but this is more limited. It should be used to create one icon on the icon bar.

When created, the icon has a 'click' handler, which is called when the user clicks SELECT on the icon. To extend this with menus and an ADJUST clik, use the canvas system to attach menu and click handlers to the iconbar canvas.

baricon_clickp (function pointer)

[top]

Definition of the click handler.

Parameters:

 - int icon_number - the WIMP's icon number for this icon.

typedef void (* baricon_clickp)(int icon_number);

See also: baricon()

baricon

[top]

Create an icon on the icon bar.

Parameters:

 - char *sprite_name - the name of the sprite (must be in the WIMP's sprite area).
 - baricon_clickp handler - the function to call when the user clicks SELECT on the icon.
 - ... - an optional list of extra parameters, the first of which is a 'flag' parameter, taken from the list below. Where an icon is created in relation to another icon, then the icon's handle, or priority is passed as the fourth parameter. If no third parameter is passed, then the icon is created on the right hand side.

Returns:

 -  the icon number for the created icon.

int baricon(char *sprite_name,
	    baricon_clickp handler,
	    ...);

See also: BARICON_LEFT, BARICON_LEFTICON, BARICON_LEFTPRIORITY, BARICON_LEFTPRIORITYSCANLEFT, BARICON_LEFTPRIORITYSCANRIGHT, BARICON_RIGHT, BARICON_RIGHTICON, BARICON_RIGHTPRIORITY, BARICON_RIGHTPRIORITYSCANLEFT, BARICON_RIGHTPRIORITYSCANRIGHT, baricon_clickp()

BARICON_RIGHT (definition)

[top]

Create an icon to the right (default).

#define BARICON_RIGHT (0x3157454e)

BARICON_LEFT (definition)

[top]

Create an icon to the left.

#define BARICON_LEFT (0x3257454e)

BARICON_RIGHTICON (definition)

[top]

Create an icon to the right of another icon.

#define BARICON_RIGHTICON (0x3357454e)

BARICON_LEFTICON (definition)

[top]

Create an icon to the left of another icon.

#define BARICON_LEFTICON (0x3457454e)

BARICON_LEFTPRIORITY (definition)

[top]

Create an icon on the left with priority (scanning left).

#define BARICON_LEFTPRIORITY (0x3557454e)

BARICON_RIGHTPRIORITY (definition)

[top]

Create an icon on the right with priority (scanning right).

#define BARICON_RIGHTPRIORITY (0x3857454e)

BARICON_LEFTPRIORITYSCANLEFT (definition)

[top]

Create an icon to the left with priority scanning left.

#define BARICON_LEFTPRIORITYSCANLEFT (0x3557454e)

BARICON_LEFTPRIORITYSCANRIGHT (definition)

[top]

Create an icon to the left with priority scanning right.

#define BARICON_LEFTPRIORITYSCANRIGHT (0x3657454e)

BARICON_RIGHTPRIORITYSCANLEFT (definition)

[top]

Create an icon to the right with priority scanning left.

#define BARICON_RIGHTPRIORITYSCANLEFT (0x3757454e)

BARICON_RIGHTPRIORITYSCANRIGHT (definition)

[top]

Create an icon to the right with priority scanning right.

#define BARICON_RIGHTPRIORITYSCANRIGHT (0x3857454e)

Generated Thu Feb 7 23:22:51 2002