gui Namespace Reference

Namespaces

namespace  gl

Classes

class  anchor
 Stores a position for a UI widget. More...
class  backdrop
 Draws borders and background of a frame. More...
class  button
 A simple button. More...
class  check_button
 A button with two additional states : checked and unchecked. More...
class  color
 A simple color class (float RGBA). More...
class  periodic_timer
 A... periodic timer. More...
class  edit_box
 An editable text box. More...
class  event
 Contains an event informations. More...
class  event_manager
 Manages events and their responses. More...
class  event_receiver
 Abstract interface for event handling. More...
class  focus_frame
 Abstract gui widget that can receive and loose focus. More...
class  font
 A texture containing characters. More...
class  font_string
 The GUI class used to draw text on the screen. More...
struct  layer
 Contains layered_region. More...
class  frame
 GUI container. More...
class  gradient
 An helper to make gradients. More...
class  layered_region
 Abstract GUI renderable. More...
class  exception
 Exception to be thrown by GUI code. More...
struct  addon
 A piece of the user interface. More...
struct  level
 Contains frame. More...
struct  strata
 Contains level. More...
class  manager
 Manages the user interface. More...
class  manager_impl
 Abstract type for implementation specific management. More...
class  material
 A class that holds rendering data. More...
class  region
 Simple GUI region (not renderable). More...
class  render_target
 A place to render things (the screen, a texture, ...). More...
class  scroll_frame
 A frame with scrollable content. More...
class  slider
 A frame with a movable texture. More...
struct  vertex
struct  quad
class  sprite
 Use to draw a texture on the screen. More...
class  status_bar
 A variable length bar. More...
class  text
 Used to draw some text on the screen. More...
class  texture
 The base of the GUI's appearence. More...
class  uiobject
 The base of the GUI. More...
class  vector2

Typedefs

typedef std::multimap
< std::string, event_receiver * >
::iterator 
iterator
typedef vector2< float > vector2f

Enumerations

enum  anchor_type { ANCHOR_ABS, ANCHOR_REL }
enum  anchor_point {
  ANCHOR_TOPLEFT, ANCHOR_TOP, ANCHOR_TOPRIGHT, ANCHOR_RIGHT,
  ANCHOR_BOTTOMRIGHT, ANCHOR_BOTTOM, ANCHOR_BOTTOMLEFT, ANCHOR_LEFT,
  ANCHOR_CENTER
}
enum  constraint { CONSTRAINT_NONE, CONSTRAINT_X, CONSTRAINT_Y }
enum  frame_strata {
  STRATA_PARENT, STRATA_BACKGROUND, STRATA_LOW, STRATA_MEDIUM,
  STRATA_HIGH, STRATA_DIALOG, STRATA_FULLSCREEN, STRATA_FULLSCREEN_DIALOG,
  STRATA_TOOLTIP
}
enum  blend_mode { BLEND_NORMAL, BLEND_ADD, BLEND_MUL }
enum  border_type { BORDER_LEFT = 0, BORDER_RIGHT = 1, BORDER_TOP = 2, BORDER_BOTTOM = 3 }
enum  layer_type {
  LAYER_BACKGROUND, LAYER_BORDER, LAYER_ARTWORK, LAYER_OVERLAY,
  LAYER_HIGHLIGHT, LAYER_SPECIALHIGH
}

Functions

 lEdgeInsets_ ({{0, 0, 0, 0}})
 uiEdgeSize_ (0u)
 uiOriginalEdgeSize_ (0u)
color operator+ (const color &c1, const color &c2)
color operator- (const color &c1, const color &c2)
color operator* (const color &c1, const color &c2)
color operator* (const color &c1, float f)
color operator* (float f, const color &c2)
std::ostream & operator<< (std::ostream &mStream, const color &mColor)
 uiLastKeyPressed_ (0u)
 dKeyRepeatSpeed_ (0.03)
 mKeyRepeatTimer_ (dKeyRepeatSpeed_, periodic_timer::START_FIRST_TICK, true)
int l_xml_error (lua_State *)
 lRelHitRectInsetList_ ({{0.0f, 0.0f, 0.0f, 0.0f}})
 uiMinWidth_ (0u)
 uiMaxWidth_ (uint(-1))
 uiMinHeight_ (0u)
 uiMaxHeight_ (uint(-1))
 fScale_ (1.0f)
 bMouseInFrame_ (false)
 bMouseInTitleRegion_ (false)
 iMousePosX_ (0)
 iMousePosY_ (0)
 pTitleRegion_ (nullptr)
 pParentFrame_ (nullptr)
 bMouseDragged_ (false)
int l_set_key_binding (lua_State *pLua)
int l_create_frame (lua_State *pLua)
int l_delete_frame (lua_State *pLua)
int l_get_locale (lua_State *pLua)
int l_log (lua_State *pLua)
void gui_out (const std::string &sMessage)
std::ostream out (std::cout.rdbuf())
void step_value (float &fValue, float fStep)
std::array< float, 4 > select_uvs (const std::array< float, 8 > &uvs)
void get_format (utils::ustring::iterator &iterChar, text::format &mFormat)
 fAlpha_ (1.0f)
 bIsShown_ (true)
 bIsVisible_ (true)
 bIsWidthAbs_ (true)
 bIsHeightAbs_ (true)
 uiAbsWidth_ (0u)
 uiAbsHeight_ (0u)
 fRelWidth_ (0.0f)
 fRelHeight_ (0.0f)
 bUpdateAnchors_ (false)
 bUpdateBorders_ (true)
 bUpdateDimensions_ (false)
template<class T >
vector2< T > operator* (T mValue, const vector2< T > &mV)
template<class T >
std::ostream & operator<< (std::ostream &mStream, const vector2< T > &mV)

Variables

const uint OUTLINE_QUALITY = 10
const float OUTLINE_THICKNESS = 2.0f
const std::string warning = "# Warning # : "
const std::string error = "# Error # : "
std::ostream out

Typedef Documentation

typedef std::multimap<std::string, event_receiver*>::iterator gui::iterator

Definition at line 13 of file gui_eventmanager.cpp.

typedef vector2< float > gui::vector2f

Definition at line 12 of file gui_font.hpp.


Enumeration Type Documentation

Enumerator:
ANCHOR_TOPLEFT 
ANCHOR_TOP 
ANCHOR_TOPRIGHT 
ANCHOR_RIGHT 
ANCHOR_BOTTOMRIGHT 
ANCHOR_BOTTOM 
ANCHOR_BOTTOMLEFT 
ANCHOR_LEFT 
ANCHOR_CENTER 

Definition at line 17 of file gui_anchor.hpp.

Enumerator:
ANCHOR_ABS 
ANCHOR_REL 

Definition at line 11 of file gui_anchor.hpp.

Enumerator:
BLEND_NORMAL 
BLEND_ADD 
BLEND_MUL 

Definition at line 38 of file gui_sprite.hpp.

Enumerator:
BORDER_LEFT 
BORDER_RIGHT 
BORDER_TOP 
BORDER_BOTTOM 

Definition at line 17 of file gui_uiobject.hpp.

Enumerator:
CONSTRAINT_NONE 
CONSTRAINT_X 
CONSTRAINT_Y 

Definition at line 30 of file gui_anchor.hpp.

Enumerator:
STRATA_PARENT 
STRATA_BACKGROUND 
STRATA_LOW 
STRATA_MEDIUM 
STRATA_HIGH 
STRATA_DIALOG 
STRATA_FULLSCREEN 
STRATA_FULLSCREEN_DIALOG 
STRATA_TOOLTIP 

Definition at line 79 of file gui_manager.hpp.

Enumerator:
LAYER_BACKGROUND 
LAYER_BORDER 
LAYER_ARTWORK 
LAYER_OVERLAY 
LAYER_HIGHLIGHT 
LAYER_SPECIALHIGH 

Definition at line 25 of file gui_uiobject.hpp.


Function Documentation

gui::bIsHeightAbs_ ( true   ) 
gui::bIsShown_ ( true   ) 
gui::bIsVisible_ ( true   ) 
gui::bIsWidthAbs_ ( true   ) 
gui::bMouseDragged_ ( false   ) 

Definition at line 32 of file gui_frame.cpp.

gui::bMouseInFrame_ ( false   ) 
gui::bMouseInTitleRegion_ ( false   ) 
gui::bUpdateAnchors_ ( false   ) 
gui::bUpdateBorders_ ( true   ) 
gui::bUpdateDimensions_ ( false   ) 

Definition at line 21 of file gui_uiobject.cpp.

gui::dKeyRepeatSpeed_ ( 0.  03  ) 
gui::fAlpha_ ( 1.  0f  ) 
gui::fRelHeight_ ( 0.  0f  ) 
gui::fRelWidth_ ( 0.  0f  ) 
gui::fScale_ ( 1.  0f  ) 
void gui::get_format ( utils::ustring::iterator &  iterChar,
text::format &  mFormat 
)

Definition at line 433 of file gui_text.cpp.

void gui::gui_out ( const std::string &  sMessage  ) 

Definition at line 694 of file gui_manager.cpp.

gui::iMousePosX_ (  ) 
gui::iMousePosY_ (  ) 
int gui::l_create_frame ( lua_State *  pLua  ) 

Definition at line 150 of file gui_manager_glues.cpp.

int gui::l_delete_frame ( lua_State *  pLua  ) 

Definition at line 203 of file gui_manager_glues.cpp.

int gui::l_get_locale ( lua_State *  pLua  ) 

Definition at line 243 of file gui_manager_glues.cpp.

int gui::l_log ( lua_State *  pLua  ) 

Definition at line 257 of file gui_manager_glues.cpp.

int gui::l_set_key_binding ( lua_State *  pLua  ) 

Definition at line 92 of file gui_manager_glues.cpp.

int gui::l_xml_error ( lua_State *  pLua  ) 

Definition at line 1190 of file gui_frame.cpp.

gui::lEdgeInsets_ (  ) 
gui::lRelHitRectInsetList_ (  ) 
gui::mKeyRepeatTimer_ ( dKeyRepeatSpeed_  ,
periodic_timer::START_FIRST_TICK  ,
true   
)

Definition at line 24 of file gui_editbox.cpp.

template<class T >
vector2<T> gui::operator* ( mValue,
const vector2< T > &  mV 
) [inline]

Definition at line 160 of file gui_vector2.hpp.

color gui::operator* ( float  f,
const color &  c2 
)
color gui::operator* ( const color &  c1,
float  f 
)
color gui::operator* ( const color &  c1,
const color &  c2 
)
color gui::operator+ ( const color &  c1,
const color &  c2 
)
color gui::operator- ( const color &  c1,
const color &  c2 
)
template<class T >
std::ostream& gui::operator<< ( std::ostream &  mStream,
const vector2< T > &  mV 
) [inline]

Definition at line 166 of file gui_vector2.hpp.

std::ostream & gui::operator<< ( std::ostream &  mStream,
const color &  mColor 
)
std::ostream gui::out ( std::cout.  rdbuf()  ) 
gui::pParentFrame_ ( nullptr   ) 
gui::pTitleRegion_ ( nullptr   ) 
std::array<float,4> gui::select_uvs ( const std::array< float, 8 > &  uvs  ) 

Definition at line 11 of file gui_statusbar.cpp.

void gui::step_value ( float &  fValue,
float  fStep 
)

Definition at line 12 of file gui_slider.cpp.

gui::uiAbsHeight_ ( 0u   ) 
gui::uiAbsWidth_ ( 0u   ) 
gui::uiEdgeSize_ ( 0u   ) 
gui::uiLastKeyPressed_ ( 0u   ) 
gui::uiMaxHeight_ ( uint(-1)   ) 
gui::uiMaxWidth_ ( uint(-1)   ) 
gui::uiMinHeight_ ( 0u   ) 
gui::uiMinWidth_ ( 0u   ) 
gui::uiOriginalEdgeSize_ ( 0u   ) 

Definition at line 15 of file gui_backdrop.cpp.


Variable Documentation

const std::string gui::error = "# Error # : "

Definition at line 7 of file gui_out.cpp.

std::ostream gui::out
const uint gui::OUTLINE_QUALITY = 10

Definition at line 11 of file gui_fontstring.cpp.

const float gui::OUTLINE_THICKNESS = 2.0f

Definition at line 12 of file gui_fontstring.cpp.

const std::string gui::warning = "# Warning # : "

Definition at line 6 of file gui_out.cpp.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines

Generated on Tue Jan 1 21:58:12 2013 for gui by  doxygen 1.6.1