SCR_TabViewComponent.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_TabViewComponent

Typedefs
typedef func	ScriptInvokerTabViewMethod
typedef ScriptInvokerBase< ScriptInvokerTabViewMethod >	ScriptInvokerTabView
typedef func	ScriptInvokerTabViewIndexMethod
typedef ScriptInvokerBase< ScriptInvokerTabViewIndexMethod >	ScriptInvokerTabViewIndex
typedef func	ScriptInvokerTabViewContentIndexMethod
typedef ScriptInvokerBase< ScriptInvokerTabViewContentIndexMethod >	ScriptInvokerTabViewContentIndex

Functions
void	ScriptInvokerTabViewMethod (SCR_TabViewComponent tabView, Widget widget)
void	ScriptInvokerTabViewIndexMethod (SCR_TabViewComponent tabView, Widget widget, int index)
void	ScriptInvokerTabViewContentIndexMethod (SCR_TabViewComponent tabView, SCR_TabViewContent tabContent, int index)
SCR_TabViewComponent SCR_ScriptedWidgetComponent	BaseContainerProps ()
override void	HandlerAttached (Widget w)
void	Init ()
	initialization More...
override void	HandlerDeattached (Widget w)
void	CreateTab (SCR_TabViewContent content)
protected void	CreateIcon (SCR_TabViewContent content)
protected void	CreateTabContent (SCR_TabViewContent content, int index)
void	FocusFirstWidget (Widget w)
void	ShowIcon (int entry, bool show)
bool	IsIconShown (int entry)
Widget	GetEntryIcon (int entry)
SCR_TabViewContent	GetEntryContent (int index)
array< ref SCR_TabViewContent >	GetContents ()
protected void	SelectIndex (bool select, int i)
void	ShowTab (int i, bool callAction=true, bool playSound=true)
void	ShowTabByIdentifier (string identifier, bool callAction=true, bool playSound=true)
int	GetShownTab ()
int	GetTabCount ()
void	AddTab (ResourceName layout, string content, bool enabled=true, ResourceName tabImage=string.Empty, ResourceName iconLayout=string.Empty, float width=32, float height=32, string contentParam1=string.Empty, string contentParam2=string.Empty, string identifier=string.Empty)
void	RemoveTab (int index)
void	RemoveTabByIdentifier (string identifier)
void	AddContentElement (SCR_TabViewContent content)
void	ShowTabText (int index, bool show, int buttonWidth=-1)
void	ShowAllTabsText (bool show, int buttonWidth=-1, bool ignoreSelected=true)
void	SetTabText (int index, string text, string textParam1=string.Empty, string textParam2=string.Empty)
void	SetTabImage (int index, ResourceName tabImage)
void	ShowImage (int index, bool show)
protected void	OnSelection (SCR_ButtonBaseComponent button)
protected void	OnTabButtonToggle (SCR_ButtonBaseComponent button, bool isToggled)
protected void	OnTabLeft ()
protected void	OnTabRight ()
protected void	UpdatePagingButtons (bool animate=true)
	Enable or disable paging buttons, if it's possible to page to the right or left. More...
int	GetNextValidItem (bool toLeft)
void	EnableTab (int tabIndex, bool enable, bool animate=true)
void	EnableAllTabs (bool enable, bool ignoreCurrentActive=true, bool animate=true)
void	SetTabVisible (int tabIndex, bool visible, bool animate=true)
void	Enable (bool enable)
bool	IsTabEnabled (int tabIndex)
void	SetCanNavigate (bool isAllowed)
bool	GetCanNavigate ()
void	SetListenToActions (bool isAllowed)
bool	GetListenToActions ()
protected void	AddActionListeners ()
protected void	RemoveActionListeners ()
SCR_TabViewContent	GetShownTabComponent ()
void	SetEntryIconSize (int index, float width=-1, float height=-1)
void	SetPagingButtonsVisible (bool visible, bool animate=true)
ScriptInvokerTabViewIndex	GetOnChanged ()
ScriptInvokerTabViewIndex	GetOnContentCreate ()
ScriptInvokerTabView	GetOnContentShow ()
ScriptInvokerTabView	GetOnContentHide ()
ScriptInvokerTabView	GetOnContentRemove ()
ScriptInvokerTabView	GetOnTabChange ()
ScriptInvokerTabViewContentIndex	GetOnContentSelect ()
SCR_TabViewComponent SCR_ScriptedWidgetComponent	SCR_BaseContainerLocalizedTitleField ("m_sTabButtonContent")

Variables
protected ref array< ref SCR_TabViewContent >	m_aElements
int	m_iSelectedTab
ref Color	m_ColorBackground
bool	m_bKeepHiddenTabs
bool	m_bCreateAllTabsAtStart
bool	m_bManualInit
bool	m_bCycleMode
ResourceName	m_TabLayout
protected bool	m_ListenToActions
string	m_sActionLeft
string	m_sActionRight
float	m_fTabWidth
float	m_fTabWidthTextHidden
protected string	m_sSwitchSound
protected bool	m_bShowTextOnlyWhenSelectedTab
protected Widget	m_wButtons
protected Widget	m_wButtonBar
protected Widget	m_wContentOverlay
protected SCR_PagingButtonComponent	m_PagingLeft
protected SCR_PagingButtonComponent	m_PagingRight
protected ref ScriptInvokerTabViewIndex	m_OnChanged
protected ref ScriptInvokerTabViewIndex	m_OnContentCreate
protected ref ScriptInvokerTabView	m_OnContentShow
protected ref ScriptInvokerTabView	m_OnContentHide
protected ref ScriptInvokerTabView	m_OnContentRemove
protected ref ScriptInvokerTabView	m_OnTabChange
protected ref ScriptInvokerTabViewContentIndex	m_OnContentSelect
const protected float	BUTTON_PADDING_RIGHT = 4

Typedef Documentation

ScriptInvokerTabView

typedef ScriptInvokerBase<ScriptInvokerTabViewMethod> ScriptInvokerTabView

Definition at line 3 of file SCR_TabViewComponent.c.

ScriptInvokerTabViewContentIndex

typedef ScriptInvokerBase<ScriptInvokerTabViewContentIndexMethod> ScriptInvokerTabViewContentIndex

Definition at line 11 of file SCR_TabViewComponent.c.

ScriptInvokerTabViewContentIndexMethod

typedef func ScriptInvokerTabViewContentIndexMethod

Definition at line 10 of file SCR_TabViewComponent.c.

ScriptInvokerTabViewIndex

typedef ScriptInvokerBase<ScriptInvokerTabViewIndexMethod> ScriptInvokerTabViewIndex

Definition at line 7 of file SCR_TabViewComponent.c.

ScriptInvokerTabViewIndexMethod

typedef func ScriptInvokerTabViewIndexMethod

Definition at line 6 of file SCR_TabViewComponent.c.

ScriptInvokerTabViewMethod

typedef func ScriptInvokerTabViewMethod

Definition at line 2 of file SCR_TabViewComponent.c.

Function Documentation

AddActionListeners()

protected void BaseContainerProps::AddActionListeners

(

)

Definition at line 846 of file SCR_TabViewComponent.c.

AddContentElement()

void BaseContainerProps::AddContentElement

(

SCR_TabViewContent

content

)

Definition at line 532 of file SCR_TabViewComponent.c.

AddTab()

void BaseContainerProps::AddTab	(	ResourceName	layout,
		string	content,
		bool	enabled = true,
		ResourceName	tabImage = string.Empty,
		ResourceName	iconLayout = string.Empty,
		float	width = 32,
		float	height = 32,
		string	contentParam1 = string.Empty,
		string	contentParam2 = string.Empty,
		string	identifier = string.Empty
	)

Definition at line 438 of file SCR_TabViewComponent.c.

BaseContainerProps()

SCR_TabViewComponent SCR_ScriptedWidgetComponent BaseContainerProps

(

)

CreateIcon()

protected void BaseContainerProps::CreateIcon

(

SCR_TabViewContent

content

)

Definition at line 191 of file SCR_TabViewComponent.c.

CreateTab()

void BaseContainerProps::CreateTab

(

SCR_TabViewContent

content

)

Definition at line 137 of file SCR_TabViewComponent.c.

CreateTabContent()

protected void BaseContainerProps::CreateTabContent	(	SCR_TabViewContent	content,
		int	index
	)

Definition at line 217 of file SCR_TabViewComponent.c.

Enable()

void BaseContainerProps::Enable

(

bool

enable

)

Definition at line 806 of file SCR_TabViewComponent.c.

EnableAllTabs()

void BaseContainerProps::EnableAllTabs	(	bool	enable,
		bool	ignoreCurrentActive = true,
		bool	animate = true
	)

Definition at line 757 of file SCR_TabViewComponent.c.

EnableTab()

void BaseContainerProps::EnableTab	(	int	tabIndex,
		bool	enable,
		bool	animate = true
	)

Definition at line 738 of file SCR_TabViewComponent.c.

FocusFirstWidget()

void BaseContainerProps::FocusFirstWidget

(

Widget

w

)

Definition at line 255 of file SCR_TabViewComponent.c.

GetCanNavigate()

bool BaseContainerProps::GetCanNavigate

(

)

Definition at line 828 of file SCR_TabViewComponent.c.

GetContents()

array<ref SCR_TabViewContent> BaseContainerProps::GetContents

(

)

Definition at line 316 of file SCR_TabViewComponent.c.

GetEntryContent()

SCR_TabViewContent BaseContainerProps::GetEntryContent

(

int

index

)

Definition at line 307 of file SCR_TabViewComponent.c.

GetEntryIcon()

Widget BaseContainerProps::GetEntryIcon

(

int

entry

)

Definition at line 298 of file SCR_TabViewComponent.c.

GetListenToActions()

bool BaseContainerProps::GetListenToActions

(

)

Definition at line 840 of file SCR_TabViewComponent.c.

GetNextValidItem()

int BaseContainerProps::GetNextValidItem

(

bool

toLeft

)

Definition at line 695 of file SCR_TabViewComponent.c.

GetOnChanged()

ScriptInvokerTabViewIndex BaseContainerProps::GetOnChanged

(

)

Definition at line 896 of file SCR_TabViewComponent.c.

GetOnContentCreate()

ScriptInvokerTabViewIndex BaseContainerProps::GetOnContentCreate

(

)

Definition at line 905 of file SCR_TabViewComponent.c.

GetOnContentHide()

ScriptInvokerTabView BaseContainerProps::GetOnContentHide

(

)

Definition at line 923 of file SCR_TabViewComponent.c.

GetOnContentRemove()

ScriptInvokerTabView BaseContainerProps::GetOnContentRemove

(

)

Definition at line 932 of file SCR_TabViewComponent.c.

GetOnContentSelect()

ScriptInvokerTabViewContentIndex BaseContainerProps::GetOnContentSelect

(

)

Definition at line 950 of file SCR_TabViewComponent.c.

GetOnContentShow()

ScriptInvokerTabView BaseContainerProps::GetOnContentShow

(

)

Definition at line 914 of file SCR_TabViewComponent.c.

GetOnTabChange()

ScriptInvokerTabView BaseContainerProps::GetOnTabChange

(

)

Definition at line 941 of file SCR_TabViewComponent.c.

GetShownTab()

int BaseContainerProps::GetShownTab

(

)

Definition at line 426 of file SCR_TabViewComponent.c.

GetShownTabComponent()

SCR_TabViewContent BaseContainerProps::GetShownTabComponent

(

)

Definition at line 865 of file SCR_TabViewComponent.c.

GetTabCount()

int BaseContainerProps::GetTabCount

(

)

Definition at line 432 of file SCR_TabViewComponent.c.

HandlerAttached()

override void BaseContainerProps::HandlerAttached

(

Widget

w

)

Definition at line 78 of file SCR_TabViewComponent.c.

HandlerDeattached()

override void BaseContainerProps::HandlerDeattached

(

Widget

w

)

Definition at line 130 of file SCR_TabViewComponent.c.

IsIconShown()

bool BaseContainerProps::IsIconShown

(

int

entry

)

Definition at line 285 of file SCR_TabViewComponent.c.

IsTabEnabled()

bool BaseContainerProps::IsTabEnabled

(

int

tabIndex

)

Definition at line 813 of file SCR_TabViewComponent.c.

OnSelection()

protected void BaseContainerProps::OnSelection

(

SCR_ButtonBaseComponent

button

)

Definition at line 629 of file SCR_TabViewComponent.c.

OnTabButtonToggle()

protected void BaseContainerProps::OnTabButtonToggle	(	SCR_ButtonBaseComponent	button,
		bool	isToggled
	)

React to button toggle and propagete state to modular button This is simplest way in current state but should be changed to not really on tab view forcing the state

Definition at line 652 of file SCR_TabViewComponent.c.

OnTabLeft()

protected void BaseContainerProps::OnTabLeft

(

)

Definition at line 663 of file SCR_TabViewComponent.c.

OnTabRight()

protected void BaseContainerProps::OnTabRight

(

)

Definition at line 674 of file SCR_TabViewComponent.c.

RemoveActionListeners()

protected void BaseContainerProps::RemoveActionListeners

(

)

Definition at line 856 of file SCR_TabViewComponent.c.

RemoveTab()

void BaseContainerProps::RemoveTab

(

int

index

)

Definition at line 478 of file SCR_TabViewComponent.c.

RemoveTabByIdentifier()

void BaseContainerProps::RemoveTabByIdentifier

(

string

identifier

)

Definition at line 519 of file SCR_TabViewComponent.c.

SCR_BaseContainerLocalizedTitleField()

SCR_TabViewComponent SCR_ScriptedWidgetComponent SCR_BaseContainerLocalizedTitleField

(

"m_sTabButtonContent"

)

Definition at line 963 of file SCR_TabViewComponent.c.

ScriptInvokerTabViewContentIndexMethod()

void ScriptInvokerTabViewContentIndexMethod	(	SCR_TabViewComponent	tabView,
		SCR_TabViewContent	tabContent,
		int	index
	)

ScriptInvokerTabViewIndexMethod()

void ScriptInvokerTabViewIndexMethod	(	SCR_TabViewComponent	tabView,
		Widget	widget,
		int	index
	)

ScriptInvokerTabViewMethod()

void ScriptInvokerTabViewMethod	(	SCR_TabViewComponent	tabView,
		Widget	widget
	)

SelectIndex()

protected void BaseContainerProps::SelectIndex	(	bool	select,
		int	i
	)

Definition at line 322 of file SCR_TabViewComponent.c.

SetCanNavigate()

void BaseContainerProps::SetCanNavigate

(

bool

isAllowed

)

Definition at line 822 of file SCR_TabViewComponent.c.

SetEntryIconSize()

void BaseContainerProps::SetEntryIconSize	(	int	index,
		float	width = -1,
		float	height = -1
	)

Definition at line 871 of file SCR_TabViewComponent.c.

SetListenToActions()

void BaseContainerProps::SetListenToActions

(

bool

isAllowed

)

Definition at line 834 of file SCR_TabViewComponent.c.

SetPagingButtonsVisible()

void BaseContainerProps::SetPagingButtonsVisible	(	bool	visible,
		bool	animate = true
	)

Definition at line 884 of file SCR_TabViewComponent.c.

SetTabImage()

void BaseContainerProps::SetTabImage	(	int	index,
		ResourceName	tabImage
	)

Definition at line 589 of file SCR_TabViewComponent.c.

SetTabText()

void BaseContainerProps::SetTabText	(	int	index,
		string	text,
		string	textParam1 = string.Empty,
		string	textParam2 = string.Empty
	)

Definition at line 576 of file SCR_TabViewComponent.c.

SetTabVisible()

void BaseContainerProps::SetTabVisible	(	int	tabIndex,
		bool	visible,
		bool	animate = true
	)

Definition at line 771 of file SCR_TabViewComponent.c.

ShowAllTabsText()

void BaseContainerProps::ShowAllTabsText	(	bool	show,
		int	buttonWidth = -1,
		bool	ignoreSelected = true
	)

Definition at line 556 of file SCR_TabViewComponent.c.

ShowIcon()

void BaseContainerProps::ShowIcon	(	int	entry,
		bool	show
	)

Definition at line 272 of file SCR_TabViewComponent.c.

ShowImage()

void BaseContainerProps::ShowImage	(	int	index,
		bool	show
	)

Definition at line 612 of file SCR_TabViewComponent.c.

ShowTab()

void BaseContainerProps::ShowTab	(	int	i,
		bool	callAction = true,
		bool	playSound = true
	)

Definition at line 383 of file SCR_TabViewComponent.c.

ShowTabByIdentifier()

void BaseContainerProps::ShowTabByIdentifier	(	string	identifier,
		bool	callAction = true,
		bool	playSound = true
	)

Definition at line 413 of file SCR_TabViewComponent.c.

ShowTabText()

void BaseContainerProps::ShowTabText	(	int	index,
		bool	show,
		int	buttonWidth = -1
	)

Definition at line 538 of file SCR_TabViewComponent.c.

UpdatePagingButtons()

protected void BaseContainerProps::UpdatePagingButtons

(

bool

animate = true

)

Enable or disable paging buttons, if it's possible to page to the right or left.

Definition at line 686 of file SCR_TabViewComponent.c.

Variable Documentation

BUTTON_PADDING_RIGHT

const protected float BUTTON_PADDING_RIGHT = 4

Definition at line 75 of file SCR_TabViewComponent.c.

m_aElements

protected ref array<ref SCR_TabViewContent> m_aElements

Definition at line 13 of file SCR_TabViewComponent.c.

m_bCreateAllTabsAtStart

bool m_bCreateAllTabsAtStart

Definition at line 25 of file SCR_TabViewComponent.c.

m_bCycleMode

bool m_bCycleMode

Definition at line 31 of file SCR_TabViewComponent.c.

m_bKeepHiddenTabs

bool m_bKeepHiddenTabs

Definition at line 22 of file SCR_TabViewComponent.c.

m_bManualInit

bool m_bManualInit

Definition at line 28 of file SCR_TabViewComponent.c.

m_bShowTextOnlyWhenSelectedTab

protected bool m_bShowTextOnlyWhenSelectedTab

Definition at line 55 of file SCR_TabViewComponent.c.

m_ColorBackground

ref Color m_ColorBackground

Definition at line 19 of file SCR_TabViewComponent.c.

m_fTabWidth

float m_fTabWidth

Definition at line 46 of file SCR_TabViewComponent.c.

m_fTabWidthTextHidden

float m_fTabWidthTextHidden

Definition at line 49 of file SCR_TabViewComponent.c.

m_iSelectedTab

int m_iSelectedTab

Definition at line 16 of file SCR_TabViewComponent.c.

m_ListenToActions

protected bool m_ListenToActions

Definition at line 37 of file SCR_TabViewComponent.c.

m_OnChanged

protected ref ScriptInvokerTabViewIndex m_OnChanged

Definition at line 64 of file SCR_TabViewComponent.c.

m_OnContentCreate

protected ref ScriptInvokerTabViewIndex m_OnContentCreate

Definition at line 65 of file SCR_TabViewComponent.c.

m_OnContentHide

protected ref ScriptInvokerTabView m_OnContentHide

Definition at line 68 of file SCR_TabViewComponent.c.

m_OnContentRemove

protected ref ScriptInvokerTabView m_OnContentRemove

Definition at line 69 of file SCR_TabViewComponent.c.

m_OnContentSelect

protected ref ScriptInvokerTabViewContentIndex m_OnContentSelect

Definition at line 73 of file SCR_TabViewComponent.c.

m_OnContentShow

protected ref ScriptInvokerTabView m_OnContentShow

Definition at line 67 of file SCR_TabViewComponent.c.

m_OnTabChange

protected ref ScriptInvokerTabView m_OnTabChange

Definition at line 70 of file SCR_TabViewComponent.c.

m_PagingLeft

protected SCR_PagingButtonComponent m_PagingLeft

Definition at line 60 of file SCR_TabViewComponent.c.

m_PagingRight

protected SCR_PagingButtonComponent m_PagingRight

Definition at line 61 of file SCR_TabViewComponent.c.

m_sActionLeft

string m_sActionLeft

Definition at line 40 of file SCR_TabViewComponent.c.

m_sActionRight

string m_sActionRight

Definition at line 43 of file SCR_TabViewComponent.c.

m_sSwitchSound

protected string m_sSwitchSound

Definition at line 52 of file SCR_TabViewComponent.c.

m_TabLayout

ResourceName m_TabLayout

Definition at line 34 of file SCR_TabViewComponent.c.

m_wButtonBar

protected Widget m_wButtonBar

Definition at line 58 of file SCR_TabViewComponent.c.

m_wButtons

protected Widget m_wButtons

Definition at line 57 of file SCR_TabViewComponent.c.

m_wContentOverlay

protected Widget m_wContentOverlay

Definition at line 59 of file SCR_TabViewComponent.c.