Humble Framework for SkyOS
Main Page | Modules | Class Hierarchy | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals | Related Pages

HPanel Class Reference
[Graphical User Interface]

#include <HPanel.h>

Inheritance diagram for HPanel:

HID HWidget HObjNoCopy HObj

Public Member Functions

 HPanel (int32 id=0)
ErrCode AddItem (int32 id, StringPtr pstrTitle, HPanelItemPtr &pItem)
 Adds an item to the panel.
ErrCode Create (HANDLE hParent, StringPtr pstrName, HRect *prBounds=NULL, uint32 uStyle=0)
 Creates the panel widget.
ErrCode Destroy (void)
 Destroys the panel widget.
HPanelItem * GetItem (int32 id) const
 Gets a pointer to a panel item.
uint32 GetItemCount (void) const
 Gets the count of items.
HPanelItem * GetNthItem (uint32 udx) const
 Gets a pointer to a panel item.
ErrCode SetHeight (int32 id, int32 nHeight)
 Sets the height of an individual item.
ErrCode SetFont (const HFont &font, int32 nPoints)
 Sets the font for the panel window.

Protected Attributes

HArray< HPanelItemPtr > m_items

Member Function Documentation

ErrCode HPanel::AddItem (  int32  id,
StringPtr  pstrTitle,
HPanelItemPtr &  pItem
) 
 

Returns:
NO_ERROR on success, error code otherwise
Parameters:
id ID of item
pstrTitle Ptr to title string for panel
[out] pItem Ptr to new item (or NULL on error)

Definition at line 291 of file HPanel.h.

ErrCode HPanel::Create (  HANDLE  hParent,
StringPtr  pstrName,
HRect *  prBounds = NULL,
uint32  uStyle = 0
) 
 

Returns:
NO_ERROR on success, error code otherwise
Parameters:
hParent Handle of parent window (must be non-NULL)
pstrName Name of panel
prBounds Ptr to optional bounds of window
uStyle Style flags (WGF_* constants)

Definition at line 341 of file HPanel.h.

ErrCode HPanel::Destroy (  void   )  [virtual]
 

Returns:
NO_ERROR on success, error code otherwise

Reimplemented from HWidget.

Definition at line 401 of file HPanel.h.

HPanelItem* HPanel::GetItem (  int32  id  )  const
 

Returns:
Ptr to panel item on success, NULL otherwise
Parameters:
id ID of panel item to retrieve

Definition at line 433 of file HPanel.h.

uint32 HPanel::GetItemCount (  void   )  const
 

Returns:
Item count

Definition at line 447 of file HPanel.h.

HPanelItem* HPanel::GetNthItem (  uint32  udx  )  const
 

Returns:
Ptr to panel item on success, NULL otherwise
Parameters:
udx Index of panel item (0..N)

Definition at line 452 of file HPanel.h.

ErrCode HPanel::SetHeight (  int32  id,
int32  nHeight
) 
 

Returns:
NO_ERROR on success, error code otherwise
Parameters:
id ID of panel item
nHeight Desired height of item (in pixels)

Definition at line 458 of file HPanel.h.

ErrCode HPanel::SetFont (  const HFont &  font,
int32  nPoints
) 
 

Returns:
NO_ERROR on success, error code otherwise
Parameters:
font Font to set
nPoints Point size (must be > 0)

Definition at line 476 of file HPanel.h.

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

2006.01.09-16:37