UI info class with setter functions. More...

Inheritance diagram for SCR_OverridableUIInfo:

Public Member Functions
override void	SetName (LocalizedString name)
	Set info name.

override void	SetDescription (LocalizedString description)
	Set info description.

void	SetIcon (string icon)
	Set info icon.

void	SetIconSetName (string iconSetName)
	Set info icon set name.

Public Member Functions inherited from SCR_UIInfo
ResourceName	GetIconPath ()
	Get icon.

ResourceName	GetImageSetPath ()
	Get Image Set.

string	GetIconSetName ()
	Returns Icon Set name if imageset.

bool	HasIcon ()
	Check if the info has an icon defined.

bool	SetIconTo (ImageWidget imageWidget)
	Set icon to given image widget.

override void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)

Public Member Functions inherited from SCR_UIDescription
LocalizedString	GetUnformattedDescription ()
	Get the unformatted description from SCR_HintUIInfo instance.

LocalizedString	GetDescription ()
	Get description.

bool	HasDescription ()
	Check if the info has a description defined.

bool	SetDescriptionTo (TextWidget textWidget)
	Set description to given text widget.

Public Member Functions inherited from SCR_UIName
LocalizedString	GetUnformattedName ()
	Get The unformatted Name from SCR_HintUIInfo instance.

LocalizedString	GetName ()
	Get name.

bool	HasName ()
	Check if the info has a name defined.

bool	SetNameTo (TextWidget textWidget)
	Set name to given text widget.

Additional Inherited Members
Static Public Member Functions inherited from SCR_UIInfo
static SCR_UIInfo	GetInfo (BaseContainer source, string varName)
	Get UIInfo from a source object.

static SCR_UIInfo	CreateInfo (UIInfo source)
	Create SCR_UIInfo from engine UIInfo.

static SCR_UIInfo	CreateInfo (LocalizedString name, LocalizedString description=LocalizedString.Empty, ResourceName icon=ResourceName.Empty, string iconSetName=string.Empty)
	Create SCR_UIInfo from basic params.

static SCR_UIInfo	CreatePlaceholderInfo (TypeName type)
	Get placeholder info.

Protected Member Functions inherited from SCR_UIInfo
override void	CopyFrom (SCR_UIName source)

Protected Attributes inherited from SCR_UIInfo
ResourceName	Icon

string	IconSetName

Protected Attributes inherited from SCR_UIDescription
LocalizedString	Description

Protected Attributes inherited from SCR_UIName
LocalizedString	Name

Detailed Description

UI info class with setter functions.

Use at own risk!

Member Function Documentation

override void SCR_OverridableUIInfo.SetDescription ( LocalizedString description )

Set info description.

Parameters

description New description

void SCR_OverridableUIInfo.SetIcon ( string icon )

Set info icon.

Parameters

icon	New icon path

void SCR_OverridableUIInfo.SetIconSetName ( string iconSetName )

Set info icon set name.

Parameters

iconSetName New icon set name

override void SCR_OverridableUIInfo.SetName ( LocalizedString name )

Set info name.

Parameters

name New name

Implements SCR_UIName.

The documentation for this interface was generated from the following file: