Pyrogenesis  trunk
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CButton Class Reference

Button. More...

#include <CButton.h>

Inheritance diagram for CButton:
Inheritance graph
[legend]
Collaboration diagram for CButton:
Collaboration graph
[legend]

Public Member Functions

 CButton ()
 
virtual ~CButton ()
 
virtual void ResetStates ()
 
virtual void HandleMessage (SGUIMessage &Message)
 
virtual void Draw ()
 Draws the Button. More...
 
- Public Member Functions inherited from IGUIButtonBehavior
 IGUIButtonBehavior ()
 
virtual ~IGUIButtonBehavior ()
 
void DrawButton (const CRect &rect, const float &z, CGUISpriteInstance &sprite, CGUISpriteInstance &sprite_over, CGUISpriteInstance &sprite_pressed, CGUISpriteInstance &sprite_disabled, int cell_id)
 This is a function that lets a button being drawn, it regards if it's over, disabled, pressed and such. More...
 
CColor ChooseColor ()
 Choosing which color of the following according to object enabled/hovered/pressed status: textcolor_disabled – disabled textcolor_pressed – pressed textcolor_over – hovered. More...
 
- Public Member Functions inherited from IGUIObject
 IGUIObject ()
 
virtual ~IGUIObject ()
 
virtual bool MouseOver ()
 Checks if mouse is hovering this object. More...
 
const CStr & GetName () const
 Get object name, name is unique. More...
 
void SetName (const CStr &Name)
 Get object name. More...
 
CStr GetPresentableName () const
 
void AddToPointersMap (map_pObjects &ObjectMap)
 Adds object and its children to the map, it's name being the first part, and the second being itself. More...
 
void AddChild (IGUIObject *pChild)
 Notice nothing will be returned or thrown if the child hasn't been inputted into the GUI yet. More...
 
vector_pObjects::iterator begin ()
 
vector_pObjects::iterator end ()
 
bool SettingExists (const CStr &Setting) const
 Checks if settings exists, only available for derived classes that has this set up, that's why the base class just returns false. More...
 
PSRETURN SetSetting (const CStr &Setting, const CStrW &Value, const bool &SkipMessage=false)
 Set a setting by string, regardless of what type it is. More...
 
PSRETURN GetSettingType (const CStr &Setting, EGUISettingType &Type) const
 Retrieves the type of a named setting. More...
 
void RegisterScriptHandler (const CStr &Action, const CStr &Code, CGUI *pGUI)
 Set the script handler for a particular object-specific action. More...
 
JSObject * GetJSObject ()
 Retrieves the JSObject representing this GUI object. More...
 
CGUIGetGUI ()
 
const CGUIGetGUI () const
 
void SetFocus ()
 Take focus! More...
 
- Public Member Functions inherited from IGUITextOwner
 IGUITextOwner ()
 
virtual ~IGUITextOwner ()
 
void AddText (SGUIText *text)
 Adds a text object. More...
 
virtual void UpdateCachedSize ()
 
virtual void DrawText (size_t index, const CColor &color, const CPos &pos, float z, const CRect &clipping=CRect())
 Draws the Text. More...
 
virtual bool MouseOverIcon ()
 Test if mouse position is over an icon. More...
 

Protected Member Functions

void SetupText ()
 Sets up text, should be called every time changes has been made that can change the visual. More...
 
- Protected Member Functions inherited from IGUIObject
void AddSetting (const EGUISettingType &Type, const CStr &Name)
 Add a setting to m_Settings. More...
 
virtual void Destroy ()
 Calls Destroy on all children, and deallocates all memory. More...
 
virtual InReaction ManuallyHandleEvent (const SDL_Event_ *ev)
 Some objects need to handle the SDL_Event_ manually. More...
 
void LoadStyle (CGUI &GUIinstance, const CStr &StyleName)
 Loads a style. More...
 
void LoadStyle (const SGUIStyle &Style)
 Loads a style. More...
 
virtual float GetBufferedZ () const
 Returns not the Z value, but the actual buffered Z value, i.e. More...
 
void SetGUI (CGUI *const &pGUI)
 
void SetParent (IGUIObject *pParent)
 Set parent of this object. More...
 
bool IsFocused () const
 Check if object is focused. More...
 
IGUIObjectGetParent () const
 NOTE! This will not just return m_pParent, when that is need use it! There is one exception to it, when the parent is the top-node (the object that isn't a real object), this will return NULL, so that the top-node's children are seemingly parentless. More...
 
CPos GetMousePos () const
 Get Mouse from CGUI. More...
 
virtual bool HandleAdditionalChildren (const XMBElement &child, CXeromyces *pFile)
 Handle additional children to the <object>-tag. More...
 
InReaction SendEvent (EGUIMessageType type, const CStr &EventName)
 Send event to this GUI object (HandleMessage and ScriptEvent) More...
 
void ScriptEvent (const CStr &Action)
 Execute the script for a particular action. More...
 
void ScriptEvent (const CStr &Action, JS::HandleValue Argument)
 Execute the script for a particular action. More...
 
void SetScriptHandler (const CStr &Action, JS::HandleObject Function)
 
void UpdateMouseOver (IGUIObject *const &pMouseOver)
 Inputes the object that is currently hovered, this function updates this object accordingly (i.e. More...
 
- Protected Member Functions inherited from IGUITextOwner
void CalculateTextPosition (CRect &ObjSize, CPos &TextPos, SGUIText &Text)
 Calculate the position for the text, based on the alignment. More...
 

Protected Attributes

CPos m_TextPos
 Placement of text. More...
 
- Protected Attributes inherited from IGUIButtonBehavior
bool m_Pressed
 Everybody knows how a button works, you don't simply press it, you have to first press the button, and then release it... More...
 
bool m_PressedRight
 
- Protected Attributes inherited from IGUIObject
CRect m_CachedActualSize
 Cached size, real size m_Size is actually dependent on resolution and can have different real outcomes, this is the real outcome cached to avoid slow calculations in real time. More...
 
CStr m_Name
 
vector_pObjects m_Children
 
IGUIObjectm_pParent
 
double m_LastClickTime [6]
 
bool m_MouseHovering
 This is an array of true or false, each element is associated with a string representing a setting. More...
 
- Protected Attributes inherited from IGUITextOwner
bool m_GeneratedTextsValid
 Whether the cached text is currently valid (if not then SetupText will be called by Draw) More...
 
std::vector< SGUIText * > m_GeneratedTexts
 Texts that are generated and ready to be rendered. More...
 

Additional Inherited Members

- Public Attributes inherited from IGUIObject
std::map< CStr, SGUISettingm_Settings
 Settings pool, all an object's settings are located here If a derived object has got more settings that the base settings, it's because they have a new version of the function SetupSettings(). More...
 

Detailed Description

Button.

See also
IGUIObject
IGUIButtonBehavior

Constructor & Destructor Documentation

CButton::CButton ( )
CButton::~CButton ( )
virtual

Member Function Documentation

void CButton::Draw ( )
virtual

Draws the Button.

Implements IGUIObject.

void CButton::HandleMessage ( SGUIMessage Message)
virtual
See also
IGUIObject::HandleMessage()

Reimplemented from IGUIButtonBehavior.

virtual void CButton::ResetStates ( )
inlinevirtual
See also
IGUIObject::ResetStates()

Reimplemented from IGUIButtonBehavior.

void CButton::SetupText ( )
protectedvirtual

Sets up text, should be called every time changes has been made that can change the visual.

Implements IGUITextOwner.

Member Data Documentation

CPos CButton::m_TextPos
protected

Placement of text.


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