resonance 1.0.1
Loading...
Searching...
No Matches
MetKeyboardRequest Struct Reference

What a screen asks of the on-screen keyboard. More...

#include <metkeyboardrequest.h>

Collaboration diagram for MetKeyboardRequest:

Public Member Functions

 MetKeyboardRequest (const HxStr &returnScreen, const HxStr &prompt, const HxStr &text, int nPad, MetKBUser *pUser)
 Fill the request, with no macro list, an empty ticker, and no limits.

Public Attributes

HxStr mReturnScreen
HxStr mPrompt
HxStr mText
MetKBUser * mUser
int mUnusedFlag
int mMaxWidth
 The widest the entered text may measure, compared against Rnd::Text::GetFontWidth().
int mMaxLength
 The most characters the entry accepts.
std::vector< HxStr > * mMacros
 The macro list the keyboard offers, or null for the default list.
HxStr mTicker
int mPad

Detailed Description

What a screen asks of the on-screen keyboard.

A plain record of 0x38 bytes with no RTTI and no string in the image naming it, so the name is inferred from its one consumer, MetKeyboardScreen::Open(). A screen builds one on its stack, adjusts the limits and the ticker text, and passes it to Open(), which copies every field except mUnusedFlag into the keyboard screen. MetSaveRemixScreen, MetRemixDelScreen, and MetLoadNewFreqScreen build one.

Constructor & Destructor Documentation

◆ MetKeyboardRequest()

MetKeyboardRequest::MetKeyboardRequest ( const HxStr & returnScreen,
const HxStr & prompt,
const HxStr & text,
int nPad,
MetKBUser * pUser )

Fill the request, with no macro list, an empty ticker, and no limits.

The out-of-line routine returns its receiver.

Parameters
returnScreenThe registry key of the screen the keyboard returns to.
promptThe prompt the keyboard shows.
textThe text the entry starts from.
nPadThe one controller the keyboard accepts, or -1 for any.
pUserThe receiver of the committed text.
Ghidra address:
NTSC-U/C: 0x0028cf18
Ghidra address:
PAL: 0x002a25f8

Member Data Documentation

◆ mReturnScreen

HxStr MetKeyboardRequest::mReturnScreen

The screen the keyboard returns to. +0x00

◆ mPrompt

HxStr MetKeyboardRequest::mPrompt

The prompt the keyboard shows. +0x08

◆ mText

HxStr MetKeyboardRequest::mText

The text the entry starts from. +0x10

◆ mUser

MetKBUser* MetKeyboardRequest::mUser

The receiver of the committed text. +0x18

◆ mUnusedFlag

int MetKeyboardRequest::mUnusedFlag

Starts at 1. MetKeyboardScreen::Open() does not read it. +0x1c

◆ mMaxWidth

int MetKeyboardRequest::mMaxWidth

The widest the entered text may measure, compared against Rnd::Text::GetFontWidth().

Starts at 500. The name is inferred. +0x20

◆ mMaxLength

int MetKeyboardRequest::mMaxLength

The most characters the entry accepts.

Starts at no limit. The name is inferred. +0x24

◆ mMacros

std::vector<HxStr>* MetKeyboardRequest::mMacros

The macro list the keyboard offers, or null for the default list.

+0x28

◆ mTicker

HxStr MetKeyboardRequest::mTicker

The ticker text the keyboard posts, empty by default. +0x2c

◆ mPad

int MetKeyboardRequest::mPad

The one controller the keyboard accepts, or -1 for any. +0x34


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