Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CP_OSPicture Class Reference

Class for dealing with the native picture format on each supported platform.

Inheritance diagram for CP_OSPicture:

CP_NoCopy List of all members.

Public Member Functions

Constructor / Destructor
 CP_OSPicture ()
 Constructor.
 CP_OSPicture (SInt16 inPictID)
virtual ~CP_OSPicture () throw ()
 Destructor.
Getters
CP_Rect Bounds () const
UInt32 Width () const
UInt32 Height () const
OSPicture GetOSPicture ()
Drawing
void Draw (CP_Canvas &inDestCanvas, const CP_Rect &inBounds)

Protected Attributes

OSPicture fPicture

Private Member Functions

void SetupBitmap (SInt16 inPictureID)

Constructor & Destructor Documentation

CPLAT_Begin_Namespace_CPLAT CP_OSPicture::CP_OSPicture  ) 
 

Constructor.

Exceptions:
none 

CP_OSPicture::CP_OSPicture SInt16  inPictID  ) 
 

Constructor.

Parameters:
inPictID Resource id of the picture.
Exceptions:
none 

CP_OSPicture::~CP_OSPicture  )  throw () [virtual]
 

Destructor.

Exceptions:
none 


Member Function Documentation

CP_Rect CP_OSPicture::Bounds  )  const
 

Returns the bounds of this picture.

Exceptions:
none 
Returns:
CP_Rect const The bounds of this picture.

UInt32 CP_OSPicture::Width  )  const
 

Returns the width of this picture.

Exceptions:
none 
Returns:
UInt32 const The width of the picture.

UInt32 CP_OSPicture::Height  )  const
 

Returns the height of this picture.

Exceptions:
none 
Returns:
UInt32 const The height of the picture.

OSPicture CP_OSPicture::GetOSPicture  ) 
 

void CP_OSPicture::Draw CP_Canvas inDestCanvas,
const CP_Rect inBounds
 

Draw the picture into the passed in canvas object, and optionally scaling to fit the passed in bounds, if supported by the underlying OS.

Parameters:
inDestCanvas The canvas to draw the picture into.
inBounds The destination bounds to draw the picture into.
Exceptions:
none 
Returns:
void

void CP_OSPicture::SetupBitmap SInt16  inPictureID  )  [private]
 

Private Windows routine to load the bitmap image from the passed in resource id.

Parameters:
inPictureID Resource id of the picture to load.
Exceptions:
none 
Returns:
void


Member Data Documentation

OSPicture CP_OSPicture::fPicture [protected]
 


The documentation for this class was generated from the following files:
Generated on Sat Sep 17 20:01:55 2005 for CPLAT by  doxygen 1.4.0