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>
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.
◆ 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
-
| pUser | The user that receives the text. |
| pReturnScreen | The screen the keyboard returns to. |
| pszText | The text the entry starts with. |
| nPad | The controller that types. |
| nMaxChars | The most characters the entry accepts. |
| nMaxWidth | The widest the text may be. |
| nFunctionKeys | Non-zero when the function keys type their texts. |
| nInvalidChars | Non-zero when the invalid_chars of the metagame configuration apply. |
| nPassword | Non-zero when the entry hides the text. |
| nNumLines | The number of lines of a scrolling entry, or 0 for one line. |
- Ghidra address:
- NTSC-U/C: 0x001a8898
◆ 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()
- 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: