4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
15 #include "support/docstring.h"
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.
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.
33 int prompt(docstring const & title, docstring const & question,
34 int default_button, int cancel_button,
35 docstring const & b1, docstring const & b2,
36 docstring const & b3 = docstring(),
37 docstring const & b4 = docstring());
40 * Display a warning to the user. Title should be a short (general) summary.
41 * Only use this if the user cannot perform some remedial action.
42 * \p askshowagain will display a check box where the user can turn off the
43 * warning for future cases. Ponder carefully if this is feasible.
45 void warning(docstring const & title, docstring const & message,
46 bool const & askshowagain = false);
49 * Display a warning to the user. Title should be a short (general) summary.
50 * Only use this if the user cannot perform some remedial action.
52 void error(docstring const & title, docstring const & message);
55 * Informational message. Use very very sparingly. That is, you must
56 * apply to me, in triplicate, under the sea, breathing in petrol
57 * and reciting the Nicene Creed, whilst running uphill and also
60 void information(docstring const & title, docstring const & message);
63 * Asks for a text. Returns true for OK. Obtained message is in response
64 * (even empty string). dflt stands for default message in the dialog.
66 bool askForText(docstring & response, docstring const & msg,
67 docstring const & dflt = docstring());
70 } // namespace frontend