UTFWin::InteractiveWindow class

Base classes

class Window

Derived classes

class WinTreeView

Protected functions

auto OnKeyDown2(int, int virtualKey, int modifiers) -> bool virtual
An event listener called every time a key is pressed on this window.
auto OnKeyUp2(int, int virtualKey, int modifiers) -> bool virtual
An event listener called every time a key is released on this window.
auto OnKeyDown(int, int virtualKey, int modifiers) -> bool virtual
An event listener called every time a key is pressed on this window.
auto OnKeyUp(int, int virtualKey, int modifiers) -> bool virtual
An event listener called every time a key is released on this window.
auto OnKeyPress(int, int16_t virtualKey) -> bool virtual
An event listener called every time a character, space or backspace key is released on this window.
auto OnMouseDown(float fMouseX, float fMouseY, int, int state) -> bool virtual
An event listener called every time a mouse key is pressed on this window.
auto OnMouseUp(float fMouseX, float fMouseY, int, int state) -> bool virtual
An event listener called every time a mouse key is released on this window.
auto OnMouseMove(float fMouseX, float fMouseY, int state) -> bool virtual
An event listener called every time the mouse is moved within this window.
auto OnMouseWheel(float fMouseX, float fMouseY, int state, int nWheelDelta) -> bool virtual
An event listener called every time the mouse wheel is moved within this window.
auto OnRefresh(RefreshType type, IWindow*) -> bool virtual
An event listener called every time the mouse pointer enters or leaves this window, or the keyboard focus is gained or lost.
auto func50h(int, IWindow*) -> bool virtual
auto func54h(int, IWindow*) -> bool virtual
auto OnUpdate() -> void virtual
An event listener called every game loop.
auto OnElementAdd() -> void virtual
An event listener called every time a window or procedure is added to the component.
auto OnElementRemove() -> void virtual
An event listener called every time a window is removed from the component.
auto OnCollisionDetect(float fMouseX, float fMouseY, bool* pbResult) -> bool virtual
An event listener called to check if the window contains the mouse pointer.
auto OnLayout(Math::Rectangle* pArea) -> void virtual
An event listener called every time the window layout is recalculated.
auto OnTransform(Math::Matrix4* pTransformation) -> void virtual
An event listener called every time a transformation is applied on the window.
auto OnButtonClick(IWindow* pSourceWindow, uint32_t commandID) -> bool virtual
An event listener called when the window is clicked, if it's a standard button.
auto OnButtonSelect(IWindow* pSourceWindow, uint32_t commandID, Message& msg) -> bool virtual
An event listener called when the window is selected, if it's a toggle or radio button.
auto func78h(int, int) -> bool virtual
auto func7Ch(int, int) -> bool virtual
auto OnMouseEnter(int, IWindow* pFocusWindow) -> bool virtual
An event listener called every time the pointer enters the component.
auto OnMouseLeave(int, IWindow* pLostFocusWindow) -> bool virtual
An event listener called every time the pointer leaves the component.

Function documentation

bool UTFWin::InteractiveWindow::OnKeyDown2(int, int virtualKey, int modifiers) virtual protected

An event listener called every time a key is pressed on this window.

Parameters
virtualKey The VK code of the key.
modifiers The modifiers (Ctrl, Alt and Shift) currently being pressed. They use the enum values kModifier....
Returns Whether the event was handled or not.

bool UTFWin::InteractiveWindow::OnKeyUp2(int, int virtualKey, int modifiers) virtual protected

An event listener called every time a key is released on this window.

Parameters
virtualKey The VK code of the key.
modifiers The modifiers (Ctrl, Alt and Shift) currently being pressed. They use the enum values kModifier....
Returns Whether the event was handled or not.

bool UTFWin::InteractiveWindow::OnKeyDown(int, int virtualKey, int modifiers) virtual protected

An event listener called every time a key is pressed on this window.

Parameters
virtualKey The VK code of the key.
modifiers The modifiers (Ctrl, Alt and Shift) currently being pressed. They use the enum values kModifier....
Returns Whether the event was handled or not.

bool UTFWin::InteractiveWindow::OnKeyUp(int, int virtualKey, int modifiers) virtual protected

An event listener called every time a key is released on this window.

Parameters
virtualKey The VK code of the key.
modifiers The modifiers (Ctrl, Alt and Shift) currently being pressed. They use the enum values kModifier....
Returns Whether the event was handled or not.

bool UTFWin::InteractiveWindow::OnKeyPress(int, int16_t virtualKey) virtual protected

An event listener called every time a character, space or backspace key is released on this window.

Parameters
virtualKey The VK code of the key.
Returns Whether the event was handled or not.

bool UTFWin::InteractiveWindow::OnMouseDown(float fMouseX, float fMouseY, int, int state) virtual protected

An event listener called every time a mouse key is pressed on this window.

Parameters
fMouseX The X position of the mouse.
fMouseY The Y position of the mouse.
state The state of the mouse, flags of the UTFWin::kMouse.... values.
Returns Whether the event was handled or not.

bool UTFWin::InteractiveWindow::OnMouseUp(float fMouseX, float fMouseY, int, int state) virtual protected

An event listener called every time a mouse key is released on this window.

Parameters
fMouseX The X position of the mouse.
fMouseY The Y position of the mouse.
state The state of the mouse, flags of the UTFWin::kMouse.... values.
Returns Whether the event was handled or not.

bool UTFWin::InteractiveWindow::OnMouseMove(float fMouseX, float fMouseY, int state) virtual protected

An event listener called every time the mouse is moved within this window.

Parameters
fMouseX The X position of the mouse.
fMouseY The Y position of the mouse.
state The state of the mouse, flags of the UTFWin::kMouse.... values.
Returns Whether the event was handled or not.

bool UTFWin::InteractiveWindow::OnMouseWheel(float fMouseX, float fMouseY, int state, int nWheelDelta) virtual protected

An event listener called every time the mouse wheel is moved within this window.

Parameters
fMouseX The X position of the mouse.
fMouseY The Y position of the mouse.
state The state of the mouse, flags of the UTFWin::kMouse.... values.
nWheelDelta
Returns Whether the event was handled or not.

bool UTFWin::InteractiveWindow::OnRefresh(RefreshType type, IWindow*) virtual protected

An event listener called every time the mouse pointer enters or leaves this window, or the keyboard focus is gained or lost.

Parameters
type The type of refresh that happened, in the RefreshType enum.
Returns Whether the event was handled or not.

void UTFWin::InteractiveWindow::OnUpdate() virtual protected

An event listener called every game loop.

Returns Whether the event was handled or not.

The return value might not be relevant.

void UTFWin::InteractiveWindow::OnElementAdd() virtual protected

An event listener called every time a window or procedure is added to the component.

Returns Whether the event was handled or not.

void UTFWin::InteractiveWindow::OnElementRemove() virtual protected

An event listener called every time a window is removed from the component.

Returns Whether the event was handled or not.

bool UTFWin::InteractiveWindow::OnCollisionDetect(float fMouseX, float fMouseY, bool* pbResult) virtual protected

An event listener called to check if the window contains the mouse pointer.

Parameters
fMouseX The X position of the mouse.
fMouseY The Y position of the mouse.
pbResult The bool* where the result of the detection must go. Set it to true if it collisions with this window.
Returns Whether the event was handled or not.

void UTFWin::InteractiveWindow::OnLayout(Math::Rectangle* pArea) virtual protected

An event listener called every time the window layout is recalculated.

Parameters
pArea

void UTFWin::InteractiveWindow::OnTransform(Math::Matrix4* pTransformation) virtual protected

An event listener called every time a transformation is applied on the window.

Parameters
pTransformation

bool UTFWin::InteractiveWindow::OnButtonClick(IWindow* pSourceWindow, uint32_t commandID) virtual protected

An event listener called when the window is clicked, if it's a standard button.

Parameters
pSourceWindow The button IWindow that was clicked.
commandID The command ID of the button.
Returns Whether the event was handled or not.

bool UTFWin::InteractiveWindow::OnButtonSelect(IWindow* pSourceWindow, uint32_t commandID, Message& msg) virtual protected

An event listener called when the window is selected, if it's a toggle or radio button.

Parameters
pSourceWindow The button IWindow that was clicked.
commandID The command ID of the button.
msg
Returns Whether the event was handled or not.

bool UTFWin::InteractiveWindow::OnMouseEnter(int, IWindow* pFocusWindow) virtual protected

An event listener called every time the pointer enters the component.

Returns Whether the event was handled or not.

bool UTFWin::InteractiveWindow::OnMouseLeave(int, IWindow* pLostFocusWindow) virtual protected

An event listener called every time the pointer leaves the component.

Parameters
pLostFocusWindow The window that lost focus.
Returns Whether the event was handled or not.