UTFWin::IButtonDrawable class
#include <Spore ModAPI/Spore/UTFWin/IButton.h>

This class is a type of UTFWin::IDrawable capable of rendering an UTFWin::IButton.

Base classes

class UTFWinObject

Derived classes

class ButtonDrawableRadio
The standard IDrawable for a standard, simple radio or checkbox button component.
class ButtonDrawableStandard
The standard IDrawable for a standard, simple button component.

Public static variables

static const uint32_t TYPE

Public functions

auto ToDrawable() -> IDrawable* pure virtual
Get the IDrawable instance that represents this class.
auto SetImage(Image* pImage, bool bTileable) -> void pure virtual
Set the image used by this drawable.

Function documentation

void UTFWin::IButtonDrawable::SetImage(Image* pImage, bool bTileable) pure virtual

Set the image used by this drawable.

Parameters
pImage The image to use in this drawable.
bTileable Specifies whether the image should be edge tiled.

The image must be composed of 4 or 6 different images of the same dimensions, that represent different states. For standard buttons: Disabled | Normal | Highlighted | Depressed. For radio buttons: Normal | Highlighted | Depressed | Selected | Selected Highlighted | Selected Depressed.