client/messagewin_common.h

   1 /***********************************************************************
   2  Freeciv - Copyright (C) 1996 - A Kjeldberg, L Gregersen, P Unold
   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 2, or (at your option)
   6    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 General Public License for more details.
  12 ***********************************************************************/
  13
  14 #ifndef FC__MESSAGEWIN_COMMON_H
  15 #define FC__MESSAGEWIN_COMMON_H
  16
  17 #ifdef __cplusplus
  18 extern "C" {
  19 #endif /* __cplusplus */
  20
  21 /* utility */
  22 #include "support.h"            /* bool type */
  23
  24 /* common */
  25 #include "events.h"             /* enum event_type */
  26 #include "fc_types.h"           /* struct tile */
  27 #include "featured_text.h"      /* struct text_tag_list */
  28
  29 struct message {
  30   char *descr;
  31   struct text_tag_list *tags;
  32   struct tile *tile;
  33   enum event_type event;
  34   bool location_ok;
  35   bool city_ok;
  36   bool visited;
  37   int turn;
  38   int phase;
  39 };
  40
  41 #define MESWIN_CLEAR_ALL (-1)
  42
  43 void meswin_clear_older(int turn, int phase);
  44 void meswin_add(const char *message, const struct text_tag_list *tags,
  45                 struct tile *ptile, enum event_type event,
  46                 int turn, int phase);
  47
  48 const struct message *meswin_get_message(int message_index);
  49 int meswin_get_num_messages(void);
  50 void meswin_set_visited_state(int message_index, bool state);
  51 void meswin_popup_city(int message_index);
  52 void meswin_goto(int message_index);
  53 void meswin_double_click(int message_index);
  54
  55 #ifdef __cplusplus
  56 }
  57 #endif /* __cplusplus */
  58
  59 #endif /* FC__MESSAGEWIN_COMMON_H */