#include <dialog.h>

Inheritance diagram for Engines::KotOR::DialogGUIBase:

[legend]

Collaboration diagram for Engines::KotOR::DialogGUIBase:

[legend]

Public Member Functions
	DialogGUIBase (bool k2)

void	startConversation (const Common::UString &name, Aurora::NWScript::Object *owner=0)

bool	isConversationActive () const

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

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

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

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

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

	~GUI ()

void	convertToXoreos (float &x, float &y, const float widgetHeight) const
	Converts Kotor' GUI coordinates with a coordinate origin in the upper left corner to the Xoreos coordinate system with the coordinate origin in the center. More...

void	convertToGUI (float &x, float &y, const float widgetHeight) const
	Converts Xoreos' coordinates with a coordinate origin in the center to Kotor's GUI coordinates with the coordinate origin in the the upper left corner. More...

Common::UString	getName () const

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

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

Protected Member Functions
virtual void	makeLookAtPC (const Common::UString &tag)=0

virtual void	playDefaultAnimations (const Common::UString &tag)=0

virtual void	playTalkAnimations (const Common::UString &tag)=0

Protected Member Functions inherited from Engines::KotOR::GUI
virtual void	mouseUp ()
	The mouse state has changed. More...

virtual void	mouseDown ()

void	load (const Common::UString &resref)

virtual void	initWidget (Widget &widget)

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

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

WidgetProtoItem *	getProtoItem (const Common::UString &tag, bool vital=false)

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

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

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

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

WidgetProgressbar *	getProgressbar (const Common::UString &tag, bool vital=false)

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

void	addBackground (const Common::UString &background, bool front=false)

void	setCheckBoxState (const Common::UString &tag, bool state)

bool	getCheckBoxState (const Common::UString &tag)

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

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

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 Member Functions
void	update (int width, int height)
	Updates the gui when a resize occurs or it is created. More...

void	refresh ()

void	playSounds ()

void	stopSounds ()

void	pickReply (int index)

void	eraseDeveloperNotes (Common::UString &str)
	Some dialog entries in KotOR 2 contain developer notes in curly braces. More...

void	notifyResized (int oldWidth, int oldHeight, int newWidth, int newHeight)

Private Member Functions inherited from Events::Notifyable
	Notifyable ()

virtual	~Notifyable ()

Private Attributes
bool	_kotor2

bool	_isActive

Common::ScopedPtr< Graphics::Aurora::KotORDialogFrame >	_frame

Common::ScopedPtr< Aurora::DLGFile >	_dlg

std::vector< uint32 >	_replyIds

Common::ScopedPtr< Sound::ChannelHandle >	_voice

Common::ScopedPtr< Sound::ChannelHandle >	_sound

Common::UString	_owner

Common::UString	_curSpeaker

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::KotOR::GUI
enum	WidgetType { kWidgetTypeInvalid = - 1, kWidgetTypePanel = 2, kWidgetTypeLabel = 4, kWidgetTypeProtoItem = 5, kWidgetTypeButton = 6, kWidgetTypeCheckBox = 7, kWidgetTypeSlider = 8, kWidgetTypeScrollbar = 9, kWidgetTypeProgressbar = 10, kWidgetTypeListBox = 11 }

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

Definition at line 46 of file dialog.h.

Constructor & Destructor Documentation

◆ DialogGUIBase()

Engines::KotOR::DialogGUIBase::DialogGUIBase ( bool k2 )

Definition at line 54 of file dialog.cpp.

References Engines::KotOR::GUI::load(), update(), and WindowMan.

Here is the call graph for this function:

Member Function Documentation

◆ callbackActive()

void Engines::KotOR::DialogGUIBase::callbackActive ( Widget & widget )

virtual

Callback that's triggered when a widget was activated.

Reimplemented from Engines::GUI.

Definition at line 89 of file dialog.cpp.

References Common::UString::beginsWith(), Engines::KotOR::GUI::getListBox(), Engines::WidgetListBox::getSelectedIndex(), Engines::Widget::getTag(), pickReply(), and Engines::WidgetListBox::selectItemByWidgetTag().

Here is the call graph for this function:

◆ callbackKeyInput()

void Engines::KotOR::DialogGUIBase::callbackKeyInput	(	const Events::Key &	key,
		const Events::EventType &	type
	)

virtual

Callback that's triggered when a key is pressed or released.

Reimplemented from Engines::GUI.

Definition at line 102 of file dialog.cpp.

References Engines::KotOR::GUI::getListBox(), Events::kEventKeyDown, Events::kKey1, Events::kKey2, Events::kKey3, Events::kKey4, Events::kKey5, Events::kKey6, Events::kKey7, Events::kKey8, Events::kKey9, Events::kKeyDown, Events::kKeyKP1, Events::kKeyKP2, Events::kKeyKP3, Events::kKeyKP4, Events::kKeyKP5, Events::kKeyKP6, Events::kKeyKP7, Events::kKeyKP8, Events::kKeyKP9, Events::kKeyUp, pickReply(), Engines::WidgetListBox::selectNextItem(), and Engines::WidgetListBox::selectPreviousItem().

Here is the call graph for this function:

◆ eraseDeveloperNotes()

void Engines::KotOR::DialogGUIBase::eraseDeveloperNotes ( Common::UString & str )

private

Some dialog entries in KotOR 2 contain developer notes in curly braces.

Erase those.

Definition at line 269 of file dialog.cpp.

References Common::UString::end(), Common::UString::erase(), and Common::UString::findFirst().

Referenced by refresh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hide()

void Engines::KotOR::DialogGUIBase::hide ( )

virtual

Hide the GUI.

Reimplemented from Engines::KotOR::GUI.

Definition at line 84 of file dialog.cpp.

References _frame, and Engines::KotOR::GUI::hide().

Here is the call graph for this function:

◆ isConversationActive()

bool Engines::KotOR::DialogGUIBase::isConversationActive ( ) const

Definition at line 74 of file dialog.cpp.

References _isActive.

◆ makeLookAtPC()

virtual void Engines::KotOR::DialogGUIBase::makeLookAtPC ( const Common::UString & tag )

protectedpure virtual

Implemented in Engines::KotOR::DialogGUI, and Engines::KotOR2::DialogGUI.

Referenced by refresh().

Here is the caller graph for this function:

◆ notifyResized()

void Engines::KotOR::DialogGUIBase::notifyResized	(	int	oldWidth,
		int	oldHeight,
		int	newWidth,
		int	newHeight
	)

privatevirtual

Reimplemented from Events::Notifyable.

Definition at line 283 of file dialog.cpp.

References update().

Here is the call graph for this function:

◆ pickReply()

void Engines::KotOR::DialogGUIBase::pickReply ( int index )

private

Definition at line 252 of file dialog.cpp.

References _curSpeaker, _dlg, _isActive, _replyIds, Common::UString::clear(), Common::UString::empty(), playDefaultAnimations(), refresh(), and stopSounds().

Referenced by callbackActive(), and callbackKeyInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ playDefaultAnimations()

virtual void Engines::KotOR::DialogGUIBase::playDefaultAnimations ( const Common::UString & tag )

protectedpure virtual

Implemented in Engines::KotOR::DialogGUI, and Engines::KotOR2::DialogGUI.

Referenced by pickReply().

Here is the caller graph for this function:

◆ playSounds()

void Engines::KotOR::DialogGUIBase::playSounds ( )

private

Definition at line 229 of file dialog.cpp.

References _dlg, _sound, _voice, Common::UString::empty(), Sound::kSoundTypeSFX, Sound::kSoundTypeVoice, Engines::playSound(), Common::ScopedPtrBase< T, Deallocator >::reset(), Aurora::DLGFile::Line::sound, and Aurora::DLGFile::Line::voice.

Referenced by refresh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ playTalkAnimations()

virtual void Engines::KotOR::DialogGUIBase::playTalkAnimations ( const Common::UString & tag )

protectedpure virtual

Implemented in Engines::KotOR::DialogGUI, and Engines::KotOR2::DialogGUI.

Referenced by refresh().

Here is the caller graph for this function:

◆ refresh()

void Engines::KotOR::DialogGUIBase::refresh ( )

private

Definition at line 174 of file dialog.cpp.

References _curSpeaker, _dlg, _isActive, _kotor2, _owner, _replyIds, Engines::WidgetListBox::addItem(), Common::UString::c_str(), ConfigMan, Common::UString::empty(), eraseDeveloperNotes(), Common::UString::format(), Engines::KotOR::GUI::getLabel(), Engines::KotOR::GUI::getListBox(), Aurora::LocString::getString(), Aurora::DLGFile::Line::id, makeLookAtPC(), playSounds(), playTalkAnimations(), Engines::WidgetListBox::refreshItemWidgets(), Engines::WidgetListBox::removeAllItems(), Engines::KotORJadeWidget::setText(), Aurora::DLGFile::Line::speaker, stopSounds(), and Aurora::DLGFile::Line::text.

Referenced by pickReply(), and startConversation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ show()

void Engines::KotOR::DialogGUIBase::show ( )

virtual

Show the GUI.

Reimplemented from Engines::KotOR::GUI.

Definition at line 78 of file dialog.cpp.

References _frame, CursorMan, and Engines::KotOR::GUI::show().

Here is the call graph for this function:

◆ startConversation()

void Engines::KotOR::DialogGUIBase::startConversation	(	const Common::UString &	name,
		Aurora::NWScript::Object *	owner = `0`
	)

Definition at line 63 of file dialog.cpp.

References _dlg, _owner, Common::UString::c_str(), Aurora::NWScript::Object::getTag(), refresh(), Common::ScopedPtrBase< T, Deallocator >::reset(), warning(), and Common::StackException::what().

Here is the call graph for this function:

◆ stopSounds()

void Engines::KotOR::DialogGUIBase::stopSounds ( )

private

Definition at line 241 of file dialog.cpp.

References _sound, _voice, Common::ScopedPtrBase< T, Deallocator >::get(), Common::ScopedPtrBase< T, Deallocator >::reset(), and SoundMan.

Referenced by pickReply(), and refresh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

void Engines::KotOR::DialogGUIBase::update	(	int	width,
		int	height
	)

private

Updates the gui when a resize occurs or it is created.

Definition at line 140 of file dialog.cpp.

References _frame, _kotor2, Engines::WidgetListBox::createItemWidgets(), Engines::KotOR::GUI::getLabel(), Engines::KotOR::GUI::getListBox(), Graphics::Aurora::kHAlignCenter, Graphics::Aurora::kVAlignBottom, Engines::WidgetListBox::setAdjustHeight(), Engines::WidgetListBox::setHeight(), Engines::KotORJadeWidget::setHeight(), Engines::KotORJadeWidget::setHorizontalTextAlign(), Engines::WidgetListBox::setItemTextColor(), Engines::KotORJadeWidget::setPosition(), Engines::WidgetListBox::setSoundClickItem(), Engines::WidgetListBox::setSoundHoverItem(), Engines::KotORJadeWidget::setTextColor(), Engines::KotORJadeWidget::setVerticalTextAlign(), and Engines::KotORJadeWidget::setWidth().

Referenced by DialogGUIBase(), and notifyResized().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ _curSpeaker

Common::UString Engines::KotOR::DialogGUIBase::_curSpeaker

private

Definition at line 72 of file dialog.h.

Referenced by pickReply(), and refresh().

◆ _dlg

Common::ScopedPtr<Aurora::DLGFile> Engines::KotOR::DialogGUIBase::_dlg

private

Definition at line 67 of file dialog.h.

Referenced by pickReply(), playSounds(), refresh(), and startConversation().

◆ _frame

Common::ScopedPtr<Graphics::Aurora::KotORDialogFrame> Engines::KotOR::DialogGUIBase::_frame

private

Definition at line 66 of file dialog.h.

Referenced by hide(), show(), and update().

◆ _isActive

bool Engines::KotOR::DialogGUIBase::_isActive

private

Definition at line 65 of file dialog.h.

Referenced by isConversationActive(), pickReply(), and refresh().

◆ _kotor2

bool Engines::KotOR::DialogGUIBase::_kotor2

private

Definition at line 64 of file dialog.h.

Referenced by refresh(), and update().

◆ _owner

Common::UString Engines::KotOR::DialogGUIBase::_owner

private

Definition at line 71 of file dialog.h.

Referenced by refresh(), and startConversation().

◆ _replyIds

std::vector<uint32> Engines::KotOR::DialogGUIBase::_replyIds

private

Definition at line 68 of file dialog.h.

Referenced by pickReply(), and refresh().

◆ _sound

Common::ScopedPtr<Sound::ChannelHandle> Engines::KotOR::DialogGUIBase::_sound

private

Definition at line 70 of file dialog.h.

Referenced by playSounds(), and stopSounds().

◆ _voice

Common::ScopedPtr<Sound::ChannelHandle> Engines::KotOR::DialogGUIBase::_voice

private

Definition at line 69 of file dialog.h.

Referenced by playSounds(), and stopSounds().

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

src/engines/kotor/gui/dialog.h
src/engines/kotor/gui/dialog.cpp

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DialogGUIBase()

Member Function Documentation

◆ callbackActive()

◆ callbackKeyInput()

◆ eraseDeveloperNotes()

◆ hide()

◆ isConversationActive()

◆ makeLookAtPC()

◆ notifyResized()

◆ pickReply()

◆ playDefaultAnimations()

◆ playSounds()

◆ playTalkAnimations()

◆ refresh()

◆ show()

◆ startConversation()

◆ stopSounds()

◆ update()

Member Data Documentation

◆ _curSpeaker

◆ _dlg

◆ _frame

◆ _isActive

◆ _kotor2

◆ _owner

◆ _replyIds

◆ _sound

◆ _voice