UFO: Alien Invasion: src/client/ui/node/ui_node_window.h File Reference

UFO: Alien Invasion

#include "../../../shared/mathlib.h"
#include "ui_node_abstractnode.h"

Include dependency graph for ui_node_window.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
class	uiWindowNode

struct	node_index_t

struct	windowExtraData_t
	extradata for the window node More...

Macros
#define	INDEXEDCHILD_HASH_SIZE 32

Functions
void	UI_RegisterWindowNode (uiBehaviour_t *behaviour)

bool	UI_WindowIsFullScreen (uiNode_t const *window)
	Check if a window is fullscreen or not. More...

bool	UI_WindowIsDropDown (uiNode_t const *window)
	True if the window is a drop down. More...

bool	UI_WindowIsModal (uiNode_t const *window)
	True if the window is a modal. More...

void	UI_WindowNodeRegisterKeyBinding (uiNode_t window, struct uiKeyBinding_s binding)

struct uiKeyBinding_s *	UI_WindowNodeGetKeyBinding (uiNode_t const *node, unsigned int key)
	Search a a key binding from a window node. Window node store key bindings for his node child. More...

vec_t *	UI_WindowNodeGetNoticePosition (uiNode_t *node)
	Get the noticePosition from a window node. More...

uiNode_t *	UI_WindowNodeGetIndexedChild (uiNode_t node, const char childName)
	Get a node from child index. More...

bool	UI_WindowNodeAddIndexedNode (uiNode_t node, uiNode_t child)
	Add a node to the child index. More...

bool	UI_WindowNodeRemoveIndexedNode (uiNode_t node, uiNode_t child)
	Remove a node from the child index. More...

void	UI_Window_SetBackgroundByName (uiNode_t node, const char name)
	set background sprite More...

void	UI_Window_SetCloseButton (uiNode_t *node, bool value)
	Create/remove close button on window. More...

void	UI_Window_SetDragButton (uiNode_t *node, bool value)
	Create/remove drag button. More...

void	UI_Window_FlagFullscreen (uiNode_t *node)
	If the node size equals the full screen size, flag the node as isFullscreen, so it is displayed properly. More...

void	UI_WindowNode_SetFill (uiNode_t *node, bool value)

Macro Definition Documentation

◆ INDEXEDCHILD_HASH_SIZE

#define INDEXEDCHILD_HASH_SIZE 32

Definition at line 52 of file ui_node_window.h.

Function Documentation

◆ UI_RegisterWindowNode()

void UI_RegisterWindowNode ( uiBehaviour_t * behaviour )

Definition at line 474 of file ui_node_window.cpp.

References EXTRADATA_TYPE, uiBehaviour_t::extraDataSize, uiBehaviour_t::lua_SWIG_typeinfo, uiBehaviour_t::manager, uiBehaviour_t::name, UI_RegisterExtradataNodeProperty, UI_SWIG_TypeQuery(), V_BOOL, V_POS, V_UI_ACTION, and V_UI_SPRITEREF.

◆ UI_Window_FlagFullscreen()

void UI_Window_FlagFullscreen ( uiNode_t * node )

If the node size equals the full screen size, flag the node as isFullscreen, so it is displayed properly.

Definition at line 391 of file ui_node_window.cpp.

References uiNode_t::box, EXTRADATA, uiBox_t::size, VID_NORM_HEIGHT, and VID_NORM_WIDTH.

Referenced by uiWindowNode::onLoaded(), and uiWindowNode::onSizeChanged().

◆ UI_Window_SetBackgroundByName()

void UI_Window_SetBackgroundByName	(	uiNode_t *	node,
		const char *	name
	)

set background sprite

Definition at line 61 of file ui_node_window.cpp.

References name, UI_EXTRADATA, and UI_GetSpriteByName().

Referenced by uiWindowNode_t_set_background().

◆ UI_Window_SetCloseButton()

void UI_Window_SetCloseButton	(	uiNode_t *	node,
		bool	value
	)

Create/remove close button on window.

Note: Creates a onClick event handler, should be refactored.

Todo:: Once image_t is known on the client, use image->width resp. image->height here

Definition at line 308 of file ui_node_window.cpp.

References _, uiNode_t::behaviour, uiNode_t::box, CONTROLS_IMAGE_DIMENSIONS, CONTROLS_PADDING, uiNode_t::dynamic, EXTRADATA, uiNode_t::onClick, uiBox_t::pos, uiNode_t::root, uiBox_t::size, uiNode_t::tooltip, UI_AllocNode(), UI_AllocStaticCommandAction(), UI_AppendNode(), UI_FindNode(), UI_GetPropertyFromBehaviour(), UI_NodeSetProperty(), UI_RemoveNode(), and WINDOW_CLOSE_BUTTON_NAME.

Referenced by uiWindowNode::onLoaded(), and uiWindowNode_t_set_closebutton().

◆ UI_Window_SetDragButton()

void UI_Window_SetDragButton	(	uiNode_t *	node,
		bool	value
	)

Create/remove drag button.

Definition at line 338 of file ui_node_window.cpp.

References _, uiNode_t::box, uiNode_t::dynamic, EXTRADATA, uiBox_t::pos, uiNode_t::root, uiBox_t::size, uiNode_t::tooltip, TOP_HEIGHT, UI_AllocNode(), UI_AppendNode(), UI_FindNode(), UI_GetPrevNode(), UI_InsertNode(), UI_RemoveNode(), WINDOW_CLOSE_BUTTON_NAME, and WINDOW_DRAG_BUTTON_NAME.

Referenced by uiWindowNode::onLoaded(), and uiWindowNode_t_set_dragbutton().

◆ UI_WindowIsDropDown()

bool UI_WindowIsDropDown ( uiNode_t const *const node )

True if the window is a drop down.

Parameters

node	A window node

Returns: True if the window is a drop down.

Definition at line 420 of file ui_node_window.cpp.

References EXTRADATACONST.

Referenced by UI_GetNodeAtPosition(), and UI_LeftClick().

◆ UI_WindowIsFullScreen()

bool UI_WindowIsFullScreen ( uiNode_t const * window )

Check if a window is fullscreen or not.

Definition at line 118 of file ui_node_window.cpp.

References EXTRADATACONST, and UI_NodeInstanceOf().

Referenced by uiWindowNode::doLayout(), uiWindowNode::draw(), UI_GetLastFullScreenWindow(), UI_GetNodeAtPosition(), and UI_MoveWindowOnTop().

◆ UI_WindowIsModal()

bool UI_WindowIsModal ( uiNode_t const *const node )

True if the window is a modal.

Parameters

node	A window node

Returns: True if the window is a modal.

Definition at line 430 of file ui_node_window.cpp.

References EXTRADATACONST.

Referenced by UI_GetNodeAtPosition(), and UI_KeyPressed().

◆ UI_WindowNode_SetFill()

void UI_WindowNode_SetFill	(	uiNode_t *	node,
		bool	value
	)

◆ UI_WindowNodeAddIndexedNode()

bool UI_WindowNodeAddIndexedNode	(	uiNode_t *	node,
		uiNode_t *	child
	)

Add a node to the child index.

Todo:: display a warning, we must not override a node name here

Definition at line 84 of file ui_node_window.cpp.

References Com_HashKey(), EXTRADATA, hash, node_index_t::hash_next, INDEXEDCHILD_HASH_SIZE, Mem_PoolAllocType, uiNode_t::name, node_index_t::next, node_index_t::node, Q_streq, and ui_sysPool.

Referenced by UI_InsertNode().

◆ UI_WindowNodeGetIndexedChild()

uiNode_t * UI_WindowNodeGetIndexedChild	(	uiNode_t *const	node,
		const char *	childName
	)

Get a node from child index.

Returns: A child node by his name, else nullptr

Definition at line 70 of file ui_node_window.cpp.

References Com_HashKey(), EXTRADATA, hash, INDEXEDCHILD_HASH_SIZE, and Q_streq.

Referenced by UI_ReadNodePath().

◆ UI_WindowNodeGetKeyBinding()

struct uiKeyBinding_s * UI_WindowNodeGetKeyBinding	(	uiNode_t const *const	node,
		unsigned int	key
	)

Search a a key binding from a window node. Window node store key bindings for his node child.

Parameters

node	A window node
key	A key code, either K_ value or lowercase ascii

Definition at line 457 of file ui_node_window.cpp.

References binding, EXTRADATACONST, key, uiKeyBinding_t::key, uiKeyBinding_t::next, and UI_NodeInstanceOf().

Referenced by UI_KeyPressedInWindow().

◆ UI_WindowNodeGetNoticePosition()

vec_t * UI_WindowNodeGetNoticePosition ( uiNode_t * node )

Get the noticePosition from a window node.

Parameters

node	A window node

Returns: A position, else nullptr if no notice position

Definition at line 408 of file ui_node_window.cpp.

References EXTRADATA, and Vector2Empty.

Referenced by UI_DrawNotice().

◆ UI_WindowNodeRegisterKeyBinding()

void UI_WindowNodeRegisterKeyBinding	(	uiNode_t *	window,
		struct uiKeyBinding_s *	binding
	)

◆ UI_WindowNodeRemoveIndexedNode()

bool UI_WindowNodeRemoveIndexedNode	(	uiNode_t *	node,
		uiNode_t *	child
	)

Remove a node from the child index.

Todo:: FIXME implement it

Definition at line 109 of file ui_node_window.cpp.

Referenced by UI_RemoveNode().

src
client
ui
node
ui_node_window.h
Generated on Tue Jul 19 2022 00:00:00 for UFO: Alien Invasion by 1.9.4