neogfx::i_scrollbar Class Reference

#include <i_scrollbar.hpp>

Inheritance diagram for neogfx::i_scrollbar:

Classes
struct	already_locked
struct	element_already_clicked
struct	element_not_clicked
struct	not_locked

Public Types
enum	update_reason_e {   Updated = 0x00 , Shown = 0x01 , Hidden = 0x02 , AttributeChanged = 0x03 ,   ScrolledUp = 0x04 , ScrolledLeft = ScrolledUp , ScrolledDown = 0x05 , ScrolledRight = ScrolledDown }
typedef double	value_type
typedef neolib::variant< point >	update_params_t

Public Member Functions
virtual i_scrollbar_container &	container () const =0
virtual scrollbar_orientation	orientation () const =0
virtual scrollbar_style	style () const =0
virtual scrollbar_style	type () const =0
virtual void	set_style (scrollbar_style aStyle)=0
virtual bool	always_visible () const =0
virtual bool	always_hidden () const =0
virtual void	show ()=0
virtual void	hide ()=0
virtual bool	visible () const =0
virtual bool	auto_hide () const =0
virtual void	set_auto_hide (bool aAutoHide)=0
virtual bool	auto_hidden () const =0
virtual scrollbar_zone	zone () const =0
virtual void	push_zone ()=0
virtual scrollbar_zone	pop_zone ()=0
virtual value_type	position () const =0
virtual value_type	effective_position () const =0
virtual value_type	maximum_position () const =0
virtual bool	set_position (value_type aPosition)=0
virtual value_type	minimum () const =0
virtual void	set_minimum (value_type aMinimum)=0
virtual value_type	maximum () const =0
virtual void	set_maximum (value_type aMaximum)=0
virtual value_type	step () const =0
virtual void	set_step (value_type aStep)=0
virtual value_type	page () const =0
virtual void	set_page (value_type aPage)=0
virtual bool	locked () const =0
virtual void	lock (value_type aPosition)=0
virtual void	unlock ()=0
virtual dimension	width () const =0
virtual void	render (i_graphics_context &aGc) const =0
virtual rect	element_geometry (scrollbar_element aElement) const =0
virtual scrollbar_element	element_at (point const &aPosition) const =0
virtual void	update (const update_params_t &aUpdateParams=update_params_t())=0
virtual scrollbar_element	clicked_element () const =0
virtual void	click_element (scrollbar_element aElement)=0
virtual void	unclick_element ()=0
virtual scrollbar_element	hovering_element () const =0
virtual void	hover_element (scrollbar_element aElement)=0
virtual void	unhover_element ()=0
virtual void	pause ()=0
virtual void	resume ()=0
virtual void	track ()=0
virtual void	untrack ()=0
virtual bool	transition_set () const noexcept=0
virtual void	set_transition (easing aTransition, double aTransitionDuration=0.5, bool aOnlyWhenPaging=true)=0
virtual void	clear_transition ()=0
Public Member Functions inherited from neogfx::i_property_owner
virtual	~i_property_owner ()=default
virtual void	property_changed (i_property &aProperty)=0
virtual const i_properties &	properties () const =0
virtual i_properties &	properties ()=0
Public Member Functions inherited from neogfx::i_object
virtual	~i_object ()=default
virtual i_object &	as_object ()=0
virtual void	class_name (neolib::i_string &aClassName) const =0
virtual neogfx::object_type	object_type () const =0
Public Member Functions inherited from neolib::i_object
	declare_event (destroying)
	declare_event (destroyed)
Public Member Functions inherited from neolib::i_lifetime
virtual	~i_lifetime ()=default
virtual lifetime_state	object_state () const =0
virtual std::shared_ptr< std::atomic< lifetime_state > >	object_state_ptr () const =0
virtual bool	is_creating () const =0
virtual bool	is_alive () const =0
virtual bool	is_destroying () const =0
virtual bool	is_destroyed () const =0
virtual void	set_alive ()=0
virtual void	set_destroying ()=0
virtual void	set_destroyed ()=0

Detailed Description

Definition at line 92 of file i_scrollbar.hpp.

Member Typedef Documentation

update_params_t

typedef neolib::variant<point> neogfx::i_scrollbar::update_params_t

Definition at line 107 of file i_scrollbar.hpp.

value_type

typedef double neogfx::i_scrollbar::value_type

Definition at line 95 of file i_scrollbar.hpp.

Member Enumeration Documentation

update_reason_e

enum neogfx::i_scrollbar::update_reason_e

Enumerator
Updated
Shown
Hidden
AttributeChanged
ScrolledUp
ScrolledLeft
ScrolledDown
ScrolledRight

Definition at line 96 of file i_scrollbar.hpp.

Member Function Documentation

always_hidden()

virtual bool neogfx::i_scrollbar::always_hidden ( ) const

pure virtual

always_visible()

virtual bool neogfx::i_scrollbar::always_visible ( ) const

pure virtual

auto_hidden()

virtual bool neogfx::i_scrollbar::auto_hidden ( ) const

pure virtual

auto_hide()

virtual bool neogfx::i_scrollbar::auto_hide ( ) const

pure virtual

clear_transition()

virtual void neogfx::i_scrollbar::clear_transition ( )

pure virtual

click_element()

virtual void neogfx::i_scrollbar::click_element ( scrollbar_element  aElement )

pure virtual

clicked_element()

virtual scrollbar_element neogfx::i_scrollbar::clicked_element ( ) const

pure virtual

container()

virtual i_scrollbar_container & neogfx::i_scrollbar::container ( ) const

pure virtual

effective_position()

virtual value_type neogfx::i_scrollbar::effective_position ( ) const

pure virtual

element_at()

virtual scrollbar_element neogfx::i_scrollbar::element_at ( point const &  aPosition ) const

pure virtual

element_geometry()

virtual rect neogfx::i_scrollbar::element_geometry ( scrollbar_element  aElement ) const

pure virtual

hide()

virtual void neogfx::i_scrollbar::hide ( )

pure virtual

hover_element()

virtual void neogfx::i_scrollbar::hover_element ( scrollbar_element  aElement )

pure virtual

hovering_element()

virtual scrollbar_element neogfx::i_scrollbar::hovering_element ( ) const

pure virtual

lock()

virtual void neogfx::i_scrollbar::lock ( value_type  aPosition )

pure virtual

locked()

virtual bool neogfx::i_scrollbar::locked ( ) const

pure virtual

maximum()

virtual value_type neogfx::i_scrollbar::maximum ( ) const

pure virtual

maximum_position()

virtual value_type neogfx::i_scrollbar::maximum_position ( ) const

pure virtual

minimum()

virtual value_type neogfx::i_scrollbar::minimum ( ) const

pure virtual

orientation()

virtual scrollbar_orientation neogfx::i_scrollbar::orientation ( ) const

pure virtual

page()

virtual value_type neogfx::i_scrollbar::page ( ) const

pure virtual

pause()

virtual void neogfx::i_scrollbar::pause ( )

pure virtual

pop_zone()

virtual scrollbar_zone neogfx::i_scrollbar::pop_zone ( )

pure virtual

position()

virtual value_type neogfx::i_scrollbar::position ( ) const

pure virtual

push_zone()

virtual void neogfx::i_scrollbar::push_zone ( )

pure virtual

render()

virtual void neogfx::i_scrollbar::render ( i_graphics_context &  aGc ) const

pure virtual

resume()

virtual void neogfx::i_scrollbar::resume ( )

pure virtual

set_auto_hide()

virtual void neogfx::i_scrollbar::set_auto_hide ( bool  aAutoHide )

pure virtual

set_maximum()

virtual void neogfx::i_scrollbar::set_maximum ( value_type  aMaximum )

pure virtual

set_minimum()

virtual void neogfx::i_scrollbar::set_minimum ( value_type  aMinimum )

pure virtual

set_page()

virtual void neogfx::i_scrollbar::set_page ( value_type  aPage )

pure virtual

set_position()

virtual bool neogfx::i_scrollbar::set_position ( value_type  aPosition )

pure virtual

set_step()

virtual void neogfx::i_scrollbar::set_step ( value_type  aStep )

pure virtual

set_style()

virtual void neogfx::i_scrollbar::set_style ( scrollbar_style  aStyle )

pure virtual

set_transition()

virtual void neogfx::i_scrollbar::set_transition ( easing  aTransition, double  aTransitionDuration = 0.5, bool  aOnlyWhenPaging = true  )

pure virtual

show()

virtual void neogfx::i_scrollbar::show ( )

pure virtual

step()

virtual value_type neogfx::i_scrollbar::step ( ) const

pure virtual

style()

virtual scrollbar_style neogfx::i_scrollbar::style ( ) const

pure virtual

track()

virtual void neogfx::i_scrollbar::track ( )

pure virtual

transition_set()

virtual bool neogfx::i_scrollbar::transition_set ( ) const

pure virtualnoexcept

type()

virtual scrollbar_style neogfx::i_scrollbar::type ( ) const

pure virtual

unclick_element()

virtual void neogfx::i_scrollbar::unclick_element ( )

pure virtual

unhover_element()

virtual void neogfx::i_scrollbar::unhover_element ( )

pure virtual

unlock()

virtual void neogfx::i_scrollbar::unlock ( )

pure virtual

untrack()

virtual void neogfx::i_scrollbar::untrack ( )

pure virtual

update()

virtual void neogfx::i_scrollbar::update ( const update_params_t &  aUpdateParams = update_params_t() )

pure virtual

visible()

virtual bool neogfx::i_scrollbar::visible ( ) const

pure virtual

width()

virtual dimension neogfx::i_scrollbar::width ( ) const

pure virtual

zone()

virtual scrollbar_zone neogfx::i_scrollbar::zone ( ) const

pure virtual

---

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

• include/neogfx/gui/widget/i_scrollbar.hpp