SCR_FormatedUIInfo Interface Reference

Inheritance diagram for SCR_FormatedUIInfo:

Public Member Functions
void	SetParams (string param1=string.Empty, string param2=string.Empty, string param3=string.Empty, string param4=string.Empty)
	Set the params used when getting and setting the Name using the UI Format.
void	GetParams (out string param1=string.Empty, out string param2=string.Empty, out string param3=string.Empty, out string param4=string.Empty)
	Get the params used when getting and setting the Name using the UI Format.
override LocalizedString	GetName ()
	Get name.
override bool	SetNameTo (TextWidget textWidget)
	Set name to given text widget.
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.
void	SetDescription (LocalizedString description)
	Change the 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.
void	SetName (LocalizedString name)
	Change the Name from SCR_HintUIInfo instance.
bool	HasName ()
	Check if the info has a name defined.

Protected Attributes
string	m_sParam1
string	m_sParam2
string	m_sParam3
string	m_sParam4
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

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)

Member Function Documentation

GetName()

override LocalizedString SCR_FormatedUIInfo.GetName

(

)

Get name.

When using it to fill TextWidget, use SetNameTo() if possible.

Returns

Name text

Implements SCR_UIName.

GetParams()

void SCR_FormatedUIInfo.GetParams	(	out string	param1 = string::Empty,
		out string	param2 = string::Empty,
		out string	param3 = string::Empty,
		out string	param4 = string::Empty )

Get the params used when getting and setting the Name using the UI Format.

Parameters

[out]	param1	First param
[out]	param2	Second param
[out]	param3	Third param
[out]	param4	Forth param

SetNameTo()

override bool SCR_FormatedUIInfo.SetNameTo

(

TextWidget

textWidget

)

Set name to given text widget.

When possible, use this function instead of retrieving the name using GetName() and setting it manually. Custom UI info classes may be using parameters which would not be applied otherwise.

Parameters

textWidget

Target text widget

Returns

True when the name was set

Implements SCR_UIName.

SetParams()

void SCR_FormatedUIInfo.SetParams	(	string	param1 = string::Empty,
		string	param2 = string::Empty,
		string	param3 = string::Empty,
		string	param4 = string::Empty )

Set the params used when getting and setting the Name using the UI Format.

Parameters

[in]	param1	First param
[in]	param2	Second param
[in]	param3	Third param
[in]	param4	Forth param

Member Data Documentation

m_sParam1

string SCR_FormatedUIInfo.m_sParam1

protected

m_sParam2

string SCR_FormatedUIInfo.m_sParam2

protected

m_sParam3

string SCR_FormatedUIInfo.m_sParam3

protected

m_sParam4

string SCR_FormatedUIInfo.m_sParam4

protected

---

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

• Game/Editor/Containers/UIInfo/SCR_FormatedUIInfo.c