KDChart::Palette Class Reference

#include <KDChartPalette.h>

Inheritance diagram for KDChart::Palette:

[legend]

Collaboration diagram for KDChart::Palette:

[legend]

List of all members.

---

Detailed Description

A Palette is a set of brushes (or colors) to be used for painting data sets.

The palette class encapsulates a colletion of brushes, which in the simplest case are colors, to be used for painting a series of data sets. When asked for the m-th color, a palette of size n will wrap around and thus cycle through the available colors.

Three builtin palettes are provided for convenience, one with a default set of colors, one with a subdued color selection, one with rainbow colors.

When a palette changes, it emits a changed() signal. Hook up to it, if you want to repaint when the color selection changes.

Definition at line 55 of file KDChartPalette.h.

Signals
void	changed ()
	Emitted whenever the palette changes.
Public Member Functions
void	addBrush (const QBrush &brush, int position=-1)
	Adds brush to the palette.
QBrush	getBrush (int position) const
	Query the palette for a brush at the specified position.
bool	isValid () const
	Returns: whether this represents a valid palette.
Palette &	operator= (const Palette &)
	Palette (const Palette &)
	Palette (QObject *parent=0)
void	removeBrush (int position)
	Remove the brush at position position, if there is one.
int	size () const
	Returns: the number of brushed in the palette.
	~Palette ()
Static Public Member Functions
static const Palette &	defaultPalette ()
	Provide access to the three builtin palettes, one with standard bright colors, one with more subdued colors, and one with rainbow colors.
static const Palette &	rainbowPalette ()
static const Palette &	subduedPalette ()

---

Constructor & Destructor Documentation

Palette::Palette

(

QObject *

parent = 0

)

[explicit]

Definition at line 132 of file KDChartPalette.cpp.

  : QObject( parent ), _d( new Private )
{

}

Palette::Palette

(

const Palette &

r

)

Definition at line 145 of file KDChartPalette.cpp.

    : QObject(), _d( new Private( *r.d ) )
{
}

Palette::~Palette

(

)

Definition at line 138 of file KDChartPalette.cpp.

{
    delete _d; _d = 0;
}

---

Member Function Documentation

void Palette::addBrush	(	const QBrush &	brush,
		int	position = -1
	)

Adds brush to the palette.

If no position is specified, the brush is appended.

Definition at line 169 of file KDChartPalette.cpp.

References changed(), d, and size().

Referenced by makeDefaultPalette(), makeRainbowPalette(), and makeSubduedPalette().

{
  if ( position < 0 || position >= size() ) {
    d->brushes.append( brush );
  } else {
    d->brushes.insert( position, brush );
  }
  emit changed();
}

void KDChart::Palette::changed

(

)

[signal]

Emitted whenever the palette changes.

Views listen to this and repaing.

Referenced by addBrush(), and removeBrush().

const Palette & Palette::defaultPalette

(

)

[static]

Provide access to the three builtin palettes, one with standard bright colors, one with more subdued colors, and one with rainbow colors.

Definition at line 114 of file KDChartPalette.cpp.

References makeDefaultPalette().

Referenced by KDChart::AttributesModel::headerData().

{
    static const Palette palette = makeDefaultPalette();
    return palette;
}

QBrush Palette::getBrush

(

int

position

)

const

Query the palette for a brush at the specified position.

If the position exceeds the size of the palette, it wraps around.

Definition at line 179 of file KDChartPalette.cpp.

References d, isValid(), and size().

Referenced by KDChart::AttributesModel::headerData(), and makeRainbowPalette().

{
  if ( !isValid() ) return QBrush();
  return d->brushes.at( position % size() );
}

bool Palette::isValid

(

)

const

Returns:

whether this represents a valid palette.

For a palette to be valid it needs to have at least one brush associated.

Definition at line 159 of file KDChartPalette.cpp.

References d.

Referenced by getBrush().

{
  return d->brushes.size() >= 1;
}

Palette & Palette::operator=

(

const Palette &

r

)

Definition at line 150 of file KDChartPalette.cpp.

{
    Palette copy( r );
    copy.swap( *this );

    // emit changed() ?
    return *this;
}

const Palette & Palette::rainbowPalette

(

)

[static]

Definition at line 126 of file KDChartPalette.cpp.

References makeRainbowPalette().

Referenced by KDChart::AttributesModel::headerData().

{
    static const Palette palette = makeRainbowPalette();
    return palette;
}

void Palette::removeBrush

(

int

position

)

Remove the brush at position position, if there is one.

Definition at line 185 of file KDChartPalette.cpp.

References changed(), d, and size().

{
  if ( position < 0 || position >= size() ) return;
  d->brushes.remove( position );
  emit changed();
}

int Palette::size

(

)

const

Returns:

the number of brushed in the palette.

Definition at line 164 of file KDChartPalette.cpp.

References d.

Referenced by addBrush(), getBrush(), and removeBrush().

{
  return d->brushes.size();
}

const Palette & Palette::subduedPalette

(

)

[static]

Definition at line 120 of file KDChartPalette.cpp.

References makeSubduedPalette().

Referenced by KDChart::AttributesModel::headerData().

{
    static const Palette palette = makeSubduedPalette();
    return palette;
}

---

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

• KDChartPalette.h
• KDChartPalette.cpp

---