Skin Class Reference

#include <skin.h>

List of all members.

---

Detailed Description

Definition at line 35 of file skin.h.

Public Member Functions
	Skin (ImageRect skin, Image *close, Image *stickyUp, Image *stickyDown, const std::string &filePath, const std::string &name="")
	~Skin ()
const std::string &	getName () const
	Returns the skin's name.
const std::string &	getFilePath () const
	Returns the skin's xml file path.
const ImageRect &	getBorder () const
	Returns the background skin.
Image *	getCloseImage () const
	Returns the image used by a close button for this skin.
Image *	getStickyImage (bool state) const
	Returns the image used by a sticky button for this skin.
int	getMinWidth () const
	Returns the minimum width which can be used with this skin.
int	getMinHeight () const
	Returns the minimum height which can be used with this skin.
void	updateAlpha ()
	Updates the alpha value of the skin.
Public Attributes
int	instances
Private Attributes
std::string	mFilePath
	File name path for the skin.
std::string	mName
	Name of the skin to use.
ImageRect	mBorder
	The window border and background.
Image *	mCloseImage
	Close Button Image.
Image *	mStickyImageUp
	Sticky Button Image.
Image *	mStickyImageDown
	Sticky Button Image.

---

Constructor & Destructor Documentation

Skin::Skin	(	ImageRect	skin,
		Image *	close,
		Image *	stickyUp,
		Image *	stickyDown,
		const std::string &	filePath,
		const std::string &	name = ""
	)

Definition at line 66 of file skin.cpp.

Skin::~Skin

(

)

Definition at line 79 of file skin.cpp.

---

Member Function Documentation

const std::string& Skin::getName

(

)

const [inline]

Returns the skin's name.

Useful for giving a human friendly skin name if a dialog for skin selection for a specific window type is done.

Definition at line 49 of file skin.h.

const std::string& Skin::getFilePath

(

)

const [inline]

Returns the skin's xml file path.

Definition at line 54 of file skin.h.

const ImageRect& Skin::getBorder

(

)

const [inline]

Returns the background skin.

Definition at line 59 of file skin.h.

Image* Skin::getCloseImage

(

)

const [inline]

Returns the image used by a close button for this skin.

Definition at line 64 of file skin.h.

Image* Skin::getStickyImage

(

bool

state

)

const [inline]

Returns the image used by a sticky button for this skin.

Definition at line 69 of file skin.h.

int Skin::getMinWidth

(

)

const

Returns the minimum width which can be used with this skin.

Definition at line 102 of file skin.cpp.

int Skin::getMinHeight

(

)

const

Returns the minimum height which can be used with this skin.

Definition at line 109 of file skin.cpp.

void Skin::updateAlpha

(

)

Updates the alpha value of the skin.

Definition at line 90 of file skin.cpp.

---

Member Data Documentation

int Skin::instances

Definition at line 87 of file skin.h.

std::string Skin::mFilePath [private]

File name path for the skin.

Definition at line 90 of file skin.h.

std::string Skin::mName [private]

Name of the skin to use.

Definition at line 91 of file skin.h.

ImageRect Skin::mBorder [private]

The window border and background.

Definition at line 92 of file skin.h.

Image* Skin::mCloseImage [private]

Close Button Image.

Definition at line 93 of file skin.h.

Image* Skin::mStickyImageUp [private]

Sticky Button Image.

Definition at line 94 of file skin.h.

Image* Skin::mStickyImageDown [private]

Sticky Button Image.

Definition at line 95 of file skin.h.

---

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

• tmw/src/gui/skin.h
• tmw/src/gui/skin.cpp