Palettes::DefaultItemFrameUI class

Base classes

class IAdvancedItemUI
class DefaultRefCounted
The default implementation of a reference counted class.

Derived classes

class cSPScenarioBrushItemUI
class OutfitterItemUI

Public static variables

static const uint32_t TYPE

Constructors, destructors, conversion operators

DefaultItemFrameUI()

Public functions

auto AddRef() -> int override
auto Release() -> int override
auto Cast(uint32_t type) const -> void* override
void Initialize(PaletteItem* pItem, IWindow* pWindow, IWindow* pItemsPanel, PaletteInfo* pInfo) override
void Dispose() override
void SetPaletteItem(PaletteItem* pItem) override
auto GetPaletteItem() -> PaletteItem* override
void func14h() override
void Update(int dt) override
void OnMouseEnter() override
void OnMouseLeave() override
void OnMouseDown() override
void OnMouseUp() override
void SetVisible(bool visible) override
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.

Protected variables

int field_14
bool mIsHovering
IWindowPtr mpWindow

Function documentation

int Palettes::DefaultItemFrameUI::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 Palettes::DefaultItemFrameUI::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.