KExtHighscore::Item Class Reference

This class defines how to convert and how to display a highscore element (such as the score, the date, . More...

#include <kexthighscore_item.h>

Inheritance diagram for KExtHighscore::Item:

[legend]List of all members.

Public Types
enum	Format {   NoFormat, OneDecimal, Percentage, MinuteTime,   DateTime }
	Possible display format. More...
enum	Special {   NoSpecial, ZeroNotDefined, NegativeNotDefined, DefaultNotDefined,   Anonymous }
	Possible special value for display format. More...
Public Member Functions
	Item (const QVariant &def=QVariant::Invalid, const QString &label=QString::null, int alignment=Qt::AlignRight)
	Constructor.
virtual	~Item ()
void	setPrettyFormat (Format format)
	Set the display format.
void	setPrettySpecial (Special special)
	Set the special value for display.
bool	isVisible () const
void	setLabel (const QString &label)
	Set the label.
QString	label () const
int	alignment () const
void	setDefaultValue (const QVariant &value)
	Set default value.
const QVariant &	defaultValue () const
virtual QVariant	read (uint i, const QVariant &value) const
virtual QString	pretty (uint i, const QVariant &value) const

---

Detailed Description

This class defines how to convert and how to display a highscore element (such as the score, the date, .

..) or a player info (such as the player name, the best score, ...).

Definition at line 40 of file kexthighscore_item.h.

---

Member Enumeration Documentation

enum KExtHighscore::Item::Format

Possible display format. NoFormat : no formatting (default) OneDecimal : with one decimal (only for Double) Percentage : with one decimal + % (only for Double) MinuteTime : MM:SS ie 3600 is 00:00, 1 is 59:59 and 0 is undefined (only for UInt, Int and Double) DateTime : date and time according to locale (only for DateTime) Enumerator: NoFormat  OneDecimal  Percentage  MinuteTime  DateTime  Definition at line 55 of file kexthighscore_item.h.

enum KExtHighscore::Item::Special

Possible special value for display format. NoSpecial : no special value ; a null DateTime is replaced by "--" (default) ZeroNotDefined : 0 is replaced by "--" (only for UInt, Int and Double) NegativeNotDefined : negative values are replaced by "--" (only for Int and Double) DefaultNotDefined : default value is replaced by "--" Anonymous : replace the special value ItemBase::ANONYMOUS by i18n("anonymous") (only for String) Enumerator: NoSpecial  ZeroNotDefined  NegativeNotDefined  DefaultNotDefined  Anonymous  Definition at line 72 of file kexthighscore_item.h.

---

Constructor & Destructor Documentation

KExtHighscore::Item::Item (  const QVariant &  def = QVariant::Invalid, const QString &  label = QString::null, int  alignment = Qt::AlignRight )

Constructor. Parameters: def  default value ; the QVariant also gives the type of data. Be sure to cast the value to the required type (for e.g. with uint). label  the label corresponding to the item. If empty, the item is not shown. alignment  the alignment of the item. Definition at line 36 of file kexthighscore_item.cpp.

KExtHighscore::Item::~Item (   )  [virtual]

Definition at line 41 of file kexthighscore_item.cpp.

---

Member Function Documentation

int KExtHighscore::Item::alignment (   )  const [inline]

Returns: the alignment. Definition at line 119 of file kexthighscore_item.h.

const QVariant& KExtHighscore::Item::defaultValue (   )  const [inline]

Returns: the default value. Definition at line 129 of file kexthighscore_item.h. Referenced by KExtHighscore::ItemContainer::read(), and KExtHighscore::Manager::setPlayerItem().

bool KExtHighscore::Item::isVisible (   )  const [inline]

Returns: if the item is shown. Definition at line 104 of file kexthighscore_item.h.

QString KExtHighscore::Item::label (   )  const [inline]

Returns: the label. Definition at line 114 of file kexthighscore_item.h.

QString KExtHighscore::Item::pretty (  uint  i, const QVariant &  value )  const [virtual]

Returns: the string to be displayed. You may need to reimplement this method for special formatting (different from the standard ones). Parameters: i  the element index ("rank" for score / "id" for player) value  the value to convert Reimplemented in KExtHighscore::ScoreNameItem, and KExtHighscore::RankItem. Definition at line 106 of file kexthighscore_item.cpp. References KExtHighscore::ItemContainer::ANONYMOUS, Anonymous, KExtHighscore::ItemContainer::ANONYMOUS_LABEL, DateTime, DefaultNotDefined, MinuteTime, NegativeNotDefined, NoFormat, NoSpecial, OneDecimal, Percentage, and ZeroNotDefined. Referenced by KExtHighscore::HistogramTab::HistogramTab(), KExtHighscore::ScoreNameItem::pretty(), and KExtHighscore::ItemContainer::pretty().

QVariant KExtHighscore::Item::read (  uint  i, const QVariant &  value )  const [virtual]

Returns: the converted value (by default the value is left unchanged). Most of the time you don't need to reimplement this method. Parameters: i  the element index ("rank" for score / "id" for player) value  the value to convert Reimplemented in KExtHighscore::RankItem. Definition at line 44 of file kexthighscore_item.cpp. Referenced by KExtHighscore::ItemContainer::read().

void KExtHighscore::Item::setDefaultValue (  const QVariant &  value  )  [inline]

Set default value. Definition at line 124 of file kexthighscore_item.h. Referenced by KExtHighscore::Manager::setPlayerItem(), and KExtHighscore::Manager::setScoreItem().

void KExtHighscore::Item::setLabel (  const QString &  label  )  [inline]

Set the label. Definition at line 109 of file kexthighscore_item.h.

void KExtHighscore::Item::setPrettyFormat (  Format  format  )

Set the display format. See also: Format Definition at line 49 of file kexthighscore_item.cpp. References DateTime, MinuteTime, NoFormat, OneDecimal, and Percentage. Referenced by KExtHighscore::Manager::createItem(), KExtHighscore::DateItem::DateItem(), KExtHighscore::Manager::setScoreType(), and KExtHighscore::SuccessPercentageItem::SuccessPercentageItem().

void KExtHighscore::Item::setPrettySpecial (  Special  special  )

Set the special value for display. See also: Special Definition at line 73 of file kexthighscore_item.cpp. References Anonymous, DefaultNotDefined, NegativeNotDefined, NoSpecial, and ZeroNotDefined. Referenced by KExtHighscore::Manager::createItem(), KExtHighscore::NameItem::NameItem(), and KExtHighscore::SuccessPercentageItem::SuccessPercentageItem().

---

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

• kexthighscore_item.h
• kexthighscore_item.cpp

---