My Project
SallyAPI::GUI::CForm Class Reference

Form for viewing the c. More...

#include <Form.h>

Inheritance diagram for SallyAPI::GUI::CForm:
SallyAPI::GUI::CControl SallyAPI::GUI::CGUIBaseObject SallyAPI::Core::CBaseObject SallyAPI::GUI::C3DCircle SallyAPI::GUI::CAppBase SallyAPI::GUI::CBottonMenu SallyAPI::GUI::CButtonBar SallyAPI::GUI::CContextMenu SallyAPI::GUI::CEditBox SallyAPI::GUI::CFileBrowser SallyAPI::GUI::CGroupBox SallyAPI::GUI::CLabelBox SallyAPI::GUI::CListView SallyAPI::GUI::CListViewExt SallyAPI::GUI::CNotificationBox SallyAPI::GUI::CNumberSelector SallyAPI::GUI::CRating SallyAPI::GUI::CScreensaverControl SallyAPI::GUI::CScreensaverControlLabel SallyAPI::GUI::CScrollForm SallyAPI::GUI::CScrollList SallyAPI::GUI::CSideMenu SallyAPI::GUI::CTabcontrol SallyAPI::GUI::CTopMenu SallyAPI::GUI::CVolumeControl

List of all members.

Public Member Functions

 CForm (SallyAPI::GUI::CGUIBaseObject *parent, int x, int y, int width, int height, int controlId=0)
 Constructor.
virtual ~CForm ()
 Destructor.
virtual void SendMessageToChilds (SallyAPI::GUI::CGUIBaseObject *reporter, int reporterId, int messageId, SallyAPI::GUI::SendMessage::CParameterBase *messageParameter=NULL)
 Send message to childs.
virtual void SendMessageToParent (CGUIBaseObject *reporter, int reporterId, int messageId, SallyAPI::GUI::SendMessage::CParameterBase *messageParameter=NULL)
 Send message to parent.
virtual void Timer (float timeDelta)
 Timers.
virtual void SetAlphaBlending (int alphaBlending)
 Sets an alpha blending.
virtual void Render ()
 Renders this object.
virtual void Update ()
 Updates this object.
virtual void AddChild (SallyAPI::GUI::CControl *control)
 Adds a child.
void RemoveChild (std::list< CControl * >::iterator iter)
 Removes the child described by iter.
void SetScrollType (SallyAPI::GUI::ScrollType scrollType)
 Sets a scroll type.
void SetHandleInputIfItIsChildHandled (bool handleInputIfItIsChildHandled)
 Sets a handle input if iterator is child handled.
void SetAlwaysHandleInput (bool alwaysHandleInput)
 Sets the always handle input.
void SetStopHandleInputOnFirstSuccess (bool stopOnFirstSuccess)
 Sets a stop handle input on first success.
bool IsScrolling ()
 Query if this object is scrolling. Only works with Smooth Scroll.

Protected Member Functions

bool MoveX (int x)
 Move x coordinate.
bool MoveY (int y)
 Move y coordinate.
virtual void RenderControl ()
 Renders a control.
virtual void UpdateControl ()
 Updates a control.
virtual void TimerScrollNormal ()
 Timer scroll normal.
virtual bool ScrollTypeNormal (int x, int y)
 Scroll type normal.
virtual bool ScrollTypeSmooth (int x, int y)
 Scroll type smooth.
virtual bool ProcessMouseDown (int x, int y)
 Process a mouse down.
virtual bool ProcessMouseUp (int x, int y)
 Process a mouse up.
virtual bool ProcessMouseMove (int x, int y)
 Process a mouse move.
virtual bool ProcessMouseDoubleClick (int x, int y)
 Process a mouse double click.

Protected Attributes

std::list
< SallyAPI::GUI::CControl * > 
m_GUIControlList
float m_fStartSendMessage
float m_fStartMouseDown
int m_iSetMessage
ScrollType m_eScrollType
int m_iScrollSmoothMouseOldX
int m_iScrollSmoothMouseOldY
std::vector< int > m_vScrollSmoothLastX
std::vector< int > m_vScrollSmoothLastY
std::vector< float > m_vScrollSmoothLastTime
bool m_bHandleInputIfItIsChildHandled
bool m_bAlwaysHandleInput
bool m_bStopOnFirstSuccess
bool m_bScrolling

Detailed Description

Form for viewing the c.

Author:
Christian Knobloch
Date:
19.04.2010

Constructor & Destructor Documentation

CForm::CForm ( SallyAPI::GUI::CGUIBaseObject parent,
int  x,
int  y,
int  width,
int  height,
int  controlId = 0 
)

Constructor.

m_iSetMessage(0), m_fStartSendMessage(0), m_fStartMouseDown(0), m_eScrollType(SallyAPI::GUI::SCROLL_TYPE_NONE), m_iScrollSmoothMouseOldX(-1), m_iScrollSmoothMouseOldY(-1), m_bHandleInputIfItIsChildHandled(true), m_bAlwaysHandleInput(false), m_bStopOnFirstSuccess(false), m_bScrolling(false)

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
[in,out]parentIf non-null, the parent.
xThe x coordinate.
yThe y coordinate.
widthThe width.
heightThe height.
controlIdIdentifier for the control.
CForm::~CForm ( ) [virtual]

Destructor.

Author:
Christian Knobloch
Date:
19.04.2010

Member Function Documentation

void CForm::AddChild ( SallyAPI::GUI::CControl control) [virtual]

Adds a child.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
[in,out]controlIf non-null, the control.

Reimplemented in SallyAPI::GUI::CListViewExt, SallyAPI::GUI::CListView, SallyAPI::GUI::CScreensaverControl, and SallyAPI::GUI::CSideMenu.

Query if this object is scrolling. Only works with Smooth Scroll.

Author:
Christian Knobloch
Date:
27.04.2010
Returns:
true if scrolling, false if not.
bool CForm::MoveX ( int  x) [protected]

Move x coordinate.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
xThe x coordinate.
bool CForm::MoveY ( int  y) [protected]

Move y coordinate.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
yThe y coordinate.
bool CForm::ProcessMouseDoubleClick ( int  x,
int  y 
) [protected, virtual]

Process a mouse double click.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
xThe x coordinate.
yThe y coordinate.
Returns:
true if it succeeds, false if it fails.

Reimplemented from SallyAPI::GUI::CControl.

bool CForm::ProcessMouseDown ( int  x,
int  y 
) [protected, virtual]

Process a mouse down.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
xThe x coordinate.
yThe y coordinate.
Returns:
true if it succeeds, false if it fails.

Reimplemented from SallyAPI::GUI::CControl.

Reimplemented in SallyAPI::GUI::CPopUpWindow.

bool CForm::ProcessMouseMove ( int  x,
int  y 
) [protected, virtual]

Process a mouse move.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
xThe x coordinate.
yThe y coordinate.
Returns:
true if it succeeds, false if it fails.

Reimplemented from SallyAPI::GUI::CControl.

bool CForm::ProcessMouseUp ( int  x,
int  y 
) [protected, virtual]

Process a mouse up.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
xThe x coordinate.
yThe y coordinate.
Returns:
true if it succeeds, false if it fails.

Reimplemented from SallyAPI::GUI::CControl.

void CForm::RemoveChild ( std::list< CControl * >::iterator  iter)

Removes the child described by iter.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
[in,out]iterIf non-null, the iterator.
void CForm::Render ( ) [virtual]

Renders this object.

Author:
Christian Knobloch
Date:
19.04.2010

Reimplemented from SallyAPI::GUI::CControl.

Reimplemented in SallyAPI::GUI::CPopUpWindow.

void CForm::RenderControl ( ) [protected, virtual]

Renders a control.

Author:
Christian Knobloch
Date:
19.04.2010

Implements SallyAPI::GUI::CGUIBaseObject.

Reimplemented in SallyAPI::GUI::CContextMenu, SallyAPI::GUI::CScreensaverControlLabel, and SallyAPI::GUI::CSideMenu.

bool CForm::ScrollTypeNormal ( int  x,
int  y 
) [protected, virtual]

Scroll type normal.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
xThe x coordinate.
yThe y coordinate.
Returns:
true if it succeeds, false if it fails.
bool CForm::ScrollTypeSmooth ( int  x,
int  y 
) [protected, virtual]

Scroll type smooth.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
xThe x coordinate.
yThe y coordinate.
Returns:
true if it succeeds, false if it fails.
void CForm::SendMessageToChilds ( SallyAPI::GUI::CGUIBaseObject reporter,
int  reporterId,
int  messageId,
SallyAPI::GUI::SendMessage::CParameterBase messageParameter = NULL 
) [virtual]

Send message to childs.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
[in,out]reporterIf non-null, the reporter.
reporterIdIdentifier for the reporter.
messageIdIdentifier for the message.
[in,out]messageParameterIf non-null, the message parameter.

Reimplemented from SallyAPI::GUI::CControl.

Reimplemented in SallyAPI::GUI::CFileBrowser, SallyAPI::GUI::CListView, SallyAPI::GUI::CListViewExt, SallyAPI::GUI::CApplicationWindow, SallyAPI::GUI::CRating, SallyAPI::GUI::CLabelBox, and SallyAPI::GUI::CEditBox.

void CForm::SendMessageToParent ( CGUIBaseObject reporter,
int  reporterId,
int  messageId,
SallyAPI::GUI::SendMessage::CParameterBase messageParameter = NULL 
) [virtual]
void CForm::SetAlphaBlending ( int  alphaBlending) [virtual]

Sets an alpha blending.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
alphaBlendingThe alpha blending.

Reimplemented from SallyAPI::GUI::CGUIBaseObject.

Reimplemented in SallyAPI::GUI::CListView, SallyAPI::GUI::CListViewExt, and SallyAPI::GUI::CScrollList.

void CForm::SetAlwaysHandleInput ( bool  alwaysHandleInput)

Sets the always handle input.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
alwaysHandleInputtrue to always handle input.
void CForm::SetHandleInputIfItIsChildHandled ( bool  handleInputIfItIsChildHandled)

Sets a handle input if iterator is child handled.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
handleInputIfItIsChildHandledtrue if handle input if iterator is child handled.

Sets a scroll type.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
scrollTypeType of the scroll.
void CForm::SetStopHandleInputOnFirstSuccess ( bool  stopOnFirstSuccess)

Sets a stop handle input on first success.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
stopOnFirstSuccesstrue if the stop on first operation was a success, false if it failed.
void CForm::Timer ( float  timeDelta) [virtual]

Timers.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
timeDeltaThe time delta.

Reimplemented from SallyAPI::GUI::CControl.

Reimplemented in SallyAPI::GUI::CListView, SallyAPI::GUI::CListViewExt, SallyAPI::GUI::C3DCircle, and SallyAPI::GUI::CNumberSelector.

void CForm::TimerScrollNormal ( ) [protected, virtual]

Timer scroll normal.

Author:
Christian Knobloch
Date:
19.04.2010
void CForm::Update ( ) [virtual]

Updates this object.

Author:
Christian Knobloch
Date:
30.04.2010

Reimplemented from SallyAPI::GUI::CControl.

void CForm::UpdateControl ( ) [protected, virtual]

Updates a control.

Author:
Christian Knobloch
Date:
30.04.2010

Reimplemented from SallyAPI::GUI::CControl.


Member Data Documentation

std::vector<float> SallyAPI::GUI::CForm::m_vScrollSmoothLastTime [protected]
std::vector<int> SallyAPI::GUI::CForm::m_vScrollSmoothLastX [protected]
std::vector<int> SallyAPI::GUI::CForm::m_vScrollSmoothLastY [protected]

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines