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

Message a text entry sends when it refuses a typed character. More...

#include <uitextentryinvalidmsg.h>

Inheritance diagram for UITextEntryInvalidMsg:
Collaboration diagram for UITextEntryInvalidMsg:

Public Member Functions

 ~UITextEntryInvalidMsg () override=default
 Destroy the object.
 UITextEntryInvalidMsg (char ch, bool bEndOfField, UITextEntry *pEntry)
 Construct the message.
void * operator new (size_t nSize)
 Allocate a message, billed to the class name.
void operator delete (void *pBlock)
 Release a message.
Message * Clone () override
 Produce a heap copy of this message.
int Type () override
 Report this message's registered identity.
const char * GetName () const override
 Report this message's class name.
void PrintExtra (PrnStream &stream) const override
 Write the character and whether the text was full.
UITextEntry * GetEntry () const
int GetEndOfField () const
Public Member Functions inherited from Message
virtual ~Message ()
 Vtable slot 1.
virtual void saveGuts (BinStream &stream) const
 Write this message's payload to a stream.
virtual void restoreGuts (BinStream &stream)
 Read this message's payload from a stream.
virtual ~Message ()
virtual void Unused1 ()
 Not called by the control.

Additional Inherited Members

Static Public Member Functions inherited from Message
static Message * NewMessage (int nType)
 Produce a message of the identified class through the factory list.

Detailed Description

Message a text entry sends when it refuses a typed character.

The RTTI records the class as deriving from Message. The object is 0x10 bytes. A text entry sends it through its own Dispatch() for a character of its invalid_chars list, and for a character that does not fit.

Constructor & Destructor Documentation

◆ ~UITextEntryInvalidMsg()

UITextEntryInvalidMsg::~UITextEntryInvalidMsg ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0037c4e8
Ghidra address:
PAL: 0x003eac18

◆ UITextEntryInvalidMsg()

UITextEntryInvalidMsg::UITextEntryInvalidMsg ( char ch,
bool bEndOfField,
UITextEntry * pEntry )
inline

Construct the message.

Inline. UITextEntry::ProcessKey() expands it on its stack.

Parameters
chThe refused character.
bEndOfFieldWhether the character was refused because the text is full.
pEntryThe text entry.

Member Function Documentation

◆ operator new()

void * UITextEntryInvalidMsg::operator new ( size_t nSize)
inline

Allocate a message, billed to the class name.

Parameters
nSizeThe object size the compiler supplies.
Returns
The block.

◆ operator delete()

void UITextEntryInvalidMsg::operator delete ( void * pBlock)
inline

Release a message.

Parameters
pBlockThe block.

◆ Clone()

Message * UITextEntryInvalidMsg::Clone ( )
inlineoverridevirtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x0037c588
Ghidra address:
PAL: 0x003eacb8

Implements Message.

◆ Type()

int UITextEntryInvalidMsg::Type ( )
inlineoverridevirtual

Report this message's registered identity.

Returns
g_nUITextEntryInvalidMsgType.
Ghidra address:
NTSC-U/C: 0x0037c5e8
Ghidra address:
PAL: 0x003ead18

Implements Message.

◆ GetName()

const char * UITextEntryInvalidMsg::GetName ( ) const
inlineoverridevirtual

Report this message's class name.

Returns
The literal UITextEntryInvalidMsg.
Ghidra address:
NTSC-U/C: 0x0037c5f8
Ghidra address:
PAL: 0x003ead28

Implements Message.

◆ PrintExtra()

void UITextEntryInvalidMsg::PrintExtra ( PrnStream & stream) const
overridevirtual

Write the character and whether the text was full.

Parameters
streamThe stream to write to.
Ghidra address:
NTSC-U/C: 0x0020e9c8
Ghidra address:
PAL: 0x002177e0

Reimplemented from Message.

◆ GetEntry()

UITextEntry * UITextEntryInvalidMsg::GetEntry ( ) const
inline
Returns
The text entry.

◆ GetEndOfField()

int UITextEntryInvalidMsg::GetEndOfField ( ) const
inline
Returns
Whether the character was refused because the text is full.

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