snowballs2/client/src/interface.h

   1 // NeL - MMORPG Framework <http://dev.ryzom.com/projects/nel/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This program is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU Affero General Public License as
   6 // published by the Free Software Foundation, either version 3 of the
   7 // License, or (at your option) any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU Affero General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Affero General Public License
  15 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 #ifndef INTERFACE_H
  18 #define INTERFACE_H
  19
  20 //
  21 // Includes
  22 //
  23
  24 #include <string>
  25
  26 #include <nel/misc/rgba.h>
  27
  28 namespace SBCLIENT {
  29
  30 //
  31 // External functions
  32 //
  33
  34 void    initInterface ();
  35 void    updateInterface ();
  36 void    releaseInterface ();
  37
  38 // Display the interface with a string and waiting a user event
  39 // queryString -> the string that will be display to the user
  40 // defaultString -> default prompt string
  41 // prompt -> set the user prompt format (0=normal, 1=with_star 2=no_prompt)
  42 // color -> the background color
  43 void    askString (const std::string &queryString, const std::string &defaultString="", sint prompt=0, const NLMISC::CRGBA &color=NLMISC::CRGBA(0,0,64,128));
  44
  45 // Return true if the answer have answered with the user answer in answer string
  46 bool    haveAnswer (std::string &answer);
  47
  48 // Return true if the interface is open
  49 bool    interfaceOpen ();
  50
  51 } /* namespace SBCLIENT */
  52
  53 #endif // INTERFACE_H
  54
  55 /* End of interface.h */