titlescreen.hpp

Go to the documentation of this file.
00001 /* $Id: titlescreen.hpp 26801 2008-05-23 19:05:31Z mordante $ */
00002 /*
00003    Copyright (C) 2003 - 2008 by David White <dave@whitevine.net>
00004    Part of the Battle for Wesnoth Project http://www.wesnoth.org/
00005 
00006    This program is free software; you can redistribute it and/or modify
00007    it under the terms of the GNU General Public License version 2
00008    or at your option any later version.
00009    This program is distributed in the hope that it will be useful,
00010    but WITHOUT ANY WARRANTY.
00011 
00012    See the COPYING file for more details.
00013 */
00014 
00015 #ifndef TITLE_HPP_INCLUDED
00016 #define TITLE_HPP_INCLUDED
00017 
00018 class config;
00019 class game_display;
00020 
00021 namespace gui {
00022 
00023 /** Values for the menu-items of the main menu. */
00024 enum TITLE_RESULT { TUTORIAL = 0,       /**< Start special campaign 'tutorial' */
00025                     NEW_CAMPAIGN,       /**< Let user select a campaign to play */
00026                     MULTIPLAYER,        /**< Play single scenario against humans or AI */
00027                     LOAD_GAME, GET_ADDONS, 
00028 #ifdef MAP_EDITOR
00029                     START_MAP_EDITOR,
00030 #endif
00031                     CHANGE_LANGUAGE, EDIT_PREFERENCES,
00032                     SHOW_ABOUT,         /**< Show credits */
00033                     QUIT_GAME,
00034                     TIP_PREVIOUS,       /**< Show previous tip-of-the-day */
00035                     TIP_NEXT,           /**< Show next tip-of-the-day */
00036                     SHOW_HELP,
00037                     BEG_FOR_UPLOAD,     /**< Ask user for permission to upload game-stats as feedback */
00038                     REDRAW_BACKGROUND,  /**< Used after an action needing a redraw (ex: fullscreen) */
00039                     NOTHING             /**< Default, nothing done, no redraw needed */
00040                   };
00041 
00042 /**
00043  *  Show titlepage with logo and background, menu-buttons and tip-of-the-day.
00044  * 
00045  *  After the page is shown, this routine waits
00046  *  for the user to click one of the menu-buttons,
00047  *  or a keypress.
00048  * 
00049  *  @param  screen          display object
00050  *  @param  tips_of_day     list of tips
00051  *  @param  redraw_background redraw background and buttons box, see draw_background()
00052  * 
00053  *  @return the value of the menu-item the user has choosen.
00054  *  @retval see @ref TITLE_RESULT for possible values
00055  */ 
00056 TITLE_RESULT show_title(game_display& screen, config& tips_of_day, bool redraw_background);
00057 }
00058 
00059 #endif

Generated by doxygen 1.5.5 on 23 May 2008 for The Battle for Wesnoth
Gna! | Forum | Wiki | CIA | devdocs