nana::scroll_interface Class Reference

Inheritance diagram for nana::scroll_interface:

Public Types
using	size_type = std::size_t

Public Member Functions
virtual	~scroll_interface ()=default
virtual bool	scrollable (bool for_less) const =0
	Determines whether it is scrollable. More...
virtual size_type	amount () const =0
	the whole total (peak) More...
virtual void	amount (size_type peak)=0
virtual size_type	range () const =0
	Get the range of the widget (how many is shown on a page, that is, How many to scroll after click on first or second) More...
virtual void	range (size_type r)=0
	Set the range of the widget. More...
virtual size_type	value () const =0
	Get the value (current offset calculated from the very beginning) More...
virtual void	value (size_type s)=0
	Set the value. More...
virtual size_type	step () const =0
	Get the step of the sroll widget. The step indicates a variation of the value. More...
virtual void	step (size_type s)=0
	Set the step. More...
virtual bool	make_step (bool forward, unsigned steps=1)=0
	Increase/decrease values by a step (alternatively by some number of steps). More...
virtual window	window_handle () const =0

Member Typedef Documentation

using nana::scroll_interface::size_type = std::size_t

Constructor & Destructor Documentation

virtual nana::scroll_interface::~scroll_interface ( )

virtualdefault

Member Function Documentation

virtual size_type nana::scroll_interface::amount ( ) const

pure virtual

the whole total (peak)

Implemented in nana::scroll< Vert >, nana::scroll< false >, nana::scroll< Vertical >, and nana::scroll< true >.

virtual void nana::scroll_interface::amount ( size_type  peak )

pure virtual

Implemented in nana::scroll< Vert >, nana::scroll< false >, nana::scroll< Vertical >, and nana::scroll< true >.

virtual bool nana::scroll_interface::make_step ( bool  forward, unsigned  steps = 1  )

pure virtual

Increase/decrease values by a step (alternatively by some number of steps).

Parameters

forward

it determines whether increase or decrease.

Returns

true if the value is changed.

Implemented in nana::scroll< Vert >, nana::scroll< false >, nana::scroll< Vertical >, and nana::scroll< true >.

virtual size_type nana::scroll_interface::range ( ) const

pure virtual

Get the range of the widget (how many is shown on a page, that is, How many to scroll after click on first or second)

Implemented in nana::scroll< Vert >, nana::scroll< false >, nana::scroll< Vertical >, and nana::scroll< true >.

virtual void nana::scroll_interface::range ( size_type  r )

pure virtual

Set the range of the widget.

Implemented in nana::scroll< Vert >, nana::scroll< false >, nana::scroll< Vertical >, and nana::scroll< true >.

virtual bool nana::scroll_interface::scrollable ( bool  for_less ) const

pure virtual

Determines whether it is scrollable.

Parameters

for_less

whether it can be scrolled for a less value (backward or "up" if true, forward or "down" if false).

Implemented in nana::scroll< Vert >, nana::scroll< false >, nana::scroll< Vertical >, and nana::scroll< true >.

virtual size_type nana::scroll_interface::step ( ) const

pure virtual

Get the step of the sroll widget. The step indicates a variation of the value.

Returns

the step.

Implemented in nana::scroll< Vert >, nana::scroll< false >, nana::scroll< Vertical >, and nana::scroll< true >.

virtual void nana::scroll_interface::step ( size_type  s )

pure virtual

Set the step.

Parameters

s	a value for step.

Implemented in nana::scroll< Vert >, nana::scroll< false >, nana::scroll< Vertical >, and nana::scroll< true >.

virtual size_type nana::scroll_interface::value ( ) const

pure virtual

Get the value (current offset calculated from the very beginning)

Returns

the value.

Implemented in nana::scroll< Vert >, nana::scroll< false >, nana::scroll< Vertical >, and nana::scroll< true >.

virtual void nana::scroll_interface::value ( size_type  s )

pure virtual

Set the value.

Parameters

s	a new value.

Implemented in nana::scroll< Vert >, nana::scroll< false >, nana::scroll< Vertical >, and nana::scroll< true >.

virtual window nana::scroll_interface::window_handle ( ) const

pure virtual

Implemented in nana::scroll< Vert >, nana::scroll< false >, nana::scroll< Vertical >, and nana::scroll< true >.