Humble Framework for SkyOS

---

HCheckbox Class Reference
[Graphical User Interface]

#include <HCheckbox.h>

Inheritance diagram for HCheckbox:

Public Member Functions
	HCheckbox (int32 id=0)
ErrCode	Create (HANDLE hParent, int32 id, StringPtr pstrLabel, HRect *prBounds=NULL, uint32 uStyle=0)
	Creates the checkbox widget.
COLOR	GetBackColor (void) const
	Returns the background color of the control.
int32	GetState (void) const
	Returns the current state of the checkbox.
ErrCode	SetEnabled (const bool bEnable=true)
	Enables or disables the check box.
ErrCode	SetState (int32 nState)
	Sets the state of the checkbox.
ErrCode	SetText (StringPtr pstrLabel)
	Sets the checkbox text.
bool	IsChecked (void) const
	Evaluates the current state of the checkbox.
Static Public Member Functions
static int32	GetPreferredHeight (void)
	Returns the preferred height of the checkbox.
Protected Member Functions
widget_check *	getWidgetData (void) const
	Returns the private widget data for this widget.

---

Member Function Documentation

ErrCode HCheckbox::Create (  HANDLE  hParent, int32  id, StringPtr  pstrLabel, HRect *  prBounds = NULL, uint32  uStyle = 0 )

Returns: NO_ERROR on success, error code otherwise Parameters: hParent  Handle of parent window (must be non-NULL) id  ID of control pstrLabel  Name of checkbox prBounds  Ptr to optional bounds rectangle (in parent coordinates) uStyle  Style flags (WGF_* constants) Definition at line 61 of file HCheckbox.h.

COLOR HCheckbox::GetBackColor (  void   )  const

Returns: Color Definition at line 109 of file HCheckbox.h.

static int32 HCheckbox::GetPreferredHeight (  void   )  [static]

Returns: Height in pixels Definition at line 118 of file HCheckbox.h.

int32 HCheckbox::GetState (  void   )  const

Returns: State Definition at line 124 of file HCheckbox.h.

ErrCode HCheckbox::SetEnabled (  const bool  bEnable = true  )

Parameters: bEnable  True to enable, false otherwise Definition at line 130 of file HCheckbox.h.

ErrCode HCheckbox::SetState (  int32  nState  )

Returns: NO_ERROR on success, error code otherwise Parameters: nState  Desired check box state Definition at line 153 of file HCheckbox.h.

ErrCode HCheckbox::SetText (  StringPtr  pstrLabel  )

Returns: NO_ERROR on success, error code otherwise Parameters: pstrLabel  Desired check box text Definition at line 173 of file HCheckbox.h.

widget_check* HCheckbox::getWidgetData (  void   )  const [protected]

Returns: widget_check * Definition at line 191 of file HCheckbox.h.

bool HCheckbox::IsChecked (  void   )  const

Returns: True if checked, false otherwise Definition at line 202 of file HCheckbox.h.

---

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

• HCheckbox.h

---

2006.01.09-16:37