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

HDib Class Reference
[Graphical User Interface]

#include <HGUI.h>

Inheritance diagram for HDib:

HObjNoCopy HObj

Detailed Description

A thin wrapper to simplify the creation and usage of DIBs.

Definition at line 512 of file HGUI.h.

Public Member Functions

ErrCode Destroy (void)
 Destroys the DIB.
ErrCode LoadFromFile (StringPtr pstrFile)
 Loads a DIB from an external file.
DIB * GetPtr (void) const
 Returns a pointer to the DIB.
void GetDimensions (HRect &rBounds) const
 Returns the dimensions of the DIB in pixels as a rectangle.
void GetDimensions (HPoint &ptDim) const
 Returns the dimensions of the DIB in pixels as a rectangle.
int32 GetHeight (void) const
 Returns the height of the DIB in pixels.
int32 GetWidth (void) const
 Returns the width of the DIB in pixels.
bool IsValid (void) const
 Evaluates to true if the DIB is valid, i.e., has non-zero dimensions.
 operator DIB * () const

Protected Attributes

DIB * m_pDIB
 Ptr to DIB structure.

Member Function Documentation

ErrCode HDib::Destroy (  void   ) 
 

Destroys the DIB by calling the GI_destroy_DIB() API call. This method can be safely called even if the HDib is invalid, in which case nothing happens.

Returns:
NO_ERROR on success, error code otherwise

Definition at line 544 of file HGUI.h.

ErrCode HDib::LoadFromFile (  StringPtr  pstrFile  ) 
 

Returns:
NO_ERROR on success, error code otherwise
Parameters:
pstrFile file to load DIB from

Definition at line 565 of file HGUI.h.

DIB* HDib::GetPtr (  void   )  const
 

Returns:
Ptr to the DIB

Definition at line 592 of file HGUI.h.

void HDib::GetDimensions (  HRect &  rBounds  )  const
 

Parameters:
[out] rBounds Dimensions in pixels

Definition at line 596 of file HGUI.h.

void HDib::GetDimensions (  HPoint &  ptDim  )  const
 

Parameters:
[out] ptDim Dimensions in pixels

Definition at line 605 of file HGUI.h.

int32 HDib::GetHeight (  void   )  const
 

Returns:
Height in pixels, or zero if invalid

Definition at line 614 of file HGUI.h.

int32 HDib::GetWidth (  void   )  const
 

Returns:
Width in pixels, or zero if invalid

Definition at line 618 of file HGUI.h.

bool HDib::IsValid (  void   )  const
 

Returns:
True if DIB is valid

Definition at line 625 of file HGUI.h.

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

2006.01.09-16:37