KColorCollection
#include <KColorCollection>
Public Types | |
enum | Editable { Yes , No , Ask } |
Public Member Functions | |
KColorCollection (const KColorCollection &) | |
KColorCollection (const QString &name=QString()) | |
~KColorCollection () | |
int | addColor (const QColor &newColor, const QString &newColorName=QString()) |
int | changeColor (const QColor &oldColor, const QColor &newColor, const QString &newColorName=QString()) |
int | changeColor (int index, 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 (const QColor &color) const |
QString | name (int index) const |
KColorCollection & | operator= (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.
Definition at line 31 of file kcolorcollection.h.
Member Enumeration Documentation
◆ Editable
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 99 of file kcolorcollection.h.
Constructor & Destructor Documentation
◆ KColorCollection() [1/2]
KColorCollection constructor.
Creates a KColorCollection from a file the filename is derived from the name.
- Parameters
-
name The name of collection as returned by installedCollections()
Definition at line 114 of file kcolorcollection.cpp.
◆ KColorCollection() [2/2]
|
default |
KColorCollection copy constructor.
◆ ~KColorCollection()
|
default |
KColorCollection destructor.
Member Function Documentation
◆ addColor()
int KColorCollection::addColor | ( | const QColor & | newColor, |
const QString & | newColorName = QString() ) |
Add a color.
- Parameters
-
newColor The color to add. newColorName The name of the color, null to remove the name.
- Returns
- The index of the added color.
Definition at line 220 of file kcolorcollection.cpp.
◆ changeColor() [1/2]
int KColorCollection::changeColor | ( | const QColor & | oldColor, |
const QColor & | newColor, | ||
const QString & | newColorName = QString() ) |
Change a color.
- Parameters
-
oldColor The original color newColor The new color. newColorName The 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 239 of file kcolorcollection.cpp.
◆ changeColor() [2/2]
int KColorCollection::changeColor | ( | int | index, |
const QColor & | newColor, | ||
const QString & | newColorName = QString() ) |
Change a color.
- Parameters
-
index Index of the color to change newColor The new color. newColorName The 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 226 of file kcolorcollection.cpp.
◆ color()
QColor KColorCollection::color | ( | int | index | ) | const |
Find color by index.
- Parameters
-
index the index of the desired color
- Returns
- The
index
-th color of the collection, null if not found.
Definition at line 187 of file kcolorcollection.cpp.
◆ count()
int KColorCollection::count | ( | ) | const |
Return the number of colors in the collection.
- Returns
- the number of colors
Definition at line 180 of file kcolorcollection.cpp.
◆ description()
QString KColorCollection::description | ( | ) | const |
Get the description of the collection.
- Returns
- the description of the collection.
Definition at line 150 of file kcolorcollection.cpp.
◆ editable()
KColorCollection::Editable KColorCollection::editable | ( | ) | const |
Returns whether the collection may be edited.
- Returns
- the state of the collection
Definition at line 170 of file kcolorcollection.cpp.
◆ findColor()
int KColorCollection::findColor | ( | const QColor & | color | ) | const |
Find index by color
.
- Parameters
-
color the color to find
- Returns
- The index of the color in the collection or -1 if the color is not found.
Definition at line 196 of file kcolorcollection.cpp.
◆ installedCollections()
|
static |
Query which KDE color collections are installed.
- Returns
- A list with installed color collection names.
Definition at line 101 of file kcolorcollection.cpp.
◆ name() [1/3]
QString KColorCollection::name | ( | ) | const |
Get the name of the collection.
- Returns
- the name of the collection
Definition at line 160 of file kcolorcollection.cpp.
◆ name() [2/3]
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 215 of file kcolorcollection.cpp.
◆ name() [3/3]
QString KColorCollection::name | ( | int | index | ) | const |
Find color name by index
.
- Parameters
-
index the 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 206 of file kcolorcollection.cpp.
◆ operator=()
|
default |
KColorCollection assignment operator.
◆ save()
bool KColorCollection::save | ( | ) |
Save the collection.
- Returns
- 'true' if successful
Definition at line 124 of file kcolorcollection.cpp.
◆ setDescription()
void KColorCollection::setDescription | ( | const QString & | desc | ) |
Set the description of the collection.
- Parameters
-
desc the new description
Definition at line 155 of file kcolorcollection.cpp.
◆ setEditable()
void KColorCollection::setEditable | ( | Editable | editable | ) |
Change whether the collection may be edited.
- Parameters
-
editable the state of the collection
Definition at line 175 of file kcolorcollection.cpp.
◆ setName()
void KColorCollection::setName | ( | const QString & | name | ) |
Set the name of the collection.
- Parameters
-
name the name of the collection
Definition at line 165 of file kcolorcollection.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:14:40 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.