kalarm/lib

ColourList Class Reference

#include <colourlist.h>

List of all members.


Detailed Description

Represents a sorted list of colours.

The ColourList class holds a list of colours, sorted in RGB value order.

It provides a sorted QValueList of colours in RGB value order, with iterators and other access methods which return either QRgb or QColor objects.

Author:
David Jarvie <software@astrojar.org.uk>

Definition at line 39 of file colourlist.h.


Public Types

typedef size_t size_type
typedef QValueListConstIterator<
QRgb > 
const_iterator

Public Member Functions

 ColourList ()
 ColourList (const ColourList &l)
 ColourList (const QValueList< QRgb > &list)
 ColourList (const QColor *list)
ColourListoperator= (const ColourList &l)
ColourListoperator= (const QValueList< QRgb > &list)
void clear ()
void insert (const QColor &c)
void remove (const QColor &c)
ColourListoperator+= (const QColor &c)
ColourListoperator+= (const ColourList &list)
bool operator== (const ColourList &l) const
bool operator!= (const ColourList &l) const
size_type count () const
bool isEmpty () const
const_iterator begin () const
const_iterator end () const
const_iterator fromLast () const
const_iterator at (size_type i) const
size_type contains (const QColor &c) const
const_iterator find (const QColor &c) const
const_iterator find (const_iterator it, const QColor &c) const
int findIndex (const QColor &c) const
QColor first () const
QColor last () const
QColor operator[] (size_type i) const

Constructor & Destructor Documentation

ColourList::ColourList (  )  [inline]

Constructs an empty list.

Definition at line 46 of file colourlist.h.

ColourList::ColourList ( const ColourList l  )  [inline]

Copy constructor.

Definition at line 48 of file colourlist.h.

ColourList::ColourList ( const QValueList< QRgb > &  list  )  [inline]

Constructs a list whose values are preset to the colours in list.

Definition at line 50 of file colourlist.h.

ColourList::ColourList ( const QColor *  list  ) 

Constructs a list whose values are preset to the colours in the list.

Terminate list by an invalid colour.

Definition at line 24 of file colourlist.cpp.


Member Function Documentation

ColourList& ColourList::operator= ( const ColourList l  )  [inline]

Assignment operator.

Definition at line 56 of file colourlist.h.

ColourList& ColourList::operator= ( const QValueList< QRgb > &  list  )  [inline]

Sets the list to comprise the colours in list.

Definition at line 58 of file colourlist.h.

void ColourList::clear (  )  [inline]

Removes all values from the list.

Definition at line 60 of file colourlist.h.

void ColourList::insert ( const QColor &  c  ) 

Adds the specified colour c to the list.

Definition at line 30 of file colourlist.cpp.

void ColourList::remove ( const QColor &  c  )  [inline]

Removes the colour c from the list.

Definition at line 64 of file colourlist.h.

ColourList& ColourList::operator+= ( const QColor &  c  )  [inline]

Adds the specified colour c to the list.

Definition at line 66 of file colourlist.h.

ColourList& ColourList::operator+= ( const ColourList list  )  [inline]

Adds the colours in list to this list.

Definition at line 68 of file colourlist.h.

bool ColourList::operator== ( const ColourList l  )  const [inline]

Returns true if the colours in the two lists are the same.

Definition at line 70 of file colourlist.h.

bool ColourList::operator!= ( const ColourList l  )  const [inline]

Returns true if the colours in the two lists differ.

Definition at line 72 of file colourlist.h.

size_type ColourList::count (  )  const [inline]

Returns the number of colours in the list.

Definition at line 74 of file colourlist.h.

bool ColourList::isEmpty (  )  const [inline]

Returns true if the list is empty.

Definition at line 76 of file colourlist.h.

const_iterator ColourList::begin (  )  const [inline]

Returns an iterator pointing to the first colour in the list.

Definition at line 78 of file colourlist.h.

const_iterator ColourList::end (  )  const [inline]

Returns an iterator pointing past the last colour in the list.

Definition at line 80 of file colourlist.h.

const_iterator ColourList::fromLast (  )  const [inline]

Returns an iterator pointing to the last colour in the list, or end() if the list is empty.

Definition at line 82 of file colourlist.h.

const_iterator ColourList::at ( size_type  i  )  const [inline]

Returns an iterator pointing to the colour at position i in the list.

Definition at line 84 of file colourlist.h.

size_type ColourList::contains ( const QColor &  c  )  const [inline]

Returns true if the list contains the colour c.

Definition at line 86 of file colourlist.h.

const_iterator ColourList::find ( const QColor &  c  )  const [inline]

Returns an iterator pointing to the first occurrence of colour c in the list.

Returns end() if colour c is not in the list.

Definition at line 90 of file colourlist.h.

const_iterator ColourList::find ( const_iterator  it,
const QColor &  c 
) const [inline]

Returns an iterator pointing to the first occurrence of colour c in the list, starting.

from position it. Returns end() if colour c is not in the list.

Definition at line 94 of file colourlist.h.

int ColourList::findIndex ( const QColor &  c  )  const [inline]

Returns the index to the first occurrence of colour c in the list.

Returns -1 if colour c is not in the list.

Definition at line 98 of file colourlist.h.

QColor ColourList::first (  )  const [inline]

Returns the first colour in the list.

If the list is empty, the result is undefined.

Definition at line 100 of file colourlist.h.

QColor ColourList::last (  )  const [inline]

Returns the last colour in the list.

If the list is empty, the result is undefined.

Definition at line 102 of file colourlist.h.

QColor ColourList::operator[] ( size_type  i  )  const [inline]

Returns the colour at position i in the list.

If the item does not exist, the result is undefined.

Definition at line 104 of file colourlist.h.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys