## GvaGameStore

GvaGameStore — A GtkTreeModel that stores game information

## Synopsis

                        GvaGameStore;
    enum                GvaGameStoreColumn;
    GtkTreeModel *      gva_game_store_new                  (void);
    GtkTreeModel *      gva_game_store_new_from_query       (const gchar *sql,
                                                             GError **error);
    void                gva_game_store_clear                (GvaGameStore *game_store);
    void                gva_game_store_index_insert         (GvaGameStore *game_store,
                                                             const gchar *key,
                                                             GtkTreeIter *iter);
    GtkTreePath *       gva_game_store_index_lookup         (GvaGameStore *game_store,
                                                             const gchar *key);

## Object Hierarchy

      GObject
       +----GtkTreeStore
             +----GvaGameStore

## Implemented Interfaces

GvaGameStore implements GtkTreeModel, GtkTreeDragSource, GtkTreeDragDest, GtkTreeSortable and GtkBuildable.

## Description

A GvaGameStore stores information from the game database as a GtkTreeModel.

## Details

### GvaGameStore

    typedef struct _GvaGameStore GvaGameStore;

Contains only private data that should be read and manipulated using the functions below.

### enum GvaGameStoreColumn

    typedef enum
    {
            GVA_GAME_STORE_COLUMN_NAME,               /* G_TYPE_STRING */
            GVA_GAME_STORE_COLUMN_BIOS,               /* G_TYPE_STRING */
            GVA_GAME_STORE_COLUMN_CATEGORY,           /* G_TYPE_STRING */
            GVA_GAME_STORE_COLUMN_FAVORITE,           /* G_TYPE_BOOLEAN */
            GVA_GAME_STORE_COLUMN_SOURCEFILE,         /* G_TYPE_STRING */
            GVA_GAME_STORE_COLUMN_ISBIOS,             /* G_TYPE_BOOLEAN */
            GVA_GAME_STORE_COLUMN_RUNNABLE,           /* G_TYPE_BOOLEAN */
            GVA_GAME_STORE_COLUMN_CLONEOF,            /* G_TYPE_STRING */
            GVA_GAME_STORE_COLUMN_ROMOF,              /* G_TYPE_STRING */
            GVA_GAME_STORE_COLUMN_ROMSET,             /* G_TYPE_STRING */
            GVA_GAME_STORE_COLUMN_SAMPLEOF,           /* G_TYPE_STRING */
            GVA_GAME_STORE_COLUMN_SAMPLESET,          /* G_TYPE_STRING */
            GVA_GAME_STORE_COLUMN_DESCRIPTION,        /* G_TYPE_STRING */
            GVA_GAME_STORE_COLUMN_YEAR,               /* G_TYPE_STRING */
            GVA_GAME_STORE_COLUMN_MANUFACTURER,       /* G_TYPE_STRING */
            GVA_GAME_STORE_COLUMN_SOUND_CHANNELS,     /* G_TYPE_INT */
            GVA_GAME_STORE_COLUMN_INPUT_SERVICE,      /* G_TYPE_BOOLEAN */
            GVA_GAME_STORE_COLUMN_INPUT_TILT,         /* G_TYPE_BOOLEAN */
            GVA_GAME_STORE_COLUMN_INPUT_PLAYERS,      /* G_TYPE_INT */
            GVA_GAME_STORE_COLUMN_INPUT_PLAYERS_ALT,  /* G_TYPE_INT */
            GVA_GAME_STORE_COLUMN_INPUT_PLAYERS_SIM,  /* G_TYPE_INT */
            GVA_GAME_STORE_COLUMN_INPUT_BUTTONS,      /* G_TYPE_INT */
            GVA_GAME_STORE_COLUMN_INPUT_COINS,        /* G_TYPE_INT */
            GVA_GAME_STORE_COLUMN_DRIVER_STATUS,      /* G_TYPE_STRING */
            GVA_GAME_STORE_COLUMN_DRIVER_EMULATION,   /* G_TYPE_STRING */
            GVA_GAME_STORE_COLUMN_DRIVER_COLOR,       /* G_TYPE_STRING */
            GVA_GAME_STORE_COLUMN_DRIVER_SOUND,       /* G_TYPE_STRING */
            GVA_GAME_STORE_COLUMN_DRIVER_GRAPHIC,     /* G_TYPE_STRING */
            GVA_GAME_STORE_COLUMN_DRIVER_COCKTAIL,    /* G_TYPE_STRING */
            GVA_GAME_STORE_COLUMN_DRIVER_PROTECTION,  /* G_TYPE_STRING */
            GVA_GAME_STORE_COLUMN_DRIVER_SAVESTATE,   /* G_TYPE_STRING */
            GVA_GAME_STORE_COLUMN_DRIVER_PALETTESIZE, /* G_TYPE_INT */
            GVA_GAME_STORE_COLUMN_LAST_PLAYED,        /* GVA_TYPE_TIME */
            GVA_GAME_STORE_COLUMN_COMMENT,            /* G_TYPE_STRING */
            GVA_GAME_STORE_COLUMN_INODE,              /* G_TYPE_INT64 */
            GVA_GAME_STORE_COLUMN_INPFILE,            /* G_TYPE_STRING */
            GVA_GAME_STORE_COLUMN_TIME,               /* GVA_TYPE_TIME */
            GVA_GAME_STORE_NUM_COLUMNS
    } GvaGameStoreColumn;

Most of these values correspond to fields in the games database.

`GVA_GAME_STORE_COLUMN_NAME` | Corresponds to the "available.name" database field.
`GVA_GAME_STORE_COLUMN_BIOS` | Corresponds to the "available.bios" database field.
`GVA_GAME_STORE_COLUMN_CATEGORY` | Corresponds to the "available.category" database field.
`GVA_GAME_STORE_COLUMN_FAVORITE` | Corresponds to the "available.favorite" database field.
`GVA_GAME_STORE_COLUMN_SOURCEFILE` | Corresponds to the "available.sourcefile" database field.
`GVA_GAME_STORE_COLUMN_ISBIOS` | Corresponds to the "available.isbios" database field.
`GVA_GAME_STORE_COLUMN_RUNNABLE` | Corresponds to the "available.runnable" database field.
`GVA_GAME_STORE_COLUMN_CLONEOF` | Corresponds to the "available.cloneof" database field.
`GVA_GAME_STORE_COLUMN_ROMOF` | Corresponds to the "available.romof" database field.
`GVA_GAME_STORE_COLUMN_ROMSET` | Corresponds to the "available.romset" database field.
`GVA_GAME_STORE_COLUMN_SAMPLEOF` | Corresponds to the "available.sampleof" database field.
`GVA_GAME_STORE_COLUMN_SAMPLESET` | Corresponds to the "available.sampleset" database field.
`GVA_GAME_STORE_COLUMN_DESCRIPTION` | Corresponds to the "available.description" database field.
`GVA_GAME_STORE_COLUMN_YEAR` | Corresponds to the "available.year" database field.
`GVA_GAME_STORE_COLUMN_MANUFACTURER` | Corresponds to the "available.manufacturer" database field.
`GVA_GAME_STORE_COLUMN_SOUND_CHANNELS` | Corresponds to the "available.sound_channels" database field.
`GVA_GAME_STORE_COLUMN_INPUT_SERVICE` | Corresponds to the "available.input_service" database field.
`GVA_GAME_STORE_COLUMN_INPUT_TILT` | Corresponds to the "available.input_tile" database field.
`GVA_GAME_STORE_COLUMN_INPUT_PLAYERS` | Corresponds to the "available.input_players" database field.
`GVA_GAME_STORE_COLUMN_INPUT_PLAYERS_ALT` | Corresponds to the "available.input_players_alt" database field.
`GVA_GAME_STORE_COLUMN_INPUT_PLAYERS_SIM` | Corresponds to the "available.input_players_sim" database field.
`GVA_GAME_STORE_COLUMN_INPUT_BUTTONS` | Corresponds to the "available.input_buttons" database field.
`GVA_GAME_STORE_COLUMN_INPUT_COINS` | Corresponds to the "available.input_coins" database field.
`GVA_GAME_STORE_COLUMN_DRIVER_STATUS` | Corresponds to the "available.driver_status" database field.
`GVA_GAME_STORE_COLUMN_DRIVER_EMULATION` | Corresponds to the "available.driver_emulation" database field.
`GVA_GAME_STORE_COLUMN_DRIVER_COLOR` | Corresponds to the "available.driver_color" database field.
`GVA_GAME_STORE_COLUMN_DRIVER_SOUND` | Corresponds to the "available.driver_sound" database field.
`GVA_GAME_STORE_COLUMN_DRIVER_GRAPHIC` | Corresponds to the "available.driver_graphic" database field.
`GVA_GAME_STORE_COLUMN_DRIVER_COCKTAIL` | Corresponds to the "available.driver_cocktail" database field.
`GVA_GAME_STORE_COLUMN_DRIVER_PROTECTION` | Corresponds to the "available.driver_protection" database field.
`GVA_GAME_STORE_COLUMN_DRIVER_SAVESTATE` | Corresponds to the "available.driver_savestate" database field.
`GVA_GAME_STORE_COLUMN_DRIVER_PALETTESIZE` | Corresponds to the "available.driver_palettesize" database field.
`GVA_GAME_STORE_COLUMN_LAST_PLAYED` | Corresponds to the "lastplayed.timestamp" database field.
`GVA_GAME_STORE_COLUMN_COMMENT` | Corresponds to the "playback.comment" database field.
`GVA_GAME_STORE_COLUMN_INODE` | Corresponds to the "playback.inode" database field.
`GVA_GAME_STORE_COLUMN_INPFILE` | Filename of a recorded game (not in the games database).
`GVA_GAME_STORE_COLUMN_TIME` | Timestamp of a recorded game (not in the games database).
`GVA_GAME_STORE_NUM_COLUMNS` | Total number of game store columns.

### gva_game_store_new ()

    GtkTreeModel *      gva_game_store_new                  (void);

Creates a new GvaGameStore with pre-defined columns and settings.

Returns : | a new GvaGameStore

### gva_game_store_new_from_query ()

    GtkTreeModel *      gva_game_store_new_from_query       (const gchar *sql,
                                                             GError **error);

This may be the most powerful function in GNOME Video Arcade.

Creates a new GvaGameStore by executing the given SQL query on the games database and converting the results to tree model rows. The resulting GtkTreeModel can then be plugged into a GtkTreeView.

XXX Say more here.

`sql` : | an SQL query
`error` : | return location for a GError, or `NULL`
Returns : | a new GvaGameStore

### gva_game_store_clear ()

    void                gva_game_store_clear                (GvaGameStore *game_store);

Removes all rows from `game_store` and clears the internal index.

`game_store` : | a GvaGameStore

### gva_game_store_index_insert ()

    void                gva_game_store_index_insert         (GvaGameStore *game_store,
                                                             const gchar *key,
                                                             GtkTreeIter *iter);

Adds an entry to `game_store`'s internal index. You will want to call this immediately after adding a new row to `game_store`, such as with `gtk_tree_store_append()`.

`game_store` : | a GvaGameStore
`key` : | an index key
`iter` : | a GtkTreeIter pointing to a row in `game_store`

### gva_game_store_index_lookup ()

    GtkTreePath *       gva_game_store_index_lookup         (GvaGameStore *game_store,
                                                             const gchar *key);

Looks up the row corresponding to `key` in `game_store` and returns a GtkTreePath to it, or `NULL` if the row was not found.

`game_store` : | a GvaGameStore
`key` : | an index key
Returns : | a GtkTreePath to the row corresponding to `key`, or `NULL`