CascadePictureWidget Class Reference

a widget that holds a picture More...

#include <cascade/widgets/CascadePictureWidget.h>

Inheritance diagram for CascadePictureWidget:

List of all members.

Public Member Functions
	CascadePictureWidget ()
virtual	~CascadePictureWidget ()
virtual bool	LoadPictureFromBitmap (const CascadeBitmap &bitmap, CascadeBitmap::RamType ramType=CascadeBitmap::kEither)
virtual bool	LoadPictureFromBitmapFile (CascadeFile &bitmapFile, CascadeBitmap::RamType ramType=CascadeBitmap::kEither)
virtual void	OnPaint (CascadeBitmap &bitmap)
virtual bool	WillAcceptFocus ()
Protected Attributes
CascadeBitmap	m_bitmap
bool	m_bLoaded

---

Detailed Description

a widget that holds a picture

Skip the description

CascadePictureWidget is a widget that holds a picture.

---

class CascadePictureWidget

---

Constructor & Destructor Documentation

CascadePictureWidget::CascadePictureWidget (   )

The CascadePictureWidget constructor - lightweight. This constructor is lightweight.

virtual CascadePictureWidget::~CascadePictureWidget (   )  [virtual]

Destructor. The destructor.

---

Member Function Documentation

virtual bool CascadePictureWidget::LoadPictureFromBitmap (  const CascadeBitmap &  bitmap, CascadeBitmap::RamType  ramType = CascadeBitmap::kEither )  [virtual]

loads a picture widget's bitmap up from an existing bitmap LoadPictureFromBitmap() blits the picture out of bitmap into CascadePictureWidget's newly created m_bitmap returning true if successful, false otherwise. If LoadPictureFromBitmap() is called twice, the first bitmap is overwritten (destroyed and recreated in the new size if necessary). Parameters: bitmap  the bitmap to use ramType  the type of ram to use for m_bitmap allocation Returns: whether or not the load succeeded See also: LoadPictureFromBitmapFile() CascadeBitmap, CascadeBitmap::RamType

virtual bool CascadePictureWidget::LoadPictureFromBitmapFile (  CascadeFile &  bitmapFile, CascadeBitmap::RamType  ramType = CascadeBitmap::kEither )  [virtual]

loads a picture widget's bitmap up from an existing bitmap LoadPictureFromBitmapFile() loads the picture from the bitmap file identified by bitmapFile returning true if successful, false otherwise. If LoadPictureFromBitmap() is called twice, the first bitmap is overwritten (destroyed and recreated in the new size if necessary). Parameters: bitmapFile  the bitmap file to load ramType  the type of ram to use for m_bitmap allocation Returns: whether or not the load succeeded See also: LoadPictureFromBitmap() CascadeBitmap, CascadeBitmap::RamType

virtual void CascadePictureWidget::OnPaint (  CascadeBitmap &  bitmap  )  [virtual]

paints the picture widget OnPaint() provides painting for the picture widget Reimplemented from CascadeWindow.

virtual bool CascadePictureWidget::WillAcceptFocus (   )  [inline, virtual]

overridden to refuse focus WillAcceptFocus() is overridden so the picture widget will not accept (refuse) focus. Reimplemented from CascadeWidget.

---

Member Data Documentation

CascadeBitmap CascadePictureWidget::m_bitmap [protected]

the bitmap of the widget m_bitmap is the bitmap the picture widget uses for rendering

bool CascadePictureWidget::m_bLoaded [protected]

whether or not the bitmap has been successfully loaded (initialized) m_bLoaded specifies whether or not m_bitmap is a valid bitmap

---

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

• CascadePictureWidget.h

---