hdicoreAlerts.h File Reference

Header file for plugin alerts, confirmation dialogs, etc. More...

#include "hdicoreTypes.h"

Include dependency graph for hdicoreAlerts.h:

Namespaces
namespace	hdi::core::alerts
	Organizes all basic alerting functions into one namespace.

Enumerations
enum	hdi::core::alerts::Response { CancelButtonChosen = 1 , NoButtonChosen = 2 , YesButtonChosen = 3 }
	Describes the choice the user made when dismissing an alert. More...

Functions
bool	hdi::core::alerts::setState (const bool enabled_)
	Allows alerts to be (temporarily) disabled.
void	hdi::core::alerts::message (const std::string &message_)
	Shows a simple platform message dialog, with just an "OK" button and a message/warning icon.
void	hdi::core::alerts::error (const std::string &error_)
	Shows a simple platform error dialog, with just an "OK" button and an error icon.
Response	hdi::core::alerts::confirm (const std::string &question_)
	Shows a confirmation dialog with default affirmative and negative buttons ("Yes" and "No")
Response	hdi::core::alerts::confirm (const std::string &question_, const std::string &yesBtnStr_, const std::string &noBtnStr_)
	Shows a confirmation dialog with affirmative and negative buttons with custom titles.
Response	hdi::core::alerts::confirm (const std::string &question_, const Callback &yesCb_, const Callback &noCb_)
	Shows a confirmation dialog with default affirmative and negative buttons ("Yes" and "No")
Response	hdi::core::alerts::confirm (const std::string &question_, const std::string &yesBtnStr_, const Callback &yesCb_, const std::string &noBtnStr_, const Callback &noCb_)
	Shows a confirmation dialog with affirmative and negative buttons with custom titles.
Response	hdi::core::alerts::question (const std::string &question_)
	Shows a question dialog with default affirmative, negative, and dismissal buttons ("Yes", "No", and "Cancel")
Response	hdi::core::alerts::question (const std::string &question_, const std::string &yesBtnStr_, const std::string &noBtnStr_, const std::string &cancelBtnStr_)
	Shows a question dialog with affirmative, negative, and dismissal buttons with custom titles.
Response	hdi::core::alerts::question (const std::string &question_, const Callback &yesCb_, const Callback &noCb_, const Callback &cancelCb_)
	Shows a question dialog with default affirmative, negative, and dismissal buttons ("Yes", "No", and "Cancel")
Response	hdi::core::alerts::question (const std::string &question_, const std::string &yesBtnStr_, const Callback &yesCb_, const std::string &noBtnStr_, const Callback &noCb_, const std::string &cancelBtnStr_, const Callback &cancelCb_)
	Shows a question dialog with affirmative, negative, and dismissal buttons with custom titles.
void	hdi::core::alerts::beep ()
	Causes a platform beep to occur.

Detailed Description

Header file for plugin alerts, confirmation dialogs, etc.

Copyright

Hot Door, Inc. 2010-2019