libkdegames Library API Documentation

KExtHighscore::Item Class Reference

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, ...). More...

#include <kexthighscore_item.h>

List of all members.

Public Types

enum  Format {
  NoFormat, OneDecimal, Percentage, MinuteTime,
  DateTime
}
enum  Special {
  NoSpecial, ZeroNotDefined, NegativeNotDefined, DefaultNotDefined,
  Anonymous
}

Public Member Functions

 Item (const QVariant &def=QVariant::Invalid, const QString &label=QString::null, int alignment=Qt::AlignRight)
void setPrettyFormat (Format format)
void setPrettySpecial (Special special)
bool isVisible () const
void setLabel (const QString &label)
QString label () const
int alignment () const
void setDefaultValue (const QVariant &value)
const QVariantdefaultValue () 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)
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)
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.


Member Function Documentation

void KExtHighscore::Item::setPrettyFormat Format  format  ) 
 

Set the display format.

See also:
Format
Definition at line 49 of file kexthighscore_item.cpp.

Referenced by KExtHighscore::Manager::createItem(), and KExtHighscore::Manager::setScoreType().

void KExtHighscore::Item::setPrettySpecial Special  special  ) 
 

Set the special value for display.

See also:
Special
Definition at line 73 of file kexthighscore_item.cpp.

Referenced by KExtHighscore::Manager::createItem().

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

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

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

Set the label.

Definition at line 109 of file kexthighscore_item.h.

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

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

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

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

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().

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

Returns:
the default value.
Definition at line 129 of file kexthighscore_item.h.

Referenced by KExtHighscore::Manager::setPlayerItem().

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
Definition at line 44 of file kexthighscore_item.cpp.

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
Definition at line 106 of file kexthighscore_item.cpp.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for libkdegames Library Version 3.3.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Aug 26 00:21:46 2004 by doxygen 1.3.8 written by Dimitri van Heesch, © 1997-2003