Movie::cMovieLetterbox class
#include <Spore ModAPI/Spore/Movie/cMovieLetterbox.h>

Base classes

template<int eventFlags = kEventFlagBasicInput | kEventFlagAdvanced>
class UTFWin::DefaultWinProc<>
A helper class to simplify the creation of window procedures (IWinProc).

Public types

enum ControlIDs { kWinRoot = -1 }

Public static variables

static const uint32_t TYPE

Public functions

auto Initialize() -> void
auto SetVisible(bool visible) -> void
auto Cast(uint32_t type) const -> void* override
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

UILayoutPtr mLayout

Function documentation

bool Movie::cMovieLetterbox::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.