PG_Image Class Reference

A static (non-resizeable by the end user) frame with image. More...

#include <pgimage.h>

Inheritance diagram for PG_Image:

[legend]List of all members.


Public Member Functions
	PG_Image (PG_Widget *parent, const PG_Point &p, const std::string &filename, PG_Draw::BkMode drawmode=PG_Draw::TILE, const std::string &style="ThemeWidget")
	Contructor of the PG_Image class (loading from file).
	PG_Image (PG_Widget parent, const PG_Point &p, SDL_Surface image, bool freeimage=true, PG_Draw::BkMode drawmode=PG_Draw::TILE, const std::string &style="ThemeWidget")
	Contructor of the PG_Image class (image from surface).
	PG_Image (PG_Widget *parent, const PG_Point &p, const std::string &filename, Uint32 colorkey, PG_Draw::BkMode drawmode=PG_Draw::TILE, const std::string &style="ThemeWidget")
	Contructor of the PG_Image class (loading from file).
void	SetColorKey (const PG_Color &key)
	Set the colorkey of the image.
void	SetDrawMode (PG_Draw::BkMode mode)
	@ Set mode of drawing (BKMODE_TILE \| BKMODE_STRETCH \| BKMODE_3TILEH \| BKMODE_3TILEV \| BKMODE_9TILE)
Uint8	GetDrawMode ()
bool	LoadImage (const std::string &filename)
	Display an image in the widget.
bool	LoadImage (const std::string &filename, const PG_Color &key)
	Display an image in the widget using a colorkey.
bool	SetImage (SDL_Surface *image, bool bFreeImage=true)
	Display an image in the widget.
	~PG_Image ()
Protected Member Functions
void	eventDraw (SDL_Surface *surface, const PG_Rect &rect)
	overridable eventhandler to draw the object surface
void	eventBlit (SDL_Surface *surface, const PG_Rect &src, const PG_Rect &dst)
	overridable eventhandler to blit the widget contents to the screen
Protected Attributes
SDL_Surface *	my_cachedSrf
PG_Draw::BkMode	my_DrawMode

Detailed Description

A static (non-resizeable by the end user) frame with image.

Author:: Jaroslav Vozab

Definition at line 44 of file pgimage.h.

Constructor & Destructor Documentation

PG_Image::PG_Image ( PG_Widget * parent,

const PG_Point & p,

const std::string & filename,

PG_Draw::BkMode drawmode = PG_Draw::TILE,

const std::string & style = "ThemeWidget"

)

Contructor of the PG_Image class (loading from file).
Creates the widget and loads the image from a file

Parameters:

parent pointer to the parent widget or NULL

p position of the PG_Image widget

filename image-file to load

drawmode Image drawmode (see PG_Draw::BkMode)

style widgetstyle to use

Definition at line 49 of file pgimage.cpp.
References LoadImage(), PG_ThemeWidget::my_image, PG_Widget::SizeWidget(), and PG_Draw::TILE.

PG_Image::PG_Image ( PG_Widget * parent,

const PG_Point & p,

SDL_Surface * image,

bool freeimage = true,

PG_Draw::BkMode drawmode = PG_Draw::TILE,

const std::string & style = "ThemeWidget"

)

Contructor of the PG_Image class (image from surface).
Creates the widget and loads the image from an SDL_Surface

Parameters:

parent pointer to the parent widget or NULL

p position of the PG_Image widget

image pointer to imagedata (SDL_Surface)

freeimage if true the imagedata is handled by the widget

drawmode Image drawmode (see PG_Draw::BkMode)

style widgetstyle to use

Definition at line 59 of file pgimage.cpp.
References PG_ThemeWidget::my_image, SetImage(), PG_Widget::SizeWidget(), and PG_Draw::TILE.

PG_Image::PG_Image ( PG_Widget * parent,

const PG_Point & p,

const std::string & filename,

Uint32 colorkey,

PG_Draw::BkMode drawmode = PG_Draw::TILE,

const std::string & style = "ThemeWidget"

)

Contructor of the PG_Image class (loading from file).
Creates the widget and loads the image from a file using a colorkey

Parameters:

parent pointer to the parent widget or NULL

p position of the PG_Image widget

filename image-file to load

colorkey colorkey (0xRRGGBB)

drawmode Image drawmode (see PG_Draw::BkMode)

style widgetstyle to use

Definition at line 41 of file pgimage.cpp.
References LoadImage(), PG_ThemeWidget::my_image, PG_Widget::SizeWidget(), and PG_Draw::TILE.

PG_Image::~PG_Image ( )

Definition at line 67 of file pgimage.cpp.
References PG_ThemeWidget::DeleteThemedSurface(), and my_cachedSrf.

Member Function Documentation

void PG_Image::eventBlit ( SDL_Surface * surface,

const PG_Rect & src,

const PG_Rect & dst

) [protected, virtual]

overridable eventhandler to blit the widget contents to the screen

Parameters:

surface pointer to SDL_Surface to be blitted

src source rectangle (client coordinates)

dst destination rectangle (screen coordinates) Override this eventhandler to perform custom blitting behaviour (without drawing onto the widget surface).

Reimplemented from PG_ThemeWidget.
Definition at line 73 of file pgimage.cpp.
References PG_ThemeWidget::CreateThemedSurface(), PG_Draw::DrawThemedSurface(), PG_Widget::eventBlit(), PG_Widget::GetClipRects(), PG_ThemeWidget::my_background, PG_ThemeWidget::my_blendLevel, my_cachedSrf, my_DrawMode, PG_Rect::my_height, PG_ThemeWidget::my_image, PG_Rect::my_width, PG_Rect::PG_Rect(), and PG_Draw::STRETCH.

void PG_Image::eventDraw ( SDL_Surface * surface,

const PG_Rect & rect

) [protected, virtual]

overridable eventhandler to draw the object surface

Parameters:

surface the widgets drawing surface.

rect rectangle to draw within. This eventhandler is called whenevener the widget contents should be redrawn.

Note:
Only widgets with drawing surfaces (see the constructor) will call this eventhandler.

Reimplemented from PG_ThemeWidget.
Definition at line 71 of file pgimage.cpp.

Uint8 PG_Image::GetDrawMode ( ) [inline]

Definition at line 102 of file pgimage.h.

bool PG_Image::LoadImage ( const std::string & filename,

const PG_Color & key

)

Display an image in the widget using a colorkey.

Parameters:

filename name of the image file to load

key the colorkey (0xRRGGBB)

Returns:
true on success With this function you can define an image with a colorkey to be displayed at the upper left corner of the widget. Image data will be erased when deleting the widget or loading / setting a new image.

Reimplemented from PG_ThemeWidget.
Definition at line 131 of file pgimage.cpp.
References PG_ThemeWidget::DeleteThemedSurface(), PG_ThemeWidget::LoadImage(), and my_cachedSrf.

bool PG_Image::LoadImage ( const std::string & filename )

Display an image in the widget.

Parameters:

filename name of the image file to load

Returns:
true on success With this function you can define an image to be displayed at the upper left corner of the widget. Image data will be erased when deleting the widget or loading / setting a new image.

Reimplemented from PG_ThemeWidget.
Definition at line 120 of file pgimage.cpp.
References PG_ThemeWidget::DeleteThemedSurface(), PG_ThemeWidget::LoadImage(), and my_cachedSrf.
Referenced by PG_Image().

void PG_Image::SetColorKey ( const PG_Color & key )

Set the colorkey of the image.

Parameters:

key colorkey (0xRRGGBB);

Definition at line 106 of file pgimage.cpp.
References PG_ThemeWidget::DeleteThemedSurface(), my_cachedSrf, and PG_ThemeWidget::my_image.

void PG_Image::SetDrawMode ( PG_Draw::BkMode mode )

@ Set mode of drawing (BKMODE_TILE | BKMODE_STRETCH | BKMODE_3TILEH | BKMODE_3TILEV | BKMODE_9TILE)

Definition at line 112 of file pgimage.cpp.
References PG_ThemeWidget::DeleteThemedSurface(), my_cachedSrf, and my_DrawMode.
Referenced by CargoDialog::CargoDialog(), and UnitInfoDialog::UnitInfoDialog().

bool PG_Image::SetImage ( SDL_Surface * image,

bool bFreeImage = true

)

Display an image in the widget.

Parameters:

image pointer to surface to display

bFreeImage true if the image should be freed by the widget (default = true)

Returns:
true on success With this function you can define an image to be displayed at the upper left corner of the widget.

Reimplemented from PG_ThemeWidget.
Definition at line 142 of file pgimage.cpp.
References PG_ThemeWidget::DeleteThemedSurface(), my_cachedSrf, and PG_ThemeWidget::SetImage().
Referenced by CargoDialog::CargoDialog(), PG_Image(), and UnitInfoDialog::UnitInfoDialog().

Member Data Documentation

SDL_Surface* PG_Image::my_cachedSrf [protected]

Definition at line 116 of file pgimage.h.
Referenced by eventBlit(), LoadImage(), SetColorKey(), SetDrawMode(), SetImage(), and ~PG_Image().

PG_Draw::BkMode PG_Image::my_DrawMode [protected]

Definition at line 118 of file pgimage.h.
Referenced by eventBlit(), and SetDrawMode().

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

Generated on Tue Jun 24 02:18:55 2008 for Advanced Strategic Command by

1.4.2

PG_Image Class Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation