uiScroll_t Struct Reference

Scroll representation. More...

#include <ui_node_abstractscrollable.h>

Collaboration diagram for uiScroll_t:

Public Member Functions
bool	set (int viewPos, int viewSize, int fullSize)
	Set the scroll to a position.
bool	move (int viewPos)
	Fix a new position.
bool	moveDelta (int deltaPos)
	Move the position with a delta position.

Data Fields
int	viewPos
int	viewSize
int	fullSize

Detailed Description

Scroll representation.

Definition at line 58 of file ui_node_abstractscrollable.h.

Member Function Documentation

move()

bool uiScroll_t::move

(

int

viewPos

)

Fix a new position.

Parameters

[in]

viewPos

New view position

Returns

True, if something have changed

Definition at line 63 of file ui_node_abstractscrollable.cpp.

References fullSize, viewPos, and viewSize.

Referenced by moveDelta().

moveDelta()

bool uiScroll_t::moveDelta ( int deltaPos )

inline

Move the position with a delta position.

Parameters

[in]

deltaPos

Variation of the position

Returns

True, if something have changed

Definition at line 70 of file ui_node_abstractscrollable.h.

References move().

set()

bool uiScroll_t::set	(	int	viewPos,
		int	viewSize,
		int	fullSize )

Set the scroll to a position.

Parameters

[in]	viewPos	New position to set, else -1 if no change
[in]	viewSize	New view size to set, else -1 if no change
[in]	fullSize	New full size to set, else -1 if no change

Returns

True, if something have changed

Definition at line 87 of file ui_node_abstractscrollable.cpp.

References fullSize, viewPos, and viewSize.

Field Documentation

fullSize

int uiScroll_t::fullSize

Full size allowed

Definition at line 61 of file ui_node_abstractscrollable.h.

Referenced by move(), and set().

viewPos

int uiScroll_t::viewPos

Position of the view

Definition at line 59 of file ui_node_abstractscrollable.h.

Referenced by move(), and set().

viewSize

int uiScroll_t::viewSize

Visible size

Definition at line 60 of file ui_node_abstractscrollable.h.

Referenced by move(), and set().

---

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

• src/client/ui/node/ui_node_abstractscrollable.h
• src/client/ui/node/ui_node_abstractscrollable.cpp