Data class used to tell the UIKeyboardController which text objects should be scrolled though/activated by the mouse. More...

Collaboration diagram for UIKeyboardControllerContext:

[legend]

Public Member Functions
	UIKeyboardControllerContext (UIKeyboardControllerContextManager.UIKeyboardControllerContextName contextName, UIKeyboardControllerContextManager.UIKeyboardControllerContextName previousContextName, UITextController[] textControllers, int currentTextControllerIndex)

UITextController	GetCurrentTextController ()

void	IncrementIndexCount ()
	Change the selected text controller to be the next object. More...

void	DecrementIndexCount ()
	Change the selected text controller to be the previous object. More...

bool	IsTextControllerInContext (UITextController controller)
	Check if the provided UITextController is in this context. More...

bool	HasPreviouscontext ()
	This method makes the assumption that if the previous context name is the same as this context name, then there is no way to go back. More...

Public Attributes
UIKeyboardControllerContextManager.UIKeyboardControllerContextName	previousContextName

UIKeyboardControllerContextManager.UIKeyboardControllerContextName	contextName

UITextController []	textControllers

int	currentTextControllerIndex

Detailed Description

Data class used to tell the UIKeyboardController which text objects should be scrolled though/activated by the mouse.

Constructor & Destructor Documentation

◆ UIKeyboardControllerContext()

UIKeyboardControllerContext.UIKeyboardControllerContext	(	UIKeyboardControllerContextManager.UIKeyboardControllerContextName	contextName,
		UIKeyboardControllerContextManager.UIKeyboardControllerContextName	previousContextName,
		UITextController []	textControllers,
		int	currentTextControllerIndex
	)

Member Function Documentation

◆ DecrementIndexCount()

void UIKeyboardControllerContext.DecrementIndexCount ( )

Change the selected text controller to be the previous object.

◆ GetCurrentTextController()

UITextController UIKeyboardControllerContext.GetCurrentTextController ( )

Returns: The UITextController that is highlighted.

◆ HasPreviouscontext()

bool UIKeyboardControllerContext.HasPreviouscontext ( )

This method makes the assumption that if the previous context name is the same as this context name, then there is no way to go back.

Returns: True if the previousContextName is not the same af the contextName

◆ IncrementIndexCount()

void UIKeyboardControllerContext.IncrementIndexCount ( )

Change the selected text controller to be the next object.

◆ IsTextControllerInContext()

bool UIKeyboardControllerContext.IsTextControllerInContext ( UITextController controller )

Check if the provided UITextController is in this context.

Parameters

controller Text object that needs to be verified.

Returns: True if the controller is in the context, otherwise false.

Member Data Documentation

◆ contextName

UIKeyboardControllerContextManager.UIKeyboardControllerContextName UIKeyboardControllerContext.contextName

The context name of this object.

◆ currentTextControllerIndex

int UIKeyboardControllerContext.currentTextControllerIndex

Index into the textControllers of the currently highlighted item.

◆ previousContextName

UIKeyboardControllerContextManager.UIKeyboardControllerContextName UIKeyboardControllerContext.previousContextName

If the menu needs to go back, what is the previous context the menus should go back to.

◆ textControllers

UITextController [] UIKeyboardControllerContext.textControllers

All the text objects in the current menu.

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

Assets/Scripts/UI/UIKeyboardControllerContext.cs

Public Member Functions

Public Attributes