ORK Framework  2.24.0
API Documentation
ORKFramework.UI.PageKeys Class Reference
Inheritance diagram for ORKFramework.UI.PageKeys:
ORKFramework.BaseData ORKFramework.IBaseData

Public Member Functions

bool AcceptNext (GUIBox box, int pages, NotifyInt notify)
 Turns to the next page if the accept key is pressed and 'acceptNext' is enabled. More...
 
bool UsePageKeys (GUIBox box, int pages, NotifyInt notify)
 Turns to the next page ('nextPageKey') or previous page ('prevPageKey'). More...
 
- Public Member Functions inherited from ORKFramework.BaseData
virtual DataObject GetData ()
 Gets a ORKFramework.DataObject representing the class. More...
 
virtual void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
 
virtual void EditorAutoSetup (string fieldName)
 Called for all fields using the autoSetup option of the ORKFramework.ORKEditorLayoutAttribute. More...
 

Public Attributes

bool acceptNext = false
 
bool usePageKeys = false
 
int nextPageKey = 0
 
int prevPageKey = 0
 
GUIBoxAudioType pageAudioType = GUIBoxAudioType.Accept
 

Member Function Documentation

bool ORKFramework.UI.PageKeys.AcceptNext ( GUIBox  box,
int  pages,
NotifyInt  notify 
)

Turns to the next page if the accept key is pressed and 'acceptNext' is enabled.

Parameters
boxThe used GUI box.
pagesThe number of pages.
notifyThe page change callback function.
Returns
true if the accept key was pressed, regardless of if 'acceptNext' is enabled.
bool ORKFramework.UI.PageKeys.UsePageKeys ( GUIBox  box,
int  pages,
NotifyInt  notify 
)

Turns to the next page ('nextPageKey') or previous page ('prevPageKey').

Parameters
boxThe used GUI box.
pagesThe number of pages.
notifyThe page change callback function.
Returns
true if the 'nextPageKey' or 'prevPageKey' where pressed.