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

Message a panel sends before it moves its focus to another component. More...

#include <uicomponentfocuschangemsg.h>

Inheritance diagram for UIComponentFocusChangeMsg:
Collaboration diagram for UIComponentFocusChangeMsg:

Public Member Functions

 ~UIComponentFocusChangeMsg () override=default
 Destroy the object.
 UIComponentFocusChangeMsg (UIComponent *pComponent, UIComponent *pOldComponent, UIPanel *pPanel, UIScreen *pScreen)
 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 components, the panel, and the screen.
UIComponent * GetComponent () const
UIComponent * GetOldComponent () const
UIPanel * GetPanel () const
UIScreen * GetScreen () 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 panel sends before it moves its focus to another component.

The RTTI records the class as deriving from Message. The object is 0x14 bytes. A handler that reports the message as handled keeps the focus where it is.

Constructor & Destructor Documentation

◆ ~UIComponentFocusChangeMsg()

UIComponentFocusChangeMsg::~UIComponentFocusChangeMsg ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0037c000
Ghidra address:
PAL: 0x003ea730

◆ UIComponentFocusChangeMsg()

UIComponentFocusChangeMsg::UIComponentFocusChangeMsg ( UIComponent * pComponent,
UIComponent * pOldComponent,
UIPanel * pPanel,
UIScreen * pScreen )
inline

Construct the message.

Inline. UIPanel::SetFocus() expands it on its stack.

Parameters
pComponentThe component to receive the focus, or null.
pOldComponentThe component with the focus, or null.
pPanelThe panel.
pScreenThe current screen.

Member Function Documentation

◆ operator new()

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

Release a message.

Parameters
pBlockThe block.

◆ Clone()

Message * UIComponentFocusChangeMsg::Clone ( )
inlineoverridevirtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x0037c0a0
Ghidra address:
PAL: 0x003ea7d0

Implements Message.

◆ Type()

int UIComponentFocusChangeMsg::Type ( )
inlineoverridevirtual

Report this message's registered identity.

Returns
g_nUIComponentFocusChangeMsgType.
Ghidra address:
NTSC-U/C: 0x0037c108
Ghidra address:
PAL: 0x003ea838

Implements Message.

◆ GetName()

const char * UIComponentFocusChangeMsg::GetName ( ) const
inlineoverridevirtual

Report this message's class name.

Returns
The literal UIComponentFocusChangeMsg.
Ghidra address:
NTSC-U/C: 0x0037c118
Ghidra address:
PAL: 0x003ea848

Implements Message.

◆ PrintExtra()

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

Write the names of both components, the panel, and the screen.

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

Reimplemented from Message.

◆ GetComponent()

UIComponent * UIComponentFocusChangeMsg::GetComponent ( ) const
inline
Returns
The component to receive the focus, or null.

◆ GetOldComponent()

UIComponent * UIComponentFocusChangeMsg::GetOldComponent ( ) const
inline
Returns
The component with the focus, or null.

◆ GetPanel()

UIPanel * UIComponentFocusChangeMsg::GetPanel ( ) const
inline
Returns
The panel.

◆ GetScreen()

UIScreen * UIComponentFocusChangeMsg::GetScreen ( ) const
inline
Returns
The current screen.

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