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

Scroll representation. More...

#include <ui_node_abstractscrollable.h>

Public Member Functions

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

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

bool uiScroll_t::move ( int  viewPos)

Fix a new position.

Parameters
[in]viewPosNew 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().

bool uiScroll_t::moveDelta ( int  deltaPos)
inline

Move the position with a delta position.

Parameters
[in]deltaPosVariation of the position
Returns
True, if something have changed

Definition at line 70 of file ui_node_abstractscrollable.h.

References move().

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

Set the scroll to a position.

Parameters
[in]viewPosNew position to set, else -1 if no change
[in]viewSizeNew view size to set, else -1 if no change
[in]fullSizeNew 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

int uiScroll_t::fullSize

Full size allowed

Definition at line 61 of file ui_node_abstractscrollable.h.

Referenced by move(), and set().

int uiScroll_t::viewPos

Position of the view

Definition at line 59 of file ui_node_abstractscrollable.h.

Referenced by move(), and set().

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: