xoreos  0.0.5
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
Engines::Jade::MainMenu Class Reference

#include <main.h>

Inheritance diagram for Engines::Jade::MainMenu:
Inheritance graph
[legend]
Collaboration diagram for Engines::Jade::MainMenu:
Collaboration graph
[legend]

Public Member Functions

 MainMenu (Module &module, ::Engines::Console *console=0)
 
 ~MainMenu ()
 
void show ()
 Show the GUI. More...
 
void hide ()
 Hide the GUI. More...
 
- Public Member Functions inherited from Engines::Jade::GUI
 GUI (::Engines::Console *console=0)
 
 ~GUI ()
 
void convertToXoreos (float &x, float &y, const float widgetHeight) const
 Converts Jade Empire' 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 Jade Empire'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

void callbackActive (Widget &widget)
 Callback that's triggered when a widget was activated. More...
 
void addBackground ()
 
- Protected Member Functions inherited from Engines::Jade::GUI
virtual void mouseUp ()
 The mouse state has changed. More...
 
virtual void mouseDown ()
 
void load (const Common::UString &resref)
 
virtual void initWidget (Widget &widget)
 
WidgetPanelgetPanel (const Common::UString &tag, bool vital=false)
 
WidgetLabelgetLabel (const Common::UString &tag, bool vital=false)
 
WidgetProtoItemgetProtoItem (const Common::UString &tag, bool vital=false)
 
WidgetButtongetButton (const Common::UString &tag, bool vital=false)
 
WidgetCheckBoxgetCheckBox (const Common::UString &tag, bool vital=false)
 
WidgetSlidergetSlider (const Common::UString &tag, bool vital=false)
 
WidgetScrollbargetScrollbar (const Common::UString &tag, bool vital=false)
 
WidgetProgressbargetProgressbar (const Common::UString &tag, bool vital=false)
 
WidgetListBoxgetListBox (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...
 
WidgetgetWidget (const Common::UString &tag, bool vital=false)
 Return a widget in the GUI. More...
 
const WidgetgetWidget (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...
 
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 Member Functions

void createOptions ()
 

Private Attributes

Module_module
 
AreaLayout_background
 
Common::ScopedPtr< GUI_options
 

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::Jade::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 37 of file main.h.

Constructor & Destructor Documentation

◆ MainMenu()

Engines::Jade::MainMenu::MainMenu ( Module module,
::Engines::Console console = 0 
)

◆ ~MainMenu()

Engines::Jade::MainMenu::~MainMenu ( )

Definition at line 87 of file main.cpp.

References _background.

Member Function Documentation

◆ addBackground()

void Engines::Jade::MainMenu::addBackground ( )
protected

Definition at line 132 of file main.cpp.

References _background, ConfigMan, Aurora::TwoDARow::empty(), Aurora::TwoDAFile::getRow(), Aurora::TwoDARow::getString(), and TwoDAReg.

Referenced by MainMenu().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ callbackActive()

void Engines::Jade::MainMenu::callbackActive ( Widget widget)
protectedvirtual

Callback that's triggered when a widget was activated.

Reimplemented from Engines::GUI.

Definition at line 104 of file main.cpp.

References _module, _options, Engines::GUI::_returnCode, createOptions(), EventMan, Common::exceptionDispatcherWarning(), Engines::Widget::getTag(), Engines::Jade::Module::load(), Engines::playVideo(), and Engines::GUI::sub().

Here is the call graph for this function:

◆ createOptions()

void Engines::Jade::MainMenu::createOptions ( )
private

Definition at line 144 of file main.cpp.

References _options.

Referenced by callbackActive().

Here is the caller graph for this function:

◆ hide()

void Engines::Jade::MainMenu::hide ( )
virtual

Hide the GUI.

Reimplemented from Engines::Jade::GUI.

Definition at line 98 of file main.cpp.

References _background, Engines::Jade::AreaLayout::hide(), and Engines::Jade::GUI::hide().

Referenced by Engines::Jade::Game::mainMenu().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ show()

void Engines::Jade::MainMenu::show ( )
virtual

Show the GUI.

Reimplemented from Engines::Jade::GUI.

Definition at line 92 of file main.cpp.

References _background, Engines::Jade::AreaLayout::show(), and Engines::Jade::GUI::show().

Referenced by Engines::Jade::Game::mainMenu().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ _background

AreaLayout* Engines::Jade::MainMenu::_background
private

Definition at line 52 of file main.h.

Referenced by addBackground(), hide(), show(), and ~MainMenu().

◆ _module

Module* Engines::Jade::MainMenu::_module
private

Definition at line 50 of file main.h.

Referenced by callbackActive().

◆ _options

Common::ScopedPtr<GUI> Engines::Jade::MainMenu::_options
private

Definition at line 54 of file main.h.

Referenced by callbackActive(), and createOptions().


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