Chapter 22. colorpalette

Chapter 22. colorpalette
	Part III. SIMPOL-Language Libraries

Chapter 22. colorpalette

Table of Contents

colorpalette

colorpalette

Description

Type Tags

None

Object Value

Objects of type colorpalette have no value, and it is an error to try to get or set this value.

colorpalette.new()

Description

Prototype

colorpalette.new ( colorpalette me, string name, integer maxcolors )

Parameters

Parameter	Default value	Type name
me	None	colorpalette
name	None	string
maxcolors	`342`	integer

Properties

Property	Type	Description
_private	colorpaletteprivate
add	function
buildstrindex	function
findcolorindex	function
findstrindex	function
getcolorblob	function
getcolorrgbvals	function
getcolorstring	function
getcolorvalue	function
getcount	function
maxcolors	integer
name	string
type	type

Methods

add()

Description

Prototype

colorpalettevar.add ( colorpalette me, blob blobrgb, integer rgbvalue, integer red, integer green, integer blue, string strindex, integer error )

Parameters

Parameter	Default value	Type name
me	None	colorpalette
blobrgb	None	blob
rgbvalue	None	integer
red	`0`	integer
green	`0`	integer
blue	`0`	integer
strindex	None	string
error	None	integer

buildstrindex()

Description

Prototype

colorpalettevar.buildstrindex ( colorpalette me )

Parameters

Parameter	Default value	Type name	Description
me	None	colorpalette

findcolorindex()

Description

Prototype

colorpalettevar.findcolorindex ( colorpalette me, blob blobrgb, integer rgbvalue, integer red, integer green, integer blue, integer error )

Parameters

Parameter	Default value	Type name
me	None	colorpalette
blobrgb	None	blob
rgbvalue	None	integer
red	None	integer
green	None	integer
blue	None	integer
error	None	integer

findstrindex()

Description

Prototype

colorpalettevar.findstrindex ( colorpalette me, integer colorindex, blob blobrgb, integer rgbvalue, integer red, integer green, integer blue, integer error )

Parameters

Parameter	Default value	Type name
me	None	colorpalette
colorindex	None	integer
blobrgb	None	blob
rgbvalue	None	integer
red	None	integer
green	None	integer
blue	None	integer
error	None	integer

getcolorblob()

Description

Prototype

colorpalettevar.getcolorblob ( colorpalette me, integer colorindex, string strindex )

Parameters

Parameter	Default value	Type name
me	None	colorpalette
colorindex	`1`	integer
strindex	None	string

getcolorrgbvals()

Description

Prototype

colorpalettevar.getcolorrgbvals ( colorpalette me, integer colorindex, string strindex, integer red, integer green, integer blue )

Parameters

Parameter	Default value	Type name
me	None	colorpalette
colorindex	None	integer
strindex	None	string
red	`0`	integer
green	`0`	integer
blue	`0`	integer

getcolorstring()

Description

Prototype

colorpalettevar.getcolorstring ( colorpalette me, integer colorindex, string strindex )

Parameters

Parameter	Default value	Type name
me	None	colorpalette
colorindex	None	integer
strindex	None	string

getcolorvalue()

Description

Prototype

colorpalettevar.getcolorvalue ( colorpalette me, integer colorindex, string strindex )

Parameters

Parameter	Default value	Type name
me	None	colorpalette
colorindex	None	integer
strindex	None	string

getcount()

Description

Prototype

colorpalettevar.getcount ( colorpalette me )

Parameters

Parameter	Default value	Type name	Description
me	None	colorpalette


convertto8bitstring()		Chapter 23. commonreportgui