KScoreDialog

Search for usage in LXR

KScoreDialog Class Reference

#include <KScoreDialog>

Inheritance diagram for KScoreDialog:

Public Types

enum  AddScoreFlag { AskName = 0x1, LessIsMore = 0x2 }
 
typedef QFlags< AddScoreFlagAddScoreFlags
 
typedef QMap< int, QStringFieldInfo
 
enum  Fields {
  Name = 1 << 0, Level = 1 << 1, Date = 1 << 2, Time = 1 << 3,
  Score = 1 << 4, Custom1 = 1 << 10, Custom2 = 1 << 11, Custom3 = 1 << 12,
  Custom4 = 1 << 13, Custom5 = 1 << 14, Max = 1 << 30
}
 
- Public Types inherited from QDialog
enum  DialogCode
 
- Public Types inherited from QWidget
enum  RenderFlag
 
- Public Types inherited from QPaintDevice
enum  PaintDeviceMetric
 

Public Member Functions

 KScoreDialog (int fields=Name, QWidget *parent=nullptr)
 
void addField (int field, const QString &header, const QString &key)
 
void addLocalizedConfigGroupName (const QPair< QByteArray, QString > &group)
 
void addLocalizedConfigGroupNames (const QMap< QByteArray, QString > &groups)
 
int addScore (const FieldInfo &newInfo=FieldInfo(), const AddScoreFlags &flags={})
 
int addScore (int newScore, const AddScoreFlags &flags={})
 
int exec () override
 
void hideField (int field)
 
int highScore ()
 
void initFromDifficulty (const KgDifficulty *difficulty, bool setConfigGroup=true)
 
void setComment (const QString &comment)
 
void setConfigGroup (const QPair< QByteArray, QString > &group)
 
void setConfigGroup (const QString &group=QString())
 
void setConfigGroupWeights (const QMap< int, QByteArray > &weights)
 
void setHiddenConfigGroups (const QList< QByteArray > &hiddenGroups)
 
virtual void show ()
 
- Public Member Functions inherited from QDialog
 QDialog (QWidget *parent, Qt::WindowFlags f)
 
virtual void accept ()
 
void accepted ()
 
virtual void done (int r)
 
QWidgetextension () const const
 
void finished (int result)
 
bool isSizeGripEnabled () const const
 
virtual QSize minimumSizeHint () const const override
 
virtual void open ()
 
Qt::Orientation orientation () const const
 
virtual void reject ()
 
void rejected ()
 
int result () const const
 
void setExtension (QWidget *extension)
 
void setModal (bool modal)
 
void setOrientation (Qt::Orientation orientation)
 
void setResult (int i)
 
void setSizeGripEnabled (bool)
 
virtual void setVisible (bool visible) override
 
void showExtension (bool showIt)
 
virtual QSize sizeHint () const const override
 
- Public Member Functions inherited from QWidget
 QWidget (QWidget *parent, Qt::WindowFlags f)
 
bool acceptDrops () const const
 
QString accessibleDescription () const const
 
QString accessibleName () const const
 
QList< QAction * > actions () const const
 
void activateWindow ()
 
void addAction (QAction *action)
 
void addActions (QList< QAction * > actions)
 
void adjustSize ()
 
bool autoFillBackground () const const
 
QPalette::ColorRole backgroundRole () const const
 
QBackingStorebackingStore () const const
 
QSize baseSize () const const
 
QWidgetchildAt (const QPoint &p) const const
 
QWidgetchildAt (int x, int y) const const
 
QRect childrenRect () const const
 
QRegion childrenRegion () const const
 
void clearFocus ()
 
void clearMask ()
 
bool close ()
 
QMargins contentsMargins () const const
 
QRect contentsRect () const const
 
Qt::ContextMenuPolicy contextMenuPolicy () const const
 
QCursor cursor () const const
 
void customContextMenuRequested (const QPoint &pos)
 
WId effectiveWinId () const const
 
void ensurePolished () const const
 
Qt::FocusPolicy focusPolicy () const const
 
QWidgetfocusProxy () const const
 
QWidgetfocusWidget () const const
 
const QFontfont () const const
 
QFontInfo fontInfo () const const
 
QFontMetrics fontMetrics () const const
 
QPalette::ColorRole foregroundRole () const const
 
QRect frameGeometry () const const
 
QSize frameSize () const const
 
const QRectgeometry () const const
 
void getContentsMargins (int *left, int *top, int *right, int *bottom) const const
 
QPixmap grab (const QRect &rectangle)
 
void grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)
 
void grabKeyboard ()
 
void grabMouse ()
 
void grabMouse (const QCursor &cursor)
 
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)
 
QGraphicsEffectgraphicsEffect () const const
 
QGraphicsProxyWidgetgraphicsProxyWidget () const const
 
bool hasEditFocus () const const
 
bool hasFocus () const const
 
virtual bool hasHeightForWidth () const const
 
bool hasMouseTracking () const const
 
bool hasTabletTracking () const const
 
int height () const const
 
virtual int heightForWidth (int w) const const
 
void hide ()
 
Qt::InputMethodHints inputMethodHints () const const
 
virtual QVariant inputMethodQuery (Qt::InputMethodQuery query) const const
 
void insertAction (QAction *before, QAction *action)
 
void insertActions (QAction *before, QList< QAction * > actions)
 
bool isActiveWindow () const const
 
bool isAncestorOf (const QWidget *child) const const
 
bool isEnabled () const const
 
bool isEnabledTo (const QWidget *ancestor) const const
 
bool isEnabledToTLW () const const
 
bool isFullScreen () const const
 
bool isHidden () const const
 
bool isMaximized () const const
 
bool isMinimized () const const
 
bool isModal () const const
 
bool isTopLevel () const const
 
bool isVisible () const const
 
bool isVisibleTo (const QWidget *ancestor) const const
 
bool isWindow () const const
 
bool isWindowModified () const const
 
QLayoutlayout () const const
 
Qt::LayoutDirection layoutDirection () const const
 
QLocale locale () const const
 
void lower ()
 
QPoint mapFrom (const QWidget *parent, const QPoint &pos) const const
 
QPoint mapFromGlobal (const QPoint &pos) const const
 
QPoint mapFromParent (const QPoint &pos) const const
 
QPoint mapTo (const QWidget *parent, const QPoint &pos) const const
 
QPoint mapToGlobal (const QPoint &pos) const const
 
QPoint mapToParent (const QPoint &pos) const const
 
QRegion mask () const const
 
int maximumHeight () const const
 
QSize maximumSize () const const
 
int maximumWidth () const const
 
int minimumHeight () const const
 
QSize minimumSize () const const
 
int minimumWidth () const const
 
void move (const QPoint &)
 
void move (int x, int y)
 
QWidgetnativeParentWidget () const const
 
QWidgetnextInFocusChain () const const
 
QRect normalGeometry () const const
 
void overrideWindowFlags (Qt::WindowFlags flags)
 
virtual QPaintEnginepaintEngine () const const override
 
const QPalettepalette () const const
 
QWidgetparentWidget () const const
 
QPoint pos () const const
 
QWidgetpreviousInFocusChain () const const
 
 QWIDGETSIZE_MAX QWIDGETSIZE_MAX
 
void raise ()
 
QRect rect () const const
 
void releaseKeyboard ()
 
void releaseMouse ()
 
void releaseShortcut (int id)
 
void removeAction (QAction *action)
 
void render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
 
void render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
 
void repaint ()
 
void repaint (const QRect &rect)
 
void repaint (const QRegion &rgn)
 
void repaint (int x, int y, int w, int h)
 
void resize (const QSize &)
 
void resize (int w, int h)
 
bool restoreGeometry (const QByteArray &geometry)
 
QByteArray saveGeometry () const const
 
QScreenscreen () const const
 
void scroll (int dx, int dy)
 
void scroll (int dx, int dy, const QRect &r)
 
void setAcceptDrops (bool on)
 
void setAccessibleDescription (const QString &description)
 
void setAccessibleName (const QString &name)
 
void setAttribute (Qt::WidgetAttribute attribute, bool on)
 
void setAutoFillBackground (bool enabled)
 
void setBackgroundRole (QPalette::ColorRole role)
 
void setBaseSize (const QSize &)
 
void setBaseSize (int basew, int baseh)
 
void setContentsMargins (const QMargins &margins)
 
void setContentsMargins (int left, int top, int right, int bottom)
 
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
 
void setCursor (const QCursor &)
 
void setDisabled (bool disable)
 
void setEditFocus (bool enable)
 
void setEnabled (bool)
 
void setFixedHeight (int h)
 
void setFixedSize (const QSize &s)
 
void setFixedSize (int w, int h)
 
void setFixedWidth (int w)
 
void setFocus ()
 
void setFocus (Qt::FocusReason reason)
 
void setFocusPolicy (Qt::FocusPolicy policy)
 
void setFocusProxy (QWidget *w)
 
void setFont (const QFont &)
 
void setForegroundRole (QPalette::ColorRole role)
 
void setGeometry (const QRect &)
 
void setGeometry (int x, int y, int w, int h)
 
void setGraphicsEffect (QGraphicsEffect *effect)
 
void setHidden (bool hidden)
 
void setInputMethodHints (Qt::InputMethodHints hints)
 
void setLayout (QLayout *layout)
 
void setLayoutDirection (Qt::LayoutDirection direction)
 
void setLocale (const QLocale &locale)
 
void setMask (const QBitmap &bitmap)
 
void setMask (const QRegion &region)
 
void setMaximumHeight (int maxh)
 
void setMaximumSize (const QSize &)
 
void setMaximumSize (int maxw, int maxh)
 
void setMaximumWidth (int maxw)
 
void setMinimumHeight (int minh)
 
void setMinimumSize (const QSize &)
 
void setMinimumSize (int minw, int minh)
 
void setMinimumWidth (int minw)
 
void setMouseTracking (bool enable)
 
void setPalette (const QPalette &)
 
void setParent (QWidget *parent)
 
void setParent (QWidget *parent, Qt::WindowFlags f)
 
void setShortcutAutoRepeat (int id, bool enable)
 
void setShortcutEnabled (int id, bool enable)
 
void setSizeIncrement (const QSize &)
 
void setSizeIncrement (int w, int h)
 
void setSizePolicy (QSizePolicy)
 
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
 
void setStatusTip (const QString &)
 
void setStyle (QStyle *style)
 
void setStyleSheet (const QString &styleSheet)
 
void setTabletTracking (bool enable)
 
void setToolTip (const QString &)
 
void setToolTipDuration (int msec)
 
void setUpdatesEnabled (bool enable)
 
void setupUi (QWidget *widget)
 
void setWhatsThis (const QString &)
 
void setWindowFilePath (const QString &filePath)
 
void setWindowFlag (Qt::WindowType flag, bool on)
 
void setWindowFlags (Qt::WindowFlags type)
 
void setWindowIcon (const QIcon &icon)
 
void setWindowIconText (const QString &)
 
void setWindowModality (Qt::WindowModality windowModality)
 
void setWindowModified (bool)
 
void setWindowOpacity (qreal level)
 
void setWindowRole (const QString &role)
 
void setWindowState (Qt::WindowStates windowState)
 
void setWindowTitle (const QString &)
 
void show ()
 
void showFullScreen ()
 
void showMaximized ()
 
void showMinimized ()
 
void showNormal ()
 
QSize size () const const
 
QSize sizeIncrement () const const
 
QSizePolicy sizePolicy () const const
 
void stackUnder (QWidget *w)
 
QString statusTip () const const
 
QStylestyle () const const
 
QString styleSheet () const const
 
bool testAttribute (Qt::WidgetAttribute attribute) const const
 
QString toolTip () const const
 
int toolTipDuration () const const
 
QWidgettopLevelWidget () const const
 
bool underMouse () const const
 
void ungrabGesture (Qt::GestureType gesture)
 
void unsetCursor ()
 
void unsetLayoutDirection ()
 
void unsetLocale ()
 
void update ()
 
void update (const QRect &rect)
 
void update (const QRegion &rgn)
 
void update (int x, int y, int w, int h)
 
void updateGeometry ()
 
bool updatesEnabled () const const
 
QRegion visibleRegion () const const
 
QString whatsThis () const const
 
int width () const const
 
QWidgetwindow () const const
 
QString windowFilePath () const const
 
Qt::WindowFlags windowFlags () const const
 
QWindowwindowHandle () const const
 
QIcon windowIcon () const const
 
void windowIconChanged (const QIcon &icon)
 
QString windowIconText () const const
 
void windowIconTextChanged (const QString &iconText)
 
Qt::WindowModality windowModality () const const
 
qreal windowOpacity () const const
 
QString windowRole () const const
 
Qt::WindowStates windowState () const const
 
QString windowTitle () const const
 
void windowTitleChanged (const QString &title)
 
Qt::WindowType windowType () const const
 
WId winId () const const
 
int x () const const
 
int y () const const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 
- Public Member Functions inherited from QPaintDevice
int colorCount () const const
 
int depth () const const
 
int devicePixelRatio () const const
 
qreal devicePixelRatioF () const const
 
int height () const const
 
int heightMM () const const
 
int logicalDpiX () const const
 
int logicalDpiY () const const
 
bool paintingActive () const const
 
int physicalDpiX () const const
 
int physicalDpiY () const const
 
int width () const const
 
int widthMM () const const
 

Additional Inherited Members

- Properties inherited from QDialog
 modal
 
 sizeGripEnabled
 
- Properties inherited from QWidget
 acceptDrops
 
 accessibleDescription
 
 accessibleName
 
 autoFillBackground
 
 baseSize
 
 childrenRect
 
 childrenRegion
 
 contextMenuPolicy
 
 cursor
 
 enabled
 
 focus
 
 focusPolicy
 
 font
 
 frameGeometry
 
 frameSize
 
 fullScreen
 
 geometry
 
 height
 
 inputMethodHints
 
 isActiveWindow
 
 layoutDirection
 
 locale
 
 maximized
 
 maximumHeight
 
 maximumSize
 
 maximumWidth
 
 minimized
 
 minimumHeight
 
 minimumSize
 
 minimumSizeHint
 
 minimumWidth
 
 modal
 
 mouseTracking
 
 normalGeometry
 
 palette
 
 pos
 
 rect
 
 size
 
 sizeHint
 
 sizeIncrement
 
 sizePolicy
 
 statusTip
 
 styleSheet
 
 tabletTracking
 
 toolTip
 
 toolTipDuration
 
 updatesEnabled
 
 visible
 
 whatsThis
 
 width
 
 windowFilePath
 
 windowFlags
 
 windowIcon
 
 windowIconText
 
 windowModality
 
 windowModified
 
 windowOpacity
 
 windowTitle
 
 x
 
 y
 
- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QWidget
QWidgetcreateWindowContainer (QWindow *window, QWidget *parent, Qt::WindowFlags flags)
 
QWidgetfind (WId id)
 
QWidgetkeyboardGrabber ()
 
QWidgetmouseGrabber ()
 
void setTabOrder (QWidget *first, QWidget *second)
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QDialog
 Accepted
 
 Rejected
 
- Public Attributes inherited from QWidget
 DrawChildren
 
 DrawWindowBackground
 
 IgnoreMask
 
typedef RenderFlags
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Public Attributes inherited from QPaintDevice
 PdmDepth
 
 PdmDevicePixelRatio
 
 PdmDevicePixelRatioScaled
 
 PdmDpiX
 
 PdmDpiY
 
 PdmHeight
 
 PdmHeightMM
 
 PdmNumColors
 
 PdmPhysicalDpiX
 
 PdmPhysicalDpiY
 
 PdmWidth
 
 PdmWidthMM
 
- Protected Member Functions inherited from QDialog
virtual void closeEvent (QCloseEvent *e) override
 
virtual void contextMenuEvent (QContextMenuEvent *e) override
 
virtual bool eventFilter (QObject *o, QEvent *e) override
 
virtual void resizeEvent (QResizeEvent *) override
 
virtual void showEvent (QShowEvent *event) override
 
- Protected Member Functions inherited from QWidget
virtual void actionEvent (QActionEvent *event)
 
virtual void changeEvent (QEvent *event)
 
void create (WId window, bool initializeWindow, bool destroyOldWindow)
 
void destroy (bool destroyWindow, bool destroySubWindows)
 
virtual void dragEnterEvent (QDragEnterEvent *event)
 
virtual void dragLeaveEvent (QDragLeaveEvent *event)
 
virtual void dragMoveEvent (QDragMoveEvent *event)
 
virtual void dropEvent (QDropEvent *event)
 
virtual void enterEvent (QEvent *event)
 
virtual bool event (QEvent *event) override
 
virtual void focusInEvent (QFocusEvent *event)
 
bool focusNextChild ()
 
virtual bool focusNextPrevChild (bool next)
 
virtual void focusOutEvent (QFocusEvent *event)
 
bool focusPreviousChild ()
 
virtual void hideEvent (QHideEvent *event)
 
virtual void initPainter (QPainter *painter) const const override
 
virtual void inputMethodEvent (QInputMethodEvent *event)
 
virtual void keyReleaseEvent (QKeyEvent *event)
 
virtual void leaveEvent (QEvent *event)
 
virtual int metric (QPaintDevice::PaintDeviceMetric m) const const override
 
virtual void mouseDoubleClickEvent (QMouseEvent *event)
 
virtual void mouseMoveEvent (QMouseEvent *event)
 
virtual void mousePressEvent (QMouseEvent *event)
 
virtual void mouseReleaseEvent (QMouseEvent *event)
 
virtual void moveEvent (QMoveEvent *event)
 
virtual bool nativeEvent (const QByteArray &eventType, void *message, long *result)
 
virtual void paintEvent (QPaintEvent *event)
 
virtual void tabletEvent (QTabletEvent *event)
 
void updateMicroFocus ()
 
virtual void wheelEvent (QWheelEvent *event)
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

A simple high score implementation.

This class can be used both for displaying the current high scores and also for adding new highscores. It is the recommended way of implementing a simple highscore table.

To display the current highscores it is simply a case of creating a KScoreDialog object and calling exec(). This example code will display the Name and Score (the score is always added automatically unless hidden hideField since it is used for sorting) of the top 10 players:

KScoreDialog ksdialog(this);
ksdialog.exec();

To add a new highscore, e.g. at the end of a game you simply create an object with the Fields you want to write (i.e. KScoreDialog::Name | KScoreDialog::Score), call addScore and then (optionally) display the dialog. This code will allow you to add a highscore with a Name and Score field. If it's the first time a player has a score on the table, they will be prompted for their name but subsequent times they will have their name filled in automatically.

KScoreDialog ksdialog(this);
ksdialog.addScore(playersScore);
ksdialog.exec();

Or if you want to fill the name in from the code you can pass a default name by doing

scoreInfo[KScoreDialog::Name] = "Matt";
scoreInfo[KScoreDialog::Score].setNum(playersScore);
ksdialog.addScore(scoreInfo);

If you want to add an extra field (e.g. the number of moves taken) then do

scoreInfo[KScoreDialog::Name] = "Matt";
scoreInfo[KScoreDialog::Score].setNum(playersScore);
ksdialog.addField(KScoreDialog::Custom1, "Num of Moves", "moves");
scoreInfo[KScoreDialog::Custom1].setNum(42);
ksdialog.addScore(scoreInfo);

You can define up to 5 Custom fields.

Author
Matt Williams [email protected][email protected]mill[email protected]iams.[email protected]com

Definition at line 79 of file kscoredialog.h.

Member Typedef Documentation

◆ AddScoreFlags

Stores a combination of AddScoreFlag values.

Definition at line 109 of file kscoredialog.h.

Member Enumeration Documentation

◆ AddScoreFlag

Flags for setting preferences for adding scores.

Enumerator
AskName 

Promt the player for their name.

LessIsMore 

A lower numerical score means higher placing on the table.

Definition at line 102 of file kscoredialog.h.

◆ Fields

Highscore fields.

Enumerator
Custom1 

Field for custom information.

Max 

Only for setting a maximum.

Definition at line 85 of file kscoredialog.h.

Constructor & Destructor Documentation

◆ KScoreDialog()

KScoreDialog::KScoreDialog ( int  fields = Name,
QWidget parent = nullptr 
)
explicit
Parameters
fieldsBitwise OR of the Fields that should be listed (Score is always present)
parentpassed to parent QWidget constructor.

Definition at line 91 of file kscoredialog.cpp.

Member Function Documentation

◆ addField()

void KScoreDialog::addField ( int  field,
const QString header,
const QString key 
)

Define an extra FieldInfo entry.

Parameters
fieldid of this field Fields e.g. KScoreDialog::Custom1
headertext shown in the header in the dialog for this field. e.g. "Number of Moves"
keyunique key used to store this field. e.g. "moves"

Definition at line 212 of file kscoredialog.cpp.

◆ addLocalizedConfigGroupName()

void KScoreDialog::addLocalizedConfigGroupName ( const QPair< QByteArray, QString > &  group)

You must add the translations of all group names to the dialog.

This is best done by passing the name through i18n(). The group set through setConfigGroup(const QPair<QByteArray, QString>& group) will be added automatically

Parameters
groupthe translated group name

Definition at line 157 of file kscoredialog.cpp.

◆ addLocalizedConfigGroupNames()

void KScoreDialog::addLocalizedConfigGroupNames ( const QMap< QByteArray, QString > &  groups)

You must add the translations of all group names to the dialog.

This is best done by passing the name through i18n(). The group set through setConfigGroup(const QPair<QByteArray, QString>& group) will be added automatically.

This function can be used directly with KGameDifficulty::localizedLevelStrings().

Parameters
groupsthe list of translated group names

Definition at line 165 of file kscoredialog.cpp.

◆ addScore() [1/2]

int KScoreDialog::addScore ( const FieldInfo newInfo = FieldInfo(),
const AddScoreFlags flags = {} 
)

Adds a new score to the list.

Parameters
newInfoinfo about the score.
flagsset whether the user should be prompted for their name and how the scores should be sorted
Returns
The highscore position if the score was good enough to make it into the list (1 being topscore) or 0 otherwise.

Definition at line 479 of file kscoredialog.cpp.

◆ addScore() [2/2]

int KScoreDialog::addScore ( int  newScore,
const AddScoreFlags flags = {} 
)

Convenience function for ease of use.

Parameters
newScorethe score of the player.
flagsset whether the user should be prompted for their name and how the scores should be sorted
Returns
The highscore position if the score was good enough to make it into the list (1 being topscore) or 0 otherwise.

Definition at line 552 of file kscoredialog.cpp.

◆ exec()

int KScoreDialog::exec ( )
overridevirtual

Display the dialog as modal.

Reimplemented from QDialog.

Definition at line 565 of file kscoredialog.cpp.

◆ hideField()

void KScoreDialog::hideField ( int  field)

Hide a field so that it is not shown on the table (but is still stored in the configuration file).

Parameters
fieldid of this field Fields e.g. KScoreDialog::Score

Definition at line 219 of file kscoredialog.cpp.

◆ highScore()

int KScoreDialog::highScore ( )
Returns
the current best score in the group

Definition at line 626 of file kscoredialog.cpp.

◆ initFromDifficulty()

void KScoreDialog::initFromDifficulty ( const KgDifficulty difficulty,
bool  setConfigGroup = true 
)

Assume that config groups (incl.

current selection) are equal to difficulty levels, and initialize them. This is usually equal to the following code using KGameDifficulty:

Definition at line 173 of file kscoredialog.cpp.

◆ setComment()

void KScoreDialog::setComment ( const QString comment)
Parameters
commentto add when showing high-scores. The comment is only used once.

Definition at line 207 of file kscoredialog.cpp.

◆ setConfigGroup() [1/2]

void KScoreDialog::setConfigGroup ( const QPair< QByteArray, QString > &  group)

The group name must be passed though i18n() in order for the group name to be translated.

i.e.

ksdialog.setConfigGroup(qMakePair(QByteArray("Easy"), i18n("Easy")));

If you set a group, it will be prefixed in the config file by 'KHighscore_' otherwise the group will simply be 'KHighscore'.

Parameters
groupto use for reading/writing highscores from/to.

Definition at line 150 of file kscoredialog.cpp.

◆ setConfigGroup() [2/2]

void KScoreDialog::setConfigGroup ( const QString group = QString())

The group name must be passed though I18N_NOOP() in order for the group name to be translated.

i.e.

ksdialog.setConfigGroup(I18N_NOOP("Easy"));

If you set a group, it will be prefixed in the config file by 'KHighscore_' otherwise the group will simply be 'KHighscore'.

Parameters
groupto use for reading/writing highscores from/to.
Deprecated:
Since 4.1, use setConfigGroup(const QPair<QByteArray, QString>&).

Definition at line 143 of file kscoredialog.cpp.

◆ setConfigGroupWeights()

void KScoreDialog::setConfigGroupWeights ( const QMap< int, QByteArray > &  weights)

It is a good idea giving config group weights, otherwise tabs get ordered by their tab name that is not probably what you want.

This function can be used directly with KGameDifficulty::levelWeights().

Parameters
weightsthe list of untranslated group weights
Since
KDE 4.2

Definition at line 195 of file kscoredialog.cpp.

◆ setHiddenConfigGroups()

void KScoreDialog::setHiddenConfigGroups ( const QList< QByteArray > &  hiddenGroups)

Hide some config groups so that they are not shown on the dialog (but are still stored in the configuration file).

ksdialog.setHiddenConfigGroups(QList<QByteArray>() << "Very Easy" << "Easy");
Parameters
hiddenGroupsthe list of group names you want to hide
Since
KDE 4.6

Definition at line 190 of file kscoredialog.cpp.

◆ show()

void KScoreDialog::show ( )
virtual

Display the dialog as non-modal.

Definition at line 559 of file kscoredialog.cpp.


The documentation for this class was generated from the following files:
static QPair< QByteArray, QString > localizedLevelString()
static QMap< int, QByteArray > levelWeights()
QString i18n(const char *text, const TYPE &arg...)
void setConfigGroup(const QString &group=QString())
The group name must be passed though I18N_NOOP() in order for the group name to be translated.
void addLocalizedConfigGroupNames(const QMap< QByteArray, QString > &groups)
You must add the translations of all group names to the dialog.
void setConfigGroupWeights(const QMap< int, QByteArray > &weights)
It is a good idea giving config group weights, otherwise tabs get ordered by their tab name that is n...
#define I18N_NOOP(text)
@ Custom1
Field for custom information.
Definition: kscoredialog.h:92
static QMap< QByteArray, QString > localizedLevelStrings()
A simple high score implementation.
Definition: kscoredialog.h:79
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Sun Dec 4 2022 03:50:22 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.