KColorCollection

#include <KColorCollection>

Public Types

enum  Editable { Yes, No, Ask }
 

Public Member Functions

 KColorCollection (const QString &name=QString())
 
 KColorCollection (const KColorCollection &)
 
 ~KColorCollection ()
 
int addColor (const QColor &newColor, const QString &newColorName=QString())
 
int changeColor (int index, const QColor &newColor, const QString &newColorName=QString())
 
int changeColor (const QColor &oldColor, const QColor &newColor, const QString &newColorName=QString())
 
QColor color (int index) const
 
int count () const
 
QString description () const
 
Editable editable () const
 
int findColor (const QColor &color) const
 
QString name () const
 
QString name (int index) const
 
QString name (const QColor &color) const
 
KColorCollectionoperator= (const KColorCollection &)
 
bool save ()
 
void setDescription (const QString &desc)
 
void setEditable (Editable editable)
 
void setName (const QString &name)
 

Static Public Member Functions

static QStringList installedCollections ()
 

Detailed Description

Class for handling color collections ("palettes").

This class makes it easy to handle color collections, sometimes referred to as "palettes". This class can read and write collections from and to a file.

This class uses the "GIMP" palette file format.

Author
Waldo Bastian (basti[email protected][email protected][email protected]de.or[email protected]g)

Definition at line 30 of file kcolorcollection.h.

Member Enumeration Documentation

Used to specify whether a collection may be edited.

See also
editable()
setEditable()
Enumerator
Yes 

Collection may be edited.

No 

Collection may not be edited.

Ask 

Ask user before editing.

Definition at line 98 of file kcolorcollection.h.

Constructor & Destructor Documentation

KColorCollection::KColorCollection ( const QString name = QString())
explicit

KColorCollection constructor.

Creates a KColorCollection from a file the filename is derived from the name.

Parameters
nameThe name of collection as returned by installedCollections()

Definition at line 113 of file kcolorcollection.cpp.

KColorCollection::KColorCollection ( const KColorCollection p)

KColorCollection copy constructor.

Definition at line 118 of file kcolorcollection.cpp.

KColorCollection::~KColorCollection ( )

KColorCollection destructor.

Definition at line 123 of file kcolorcollection.cpp.

Member Function Documentation

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

Add a color.

Parameters
newColorThe color to add.
newColorNameThe name of the color, null to remove the name.
Returns
The index of the added color.

Definition at line 244 of file kcolorcollection.cpp.

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

Change a color.

Parameters
indexIndex of the color to change
newColorThe new color.
newColorNameThe new color name, null to remove the name.
Returns
The index of the new color or -1 if the color couldn't be changed.

Definition at line 251 of file kcolorcollection.cpp.

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

Change a color.

Parameters
oldColorThe original color
newColorThe new color.
newColorNameThe new color name, null to remove the name.
Returns
The index of the new color or -1 if the color couldn't be changed.

Definition at line 266 of file kcolorcollection.cpp.

QColor KColorCollection::color ( int  index) const

Find color by index.

Parameters
indexthe index of the desired color
Returns
The index -th color of the collection, null if not found.

Definition at line 208 of file kcolorcollection.cpp.

int KColorCollection::count ( ) const

Return the number of colors in the collection.

Returns
the number of colors

Definition at line 189 of file kcolorcollection.cpp.

QString KColorCollection::description ( ) const

Get the description of the collection.

Returns
the description of the collection.

Definition at line 159 of file kcolorcollection.cpp.

KColorCollection::Editable KColorCollection::editable ( ) const

Returns whether the collection may be edited.

Returns
the state of the collection

Definition at line 179 of file kcolorcollection.cpp.

int KColorCollection::findColor ( const QColor color) const

Find index by color.

Parameters
colorthe color to find
Returns
The index of the color in the collection or -1 if the color is not found.

Definition at line 218 of file kcolorcollection.cpp.

QStringList KColorCollection::installedCollections ( )
static

Query which KDE color collections are installed.

Returns
A list with installed color collection names.

Definition at line 98 of file kcolorcollection.cpp.

QString KColorCollection::name ( ) const

Get the name of the collection.

Returns
the name of the collection

Definition at line 169 of file kcolorcollection.cpp.

QString KColorCollection::name ( int  index) const

Find color name by index.

Parameters
indexthe index of the color
Returns
The name of the index -th color. Note that not all collections have named the colors. Null is returned if the color does not exist or has no name.

Definition at line 229 of file kcolorcollection.cpp.

QString KColorCollection::name ( const QColor color) const

Find color name by color.

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

Definition at line 238 of file kcolorcollection.cpp.

KColorCollection & KColorCollection::operator= ( const KColorCollection p)

KColorCollection assignment operator.

Definition at line 195 of file kcolorcollection.cpp.

bool KColorCollection::save ( )

Save the collection.

Returns
'true' if successful

Definition at line 130 of file kcolorcollection.cpp.

void KColorCollection::setDescription ( const QString desc)

Set the description of the collection.

Parameters
descthe new description

Definition at line 164 of file kcolorcollection.cpp.

void KColorCollection::setEditable ( Editable  editable)

Change whether the collection may be edited.

Parameters
editablethe state of the collection

Definition at line 184 of file kcolorcollection.cpp.

void KColorCollection::setName ( const QString name)

Set the name of the collection.

Parameters
namethe name of the collection

Definition at line 174 of file kcolorcollection.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Tue Sep 29 2020 23:05:49 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.