#include <ui_node_abstractnode.h>

Inherits uiNode.

Inherited by uiAbstractOptionNode, uiAbstractScrollableNode, uiAbstractScrollbarNode, uiAbstractValueNode, uiBaseLayoutNode, uiBattleScapeNode, uiButtonNode, uiContainerNode, uiEditorNode, uiGeoscapeNode, uiImageNode, uiLineChartNode, uiModelNode, uiOptionNode, uiRadarNode, uiRadioButtonNode, uiRowsNode, uiSequenceNode, uiStringNode, uiTextEntryNode, uiTextureNode, uiTimerNode, uiVideoNode, uiWindowNode, and uiZoneNode.

Public Member Functions
virtual void	draw (uiNode_t *node)

virtual void	drawTooltip (const uiNode_t *node, int x, int y) const

virtual void	drawOverWindow (uiNode_t *node)

virtual void	doLayout (uiNode_t *node)
	Call to update the node layout. This common code revalidates the node tree. More...

virtual void	onSizeChanged (uiNode_t *node)
	Callback stub. More...

virtual void	onLeftClick (uiNode_t *node, int x, int y)

virtual void	onRightClick (uiNode_t *node, int x, int y)

virtual void	onMiddleClick (uiNode_t *node, int x, int y)

virtual bool	onScroll (uiNode_t *node, int deltaX, int deltaY)

virtual void	onMouseMove (uiNode_t *node, int x, int y)

virtual void	onMouseDown (uiNode_t *node, int x, int y, int button)

virtual void	onMouseUp (uiNode_t *node, int x, int y, int button)

virtual bool	onMouseLongPress (uiNode_t *node, int x, int y, int button)
	Send mouse event when a pressed mouse button is dragged. More...

virtual void	onMouseEnter (uiNode_t *node)

virtual void	onMouseLeave (uiNode_t *node)

virtual void	onCapturedMouseMove (uiNode_t *node, int x, int y)

virtual void	onCapturedMouseLost (uiNode_t *node)

virtual bool	onStartDragging (uiNode_t *node, int startX, int startY, int currentX, int currentY, int button)
	Send mouse event when a pressed mouse button is dragged. More...

virtual bool	onDndEnter (uiNode_t *node)

virtual bool	onDndMove (uiNode_t *node, int x, int y)

virtual void	onDndLeave (uiNode_t *node)

virtual bool	onDndDrop (uiNode_t *node, int x, int y)

virtual bool	onDndFinished (uiNode_t *node, bool isDropped)

virtual void	onFocusGained (uiNode_t *node)

virtual void	onFocusLost (uiNode_t *node)

virtual bool	onKeyPressed (uiNode_t *node, unsigned int key, unsigned short unicode)

virtual bool	onKeyReleased (uiNode_t *node, unsigned int key, unsigned short unicode)

virtual void	getClientPosition (uiNode_t const *node, vec2_t position)

virtual int	getCellWidth (uiNode_t *node)

virtual int	getCellHeight (uiNode_t *node)

Public Member Functions inherited from uiNode
virtual void	onLoading (uiNode_t *node)

virtual void	onLoaded (uiNode_t *node)

virtual void	clone (uiNode_t const source, uiNode_t clone)

virtual void	initNode (uiNode_t *node)

virtual void	initNodeDynamic (uiNode_t *node)

virtual void	deleteNode (uiNode_t *node)

virtual void	onWindowOpened (uiNode_t node, linkedList_t params)

virtual void	onWindowClosed (uiNode_t *node)

virtual void	onWindowActivate (uiNode_t *node)

virtual void	onActivate (uiNode_t *node)
	Activate the node. Can be used without the mouse (ie. a button will execute onClick) More...

virtual void	onPropertyChanged (uiNode_t node, const value_t property)

virtual	~uiNode ()

Detailed Description

Definition at line 68 of file ui_node_abstractnode.h.

Member Function Documentation

void uiLocatedNode::doLayout ( uiNode_t * node )

virtual

Call to update the node layout. This common code revalidates the node tree.

Called to update node layout

Reimplemented in uiTextNode, uiModelNode, uiWindowNode, uiOptionTreeNode, uiAbstractOptionNode, uiPanelNode, and uiOptionNode.

Definition at line 233 of file ui_node_abstractnode.cpp.

References uiNode_t::firstChild, uiNode_t::invalidated, uiNode_t::next, and UI_Node_DoLayout().

Referenced by uiPanelNode::doLayout(), uiWindowNode::doLayout(), uiModelNode::doLayout(), uiTextNode::doLayout(), and UI_Node_DoLayout().

virtual void uiLocatedNode::draw ( uiNode_t * node )

inlinevirtual

How to draw a node

Reimplemented in uiSpinnerNode, uiGeoscapeNode, uiContainerNode, uiWindowNode, uiTimerNode, uiImageNode, uiBaseInventoryNode, uiTextEntryNode, uiModelNode, uiRadioButtonNode, uiSequenceNode, uiVideoNode, uiButtonNode, uiCheckBoxNode, uiOptionListNode, uiRadarNode, uiTabNode, uiTextNode, uiText2Node, uiBarNode, uiItemNode, uiLineChartNode, uiMessageListNode, uiOptionTreeNode, uiPanelNode, uiRowsNode, uiSelectBoxNode, uiTBarNode, uiTextureNode, uiBaseLayoutNode, uiMaterialEditorNode, uiBattleScapeNode, uiEditorNode, uiStringNode, uiTextListNode, and uiVScrollbarNode.

Definition at line 71 of file ui_node_abstractnode.h.

Referenced by uiTimerNode::draw(), and UI_Node_Draw().

virtual void uiLocatedNode::drawOverWindow ( uiNode_t * node )

inlinevirtual

Callback to draw content over the window

See also: UI_CaptureDrawOver

Reimplemented in uiVideoNode, uiSelectBoxNode, and uiEditorNode.

Definition at line 75 of file ui_node_abstractnode.h.

Referenced by UI_Node_DrawOverWindow().

void uiLocatedNode::drawTooltip	(	const uiNode_t *	node,
		int	x,
		int	y
	)		const

virtual

Allow to draw a custom tooltip

Reimplemented in uiContainerNode, uiBaseInventoryNode, uiTabNode, uiBaseLayoutNode, and uiStringNode.

Definition at line 383 of file ui_node_abstractnode.cpp.

References UI_Tooltip().

Referenced by UI_Node_DrawTooltip().

virtual int uiLocatedNode::getCellHeight ( uiNode_t * node )

inlinevirtual

cell size

Reimplemented in uiTextNode, uiAbstractOptionNode, uiOptionListNode, uiOptionTreeNode, and uiMessageListNode.

Definition at line 145 of file ui_node_abstractnode.h.

Referenced by UI_Node_GetCellHeight().

virtual int uiLocatedNode::getCellWidth ( uiNode_t * node )

inlinevirtual

cell size

Reimplemented in uiAbstractOptionNode.

Definition at line 143 of file ui_node_abstractnode.h.

Referenced by UI_Node_GetCellWidth().

virtual void uiLocatedNode::getClientPosition	(	uiNode_t const *	node,
		vec2_t	position
	)

inlinevirtual

Return the position of the client zone into the node

Reimplemented in uiPanelNode.

Definition at line 141 of file ui_node_abstractnode.h.

Referenced by UI_Node_GetClientPosition().

virtual void uiLocatedNode::onCapturedMouseLost ( uiNode_t * node )

inlinevirtual

Capture is finished

Reimplemented in uiSpinnerNode, uiGeoscapeNode, uiVScrollbarNode, uiEditorNode, and uiZoneNode.

Definition at line 112 of file ui_node_abstractnode.h.

Referenced by UI_Node_CapturedMouseLost().

virtual void uiLocatedNode::onCapturedMouseMove	(	uiNode_t *	node,
		int	x,
		int	y
	)

inlinevirtual

Mouse move event in the node when captured

Reimplemented in uiContainerNode, uiGeoscapeNode, uiModelNode, uiPanelNode, uiBaseInventoryNode, uiTextNode, uiOptionListNode, uiRadarNode, uiMessageListNode, uiOptionTreeNode, uiBarNode, uiVScrollbarNode, uiControlNode, uiSelectBoxNode, and uiEditorNode.

Definition at line 110 of file ui_node_abstractnode.h.

Referenced by UI_Node_CapturedMouseMove().

bool uiLocatedNode::onDndDrop	(	uiNode_t *	node,
		int	x,
		int	y
	)

virtual

Send to the target to finalize the drop

Definition at line 207 of file ui_node_abstractnode.cpp.

References uiNode_t::dragdrop, uiNode_t::lua_onDragDropDrop, and UI_ExecuteLuaEventScript_DragDrop_XY().

Referenced by UI_Node_DndDrop().

bool uiLocatedNode::onDndEnter ( uiNode_t * node )

virtual

Send to the target when we enter first, return true if we can drop the DND somewhere on the node

Reimplemented in uiContainerNode, and uiBaseInventoryNode.

Definition at line 173 of file ui_node_abstractnode.cpp.

References uiNode_t::dragdrop, uiNode_t::lua_onDragDropEnter, and UI_ExecuteLuaEventScript_DragDrop().

Referenced by UI_Node_DndEnter().

bool uiLocatedNode::onDndFinished	(	uiNode_t *	node,
		bool	isDropped
	)

virtual

Sent to the source to finalize the drop

Reimplemented in uiContainerNode.

Definition at line 219 of file ui_node_abstractnode.cpp.

References uiNode_t::dragdrop, uiNode_t::lua_onDragDropFinished, and UI_ExecuteLuaEventScript_DragDrop_IsDropped().

Referenced by UI_Node_DndFinished().

void uiLocatedNode::onDndLeave ( uiNode_t * node )

virtual

Send to the target when the DND is canceled

Reimplemented in uiContainerNode, and uiBaseInventoryNode.

Definition at line 197 of file ui_node_abstractnode.cpp.

References uiNode_t::dragdrop, uiNode_t::lua_onDragDropLeave, and UI_ExecuteLuaEventScript_DragDrop().

Referenced by UI_Node_DndLeave().

bool uiLocatedNode::onDndMove	(	uiNode_t *	node,
		int	x,
		int	y
	)

virtual

Send to the target when we enter first, return true if we can drop the DND here

Reimplemented in uiContainerNode, and uiBaseInventoryNode.

Definition at line 185 of file ui_node_abstractnode.cpp.

References uiNode_t::dragdrop, uiNode_t::lua_onDragDropMove, and UI_ExecuteLuaEventScript_DragDrop_XY().

Referenced by UI_Node_DndMove().

void uiLocatedNode::onFocusGained ( uiNode_t * node )

virtual

Reimplemented in uiTextEntryNode.

Definition at line 444 of file ui_node_abstractnode.cpp.

References uiNode_t::lua_onFocusGained, and UI_ExecuteLuaEventScript().

Referenced by UI_Node_FocusGained().

void uiLocatedNode::onFocusLost ( uiNode_t * node )

virtual

Reimplemented in uiTextEntryNode.

Definition at line 450 of file ui_node_abstractnode.cpp.

References uiNode_t::lua_onFocusLost, and UI_ExecuteLuaEventScript().

Referenced by UI_Node_FocusLost().

bool uiLocatedNode::onKeyPressed	(	uiNode_t *	node,
		unsigned int	key,
		unsigned short	unicode
	)

virtual

Reimplemented in uiTextEntryNode.

Definition at line 456 of file ui_node_abstractnode.cpp.

References uiNode_t::lua_onKeyPressed, and UI_ExecuteLuaEventScript_Key().

Referenced by UI_Node_KeyPressed().

bool uiLocatedNode::onKeyReleased	(	uiNode_t *	node,
		unsigned int	key,
		unsigned short	unicode
	)

virtual

Definition at line 464 of file ui_node_abstractnode.cpp.

References uiNode_t::lua_onKeyReleased, and UI_ExecuteLuaEventScript_Key().

Referenced by UI_Node_KeyReleased().

void uiLocatedNode::onLeftClick	(	uiNode_t *	node,
		int	x,
		int	y
	)

virtual

Left mouse click event in the node

Reimplemented in uiGeoscapeNode, uiCheckBoxNode, uiSequenceNode, uiTabNode, uiOptionListNode, uiSelectBoxNode, uiTextNode, uiText2Node, uiTextEntryNode, uiOptionTreeNode, uiRadioButtonNode, and uiTextListNode.

Definition at line 388 of file ui_node_abstractnode.cpp.

References uiNode_t::lua_onClick, uiNode_t::onClick, UI_ExecuteEventActions(), UI_ExecuteLuaEventScript_XY(), and UI_PlaySound().

Referenced by UI_Node_LeftClick().

void uiLocatedNode::onMiddleClick	(	uiNode_t *	node,
		int	x,
		int	y
	)

virtual

Middle mouse button click event in the node

Definition at line 412 of file ui_node_abstractnode.cpp.

References uiNode_t::lua_onMiddleClick, uiNode_t::onMiddleClick, UI_ExecuteEventActions(), UI_ExecuteLuaEventScript_XY(), and UI_PlaySound().

Referenced by UI_Node_MiddleClick().

virtual void uiLocatedNode::onMouseDown	(	uiNode_t *	node,
		int	x,
		int	y,
		int	button
	)

inlinevirtual

Mouse button down event in the node

Reimplemented in uiSpinnerNode, uiContainerNode, uiBaseInventoryNode, uiTextNode, uiOptionListNode, uiRadarNode, uiMessageListNode, uiModelNode, uiOptionTreeNode, uiBarNode, uiControlNode, uiMaterialEditorNode, uiVScrollbarNode, uiEditorNode, and uiZoneNode.

Definition at line 95 of file ui_node_abstractnode.h.

Referenced by UI_Node_MouseDown().

void uiLocatedNode::onMouseEnter ( uiNode_t * node )

virtual

Mouse entered on the node (a child node is part of the node)

Mouse enter on the node (a child node is part of the node)

Definition at line 150 of file ui_node_abstractnode.cpp.

References uiNode_t::lua_onMouseEnter, uiNode_t::onMouseEnter, UI_ExecuteEventActions(), and UI_ExecuteLuaEventScript().

Referenced by UI_Node_MouseEnter().

void uiLocatedNode::onMouseLeave ( uiNode_t * node )

virtual

Mouse left the node

Mouse leave the node (a child node is part of the node)

Definition at line 163 of file ui_node_abstractnode.cpp.

References uiNode_t::lua_onMouseLeave, uiNode_t::onMouseLeave, UI_ExecuteEventActions(), and UI_ExecuteLuaEventScript().

Referenced by UI_Node_MouseLeave().

virtual bool uiLocatedNode::onMouseLongPress	(	uiNode_t *	node,
		int	x,
		int	y,
		int	button
	)

inlinevirtual

Send mouse event when a pressed mouse button is dragged.

Returns: True if the event is used

Reimplemented in uiPanelNode.

Definition at line 102 of file ui_node_abstractnode.h.

Referenced by UI_Node_MouseLongPress().

virtual void uiLocatedNode::onMouseMove	(	uiNode_t *	node,
		int	x,
		int	y
	)

inlinevirtual

Mouse move event in the node

Reimplemented in uiTextNode, uiText2Node, and uiTextListNode.

Definition at line 93 of file ui_node_abstractnode.h.

Referenced by uiMessageListNode::onCapturedMouseMove(), uiOptionTreeNode::onCapturedMouseMove(), uiOptionListNode::onCapturedMouseMove(), and UI_Node_MouseMove().

virtual void uiLocatedNode::onMouseUp	(	uiNode_t *	node,
		int	x,
		int	y,
		int	button
	)

inlinevirtual

Mouse button up event in the node

Reimplemented in uiSpinnerNode, uiContainerNode, uiGeoscapeNode, uiBaseInventoryNode, uiPanelNode, uiTextNode, uiOptionListNode, uiRadarNode, uiMessageListNode, uiModelNode, uiOptionTreeNode, uiBarNode, uiControlNode, uiVScrollbarNode, uiEditorNode, and uiZoneNode.

Definition at line 97 of file ui_node_abstractnode.h.

Referenced by UI_Node_MouseUp().

void uiLocatedNode::onRightClick	(	uiNode_t *	node,
		int	x,
		int	y
	)

virtual

Right mouse button click event in the node

Reimplemented in uiTextNode, uiText2Node, and uiTextListNode.

Definition at line 400 of file ui_node_abstractnode.cpp.

References uiNode_t::lua_onRightClick, uiNode_t::onRightClick, UI_ExecuteEventActions(), UI_ExecuteLuaEventScript_XY(), and UI_PlaySound().

Referenced by UI_Node_RightClick().

bool uiLocatedNode::onScroll	(	uiNode_t *	node,
		int	deltaX,
		int	deltaY
	)

virtual

Mouse wheel event in the node

Reimplemented in uiSpinnerNode, uiGeoscapeNode, uiBaseInventoryNode, uiPanelNode, uiTextNode, uiBattleScapeNode, uiOptionListNode, uiVScrollbarNode, uiMaterialEditorNode, uiMessageListNode, and uiOptionTreeNode.

Definition at line 363 of file ui_node_abstractnode.cpp.

References uiNode_t::lua_onWheel, uiNode_t::lua_onWheelDown, uiNode_t::lua_onWheelUp, uiNode_t::onWheel, uiNode_t::onWheelDown, uiNode_t::onWheelUp, UI_ExecuteEventActions(), and UI_ExecuteLuaEventScript_DxDy().

Referenced by UI_Node_Scroll().

void uiLocatedNode::onSizeChanged ( uiNode_t * node )

virtual

Callback stub.

Called when the node size change

Reimplemented in uiWindowNode, and uiBattleScapeNode.

Definition at line 269 of file ui_node_abstractnode.cpp.

References uiNode_t::firstChild, and UI_Invalidate().

Referenced by UI_Node_PosChanged(), and UI_Node_SizeChanged().

virtual bool uiLocatedNode::onStartDragging	(	uiNode_t *	node,
		int	startX,
		int	startY,
		int	currentX,
		int	currentY,
		int	button
	)

inlinevirtual

Send mouse event when a pressed mouse button is dragged.

Returns: True if the event is used

Reimplemented in uiGeoscapeNode, and uiPanelNode.

Definition at line 117 of file ui_node_abstractnode.h.

Referenced by UI_Node_StartDragging().

The documentation for this class was generated from the following files:

src/client/ui/node/ui_node_abstractnode.h
src/client/ui/node/ui_node_abstractnode.cpp

Public Member Functions

Detailed Description

Member Function Documentation