CGUIBorder Class Reference

GUI Border. More...

#include <GUI.h>

Inheritance diagram for CGUIBorder:

List of all members.

Public Member Functions
virtual void	Initialize ()
virtual int	Create (CGUIElement *pParent)
virtual bool	PropertyChanging (const void *pvProperty, void *pvNewValue)
virtual void	GetProperties (EPropList &PropList)
virtual void	Draw ()
virtual int	LoadXML (TiXmlNode *pDataNode, CString strFilename)
virtual int	SaveXML (TiXmlNode *pDataNode, CString strFilename)
virtual int	Resize (tRect &NewRect)
virtual int	OnLMouseDown (UINT x, UINT y)
virtual int	OnLMouseUp (UINT x, UINT y)
virtual int	OnMouseMove (UINT x, UINT y)
void	SetBorderWidth (UINT uiWidth)
UINT	GetBorderWidth ()
void	SetBorderSpacing (UINT uiSpacing)
UINT	GetBorderSpacing ()
virtual void	ProcessMessage (tGUIMessage &Message)
virtual bool	IsOfType (eEntityType eType)

---

Detailed Description

GUI Border.

This is a border class which consists of 8 elements (for now, it can have any amount of them). It tracks their movement and resizes parent widget accordingly. NOTE: can be locked.

Definition at line 809 of file GUI.h.

---

Member Function Documentation

int CGUIBorder::Create (  CGUIElement *  pParent  )  [virtual]

Method details: Parameters: pParent  - Pointer to parent widget Returns: 1 if sucessful, 0 if not Definition at line 24 of file GUIBorder.cpp. References CGUIElement::Create(), and CGUIElement::GetRect().

void CGUIBorder::Draw (   )  [virtual]

Method details: Draws the widget Reimplemented from CGUIElement. Definition at line 32 of file GUIBorder.cpp. References CGUIElement::Draw().

UINT CGUIBorder::GetBorderSpacing (   )

Method details: Returns: Current border spacing Definition at line 266 of file GUIBorder.cpp.

UINT CGUIBorder::GetBorderWidth (   )

Method details: Returns: Current border size Definition at line 255 of file GUIBorder.cpp.

void CGUIBorder::GetProperties (  EPropList &  PropList  )  [virtual]

Method details: Parameters: PropList  - Const. reference to the property list Reimplemented from CGUIElement. Definition at line 305 of file GUIBorder.cpp. References CGUIElement::GetChild(), and CGUIElement::GetProperties().

void CGUIBorder::Initialize (   )  [virtual]

Method details: Initializes GUI Border' variables Reimplemented from CGUIElement. Definition at line 16 of file GUIBorder.cpp.

bool CGUIBorder::IsOfType (  eEntityType  eType  )  [virtual]

Method details: This is an implementation of Custom RTTI Reimplemented from CGUIElement. Definition at line 290 of file GUIBorder.cpp. References CGUIElement::IsOfType().

int CGUIBorder::LoadXML (  TiXmlNode *  pDataNode, CString  strFilename )  [virtual]

Method details: Parameters: pDataNode  - Pointer to XML Node that holds data for this widget strFilename  - String containing filename where the data for the widget is stored Reimplemented from CGUIElement. Definition at line 37 of file GUIBorder.cpp. References TiXmlElement::Attribute(), CEntity::GetID(), CEntity::GetName(), CSingleton< CGlobalLogger >::GetSingleton(), CGUIElement::LoadXML(), SetBorderSpacing(), SetBorderWidth(), and CLogger::Write().

int CGUIBorder::OnLMouseDown (  UINT  x, UINT  y )  [virtual]

Method details: Parameters: x  - X Location of the mouse when Left button has been held y  - Y Location of the mouse when Left button has been held Returns: 1 if it has been processed by widget (or it's children), 0 if not Reimplemented from CGUIElement. Definition at line 165 of file GUIBorder.cpp. References CDoubleList< CGUIElement * >::begin(), CGUIElement::GetType(), CDoubleList< CGUIElement * >::next(), CGUIElement::OnLMouseDown(), and CDoubleList< CGUIElement * >::set_ptr().

int CGUIBorder::OnLMouseUp (  UINT  x, UINT  y )  [virtual]

Method details: Parameters: x  - X Location of the mouse when Left button has been released y  - Y Location of the mouse when Left button has been released Returns: 1 if it has been processed by widget (or it's children), 0 if not Reimplemented from CGUIElement. Definition at line 191 of file GUIBorder.cpp. References CGUIElement::OnLMouseUp().

int CGUIBorder::OnMouseMove (  UINT  x, UINT  y )  [virtual]

Method details: Parameters: x  - X Units the mosue has moved y  - Y Units the mosue has moved Returns: 1 if it has been processed by widget (or it's children), 0 if not Reimplemented from CGUIElement. Definition at line 198 of file GUIBorder.cpp. References CDoubleList< CGUIElement * >::at(), CGUIElement::GetParent(), CGUIElement::GetRect(), CGUIElement::OnMouseMove(), Resize(), and CGUIElement::Resize().

void CGUIBorder::ProcessMessage (  tGUIMessage &  Message  )  [virtual]

Method details: Parameters: Message  - Const. Reference to the message structure that is to be processed. Reimplemented from CGUIElement. Definition at line 271 of file GUIBorder.cpp. References CGUIElement::GetParent(), CGUIElement::GetRect(), tGUIMessage::pSender, and Resize().

bool CGUIBorder::PropertyChanging (  const void *  pvProperty, void *  pvNewValue )  [virtual]

Method details: Parameters: pvProperty  - Pointer to the property pvNewValue  - Pointer to the new value Reimplemented from CGUIElement. Definition at line 298 of file GUIBorder.cpp. References CGUIElement::PropertyChanging().

int CGUIBorder::Resize (  tRect &  NewRect  )  [virtual]

Method details: Parameters: NewRect  - New rectangle for the widget Returns: Varied returns See also: GUI_Message_SizeX/Y/XY Reimplemented from CGUIElement. Definition at line 98 of file GUIBorder.cpp. References CDoubleList< CGUIElement * >::at(), CGUIElement::GetParent(), CGUIElement::GetRect(), and CGUIElement::SetRect(). Referenced by OnMouseMove(), and ProcessMessage().

int CGUIBorder::SaveXML (  TiXmlNode *  pDataNode, CString  strFilename )  [virtual]

Method details: Parameters: pDataNode  - Pointer to XML Node that will be the parent hold the data for this element strFilename  - String containing filename where the data for the widget is stored Reimplemented from CGUIElement. Definition at line 75 of file GUIBorder.cpp. References CXMLResource::GetFilename(), TiXmlElement::SetAttribute(), and TiXmlNode::ToElement().

void CGUIBorder::SetBorderSpacing (  UINT  uiSpacing  )

Method details: Parameters: uiSpacing  - New spacing between border' and element' rectangles Definition at line 261 of file GUIBorder.cpp. Referenced by LoadXML().

void CGUIBorder::SetBorderWidth (  UINT  uiWidth  )

Method details: Parameters: uiWidth  - New size for the border Definition at line 250 of file GUIBorder.cpp. Referenced by LoadXML().

---

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

• D:/Programming/GUI Editor (Source)/GUI.h
• D:/Programming/GUI Editor (Source)/GUIBorder.cpp

---