Palettes::DefaultItemFrameUI class

Base classes

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

Derived classes

class OutfitterItemUI
class cSPScenarioBrushItemUI

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
auto Initialize(PaletteItem* pItem, UTFWin::IWindow* pWindow, UTFWin::IWindow* pItemsPanel, PaletteInfo* pInfo) -> void override
auto Dispose() -> void override
auto SetPaletteItem(PaletteItem* pItem) -> void override
auto GetPaletteItem() -> PaletteItem* override
auto func14h() -> void override
auto Update(int dt) -> void override
auto OnMouseEnter() -> void override
auto OnMouseLeave() -> void override
auto OnMouseDown() -> void override
auto OnMouseUp() -> void override
auto SetVisible(bool visible) -> void override
auto GetEventFlags() const -> int override
Gets the flags that represent which type of messages this IWinProc can handle.
auto HandleUIMessage(UTFWin::IWindow* pWindow, const UTFWin::Message& message) -> bool override
Method called every time a message is received on a window that has this IWinProc added.

Public 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(UTFWin::IWindow* pWindow, const UTFWin::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.