UTFWin::IDialogDrawable class

An abstract class that has the methods that a drawable for a dialog would require.

Base classes

class UTFWinObject

Derived classes

class DialogDrawable
The standard IDrawable for a dialog component.

Public types

enum (anonymous) { kImageBackground = 0, kImageTitleBar = 1, kImageBorderLeft = 2, kImageBorderRight = 3, kImageBorderTop = 4, kImageBorderBottom = 5, kImageBorderTopLeft = 6, kImageBorderTopRight = 7, kImageBorderBottomLeft = 8, kImageBorderBottomRight = 9 }

Public functions

auto ToDrawable() -> IDrawable* pure virtual
Get the IDrawable instance that represents this class.
void SetImage(int index, Image* image) pure virtual
Set the images used by this drawable.
auto GetBackgroundColor(Color& dst) const -> Color pure virtual
Gets the color used to fill the background.
void SetBackgroundColor(Color color) pure virtual
Sets the color used to fill the background.
auto GetBackgroundTiling(BackgroundTiling& dst) const -> BackgroundTiling pure virtual
Gets the tiling mode used to fill the background.
void SetBackgroundTiling(BackgroundTiling value) pure virtual
Sets the color used to fill the background.

Function documentation

void UTFWin::IDialogDrawable::SetImage(int index, Image* image) pure virtual

Set the images used by this drawable.

Parameters
index The index of the image to set.
image

The index is one of the AbstractDialogDrawable::kImage... values.

Color UTFWin::IDialogDrawable::GetBackgroundColor(Color& dst) const pure virtual

Gets the color used to fill the background.

Parameters
dst The Color where the value will be set.
Returns The background fill color.

void UTFWin::IDialogDrawable::SetBackgroundColor(Color color) pure virtual

Sets the color used to fill the background.

Parameters
color The new Color value.
Returns The background fill color.

BackgroundTiling UTFWin::IDialogDrawable::GetBackgroundTiling(BackgroundTiling& dst) const pure virtual

Gets the tiling mode used to fill the background.

Parameters
dst The BackgroundTiling where the value will be set.
Returns The background tiling mode.

void UTFWin::IDialogDrawable::SetBackgroundTiling(BackgroundTiling value) pure virtual

Sets the color used to fill the background.

Parameters
value The new tiling value, from the BackgroundTiling enum.
Returns The background tiling mode.