MFC Grid manual

CBackgroundImage Class Reference

This class is destined to store a backgound image with information that determines how is the image presented in the grid. More...

#include <Dapfor/GUI/BackgroundImage.h>

List of all members.


Public Types

enum  Mode { Center, Stretch, Scale }
 Transformation mode. More...

Public Member Functions

 CBackgroundImage ()
 constructor
 ~CBackgroundImage ()
 destructor
Set methods
void SetBitmap (CBitmap *image)
 Sets a new bitmap.
void SetOpacity (BYTE opacity)
 Sets opacity value.
void SetMode (Mode mode)
 Sets transformation mode.
Get methods
CBitmap * GetBitmap () const
 Gets the bitmap.
BYTE GetOpacity () const
 Gets opacity level.
Mode GetMode () const
 Gets transformation mode.

Detailed Description

This class is destined to store a backgound image with information that determines how is the image presented in the grid.

Example

Member Enumeration Documentation

enum Mode

Transformation mode.

Enumerator:
Center  Bitmap is centered in the grid.
Stretch  Bitmap is fitted to the grid's size.
Scale  Bitmap is cloned in the grid.


Member Function Documentation

void SetBitmap ( CBitmap *  image  ) 

Sets a new bitmap.

Parameters:
[in] image A new bitmap

void SetOpacity ( BYTE  opacity  ) 

Sets opacity value.

Parameters:
[in] opacity A new opacity level. 0..255; 0-opaque, 255-transparent.

void SetMode ( Mode  mode  ) 

Sets transformation mode.

Parameters:
[in] mode A new transformation mode

CBitmap * GetBitmap (  )  const

Gets the bitmap.

Returns:
Current bitmap

BYTE GetOpacity (  )  const

Gets opacity level.

Returns:
Value indicating opacity level. 0-opaque, 255-transparent.

CBackgroundImage::Mode GetMode (  )  const

Gets transformation mode.

Returns:
Current transformation mode