UFO: Alien Invasion
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
uiSpinnerNode Class Reference

#include <ui_node_spinner.h>

Inherits uiAbstractValueNode.

Public Member Functions

void repeat (uiNode_t *node, struct uiTimer_s *timer)
 
- Public Member Functions inherited from uiAbstractValueNode
void onLoaded (uiNode_t *node) override
 
void clone (uiNode_t const *source, uiNode_t *clone) override
 Call to update a cloned node. More...
 
void initNode (uiNode_t *node) override
 
void initNodeDynamic (uiNode_t *node) override
 
void deleteNode (uiNode_t *node) override
 
void setRange (uiNode_t *node, float min, float max)
 
bool setValue (uiNode_t *node, float value)
 
bool setDelta (uiNode_t *node, float delta)
 
bool setMax (uiNode_t *node, float max)
 
bool setMin (uiNode_t *node, float min)
 
bool incValue (uiNode_t *node)
 
bool decValue (uiNode_t *node)
 
float getFactorFloat (uiNode_t const *node)
 
float getMin (uiNode_t const *node)
 
float getMax (uiNode_t const *node)
 
float getDelta (uiNode_t const *node)
 
float getValue (uiNode_t const *node)
 
float getLastDiff (uiNode_t const *node)
 
float getShiftIncreaseFactor (uiNode_t *const node)
 
- Public Member Functions inherited from uiLocatedNode
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 void onMouseMove (uiNode_t *node, int x, int y)
 
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 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 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 ()
 

Protected Member Functions

bool isPositionIncrease (uiNode_t *node, int x, int y)
 Check a position relative to the node to check action is can produce. More...
 
bool step (uiNode_t *node, bool down)
 change the value of the spinner of one step More...
 

Private Member Functions

void draw (uiNode_t *node) override
 
void onLoading (uiNode_t *node) override
 
void onMouseDown (uiNode_t *node, int x, int y, int button) override
 
void onMouseUp (uiNode_t *node, int x, int y, int button) override
 
void onCapturedMouseLost (uiNode_t *node) override
 Called when the node have lost the captured node We clean cached data. More...
 
bool onScroll (uiNode_t *node, int deltaX, int deltaY) override
 

Detailed Description

Definition at line 45 of file ui_node_spinner.h.

Member Function Documentation

bool uiSpinnerNode::isPositionIncrease ( uiNode_t node,
int  x,
int  y 
)
protected

Check a position relative to the node to check action is can produce.

Parameters
nodeThis node
x,yRelative location to the node
Returns
True if the current location can increase the value

Definition at line 85 of file ui_node_spinner.cpp.

References uiNode_t::box, EXTRADATA, uiBox_t::size, SPINNER_NORMAL, SPINNER_ONLY_DECREASE, and SPINNER_ONLY_INCREASE.

Referenced by draw(), and onMouseDown().

void uiSpinnerNode::onCapturedMouseLost ( uiNode_t node)
overrideprivatevirtual

Called when the node have lost the captured node We clean cached data.

Reimplemented from uiLocatedNode.

Definition at line 130 of file ui_node_spinner.cpp.

References UI_TimerRelease().

void uiSpinnerNode::onLoading ( uiNode_t node)
overrideprivatevirtual

Called before script initialization, initialized default values

Reimplemented from uiAbstractValueNode.

Definition at line 219 of file ui_node_spinner.cpp.

References uiAbstractValueNode::onLoading().

void uiSpinnerNode::onMouseDown ( uiNode_t node,
int  x,
int  y,
int  button 
)
overrideprivatevirtual
void uiSpinnerNode::onMouseUp ( uiNode_t node,
int  x,
int  y,
int  button 
)
overrideprivatevirtual

Mouse button up event in the node

Reimplemented from uiLocatedNode.

Definition at line 119 of file ui_node_spinner.cpp.

References K_MOUSE1, UI_GetMouseCapture(), and UI_MouseRelease().

bool uiSpinnerNode::onScroll ( uiNode_t node,
int  deltaX,
int  deltaY 
)
overrideprivatevirtual
Note
Mouse wheel is not inhibited when node is disabled

Reimplemented from uiLocatedNode.

Definition at line 141 of file ui_node_spinner.cpp.

References uiNode_t::disabled, down, uiNode_t::parent, and step().

void uiSpinnerNode::repeat ( uiNode_t node,
struct uiTimer_s timer 
)

Definition at line 62 of file ui_node_spinner.cpp.

References uiTimer_s::calledTime, capturedDownButton, uiTimer_s::delay, and step().

Referenced by UI_SpinnerNodeRepeat().

bool uiSpinnerNode::step ( uiNode_t node,
bool  down 
)
protected

change the value of the spinner of one step

Parameters
[in]nodeSpinner to change
[in]downDirection of the step (if down is true, decrease the value)

Definition at line 55 of file ui_node_spinner.cpp.

References uiAbstractValueNode::decValue(), and uiAbstractValueNode::incValue().

Referenced by onMouseDown(), onScroll(), and repeat().


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