lyx_mirror/src/frontends/Alert.h
Lars Gullik Bjønnes 44cd0fc9a1 The std::string mammoth path.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@7862 a592a061-630c-0410-9148-cb99ea01b6c8
2003-10-06 15:43:21 +00:00

63 lines
1.9 KiB
C++

// -*- C++ -*-
/**
* \file Alert.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author John Levon
*
* Full author contact details are available in file CREDITS.
*/
#ifndef LYX_ALERT_H
#define LYX_ALERT_H
#include "support/lstrings.h"
namespace Alert {
/**
* Prompt for a question. Returns 0-2 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.
* Please think about the poor user.
*
* Remember to use boost::format. If you make any of these buttons
* "Yes" or "No", I will personally come around to your house and
* slap you with fish, and not in an enjoyable way either.
*/
int prompt(std::string const & title, std::string const & question,
int default_button, int cancel_button,
std::string const & b1, std::string const & b2, std::string const & b3 = std::string());
/**
* Display a warning to the user. Title should be a short (general) summary.
* Only use this if the user cannot perform some remedial action.
*/
void warning(std::string const & title, std::string const & message);
/**
* Display a warning to the user. Title should be a short (general) summary.
* Only use this if the user cannot perform some remedial action.
*/
void error(std::string const & title, std::string const & message);
/**
* Informational message. Use very very sparingly. That is, you must
* apply to me, in triplicate, under the sea, breathing in petrol
* and reciting the Nicene Creed, whilst running uphill and also
* eating.
*/
void information(std::string const & title, std::string const & message);
/// Asks for a text. DO NOT USE !!
std::pair<bool, std::string> const
askForText(std::string const & msg,
std::string const & dflt = std::string());
}
#endif // LYX_ALERT_H