Remove obsolete (and false) comment.

[lyx.git] / src / frontends / alert.h

diff --git a/src/frontends/alert.h b/src/frontends/alert.h
index a163caf69a08d6af88ff001112267eca58c2515a..c3b8065f98723e2ea3c911d9daaad7af802fd481 100644 (file)
--- a/src/frontends/alert.h
+++ b/src/frontends/alert.h
@@ -12,7 +12,7 @@
 #ifndef LYX_ALERT_H
 #define LYX_ALERT_H
 
-#include "support/lstrings.h"
+#include "support/strfwd.h"
 
 
 namespace lyx {
@@ -20,7 +20,7 @@ namespace frontend {
 namespace Alert {
 
 /**
- * Prompt for a question. Returns 0-2 for the chosen button.
+ * Prompt for a question. Returns 0-3 for the chosen button.
  * Set default_button and cancel_button to reasonable values. b1-b3
  * should have accelerators marked with an '&'. title should be
  * a short summary. Strings should be gettextised.
@@ -32,19 +32,29 @@ namespace Alert {
  */
 int prompt(docstring const & title, docstring const & question,
           int default_button, int cancel_button,
-          docstring const & b1, docstring const & b2, docstring const & b3 = docstring());
+          docstring const & b0, docstring const & b1,
+          docstring const & b2 = empty_docstring(),
+          docstring const & b3 = empty_docstring());
 
 /**
  * Display a warning to the user. Title should be a short (general) summary.
  * Only use this if the user cannot perform some remedial action.
+ * \p askshowagain will display a check box where the user can turn off the
+ * warning for future cases. Ponder carefully if this is feasible.
+ *
+ * The console output takes care of converting any Qt html to plain text.
  */
-void warning(docstring const & title, docstring const & message);
+void warning(docstring const & title, docstring const & message,
+            bool const & askshowagain = false);
 
 /**
  * Display a warning to the user. Title should be a short (general) summary.
  * Only use this if the user cannot perform some remedial action.
+ * On some systems it is possible to show a backtrace.
+ *
+ * The console output takes care of converting any Qt html to plain text.
  */
-void error(docstring const & title, docstring const & message);
+void error(docstring const & title, docstring const & message, bool backtrace = false);
 
 /**
  * Informational message. Use very very sparingly. That is, you must
@@ -54,9 +64,12 @@ void error(docstring const & title, docstring const & message);
  */
 void information(docstring const & title, docstring const & message);
 
-/// Asks for a text. DO NOT USE !!
-std::pair<bool, docstring> const
-askForText(docstring const & msg, docstring const & dflt = docstring());
+/**
+ * Asks for a text. Returns true for OK. Obtained message is in response
+ * (even empty string). dflt stands for default message in the dialog.
+ */
+bool askForText(docstring & response, docstring const & msg,
+       docstring const & dflt = empty_docstring());
 
 } // namespace Alert
 } // namespace frontend