hdi::core::ModalDialog::ButtonOptions Class Reference

Controls button options for the ModalDialog constructor. More...

#include <hdicoreModalDialog.h>

Public Member Functions
	ButtonOptions ()
	Constructs a ButtonOptions object with default settings.
	ButtonOptions (const ButtonOptions &bo_)
	Constructs a ButtonOptions object with the same settings as another object.
	ButtonOptions (const bool enable_, const Callback &callback_, const bool dismiss_=true, const std::string &title_="")
	Constructs a ButtonOptions object with the given settings.
virtual	~ButtonOptions ()
	Destructs a ButtonOptions object.
ButtonOptions &	operator= (const ButtonOptions &rhs_)
	Overloaded assignment operator to copy values from one ButtonOptions object to another.
Callback *const	callback () const
	Gets the callback for the modal dialog button.
void	setCallback (const Callback &cb_)
	Sets the callback for the modal dialog button.

Public Attributes
bool	enable
	Whether the button should be shown.
bool	dismiss
	Whether the modal should be automatically dismissed when the button is chosen.
std::string	title
	Button text value, as UTF-8.

Detailed Description

Controls button options for the ModalDialog constructor.

Constructor & Destructor Documentation

ButtonOptions() [1/3]

hdi::core::ModalDialog::ButtonOptions::ButtonOptions

(

)

Constructs a ButtonOptions object with default settings.

Author

GW

Date

09/2013

ButtonOptions() [2/3]

hdi::core::ModalDialog::ButtonOptions::ButtonOptions

(

const ButtonOptions &

bo_

)

Constructs a ButtonOptions object with the same settings as another object.

Author

GW

Date

02/2015

ButtonOptions() [3/3]

hdi::core::ModalDialog::ButtonOptions::ButtonOptions	(	const bool	enable_,
		const Callback &	callback_,
		const bool	dismiss_ = true,
		const std::string &	title_ = ""
	)

Constructs a ButtonOptions object with the given settings.

Author

GW

Date

09/2013

Parameters

enable_	Whether the button is enabled
callback_	Button callback
dismiss_	Whether the automatically dismiss the dialog when the button is chosen
title_	Title for the button (pass "" to use the default localized title), as UTF-8

~ButtonOptions()

virtual hdi::core::ModalDialog::ButtonOptions::~ButtonOptions ( )

virtual

Destructs a ButtonOptions object.

Author

GW

Date

09/2013

Member Function Documentation

callback()

Callback *const hdi::core::ModalDialog::ButtonOptions::callback

(

)

const

Gets the callback for the modal dialog button.

Author

GW

Date

09/2013

Returns

A pointer to the registered callback

operator=()

ButtonOptions & hdi::core::ModalDialog::ButtonOptions::operator=

(

const ButtonOptions &

rhs_

)

Overloaded assignment operator to copy values from one ButtonOptions object to another.

Author

GW

Date

02/2015

Parameters

rhs_	Righthand side of the assignment

Returns

The lefthand side of the assignment, but with its values updated

setCallback()

void hdi::core::ModalDialog::ButtonOptions::setCallback

(

const Callback &

cb_

)

Sets the callback for the modal dialog button.

Author

GW

Date

09/2013

Parameters

cb_	New button callback

Member Data Documentation

title

std::string hdi::core::ModalDialog::ButtonOptions::title

Button text value, as UTF-8.

Note

If enable is true and title is empty (""), a localized default will be used (e.g. "OK", "Cancel", etc.)