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

Message UIManager sends before it leaves the current screen for another. More...

#include <uiscreenchangemsg.h>

Inheritance diagram for UIScreenChangeMsg:
Collaboration diagram for UIScreenChangeMsg:

Public Member Functions

 UIScreenChangeMsg (UIScreen *pScreen, UIScreen *pOldScreen)
 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 names of both screens.
UIScreen * GetScreen () const
UIScreen * GetOldScreen () 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 UIManager sends before it leaves the current screen for another.

The RTTI records the class as deriving from Message. The object is 0x0c bytes. A sink of the manager that reports the message as handled cancels the change.

Constructor & Destructor Documentation

◆ UIScreenChangeMsg()

UIScreenChangeMsg::UIScreenChangeMsg ( UIScreen * pScreen,
UIScreen * pOldScreen )
inline

Construct the message.

Inline. UIManager::GotoScreen() expands it on its stack.

Parameters
pScreenThe screen to change to.
pOldScreenThe current screen.

Member Function Documentation

◆ operator new()

void * UIScreenChangeMsg::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 UIScreenChangeMsg::operator delete ( void * pBlock)
inline

Release a message.

Parameters
pBlockThe block.

◆ Clone()

Message * UIScreenChangeMsg::Clone ( )
inlineoverridevirtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x0037c1d8
Ghidra address:
PAL: 0x003ea908

Implements Message.

◆ Type()

int UIScreenChangeMsg::Type ( )
inlineoverridevirtual

Report this message's registered identity.

Returns
g_nUIScreenChangeMsgType.
Ghidra address:
NTSC-U/C: 0x0037c230
Ghidra address:
PAL: 0x003ea960

Implements Message.

◆ GetName()

const char * UIScreenChangeMsg::GetName ( ) const
inlineoverridevirtual

Report this message's class name.

Returns
The literal UIScreenChangeMsg.
Ghidra address:
NTSC-U/C: 0x0037c240
Ghidra address:
PAL: 0x003ea970

Implements Message.

◆ PrintExtra()

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

Write the names of both screens.

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

Reimplemented from Message.

◆ GetScreen()

UIScreen * UIScreenChangeMsg::GetScreen ( ) const
inline
Returns
The screen to change to.

◆ GetOldScreen()

UIScreen * UIScreenChangeMsg::GetOldScreen ( ) const
inline
Returns
The current screen.

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