class KPalette

Class for handling Palettes. More...

Definition#include <kpalette.h>
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods

Public Static Methods


Detailed Description

Class for handling Palettes.

This class makes it easy to handle palettes. A palette is a set of colors. This class can read and write palettes from and to a file.

This class uses the "GIMP" palette file format.

This class is totally unrelated to QPalette.

QStringList getPaletteList ()
[static]

Query which KDE palettes are installed.

Returns: A list with a palette names.

KPalette (const QString &name=QString::null)

KPalette constructor. Creates a KPalette from a file the filename is derived from the name.

Parameters:
nameThe name of palette as returned by getPaletteList()

KPalette (const KPalette &)

KPalette copy constructor.

~KPalette ()
[virtual]

KPalette destructor.

KPalette& operator= ( const KPalette &)

KPalette assignment operator

bool save ()

Save the palette

Returns: 'true' if successfull

QString description ()

Get the description of the palette.

void setDescription (const QString &desc)

Set the description of the palette.

QString name ()

Get the name of the palette.

void setName (const QString &name)

Set the name of the palette.

Editable editable ()

Returns whether the palette may be edited.

void setEditable (Editable editable)

Change whether the palette may be editted.

int nrColors ()

Return the number of colors in the palette.

QColor color (int index)

Find color by index.

Returns: The index -th color of the palette.

int findColor (const QColor &color)

Find index by color.

Returns: The index of the color in the palette or -1 if the color is not found.

QString colorName (int index)

Find colorname by index.

Returns: The name of the index -th color. Note that not all palettes have named the colors.

QString colorName (const QColor &color)

Find colorname by color.

Returns: The name of color according to this palette. Note that not all palettes have named the colors. Note also that each palette can give the same color a different name.

int addColor (const QColor &newColor, const QString &newColorName = QString::null)

Add a color.

Parameters:
newColorThe color to add.
newColorNameThe name of the color.

Returns: The index of the added color.

int changeColor (int index, const QColor &newColor, const QString &newColorName = QString::null)

Change a color.

Parameters:
indexIndex of the color to change
newColorThe new color.
newColorNameThe new color name.

Returns: The index of the new color or -1 if the color couldn't be changed.

int changeColor (const QColor &oldColor, const QColor &newColor, const QString &newColorName = QString::null)

Change a color.

Parameters:
oldColorThe original color
newColorThe new color.
newColorNameThe new color name.

Returns: The index of the new color or -1 if the color couldn't be changed.