# GnomeScores

## Name

GnomeScores --

## Synopsis

    #include <libgnomeui/libgnomeui.h>

    struct      GnomeScores;
    GtkWidget*  gnome_scores_display_with_pixmap
                                                (const gchar *pixmap_logo,
                                                 const gchar *app_name,
                                                 const gchar *level,
                                                 int pos);
    GtkWidget*  gnome_scores_new                (guint n_scores,
                                                 gchar **names,
                                                 gfloat *scores,
                                                 time_t *times,
                                                 gboolean clear);
    void        gnome_scores_construct          (GnomeScores *gs,
                                                 guint n_scores,
                                                 gchar **names,
                                                 gfloat *scores,
                                                 time_t *times,
                                                 gboolean clear);
    void        gnome_scores_set_logo_label     (GnomeScores *gs,
                                                 const gchar *txt,
                                                 const gchar *font,
                                                 GdkColor *col);
    void        gnome_scores_set_logo_pixmap    (GnomeScores *gs,
                                                 const gchar *pix_name);
    void        gnome_scores_set_logo_widget    (GnomeScores *gs,
                                                 GtkWidget *w);
    void        gnome_scores_set_color          (GnomeScores *gs,
                                                 guint n,
                                                 GdkColor *col);
    void        gnome_scores_set_def_color      (GnomeScores *gs,
                                                 GdkColor *col);
    void        gnome_scores_set_colors         (GnomeScores *gs,
                                                 GdkColor *col);
    void        gnome_scores_set_logo_label_title
                                                (GnomeScores *gs,
                                                 const gchar *txt);
    void        gnome_scores_set_current_player (GnomeScores *gs,
                                                 gint i);

## Object Hierarchy

      GObject
       +----GtkObject
             +----GtkWidget
                   +----GtkContainer
                         +----GtkBin
                               +----GtkWindow
                                     +----GtkDialog
                                           +----GnomeScores

## Implemented Interfaces

GnomeScores implements AtkImplementorIface.

## Description

## Details

### struct GnomeScores

    struct GnomeScores;

### gnome_scores_display_with_pixmap ()

    GtkWidget*  gnome_scores_display_with_pixmap
                                                (const gchar *pixmap_logo,
                                                 const gchar *app_name,
                                                 const gchar *level,
                                                 int pos);

Does all the work of displaying the best scores. It calls gnome_score_get_notables to retrieve the info, creates the window, and show it.

`pixmap_logo` : | Filename of a logo pixmap to display
`app_name` : | Name of the application, as in gnome_score_init.
`level` : | Level of the game or `NULL`.
`pos` : | Position in the top ten of the current player, as returned by gnome_score_log.
Returns : | If a dialog is displayed return it's pointer. It can also be `NULL` if no dialog is displayed

### gnome_scores_new ()

    GtkWidget*  gnome_scores_new                (guint n_scores,
                                                 gchar **names,
                                                 gfloat *scores,
                                                 time_t *times,
                                                 gboolean clear);

Creates the high-scores window.

`n_scores` : | Number of positions.
`names` : | Names of the players.
`scores` : | Scores
`times` : | Time in which the scores were done
`clear` : | Add a "Clear" Button?
Returns : | A new GnomeScores widget

### gnome_scores_construct ()

    void        gnome_scores_construct          (GnomeScores *gs,
                                                 guint n_scores,
                                                 gchar **names,
                                                 gfloat *scores,
                                                 time_t *times,
                                                 gboolean clear);

useful for language bindings and subclassing, not to be used by itself, see gnome_scores_new.

`gs` : |
`n_scores` : | Number of positions.
`names` : | Names of the players.
`scores` : | Scores
`times` : | Time in which the scores were done
`clear` : | Add a "Clear" Button?

### gnome_scores_set_logo_label ()

    void        gnome_scores_set_logo_label     (GnomeScores *gs,
                                                 const gchar *txt,
                                                 const gchar *font,
                                                 GdkColor *col);

Creates a label to be the logo

`gs` : | A GnomeScores widget
`txt` : | Text in the label.
`font` : | Font to use in the label.
`col` : | Color to use in the label.

### gnome_scores_set_logo_pixmap ()

    void        gnome_scores_set_logo_pixmap    (GnomeScores *gs,
                                                 const gchar *pix_name);

Sets the logo on the scores dialog box to a pixmap

`gs` : | A GnomeScores widget
`pix_name` : | filename of a pixmap

### gnome_scores_set_logo_widget ()

    void        gnome_scores_set_logo_widget    (GnomeScores *gs,
                                                 GtkWidget *w);

Set an arbitrary widget to be the logo.

`gs` : | A GnomeScores widget
`w` : | Widget to be used as logo.

### gnome_scores_set_color ()

    void        gnome_scores_set_color          (GnomeScores *gs,
                                                 guint n,
                                                 GdkColor *col);

Set the color of one entry.

`gs` : | A GnomeScores widget
`n` : | Entry to be changed.
`col` : | Color.

### gnome_scores_set_def_color ()

    void        gnome_scores_set_def_color      (GnomeScores *gs,
                                                 GdkColor *col);

Set the default color of the entries.

`gs` : | A GnomeScores widget
`col` : | Color

### gnome_scores_set_colors ()

    void        gnome_scores_set_colors         (GnomeScores *gs,
                                                 GdkColor *col);

Set the color of all the entries.

`gs` : | A GnomeScores widget
`col` : | Array of colors.

### gnome_scores_set_logo_label_title ()

    void        gnome_scores_set_logo_label_title
                                                (GnomeScores *gs,
                                                 const gchar *txt);

Creates a label to be the logo

`gs` : | A GnomeScores widget
`txt` : | Name of the logo.

### gnome_scores_set_current_player ()

    void        gnome_scores_set_current_player (GnomeScores *gs,
                                                 gint i);

Set the index of the current player in top ten.

`gs` : | A GnomeScores widget
`i` : | Index of the current(from 0 to 9).