src/frontends/alert.h

   1 // -*- C++ -*-
   2 /**
   3  * \file alert.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author John Levon
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef LYX_ALERT_H
  13 #define LYX_ALERT_H
  14
  15 #include "support/lstrings.h"
  16
  17
  18 namespace lyx {
  19 namespace frontend {
  20 namespace Alert {
  21
  22 /**
  23  * Prompt for a question. Returns 0-2 for the chosen button.
  24  * Set default_button and cancel_button to reasonable values. b1-b3
  25  * should have accelerators marked with an '&'. title should be
  26  * a short summary. Strings should be gettextised.
  27  * Please think about the poor user.
  28  *
  29  * Remember to use boost::format. If you make any of these buttons
  30  * "Yes" or "No", I will personally come around to your house and
  31  * slap you with fish, and not in an enjoyable way either.
  32  */
  33 int prompt(docstring const & title, docstring const & question,
  34            int default_button, int cancel_button,
  35            docstring const & b1, docstring const & b2, docstring const & b3 = docstring());
  36
  37 /**
  38  * Display a warning to the user. Title should be a short (general) summary.
  39  * Only use this if the user cannot perform some remedial action.
  40  */
  41 void warning(docstring const & title, docstring const & message);
  42
  43 /**
  44  * Display a warning to the user. Title should be a short (general) summary.
  45  * Only use this if the user cannot perform some remedial action.
  46  */
  47 void error(docstring const & title, docstring const & message);
  48
  49 /**
  50  * Informational message. Use very very sparingly. That is, you must
  51  * apply to me, in triplicate, under the sea, breathing in petrol
  52  * and reciting the Nicene Creed, whilst running uphill and also
  53  * eating.
  54  */
  55 void information(docstring const & title, docstring const & message);
  56
  57 /// Asks for a text. DO NOT USE !!
  58 std::pair<bool, docstring> const
  59 askForText(docstring const & msg, docstring const & dflt = docstring());
  60
  61 } // namespace Alert
  62 } // namespace frontend
  63 } // namespace lyx
  64
  65 #endif // LYX_ALERT_H