The NWN okay/cancel dialog. More...

#include <okcancel.h>

Inheritance diagram for Engines::NWN::OKCancelDialog:

Collaboration diagram for Engines::NWN::OKCancelDialog:

[legend]

Public Member Functions
	OKCancelDialog (const Common::UString &msg, const Common::UString &ok="", const Common::UString &cancel="", ::Engines::Console *console=0)

	~OKCancelDialog ()

void	show ()
	Show the GUI. More...

Public Member Functions inherited from Engines::NWN::GUI
	GUI (::Engines::Console *console=0)

	~GUI ()

Public Member Functions inherited from Engines::GUI
	GUI (Console *console=0)

virtual void	hide ()
	Hide the GUI. More...

uint32	run (uint32 startCode=kStartCodeNone)
	Run the GUI. More...

virtual void	abort ()
	Abort the currently running GUI. More...

void	addEvent (const Events::Event &event)
	Add a single event for consideration into the GUI event queue. More...

uint32	processEventQueue ()
	Process the current event queue. More...

virtual Common::UString	getName () const

Protected Member Functions
void	initWidget (Widget &widget)

void	callbackActive (Widget &widget)
	Callback that's triggered when a widget was activated. More...

Protected Member Functions inherited from Engines::NWN::GUI
void	load (const Common::UString &resref)

virtual void	fixWidgetType (const Common::UString &tag, WidgetType &type)

WidgetFrame *	getFrame (const Common::UString &tag, bool vital=false)

WidgetClose *	getClose (const Common::UString &tag, bool vital=false)

WidgetCheckBox *	getCheckBox (const Common::UString &tag, bool vital=false)

WidgetPanel *	getPanel (const Common::UString &tag, bool vital=false)

WidgetLabel *	getLabel (const Common::UString &tag, bool vital=false)

WidgetSlider *	getSlider (const Common::UString &tag, bool vital=false)

WidgetEditBox *	getEditBox (const Common::UString &tag, bool vital=false)

WidgetButton *	getButton (const Common::UString &tag, bool vital=false)

WidgetListBox *	getListBox (const Common::UString &tag, bool vital=false)

WidgetScrollbar *	getScrollbar (const Common::UString &tag, bool vital=false)

Protected Member Functions inherited from Engines::GUI
void	addWidget (Widget *widget)
	Add a widget. More...

void	removeWidget (Widget *widget)
	Remove a widget. More...

void	clearWidgets ()
	Clear all widgets. More...

bool	empty ()
	Check if the gui is currently empty. More...

bool	hasWidget (const Common::UString &tag) const
	Does this specific widget exist within the GUI? More...

Widget *	getWidget (const Common::UString &tag, bool vital=false)
	Return a widget in the GUI. More...

const Widget *	getWidget (const Common::UString &tag, bool vital=false) const
	Return a widget in the GUI. More...

void	declareGroup (const std::list< Widget *> &group)
	Put these widgets together into a group. More...

void	removeFocus ()
	Forcefully remove the focus from the current widget. More...

void	updateMouse ()
	Force an update of the mouse position. More...

virtual void	mouseUp ()
	The mouse state has changed. More...

virtual void	mouseDown ()

uint32	sub (GUI &gui, uint32 startCode=kStartCodeNone, bool showSelf=true, bool hideSelf=true)
	Open up a sub GUI. More...

void	setPosition (float x, float y, float z)
	Set the GUI's position. More...

void	getPosition (float &x, float &y, float &z) const
	Get the GUI's position. More...

virtual void	callbackRun ()
	Callback that's triggered periodically in the run() method. More...

virtual void	callbackTextInput (const Common::UString &text)
	Callback that's triggered when a text input is received. More...

virtual void	callbackKeyInput (const Events::Key &key, const Events::EventType &type)
	Callback that's triggered when a key is pressed or released. More...

void	addChild (GUI *gui)
	Add a child GUI object to this GUI. More...

void	removeChild (GUI *gui)
	Remove a child GUI object from this GUI. More...

Private Attributes
Common::UString	_msg

Common::UString	_ok

Common::UString	_cancel

Additional Inherited Members
Static Public Attributes inherited from Engines::GUI
static const uint32	kStartCodeNone = 0

static const uint32	kReturnCodeNone = 0

static const uint32	kReturnCodeAbort = 0xFFFFFFFF

Protected Types inherited from Engines::NWN::GUI
enum	WidgetType { kWidgetTypeInvalid = - 1, kWidgetTypeFrame = 0, kWidgetTypeCloseButton = 1, kWidgetTypeCheckBox = 2, kWidgetTypePanel = 3, kWidgetTypeLabel = 5, kWidgetTypeSlider = 6, kWidgetTypeEditBox = 8, kWidgetTypeButton = 9, kWidgetTypeListBox = 100, kWidgetTypeScrollbar = 101 }

Protected Attributes inherited from Engines::GUI
Console *	_console

Widget *	_currentWidget
	The widget the mouse is currently on. More...

uint32	_startCode
	The GUI's start code. More...

uint32	_returnCode
	The GUI's return code. More...

GUI *	_sub
	The currently running sub GUI. More...

Detailed Description

The NWN okay/cancel dialog.

Definition at line 37 of file okcancel.h.

Constructor & Destructor Documentation

◆ OKCancelDialog()

Engines::NWN::OKCancelDialog::OKCancelDialog	(	const Common::UString &	msg,
		const Common::UString &	ok = `""`,
		const Common::UString &	cancel = `""`,
		::Engines::Console *	console = `0`
	)

Definition at line 37 of file okcancel.cpp.

References Engines::NWN::GUI::load().

Here is the call graph for this function:

◆ ~OKCancelDialog()

Engines::NWN::OKCancelDialog::~OKCancelDialog ( )

Definition at line 45 of file okcancel.cpp.

Member Function Documentation

◆ callbackActive()

void Engines::NWN::OKCancelDialog::callbackActive ( Widget & widget )

protectedvirtual

Callback that's triggered when a widget was activated.

Reimplemented from Engines::GUI.

Definition at line 80 of file okcancel.cpp.

References Engines::GUI::_returnCode, and Engines::Widget::getTag().

Here is the call graph for this function:

◆ initWidget()

void Engines::NWN::OKCancelDialog::initWidget ( Widget & widget )

protectedvirtual

Reimplemented from Engines::NWN::GUI.

Definition at line 48 of file okcancel.cpp.

References _cancel, _msg, _ok, Common::UString::empty(), Engines::Widget::getTag(), and Engines::NWN::WidgetLabel::setText().

Here is the call graph for this function:

◆ show()

void Engines::NWN::OKCancelDialog::show ( )

virtual

Show the GUI.

Reimplemented from Engines::GUI.

Definition at line 67 of file okcancel.cpp.

References Engines::NWN::WidgetLabel::getHeight(), Engines::NWN::GUI::getLabel(), Engines::NWN::GUI::getPanel(), Engines::Widget::getPosition(), Engines::NWN::WidgetLabel::getWidth(), Engines::NWN::NWNWidgetWithCaption::setPosition(), and Engines::GUI::show().

Here is the call graph for this function:

Member Data Documentation

◆ _cancel

Common::UString Engines::NWN::OKCancelDialog::_cancel

private

Definition at line 55 of file okcancel.h.

Referenced by initWidget().

◆ _msg

Common::UString Engines::NWN::OKCancelDialog::_msg

private

Definition at line 52 of file okcancel.h.

Referenced by initWidget().

◆ _ok

Common::UString Engines::NWN::OKCancelDialog::_ok

private

Definition at line 54 of file okcancel.h.

Referenced by initWidget().

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

src/engines/nwn/gui/dialogs/okcancel.h
src/engines/nwn/gui/dialogs/okcancel.cpp

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OKCancelDialog()

◆ ~OKCancelDialog()

Member Function Documentation

◆ callbackActive()

◆ initWidget()

◆ show()

Member Data Documentation

◆ _cancel

◆ _msg

◆ _ok