git.maemo.org Git - lordsawar/blob - src/heromap.h

   1 //  Copyright (C) 2007, 2008, 2009 Ben Asselstine
   2 //
   3 //  This program is free software; you can redistribute it and/or modify
   4 //  it under the terms of the GNU General Public License as published by
   5 //  the Free Software Foundation; either version 3 of the License, or
   6 //  (at your option) any later version.
   7 //
   8 //  This program is distributed in the hope that it will be useful,
   9 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 //  GNU Library General Public License for more details.
  12 //
  13 //  You should have received a copy of the GNU General Public License
  14 //  along with this program; if not, write to the Free Software
  15 //  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  16 //  02110-1301, USA.
  17
  18 #ifndef HEROMAP_H
  19 #define HEROMAP_H
  20
  21 #include <sigc++/signal.h>
  22
  23 #include "overviewmap.h"
  24 #include "input-events.h"
  25
  26 class City;
  27
  28 //! Draw a miniature map graphic with an indication of where a Hero is.
  29 /**
  30   * This is a map where you can highlight a city with a hero icon.  This
  31   * draws the shields for City objects and the icon for the Hero.
  32   *
  33   * @note This is used to show a map when a Hero initially emerges from a City.
  34   */
  35 class HeroMap : public OverviewMap
  36 {
  37  public:
  38      //! Default constructor.  Make a new HeroMap.
  39      /**
  40       * @param city  The city where the Hero has emerged.
  41       */
  42      HeroMap(City *city);
  43
  44     //! Emitted when the Hero icon is finished being drawn on the map surface.
  45     /**
  46      * Classes that use HeroMap must catch this signal to display the map.
  47      */
  48     sigc::signal<void, Glib::RefPtr<Gdk::Pixmap> > map_changed;
  49
  50  private:
  51     //! The City of where to draw the Hero icon.
  52     City *city;
  53
  54     //! Draw the Hero icon onto the miniature map graphic.
  55     /**
  56      * This draws the shields for each city as well as the icon to indicate
  57      * that a Hero is there.
  58      *
  59      * This method is automatically called by the HeroMap::draw method.
  60      */
  61     virtual void after_draw();
  62 };
  63
  64 #endif