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

HFont Class Reference
[Graphical User Interface]

#include <HGUI.h>

Inheritance diagram for HFont:

HObjNoCopy HObj

Public Member Functions

ErrCode Create (StringPtr pstrFamily, StringPtr pstrStyle, StringPtr pstrFile)
 Creates the font.
ErrCode Destroy (void)
 Destroys the font.
int32 Get (void) const
 Gets the font handle.
HANDLE GetHandle (void) const
 Gets the font handle.
ErrCode Set (StringPtr pstrFamily, StringPtr pstrStyle, StringPtr pstrFile)
 Sets the font face.
ErrCode SetDefault (void)
 Sets the font to the system default font.
bool IsValid (void) const
 Evaluates to true if the font is valid.

Data Fields

int32 m_nFont

Member Function Documentation

ErrCode HFont::Create (  StringPtr  pstrFamily,
StringPtr  pstrStyle,
StringPtr  pstrFile
) 
 

Returns:
NO_ERROR on success, error code otherwise
Parameters:
pstrFamily [optional] String describing font family
pstrStyle [optional] String describing font style
pstrFile Ptr to font file

Definition at line 64 of file HGUI.h.

ErrCode HFont::Destroy (  void   ) 
 

Releases the underlying font resource, which (according to a posting by Robert) is nothing more than an index into a kernel-managed table of fonts. Because of this, there really isn't any actual 'destruction' required.

Returns:
NO_ERROR on success, error code otherwise

Definition at line 80 of file HGUI.h.

int32 HFont::Get (  void   )  const
 

Returns:
Font handle

Definition at line 94 of file HGUI.h.

HANDLE HFont::GetHandle (  void   )  const
 

Returns:
Font handle

Definition at line 98 of file HGUI.h.

ErrCode HFont::Set (  StringPtr  pstrFamily,
StringPtr  pstrStyle,
StringPtr  pstrFile
) 
 

Returns:
NO_ERROR on success, error code otherwise
Parameters:
pstrFamily [optional] String describing font family
pstrStyle [optional] String describing font style
pstrFile Ptr to font file

Definition at line 107 of file HGUI.h.

ErrCode HFont::SetDefault (  void   ) 
 

Returns:
NO_ERROR on success, error code otherwise

Definition at line 127 of file HGUI.h.

bool HFont::IsValid (  void   )  const
 

Returns:
True if valid, false otherwise

Definition at line 141 of file HGUI.h.

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

2006.01.09-16:37