SCR_ContentEntryComponent Interface Reference

Base component for widgets displaying content data. More...

Inheritance diagram for SCR_ContentEntryComponent:

Public Member Functions
override void	HandlerAttached (Widget w)
void	SetLabelText (string str)
void	SetDescriptionText (string str)
void	SetThumbnail (ResourceName image)
Public Member Functions inherited from SCR_ButtonBaseComponent
override void	HandlerAttached (Widget w)
override bool	OnClick (Widget w, int x, int y, int button)
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)
override bool	OnFocus (Widget w, int x, int y)
override bool	OnFocusLost (Widget w, int x, int y)
void	SetToggled (bool toggled, bool animate=true, bool invokeChange=true, bool instant=false)
bool	IsToggled ()
void	SetToggleable (bool togglable)
bool	GetToggleable ()
void	ShowBorder (bool show, bool animate=true)
bool	IsBorderShown ()
void	SetBackgroundColors (Color defColor=null, Color hoverColor=null, Color selectColor=null, Color selectHoverColor=null, Color clickColor=null)
	Alternate way of setting button background colors through script.
void	ColorizeBackground (bool animate=true)
Public Member Functions inherited from SCR_WLibComponentBase
override void	HandlerAttached (Widget w)
override bool	OnClick (Widget w, int x, int y, int button)
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnFocus (Widget w, int x, int y)
void	SetHoverSound (string soundHover)
void	SetClickedSound (string soundClicked)
string	GetHoverSound ()
string	GetClickedSound ()
void	SetEnabled (bool enabled, bool animate=true)
void	SetVisible (bool visible, bool animate=true)
bool	IsEnabled ()
void	SetMouseOverToFocus (bool mouseOverToFocus)
void	SetDisabledOpacity (float newDisabledOpacity)
Public Member Functions inherited from SCR_ScriptedWidgetComponent
override void	HandlerAttached (Widget w)
override bool	OnClick (Widget w, int x, int y, int button)
Widget	GetRootWidget ()
bool	IsVisible ()

Static Public Attributes
const string	WIDGET_IMAGE_THUMBNAIL = "ImgThumbnail"
const string	WIDGET_TEXT_LABEL = "TxtLabel"
const string	WIDGET_TEXT_DESCRIPTION = "TxtDescription"
const string	WIDGET_BTN_DOWNLOAD = "BtnDownload"
Static Public Attributes inherited from SCR_WLibComponentBase
static const float	START_ANIMATION_RATE = 10001
static const float	START_ANIMATION_PERIOD = 250

Protected Member Functions
void	SetTextSafe (TextWidget txt, string str)
	Just simple on line text setting.
Protected Member Functions inherited from SCR_ButtonBaseComponent
void	OnMenuSelect ()
void	MenuSelectBase ()
void	FindParentMenu ()
	Finds the parent menu of this component.
bool	IsParentMenuFocused ()
	Returns true if parent menu is focused, or if there is no parent menu.
Protected Member Functions inherited from SCR_WLibComponentBase
void	OnEnabled (bool animate)
void	OnDisabled (bool animate)
bool	IsChildWidget (Widget parent, Widget child)
void	SetAnimationRate ()
void	PlaySound (string sound)

Protected Attributes
ImageWidget	m_wImgThumbnail
TextWidget	m_wTxtLabel
TextWidget	m_wTxtDescription
Protected Attributes inherited from SCR_ButtonBaseComponent
bool	m_bIsToggled
MenuBase	m_ParentMenu
SCR_SubMenuBase	m_ParentSubMenu
Protected Attributes inherited from SCR_WLibComponentBase
string	m_sSoundHovered
string	m_sSoundClicked
float	m_fAnimationTime
bool	m_bMouseOverToFocus
float	m_fDisabledOpacity
float	m_fAnimationRate
Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Additional Inherited Members
Static Public Member Functions inherited from SCR_ButtonBaseComponent
static SCR_ButtonBaseComponent	GetButtonBase (string name, Widget parent, bool searchAllChildren=true)
Static Public Member Functions inherited from SCR_WLibComponentBase
static bool	SetTexture (ImageWidget widget, ResourceName texture, string image="")
Static Public Member Functions inherited from SCR_ScriptedWidgetComponent
static SCR_ScriptedWidgetComponent	GetComponent (TypeName componentType, string name, Widget parent, bool searchAllChildren=true)
	Base method for component lookup through the widget library.
Public Attributes inherited from SCR_ButtonBaseComponent
bool	m_bCanBeToggled
bool	m_bUseColorization
ref Color	m_BackgroundDefault
ref Color	m_BackgroundHovered
ref Color	m_BackgroundSelected
ref Color	m_BackgroundSelectedHovered
ref Color	m_BackgroundClicked
bool	m_bShowBorderOnFocus
bool	m_bShowBackgroundOnFocus
bool	m_bNoBorderAnimation
bool	m_bNoBackgroundAnimation
bool	m_bShowBorderOnHover
Widget	m_wBackground
Widget	m_wBorder
ref ScriptInvoker	m_OnClicked = new ScriptInvoker()
ref ScriptInvoker	m_OnToggled = new ScriptInvoker()
ref ScriptInvoker< Widget >	m_OnFocus = new ScriptInvoker<Widget>()
ref ScriptInvoker< Widget >	m_OnFocusLost = new ScriptInvoker<Widget>()
ref ScriptInvoker	m_OnShowBorder = new ScriptInvoker()
Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Detailed Description

Base component for widgets displaying content data.

Member Function Documentation

HandlerAttached()

override void SCR_ContentEntryComponent.HandlerAttached

(

Widget

w

)

Implements SCR_ButtonBaseComponent.

Implemented in SCR_ModEntryComponent.

SetDescriptionText()

void SCR_ContentEntryComponent.SetDescriptionText

(

string

str

)

SetLabelText()

void SCR_ContentEntryComponent.SetLabelText

(

string

str

)

SetTextSafe()

void SCR_ContentEntryComponent.SetTextSafe ( TextWidget  txt, string  str  )

protected

Just simple on line text setting.

SetThumbnail()

void SCR_ContentEntryComponent.SetThumbnail

(

ResourceName

image

)

Member Data Documentation

m_wImgThumbnail

ImageWidget SCR_ContentEntryComponent.m_wImgThumbnail

protected

m_wTxtDescription

TextWidget SCR_ContentEntryComponent.m_wTxtDescription

protected

m_wTxtLabel

TextWidget SCR_ContentEntryComponent.m_wTxtLabel

protected

WIDGET_BTN_DOWNLOAD

const string SCR_ContentEntryComponent.WIDGET_BTN_DOWNLOAD = "BtnDownload"

static

WIDGET_IMAGE_THUMBNAIL

const string SCR_ContentEntryComponent.WIDGET_IMAGE_THUMBNAIL = "ImgThumbnail"

static

WIDGET_TEXT_DESCRIPTION

const string SCR_ContentEntryComponent.WIDGET_TEXT_DESCRIPTION = "TxtDescription"

static

WIDGET_TEXT_LABEL

const string SCR_ContentEntryComponent.WIDGET_TEXT_LABEL = "TxtLabel"

static

---

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

• Game/UI/Menu/ContentBrowser/Deprecated/SCR_ContentEntryComponent.c