QTfrontend/model/MapModel.h
author nemo
Fri, 31 May 2013 14:52:30 -0400
branch0.9.19
changeset 9095 17ee5231f31f
parent 9080 9b42757d7e71
child 9744 1ee4842a9c86
permissions -rw-r--r--
oups
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
6938
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
     1
/*
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
     2
 * Hedgewars, a free turn based strategy game
9080
9b42757d7e71 bump copyright year for Andrey entries
unc0rr
parents: 8419
diff changeset
     3
 * Copyright (c) 2004-2013 Andrey Korotaev <unC0Rr@gmail.com>
6938
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
     4
 *
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
     5
 * This program is free software; you can redistribute it and/or modify
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
     6
 * it under the terms of the GNU General Public License as published by
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
     7
 * the Free Software Foundation; version 2 of the License
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
     8
 *
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
     9
 * This program is distributed in the hope that it will be useful,
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    12
 * GNU General Public License for more details.
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    13
 *
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    14
 * You should have received a copy of the GNU General Public License
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    15
 * along with this program; if not, write to the Free Software
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    16
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    17
 */
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    18
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    19
/**
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    20
 * @file
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    21
 * @brief MapModel class definition
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    22
 */
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    23
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    24
#ifndef HEDGEWARS_MAPMODEL_H
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    25
#define HEDGEWARS_MAPMODEL_H
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    26
6939
970389573788 MapModel converted to QStandardItemList; separators fixed; changed used data format (human-readable struct instead of magic list) for map info in HwMapContainer (+ various small cleanups in that class)
sheepluva
parents: 6938
diff changeset
    27
#include <QStandardItemModel>
6938
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    28
#include <QStringList>
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    29
#include <QTextStream>
6983
ede55af89e78 roomslistmodel: prettier names for map +rnd+ etc.; point out unavailable maps
sheepluva
parents: 6952
diff changeset
    30
#include <QHash>
6938
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    31
#include <QMap>
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    32
#include <QIcon>
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    33
#include <QComboBox>
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    34
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    35
#include "DataManager.h"
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    36
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    37
/**
6947
1be3e48e1d53 MapModel: add getters for random maps based on type, so that the mapContainer does not have to magically know how maps and separators are ordered within the model
sheepluva
parents: 6943
diff changeset
    38
 * @brief A model that vertically lists available maps
6938
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    39
 *
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    40
 * @author sheepluva
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    41
 * @since 0.9.18
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    42
 */
6939
970389573788 MapModel converted to QStandardItemList; separators fixed; changed used data format (human-readable struct instead of magic list) for map info in HwMapContainer (+ various small cleanups in that class)
sheepluva
parents: 6938
diff changeset
    43
class MapModel : public QStandardItemModel
6938
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    44
{
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    45
        Q_OBJECT
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    46
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    47
    public:
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    48
        enum MapType {
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    49
            Invalid,
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    50
            GeneratedMap,
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    51
            GeneratedMaze,
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    52
            HandDrawnMap,
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    53
            MissionMap,
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    54
            StaticMap
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    55
        };
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    56
6943
1fe601a2761b MapModel: comments/docs, small tweaks
sheepluva
parents: 6939
diff changeset
    57
        /// a struct for holding the attributes of a map.
6938
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    58
        struct MapInfo
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    59
        {
6943
1fe601a2761b MapModel: comments/docs, small tweaks
sheepluva
parents: 6939
diff changeset
    60
            MapType type; ///< The map-type
1fe601a2761b MapModel: comments/docs, small tweaks
sheepluva
parents: 6939
diff changeset
    61
            QString name; ///< The internal name.
1fe601a2761b MapModel: comments/docs, small tweaks
sheepluva
parents: 6939
diff changeset
    62
            QString theme; ///< The theme to be used. (can be empty)
1fe601a2761b MapModel: comments/docs, small tweaks
sheepluva
parents: 6939
diff changeset
    63
            quint32 limit; ///< The maximum allowed number of hedgehogs.
1fe601a2761b MapModel: comments/docs, small tweaks
sheepluva
parents: 6939
diff changeset
    64
            QString scheme; ///< Default scheme name or "locked", for mission-maps.
1fe601a2761b MapModel: comments/docs, small tweaks
sheepluva
parents: 6939
diff changeset
    65
            QString weapons; ///< Default weaponset name or "locked", for missions-maps.
8377
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    66
            QString desc; ///< The brief 1-2 sentence description of the mission, for mission-maps.
8419
d99f46b676b5 Prepends an asterisk on maps, styles, and themes that are DLC. (Resolves issue 515)
dag10
parents: 8377
diff changeset
    67
            bool dlc; ///< True if this map was not packaged with the game
6938
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    68
        };
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
    69
6943
1fe601a2761b MapModel: comments/docs, small tweaks
sheepluva
parents: 6939
diff changeset
    70
        /**
8377
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    71
         * @brief Searches maps in model to find out if one exists
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    72
         * @param map map of which to check existence
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    73
         * @return true if it exists
6943
1fe601a2761b MapModel: comments/docs, small tweaks
sheepluva
parents: 6939
diff changeset
    74
         */
8377
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    75
        bool mapExists(const QString & map) const;
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    76
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    77
        /**
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    78
         * @brief Finds a map index (column, row) for a map name
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    79
         * @param map map of which to find index+column
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    80
         * @return QPair<int, int> with column, index, or (-1, -1) if map not found
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    81
         */
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    82
        //QPair<int, int> findMap(const QString & map) const;
6947
1be3e48e1d53 MapModel: add getters for random maps based on type, so that the mapContainer does not have to magically know how maps and separators are ordered within the model
sheepluva
parents: 6943
diff changeset
    83
1be3e48e1d53 MapModel: add getters for random maps based on type, so that the mapContainer does not have to magically know how maps and separators are ordered within the model
sheepluva
parents: 6943
diff changeset
    84
        /**
8377
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    85
         * @brief Finds a map index for a map name
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    86
         * @param map map of which to find index
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    87
         * @return int of index, or -1 if map not found
6947
1be3e48e1d53 MapModel: add getters for random maps based on type, so that the mapContainer does not have to magically know how maps and separators are ordered within the model
sheepluva
parents: 6943
diff changeset
    88
         */
8377
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    89
        int findMap(const QString & map) const;
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    90
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    91
        /**
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    92
         * @brief Finds and returns a map item for a map name
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    93
         * @param map map
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    94
         * @return QStandardItem of map, or NULL if map not found
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    95
         */
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    96
        QStandardItem * getMap(const QString & map);
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    97
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    98
        // Static MapInfos for drawn and generated maps
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
    99
        static MapInfo MapInfoRandom, MapInfoMaze, MapInfoDrawn;
6938
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
   100
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
   101
    public slots:
6948
7271ce89950f various comment tweaks/fixes
sheepluva
parents: 6947
diff changeset
   102
        /// Reloads the maps using the DataManager.
8377
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
   103
        /// Accepts two map types: StaticMap or MissionMap.
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
   104
        void loadMaps(MapType maptype);
6938
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
   105
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
   106
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
   107
    private:
8377
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
   108
        /// map index lookup table. QPair<int, int> contains: <column, index>
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
   109
        //QHash<QString, QPair<int, int> > m_mapIndexes;
6983
ede55af89e78 roomslistmodel: prettier names for map +rnd+ etc.; point out unavailable maps
sheepluva
parents: 6952
diff changeset
   110
        QHash<QString, int> m_mapIndexes;
6939
970389573788 MapModel converted to QStandardItemList; separators fixed; changed used data format (human-readable struct instead of magic list) for map info in HwMapContainer (+ various small cleanups in that class)
sheepluva
parents: 6938
diff changeset
   111
6943
1fe601a2761b MapModel: comments/docs, small tweaks
sheepluva
parents: 6939
diff changeset
   112
        /**
1fe601a2761b MapModel: comments/docs, small tweaks
sheepluva
parents: 6939
diff changeset
   113
         * @brief Creates a QStandardItem, that holds the map info and item appearance.
1fe601a2761b MapModel: comments/docs, small tweaks
sheepluva
parents: 6939
diff changeset
   114
         * The used role for the data is Qt::UserRole + 1.
1fe601a2761b MapModel: comments/docs, small tweaks
sheepluva
parents: 6939
diff changeset
   115
         * @param icon the icon to be displayed (can be an empty QIcon()).
1fe601a2761b MapModel: comments/docs, small tweaks
sheepluva
parents: 6939
diff changeset
   116
         * @param caption the text to be displayed.
1fe601a2761b MapModel: comments/docs, small tweaks
sheepluva
parents: 6939
diff changeset
   117
         * @param type the type of the map.
1fe601a2761b MapModel: comments/docs, small tweaks
sheepluva
parents: 6939
diff changeset
   118
         * @param name the internal name of the map.
1fe601a2761b MapModel: comments/docs, small tweaks
sheepluva
parents: 6939
diff changeset
   119
         * @param theme the theme of the map (or empty if none).
1fe601a2761b MapModel: comments/docs, small tweaks
sheepluva
parents: 6939
diff changeset
   120
         * @param limit the hedgehog limit of the map.
1fe601a2761b MapModel: comments/docs, small tweaks
sheepluva
parents: 6939
diff changeset
   121
         * @param scheme mission map: default scheme name or "locked".
1fe601a2761b MapModel: comments/docs, small tweaks
sheepluva
parents: 6939
diff changeset
   122
         * @param weapons mission map: default weaponset name or "locked".
8377
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
   123
         * @param desc mission map: description of mission.
6943
1fe601a2761b MapModel: comments/docs, small tweaks
sheepluva
parents: 6939
diff changeset
   124
         * @return pointer to item representing the map info: at Qt::UserRole + 1.
1fe601a2761b MapModel: comments/docs, small tweaks
sheepluva
parents: 6939
diff changeset
   125
         */
8377
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
   126
        static QStandardItem * infoToItem(
6939
970389573788 MapModel converted to QStandardItemList; separators fixed; changed used data format (human-readable struct instead of magic list) for map info in HwMapContainer (+ various small cleanups in that class)
sheepluva
parents: 6938
diff changeset
   127
            const QIcon & icon,
970389573788 MapModel converted to QStandardItemList; separators fixed; changed used data format (human-readable struct instead of magic list) for map info in HwMapContainer (+ various small cleanups in that class)
sheepluva
parents: 6938
diff changeset
   128
            const QString caption,
970389573788 MapModel converted to QStandardItemList; separators fixed; changed used data format (human-readable struct instead of magic list) for map info in HwMapContainer (+ various small cleanups in that class)
sheepluva
parents: 6938
diff changeset
   129
            MapType type = Invalid,
970389573788 MapModel converted to QStandardItemList; separators fixed; changed used data format (human-readable struct instead of magic list) for map info in HwMapContainer (+ various small cleanups in that class)
sheepluva
parents: 6938
diff changeset
   130
            QString name = "",
970389573788 MapModel converted to QStandardItemList; separators fixed; changed used data format (human-readable struct instead of magic list) for map info in HwMapContainer (+ various small cleanups in that class)
sheepluva
parents: 6938
diff changeset
   131
            QString theme = "",
970389573788 MapModel converted to QStandardItemList; separators fixed; changed used data format (human-readable struct instead of magic list) for map info in HwMapContainer (+ various small cleanups in that class)
sheepluva
parents: 6938
diff changeset
   132
            quint32 limit = 0,
970389573788 MapModel converted to QStandardItemList; separators fixed; changed used data format (human-readable struct instead of magic list) for map info in HwMapContainer (+ various small cleanups in that class)
sheepluva
parents: 6938
diff changeset
   133
            QString scheme = "",
8377
869f80966a77 GCI2012: Improve Game Configuration Widget
dag10
parents: 6983
diff changeset
   134
            QString weapons = "",
8419
d99f46b676b5 Prepends an asterisk on maps, styles, and themes that are DLC. (Resolves issue 515)
dag10
parents: 8377
diff changeset
   135
            QString desc = "",
d99f46b676b5 Prepends an asterisk on maps, styles, and themes that are DLC. (Resolves issue 515)
dag10
parents: 8377
diff changeset
   136
            bool dlc = false);
6938
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
   137
};
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
   138
6939
970389573788 MapModel converted to QStandardItemList; separators fixed; changed used data format (human-readable struct instead of magic list) for map info in HwMapContainer (+ various small cleanups in that class)
sheepluva
parents: 6938
diff changeset
   139
Q_DECLARE_METATYPE(MapModel::MapInfo)
970389573788 MapModel converted to QStandardItemList; separators fixed; changed used data format (human-readable struct instead of magic list) for map info in HwMapContainer (+ various small cleanups in that class)
sheepluva
parents: 6938
diff changeset
   140
6938
217ed62e872c MapModel, various cleanups. TODO/FIXME: QComboBox separator not working with custom models
sheepluva
parents:
diff changeset
   141
#endif // HEDGEWARS_MAPMODEL_H