Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
Public Member Functions | Public Attributes | List of all members
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. More...
 
 ButtonOptions (const ButtonOptions &bo_)
 Constructs a ButtonOptions object with the same settings as another object. More...
 
 ButtonOptions (const bool enable_, const Callback &callback_, const bool dismiss_=true, const std::string &title_="")
 Constructs a ButtonOptions object with the given settings. More...
 
virtual ~ButtonOptions ()
 Destructs a ButtonOptions object. More...
 
ButtonOptionsoperator= (const ButtonOptions &rhs_)
 Overloaded assignment operator to copy values from one ButtonOptions object to another. More...
 
Callback *const callback () const
 Gets the callback for the modal dialog button. More...
 
void setCallback (const Callback &cb_)
 Sets the callback for the modal dialog button. More...
 

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. More...
 

Detailed Description

Controls button options for the ModalDialog constructor.

Constructor & Destructor Documentation

hdi::core::ModalDialog::ButtonOptions::ButtonOptions ( )

Constructs a ButtonOptions object with default settings.

Author
GW
Date
09/2013
hdi::core::ModalDialog::ButtonOptions::ButtonOptions ( const ButtonOptions bo_)

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

Author
GW
Date
02/2015
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
virtual hdi::core::ModalDialog::ButtonOptions::~ButtonOptions ( )
virtual

Destructs a ButtonOptions object.

Author
GW
Date
09/2013

Member Function Documentation

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
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
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

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.)