PaletteList Class Reference

Defines a collection of palettes. More...

#include <palettelistinterface.h>

Inheritance diagram for PaletteList:

Collaboration diagram for PaletteList:

Public Slots
String	getPath ()
	Returns the folder in which this palette list is located. More...
Palette *	getPaletteByIndex (int index)
	Returns a Palette object for the palette at position 'index'. More...
Palette *	getPaletteById (String id)
	Returns a Palette object for the palette with ID 'id'. More...
Palette *	addPalette (String &path)
	Adds a palette to the end of this palette list, returning a Palette object. More...
Palette *	insertPalette (String &path, int index)
	Adds a palette to this palette list at the position specified by 'index', returning a Palette object. More...
bool	removePaletteByIndex (int index)
	Remove the palette at the position specified by 'index'. More...
bool	removePaletteById (String id)
	Remove the palette with the specified palette ID. More...
bool	movePaletteUp (String &id)
	Move the specified palette up one place in this palette list. More...
bool	movePaletteDown (String &id)
	Move the specified palette down one place in this palette list. More...
bool	isLoaded ()
	Was the palette list successfully loaded from disk (true or false)? More...

Properties
int	numPalettes
	Number of palettes in this palette list. More...
String	id
	The palette list ID of this palette list. More...

Detailed Description

Defines a collection of palettes.

Provides access to some of the standard functionality of palette lists.

Member Function Documentation

Palette* PaletteList::addPalette ( String &  path )

slot

Adds a palette to the end of this palette list, returning a Palette object.

Parameters

path	Path to existing palette file

Palette* PaletteList::getPaletteById ( String  id )

slot

Returns a Palette object for the palette with ID 'id'.

Parameters

id	palette ID of palette in this palette list

Palette* PaletteList::getPaletteByIndex ( int  index )

slot

Returns a Palette object for the palette at position 'index'.

Parameters

index

index of palette in this palette list

String PaletteList::getPath ( )

slot

Returns the folder in which this palette list is located.

Palette* PaletteList::insertPalette ( String &  path, int  index  )

slot

Adds a palette to this palette list at the position specified by 'index', returning a Palette object.

Parameters

path	Path to existing palette file

bool PaletteList::isLoaded ( )

slot

Was the palette list successfully loaded from disk (true or false)?

bool PaletteList::movePaletteDown ( String &  id )

slot

Move the specified palette down one place in this palette list.

Parameters

id	ID of the palette to move

bool PaletteList::movePaletteUp ( String &  id )

slot

Move the specified palette up one place in this palette list.

Parameters

id	ID of the palette to move

bool PaletteList::removePaletteById ( String  id )

slot

Remove the palette with the specified palette ID.

Parameters

id	ID of the palette to remove

bool PaletteList::removePaletteByIndex ( int  index )

slot

Remove the palette at the position specified by 'index'.

Parameters

index

index of palette to remove

Property Documentation

String PaletteList::id

readprivate

The palette list ID of this palette list.

int PaletteList::numPalettes

readprivate

Number of palettes in this palette list.

---

The documentation for this class was generated from the following file:

• dox_files/objectScript/palettelistinterface.h