Popup Class Reference

A JavaScript based popup window, encapsulating the Javascript functions alert(), confirm(), and prompt(). More...

#include <Popup.h>

Inheritance diagram for Popup:

Public Types
enum	Type { Confirm , Alert , Prompt }
	Popup type. More...
Public Types inherited from Wt::WObject
typedef void(WObject::*	Method) ()

Public Member Functions
	Popup (Type t, const WString &message, const std::string defaultValue)
	Popup constructor. More...
void	setMessage (const WString &message)
	Change the message. More...
void	setDefaultValue (const std::string defaultValue)
	Change the default value for a prompt dialog. More...
const WString &	message () const
	Get the current message. More...
const std::string &	defaultValue () const
	Get the default value for a prompt dialog. More...
JSignal< std::string > &	okPressed ()
	Signal emitted when ok pressed. More...
JSignal &	cancelPressed ()
	Signal emitted when cancel is pressed. More...
Public Member Functions inherited from Wt::WObject
void	addChild (std::unique_ptr< WObject > child)
Child *	addChild (std::unique_ptr< Child > child)
std::unique_ptr< WObject >	removeChild (WObject *child)
std::unique_ptr< Child >	removeChild (Child *child)
virtual const std::string	id () const
virtual void	setObjectName (const std::string &name)
virtual std::string	objectName () const
void	resetLearnedSlots ()
void	resetLearnedSlot (void(T::*method)())
WStatelessSlot *	implementStateless (void(T::*method)())
WStatelessSlot *	implementStateless (void(T::*method)(), void(T::*undoMethod)())
void	isNotStateless ()
WStatelessSlot *	implementJavaScript (void(T::*method)(), const std::string &jsCode)
Public Member Functions inherited from Wt::Core::observable
	observable () noexcept
virtual	~observable ()
auto	bindSafe (void(C::*method)(Args...)) noexcept
auto	bindSafe (void(C::*method)(Args...) const) const noexcept
auto	bindSafe (const Function &function) noexcept

Static Public Member Functions
static std::unique_ptr< Popup >	createConfirm (const WString &message)
	Create a confirm dialog. More...
static std::unique_ptr< Popup >	createPrompt (const WString &message, const std::string defaultValue)
	Create a prompt dialog with the given default value. More...
static std::unique_ptr< Popup >	createAlert (const WString &message)
	Create an alert dialog. More...

Public Attributes
JSlot	show
	Show the dialog. More...

Private Member Functions
void	setJavaScript ()
	Update the javascript code. More...

Private Attributes
JSignal< std::string >	okPressed_
JSignal	cancelPressed_
Type	t_
WString	message_
std::string	defaultValue_

Additional Inherited Members
Protected Member Functions inherited from Wt::WObject
virtual WStatelessSlot *	getStateless (Method method)

Detailed Description

A JavaScript based popup window, encapsulating the Javascript functions alert(), confirm(), and prompt().

Use one of the create static methods to create a popup. This will not display the popup, until either the show slot is triggered from an event handler, or is executed using it's exec() method.

When the user closes the popup, either the okPressed or cancelPressed signal is emitted. For a prompt dialog, the value is passed as a parameter to the okPressed signal.

Definition at line 32 of file Popup.h.

Member Enumeration Documentation

Type

enum Popup::Type

Popup type.

Enumerator
Confirm
Alert
Prompt

Definition at line 37 of file Popup.h.

{ Confirm, Alert, Prompt };

Constructor & Destructor Documentation

Popup()

Popup::Popup	(	Type	t,
		const WString &	message,
		const std::string	defaultValue
	)

Popup constructor.

Definition at line 14 of file Popup.C.

  : WObject(),
    okPressed_(this, "ok"),
    cancelPressed_(this, "cancel"),
    t_(t),
    message_(message),
    defaultValue_(defaultValue)
{
  setJavaScript();
}

Member Function Documentation

cancelPressed()

JSignal& Popup::cancelPressed ( )

inline

Signal emitted when cancel is pressed.

Definition at line 85 of file Popup.h.

{ return cancelPressed_; }

createAlert()

std::unique_ptr< Popup > Popup::createAlert ( const WString &  message )

static

Create an alert dialog.

Definition at line 78 of file Popup.C.

{
  return std::make_unique<Popup>(Type::Alert, message, std::string());
}

createConfirm()

std::unique_ptr< Popup > Popup::createConfirm ( const WString &  message )

static

Create a confirm dialog.

Definition at line 73 of file Popup.C.

{
  return std::make_unique<Popup>(Type::Confirm, message, std::string());
}

createPrompt()

std::unique_ptr< Popup > Popup::createPrompt ( const WString &  message, const std::string  defaultValue  )

static

Create a prompt dialog with the given default value.

Definition at line 83 of file Popup.C.

{
  return std::make_unique<Popup>(Type::Prompt, message, defaultValue);
}

defaultValue()

const std::string& Popup::defaultValue ( ) const

inline

Get the default value for a prompt dialog.

Definition at line 70 of file Popup.h.

{ return defaultValue_; }

message()

const WString& Popup::message ( ) const

inline

Get the current message.

Definition at line 66 of file Popup.h.

{ return message_; }

okPressed()

JSignal<std::string>& Popup::okPressed ( )

inline

Signal emitted when ok pressed.

Definition at line 81 of file Popup.h.

{ return okPressed_; }

setDefaultValue()

void Popup::setDefaultValue

(

const std::string

defaultValue

)

Change the default value for a prompt dialog.

Definition at line 67 of file Popup.C.

{
  defaultValue_ = defaultValue;
  setJavaScript();
}

setJavaScript()

void Popup::setJavaScript ( )

private

Update the javascript code.

Definition at line 25 of file Popup.C.

{
  /*
   * Sets the JavaScript code.
   *
   * Notice how Wt.emit() is used to emit the okPressed or cancelPressed
   * signal, and how arguments may be passed to it, matching the number and
   * type of arguments in the JSignal definition.
   */
  switch (t_) {
  case Confirm:
    show.setJavaScript
      ("function(){ if (confirm('" + message_.narrow() + "')) {"
       + okPressed_.createCall({"''"}) +
       "} else {"
       + cancelPressed_.createCall({}) +
       "}}");
    break;
  case Alert:
    show.setJavaScript
      ("function(){ alert('" + message_.narrow() + "');"
       + okPressed_.createCall({"''"}) +
       "}");
    break;
  case Prompt:
    show.setJavaScript
      ("function(){var n = prompt('" + message_.narrow() + "', '"
       + defaultValue_ + "');"
       "if (n != null) {"
       + okPressed_.createCall({"n"}) +
       "} else {"
       + cancelPressed_.createCall({}) +
       "}}");
  }
}

setMessage()

void Popup::setMessage

(

const WString &

message

)

Change the message.

Definition at line 61 of file Popup.C.

{
  message_ = message;
  setJavaScript();
}

Member Data Documentation

cancelPressed_

JSignal Popup::cancelPressed_

private

Definition at line 89 of file Popup.h.

defaultValue_

std::string Popup::defaultValue_

private

Definition at line 93 of file Popup.h.

message_

WString Popup::message_

private

Definition at line 92 of file Popup.h.

okPressed_

JSignal<std::string> Popup::okPressed_

private

Definition at line 88 of file Popup.h.

show

JSlot Popup::show

Show the dialog.

Use show.exec() to show the dialog, or connect the slot to an EventSignal to directly show the dialog without a server round trip.

Definition at line 77 of file Popup.h.

t_

Type Popup::t_

private

Definition at line 91 of file Popup.h.

---

The documentation for this class was generated from the following files:

• javascript/Popup.h
• javascript/Popup.C