ClusterColors Class Reference

This class represents the list of the clusters with their associated id, color and color status (i.e the color has been changed or not). More...

#include <clustercolors.h>

Inheritance diagram for ClusterColors:

[legend]Collaboration diagram for ClusterColors:

[legend]List of all members.

Public Member Functions
	ClusterColors (const ClusterColors &clustercolors)
virtual QColor	color (int identifier, SelectionMode mode=ItemColors::BY_ITEM_NUMBER)
	Returns the color for a cluster with a given id or position in the list (identifier).
virtual void	setColor (int identifier, QColor color, SelectionMode mode=ItemColors::BY_ITEM_NUMBER)
	Sets the color for a cluster with a given id or position in the list (identifier) to color.
virtual int	clusterId (int index)
	Returns the cluster id with a given position in the list (index).
virtual bool	contains (int clusterId)
	Returns true if the cluster Id exists false otherwise.
virtual bool	isColorChanged (int identifier, SelectionMode mode=ItemColors::BY_ITEM_NUMBER)
	Returns true if the color for a cluster with a given id or position in the list (identifier) has been changed, otherwise returns false.
virtual void	setColorChanged (int identifier, bool changed, SelectionMode mode=ItemColors::BY_ITEM_NUMBER)
	If changed is true, the color for a cluster with a given id or position in the list (identifier) is said to have changed, otherwise is said not to have changed.
uint	numberOfClusters () const
	Returns the number of clusters.
virtual bool	isColorChanged () const
	Returns true if at least the color of one cluster have changed, otherwise returns false.
virtual void	setColorChanged (bool changed)
	Sets the color status for the entire list of clusters.
virtual uint	append (int clusterId, QColor color)
	Appends a cluster to the list of clusters, the color status is set to false.
virtual void	insert (int clusterId, QColor color, int index)
	Inserts a cluster at position index in the list of clusters, the color status is set to false.
virtual bool	remove (int identifier, SelectionMode mode=ItemColors::BY_ITEM_NUMBER)
	Removes a cluster, with a given id or position in the list (identifier),from the list of clusters.
virtual QValueList< int >	colorChangedClusterList ()
	Returns the list of cluster ids for which the color has been changed since the last reset of their status.
virtual void	resetAllColorStatus ()
	Resets the status color of the object to false and do the same for all the clusters.
virtual void	changeClusterId (int index, int newClusterId)
	Changes the clusterId of a given element in the list.
	ClusterColors (const ClusterColors &clustercolors)
virtual QColor	color (int identifier, SelectionMode mode=ItemColors::BY_ITEM_NUMBER)
	Returns the color for a cluster with a given id or position in the list (identifier).
virtual void	setColor (int identifier, QColor color, SelectionMode mode=ItemColors::BY_ITEM_NUMBER)
	Sets the color for a cluster with a given id or position in the list (identifier) to color.
virtual int	clusterId (int index)
	Returns the cluster id with a given position in the list (index).
virtual bool	contains (int clusterId)
	Returns true if the cluster Id exists false otherwise.
virtual bool	isColorChanged (int identifier, SelectionMode mode=ItemColors::BY_ITEM_NUMBER)
	Returns true if the color for a cluster with a given id or position in the list (identifier) has been changed, otherwise returns false.
virtual void	setColorChanged (int identifier, bool changed, SelectionMode mode=ItemColors::BY_ITEM_NUMBER)
	If changed is true, the color for a cluster with a given id or position in the list (identifier) is said to have changed, otherwise is said not to have changed.
uint	numberOfClusters () const
	Returns the number of clusters.
virtual bool	isColorChanged () const
	Returns true if at least the color of one cluster have changed, otherwise returns false.
virtual void	setColorChanged (bool changed)
	Sets the color status for the entire list of clusters.
virtual uint	append (int clusterId, QColor color)
	Appends a cluster to the list of clusters, the color status is set to false.
virtual void	insert (int clusterId, QColor color, int index)
	Inserts a cluster at position index in the list of clusters, the color status is set to false.
virtual bool	remove (int identifier, SelectionMode mode=ItemColors::BY_ITEM_NUMBER)
	Removes a cluster, with a given id or position in the list (identifier),from the list of clusters.
virtual QValueList< int >	colorChangedClusterList ()
	Returns the list of cluster ids for which the color has been changed since the last reset of their status.
virtual void	resetAllColorStatus ()
	Resets the status color of the object to false and do the same for all the clusters.
virtual void	changeClusterId (int index, int newClusterId)
	Changes the clusterId of a given element in the list.

---

Detailed Description

This class represents the list of the clusters with their associated id, color and color status (i.e the color has been changed or not).

The list index is zero based.

Author:

Lynn Hazan

---

Member Function Documentation

virtual QColor ClusterColors::color	(	int	identifier,
		SelectionMode	mode = ItemColors::BY_ITEM_NUMBER
	)			[inline, virtual]

Returns the color for a cluster with a given id or position in the list (identifier).

Parameters:

	identifier	depending on the mode the index in the list of clusters or the cluster idr
	mode	the way of looking up for the color

Returns:

the QColor for the given cluster

Reimplemented from ItemColors.

virtual void ClusterColors::setColor	(	int	identifier,
		QColor	color,
		SelectionMode	mode = ItemColors::BY_ITEM_NUMBER
	)			[inline, virtual]

Sets the color for a cluster with a given id or position in the list (identifier) to color.

Parameters:

	identifier	identifier depending on the mode the index in the list of clusters or the cluster id
	mode	the way of looking up for the cluster
	color	color to attribute to the cluster

Reimplemented from ItemColors.

virtual int ClusterColors::clusterId

(

int

index

)

[inline, virtual]

Returns the cluster id with a given position in the list (index).

Parameters:

index

the index in the list of clusters

Returns:

the cluster id

virtual bool ClusterColors::contains

(

int

clusterId

)

[inline, virtual]

Returns true if the cluster Id exists false otherwise.

Parameters:

clusterId

the id of the cluster to check for existence

Returns:

the boolean value for the existance of the cluster

Reimplemented from ItemColors.

virtual bool ClusterColors::isColorChanged	(	int	identifier,
		SelectionMode	mode = ItemColors::BY_ITEM_NUMBER
	)			[inline, virtual]

Returns true if the color for a cluster with a given id or position in the list (identifier) has been changed, otherwise returns false.

Parameters:

	identifier	depending on the mode the index in the list of clusters or the cluster id
	mode	the way of looking up for the color

Returns:

the color status for the given cluster

Reimplemented from ItemColors.

virtual void ClusterColors::setColorChanged	(	int	identifier,
		bool	changed,
		SelectionMode	mode = ItemColors::BY_ITEM_NUMBER
	)			[inline, virtual]

If changed is true, the color for a cluster with a given id or position in the list (identifier) is said to have changed, otherwise is said not to have changed.

Parameters:

	identifier	depending on the mode the index in the list of clusters or the cluster id
	mode	the way of looking up for the color
	changed	color status.

Reimplemented from ItemColors.

uint ClusterColors::numberOfClusters

(

)

const [inline]

Returns the number of clusters.

Returns:

the number of clusters in the list

virtual bool ClusterColors::isColorChanged

(

)

const [inline, virtual]

Returns true if at least the color of one cluster have changed, otherwise returns false.

Returns:

the color status for the identifierle list of clusters

Reimplemented from ItemColors.

virtual void ClusterColors::setColorChanged

(

bool

changed

)

[inline, virtual]

Sets the color status for the entire list of clusters.

Parameters:

changed

color status.

Reimplemented from ItemColors.

virtual uint ClusterColors::append	(	int	clusterId,
		QColor	color
	)			[inline, virtual]

Appends a cluster to the list of clusters, the color status is set to false.

Parameters:

	clusterId	the cluster id.
	color	the color of the cluster.

Returns:

the index in the list.

Reimplemented from ItemColors.

virtual void ClusterColors::insert	(	int	clusterId,
		QColor	color,
		int	index
	)			[inline, virtual]

Inserts a cluster at position index in the list of clusters, the color status is set to false.

Parameters:

	clusterId	the cluster id.
	index	index position where to insert the cluster.
	color	the color of the cluster.

Reimplemented from ItemColors.

virtual bool ClusterColors::remove	(	int	identifier,
		SelectionMode	mode = ItemColors::BY_ITEM_NUMBER
	)			[inline, virtual]

Removes a cluster, with a given id or position in the list (identifier),from the list of clusters.

Parameters:

	identifier	depending on the mode the index in the list of clusters or the cluster id
	mode	the way of looking up for the cluster

Returns:

true if successful,i.e. if identifier is in range, otherwise returns false.

Reimplemented from ItemColors.

virtual QValueList<int> ClusterColors::colorChangedClusterList

(

)

[inline, virtual]

Returns the list of cluster ids for which the color has been changed since the last reset of their status.

Returns:

cluster ids list.

virtual void ClusterColors::changeClusterId	(	int	index,
		int	newClusterId
	)			[inline, virtual]

Changes the clusterId of a given element in the list.

Parameters:

	index	position of the cluster in the list.
	newClusterId	the new id to assign.

virtual QColor ClusterColors::color	(	int	identifier,
		SelectionMode	mode = ItemColors::BY_ITEM_NUMBER
	)			[inline, virtual]

Returns the color for a cluster with a given id or position in the list (identifier).

Parameters:

	identifier	depending on the mode the index in the list of clusters or the cluster idr
	mode	the way of looking up for the color

Returns:

the QColor for the given cluster

Reimplemented from ItemColors.

virtual void ClusterColors::setColor	(	int	identifier,
		QColor	color,
		SelectionMode	mode = ItemColors::BY_ITEM_NUMBER
	)			[inline, virtual]

Sets the color for a cluster with a given id or position in the list (identifier) to color.

Parameters:

	identifier	identifier depending on the mode the index in the list of clusters or the cluster id
	mode	the way of looking up for the cluster
	color	color to attribute to the cluster

Reimplemented from ItemColors.

virtual int ClusterColors::clusterId

(

int

index

)

[inline, virtual]

Returns the cluster id with a given position in the list (index).

Parameters:

index

the index in the list of clusters

Returns:

the cluster id

virtual bool ClusterColors::contains

(

int

clusterId

)

[inline, virtual]

Returns true if the cluster Id exists false otherwise.

Parameters:

clusterId

the id of the cluster to check for existence

Returns:

the boolean value for the existance of the cluster

Reimplemented from ItemColors.

virtual bool ClusterColors::isColorChanged	(	int	identifier,
		SelectionMode	mode = ItemColors::BY_ITEM_NUMBER
	)			[inline, virtual]

Returns true if the color for a cluster with a given id or position in the list (identifier) has been changed, otherwise returns false.

Parameters:

	identifier	depending on the mode the index in the list of clusters or the cluster id
	mode	the way of looking up for the color

Returns:

the color status for the given cluster

Reimplemented from ItemColors.

virtual void ClusterColors::setColorChanged	(	int	identifier,
		bool	changed,
		SelectionMode	mode = ItemColors::BY_ITEM_NUMBER
	)			[inline, virtual]

If changed is true, the color for a cluster with a given id or position in the list (identifier) is said to have changed, otherwise is said not to have changed.

Parameters:

	identifier	depending on the mode the index in the list of clusters or the cluster id
	mode	the way of looking up for the color
	changed	color status.

Reimplemented from ItemColors.

uint ClusterColors::numberOfClusters

(

)

const [inline]

Returns the number of clusters.

Returns:

the number of clusters in the list

virtual bool ClusterColors::isColorChanged

(

)

const [inline, virtual]

Returns true if at least the color of one cluster have changed, otherwise returns false.

Returns:

the color status for the identifierle list of clusters

Reimplemented from ItemColors.

virtual void ClusterColors::setColorChanged

(

bool

changed

)

[inline, virtual]

Sets the color status for the entire list of clusters.

Parameters:

changed

color status.

Reimplemented from ItemColors.

virtual uint ClusterColors::append	(	int	clusterId,
		QColor	color
	)			[inline, virtual]

Appends a cluster to the list of clusters, the color status is set to false.

Parameters:

	clusterId	the cluster id.
	color	the color of the cluster.

Returns:

the index in the list.

Reimplemented from ItemColors.

virtual void ClusterColors::insert	(	int	clusterId,
		QColor	color,
		int	index
	)			[inline, virtual]

Inserts a cluster at position index in the list of clusters, the color status is set to false.

Parameters:

	clusterId	the cluster id.
	index	index position where to insert the cluster.
	color	the color of the cluster.

Reimplemented from ItemColors.

virtual bool ClusterColors::remove	(	int	identifier,
		SelectionMode	mode = ItemColors::BY_ITEM_NUMBER
	)			[inline, virtual]

Removes a cluster, with a given id or position in the list (identifier),from the list of clusters.

Parameters:

	identifier	depending on the mode the index in the list of clusters or the cluster id
	mode	the way of looking up for the cluster

Returns:

true if successful,i.e. if identifier is in range, otherwise returns false.

Reimplemented from ItemColors.

virtual QValueList<int> ClusterColors::colorChangedClusterList

(

)

[inline, virtual]

Returns the list of cluster ids for which the color has been changed since the last reset of their status.

Returns:

cluster ids list.

virtual void ClusterColors::changeClusterId	(	int	index,
		int	newClusterId
	)			[inline, virtual]

Changes the clusterId of a given element in the list.

Parameters:

	index	position of the cluster in the list.
	newClusterId	the new id to assign.

---

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

• debug/src/clustercolors.h
• src/clustercolors.h
• debug/src/clustercolors.cpp
• src/clustercolors.cpp

---