wavelength 1.0.0
Loading...
Searching...
No Matches
KeyboardRequest Class Reference

What a screen requests of the front-end keyboard: who receives the text, the text to start from, and the limits of the entry. More...

#include <keyboardrequest.h>

Public Member Functions

 KeyboardRequest ()
 Construct a request with no user and the default limits.
 KeyboardRequest (KeyboardUser *pUser, UIScreen *pReturnScreen, const char *pszText, int nPad, int nMaxChars, int nMaxWidth, int nFunctionKeys, int nInvalidChars, int nPassword, int nNumLines)
 Construct a request.
int GetPassword () const
int GetInvalidChars () const
int GetMaxWidth () const
int GetMaxChars () const
int GetNumLines () const
const String & GetText () const
String & GetText ()
int GetPad () const
UIScreen * GetReturnScreen () const
KeyboardUser * GetUser () const
int GetFunctionKeys () const

Detailed Description

What a screen requests of the front-end keyboard: who receives the text, the text to start from, and the limits of the entry.

The class is not polymorphic and has no RTTI. The name is inferred. The object is 0x38 bytes. A screen builds one on its stack and hands it to KeyboardPanel::SetRequest() before it opens kb_screen.

Constructor & Destructor Documentation

◆ KeyboardRequest() [1/2]

KeyboardRequest::KeyboardRequest ( )

Construct a request with no user and the default limits.

Ghidra address:
NTSC-U/C: 0x001a8830
Ghidra address:
PAL: 0x001b0520

◆ KeyboardRequest() [2/2]

KeyboardRequest::KeyboardRequest ( KeyboardUser * pUser,
UIScreen * pReturnScreen,
const char * pszText,
int nPad,
int nMaxChars,
int nMaxWidth,
int nFunctionKeys,
int nInvalidChars,
int nPassword,
int nNumLines )

Construct a request.

Parameters
pUserThe user that receives the text.
pReturnScreenThe screen the keyboard returns to.
pszTextThe text the entry starts with.
nPadThe controller that types.
nMaxCharsThe most characters the entry accepts.
nMaxWidthThe widest the text may be.
nFunctionKeysNon-zero when the function keys type their texts.
nInvalidCharsNon-zero when the invalid_chars of the metagame configuration apply.
nPasswordNon-zero when the entry hides the text.
nNumLinesThe number of lines of a scrolling entry, or 0 for one line.
Ghidra address:
NTSC-U/C: 0x001a8898

Member Function Documentation

◆ GetPassword()

int KeyboardRequest::GetPassword ( ) const
inline
Returns
Non-zero when the entry hides the text.

◆ GetInvalidChars()

int KeyboardRequest::GetInvalidChars ( ) const
inline
Returns
Non-zero when the invalid_chars apply.

◆ GetMaxWidth()

int KeyboardRequest::GetMaxWidth ( ) const
inline
Returns
The widest the text may be.

◆ GetMaxChars()

int KeyboardRequest::GetMaxChars ( ) const
inline
Returns
The most characters the entry accepts.

◆ GetNumLines()

int KeyboardRequest::GetNumLines ( ) const
inline
Returns
The lines of a scrolling entry, or 0 for one line.

◆ GetText() [1/2]

const String & KeyboardRequest::GetText ( ) const
inline
Returns
The text the entry starts with.

◆ GetText() [2/2]

String & KeyboardRequest::GetText ( )
inline
Returns
The text the entry starts with.

◆ GetPad()

int KeyboardRequest::GetPad ( ) const
inline
Returns
The controller that types.

◆ GetReturnScreen()

UIScreen * KeyboardRequest::GetReturnScreen ( ) const
inline
Returns
The screen the keyboard returns to, or null.

◆ GetUser()

KeyboardUser * KeyboardRequest::GetUser ( ) const
inline
Returns
The user that receives the text, or null.

◆ GetFunctionKeys()

int KeyboardRequest::GetFunctionKeys ( ) const
inline
Returns
Non-zero when the function keys type their texts.

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