UTFWin::SporeTooltipWinProc class
#include <Spore ModAPI/Spore/UTFWin/SporeTooltipWinProc.h>

Base classes

class InteractiveWinProc

Public static variables

static const uint32_t TYPE

Constructors, destructors, conversion operators

SporeTooltipWinProc()
SporeTooltipWinProc(const char16_t* pLayoutName, uint32_t controlID, const char16_t* pText, const Math::Point& offsetPositon, TooltipBehaviour behaviour, const char16_t* pDetailedText, uint32_t detailControlID)
~SporeTooltipWinProc() virtual

Public functions

auto AddRef() -> int override
auto Release() -> int override
auto Cast(uint32_t typeID) const -> void* override
auto SetSerializer(Serializer& dst) -> void override
auto GetProxyID() const -> uint32_t override
Returns the ID that identifies this type of element in a SPUI file.
auto GetEventFlags() const -> int override
Gets the flags that represent which type of messages this IWinProc can handle.
auto HandleUIMessage(IWindow* pWindow, const Message& message) -> bool override
Method called every time a message is received on a window that has this IWinProc added.

Public variables

eastl::string16 mLayoutName
Filename of the layout which contains tooltip window, by default "Tooltips".
uint32_t mControlID
Control ID of tooltip window, by default 0x3754E6C.
uint32_t mDetailControlID
Control ID of detailed tooltip window, by default 0x3754E6C.
eastl::string16 mText
Text to display in tooltip.
eastl::string16 mDetailedText
Detailed text to display in tooltip after extended hover.
Math::Point mOffsetPosition
The offset of the tooltip window relative to the cursor, by default (0, 30).
int field_4C
int field_50
int field_54
bool field_58
TooltipBehaviour mBehaviour
Sets the tooltip display behavior.
int field_60
int field_64

Function documentation

int UTFWin::SporeTooltipWinProc::GetEventFlags() const override

Gets the flags that represent which type of messages this IWinProc can handle.

This allows for better performance, since generally a procedure only needs to listen specific events. The flags are in the kEventFlag... values.

bool UTFWin::SporeTooltipWinProc::HandleUIMessage(IWindow* pWindow, const Message& message) override

Method called every time a message is received on a window that has this IWinProc added.

Parameters
pWindow The window that received this message.
message The message received.
Returns Whether the message was handled or not.

This method is responsible of handling (or not) the message. This method receives the IWindow that is currently receiving the message; this way, the same IWinProc can be listening for more than one window. This method returns whether the message was handled or not; if it was handled, no other IWinProcs will be called on that window.