Documentation from colourpick.h

ROV

Introduction

[top]

ROV - Easy applications from C

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

Contributing authors - Jason Tribbeck

File - colourpick.h

Type - helper

Description

The colourpicker helper is used to display the RISC OS standard colour picker.

colourmodel (type definition)

[top]

The colour model structure

typedef struct colourmodel {
 unsigned char z, r, g, b;
 int ext_size;
 int model;
 int v[4];
} colourmodel;

See also: Colour picker models, colourpick_create(), colourpick_update()

colourpick_block (type definition)

[top]

The colourpicker block returned by the ColourPicker module.

typedef void * colourpick_block;

See also: colourpick_close(), colourpick_create(), colourpick_update()

colourpick_create

[top]

Open a colourpicker

Parameters:

 - int flags - the flags for creating the colourpicker window.
 - char *title - the title of the colourpicker window.
 - int x - the left hand (screen) coordinate to open it up.
 - int y - the bottom (screen) coordinate to open it up.
 - colourmodel *mod - the colour model to use.

Returns:

 -  the colourpicker block. 

colourpick_block * colourpick_create(int flags,
				     char * title,
				     int x,
				     int y,
				     colourmodel * mod);

See also: Colour picker creation flags

colourpick_close

[top]

Close the colourpicker

Parameters:

 - colourpick_block *b - the colourpicker block returned from colourpick_create()

void colourpick_close(colourpick_block * b);

colourpick_update

[top]

Update the colourpicker

Parameters:

 - int flags - the flags for updating the colourpicker window.
 - char *title - the title of the colourpicker window.
 - int x - the left hand (screen) coordinate to open it up.
 - int y - the bottom (screen) coordinate to open it up.
 - colourmodel *mod - the colourpicker model to use
 - colourpick_block *b - the colourpicker block to use. 

void colourpick_update(int flags,
		       char * title,
		       int x,
		       int y,
		       colourmodel * mod,
		       colourpick_block * b);

See also: Colour picker update flags.

Colour picker creation flags

[top]
#define COLOURPICK_NORMAL	(0<<0)
#define COLOURPICK_MENU		(1<<0)
#define COLOURPICK_TOOLBOX	(2<<0)
#define COLOURPICK_SUBMENU	(3<<0)
#define COLOURPICK_HASNONE	(1<<8)
#define COLOURPICK_ISNONE	(1<<9)
#define COLOURPICK_NOCHANGE	(0<<10)
#define COLOURPICK_ANYCHANGE	(1<<10)
#define COLOURPICK_DRAGCHANGE	(2<<10)
#define COLOURPICK_IGNOREHELP	(1<<12)
#define COLOURPICK_NOKEYS	(1<<13)

Colour picker update flags

[top]
#define COLOURPICK_UPDATEHASNONE	(1<<16)
#define COLOURPICK_UPDATEISNONE		(1<<17)
#define COLOURPICK_UPDATEBUTTONTYPE	(1<<18)
#define COLOURPICK_UPDATEVISIBLEAREA	(1<<19)
#define COLOURPICK_UPDATETITLE		(1<<21)
#define COLOURPICK_UPDATECOLOUR		(1<<22)
#define COLOURPICK_UPDATEMODEL		(1<<23)
#define COLOURPICK_UPDATEIGNOREHELP	(1<<24)
#define COLOURPICK_UPDATENOKEYS		(1<<25)

Colour picker models

[top]

These are the models that are defined in the colour picker.

#define COLOURPICK_RGB		(0)
#define COLOURPICK_CMYK		(1)
#define COLOURPICK_HSV		(2)

Generated Thu Feb 7 23:22:51 2002