neoGFX
Cross-platform C++ app/game engine
Loading...
Searching...
No Matches
neogfx::scrollbar Class Reference

#include <scrollbar.hpp>

Inheritance diagram for neogfx::scrollbar:
neogfx::object< i_scrollbar > neogfx::i_skinnable_item neolib::object< Base > neogfx::i_properties neolib::lifetime< Base > neolib::i_lifetime

Classes

struct  no_transition
 

Public Member Functions

 scrollbar (i_scrollbar_container &aContainer, scrollbar_orientation aOrientation, scrollbar_style aStyle=scrollbar_style::Normal, bool aIntegerPositions=true)
 
 ~scrollbar ()
 
i_scrollbar_containercontainer () const override
 
scrollbar_orientation orientation () const override
 
scrollbar_style style () const override
 
scrollbar_style type () const override
 
void set_style (scrollbar_style aStyle) override
 
bool always_visible () const override
 
bool always_hidden () const override
 
void show () override
 
void hide () override
 
bool visible () const override
 
bool auto_hide () const override
 
void set_auto_hide (bool aAutoHide) override
 
bool auto_hidden () const override
 
scrollbar_zone zone () const override
 
void push_zone () override
 
scrollbar_zone pop_zone () override
 
value_type position () const override
 
value_type effective_position () const override
 
value_type maximum_position () const override
 
bool set_position (value_type aPosition) override
 
value_type minimum () const override
 
void set_minimum (value_type aMinimum) override
 
value_type maximum () const override
 
void set_maximum (value_type aMaximum) override
 
value_type step () const override
 
void set_step (value_type aStep) override
 
value_type page () const override
 
void set_page (value_type aPage) override
 
bool locked () const override
 
void lock (value_type aPosition) override
 
void unlock () override
 
dimension width () const override
 
void render (i_graphics_context &aGc) const override
 
rect element_geometry (scrollbar_element aElement) const override
 
scrollbar_element element_at (const point &aPosition) const override
 
void update (const update_params_t &aUpdateParams=update_params_t()) override
 
scrollbar_element clicked_element () const override
 
void click_element (scrollbar_element aElement) override
 
void unclick_element () override
 
scrollbar_element hovering_element () const override
 
void hover_element (scrollbar_element aElement) override
 
void unhover_element () override
 
void pause () override
 
void resume () override
 
void track () override
 
void untrack () override
 
bool transition_set () const noexcept override
 
void set_transition (easing aTransition, double aTransitionDuration=0.5, bool aOnlyWhenPaging=true) override
 
void clear_transition () override
 
bool is_widget () const final
 
const i_widgetas_widget () const final
 
i_widgetas_widget ()
 
rect element_rect (skin_element aElement) const override
 
- Public Member Functions inherited from neogfx::object< i_scrollbar >
i_objectas_object () override
 
void class_name (neolib::i_string &aClassName) const override
 
neogfx::object_type object_type () const override
 
void property_changed (i_property &) override
 
const i_propertiesproperties () const override
 
i_propertiesproperties () override
 
void register_property (i_property &aProperty) override
 
const neogfx::property_mapproperty_map () const override
 
- Public Member Functions inherited from neolib::object< Base >
 define_declared_event (Destroying, destroying)
 
 define_declared_event (Destroyed, destroyed)
 
 object (lifetime_state aState=lifetime_state::Creating)
 
 ~object ()
 
void set_destroying () override
 
void set_destroyed () override
 
bool is_alive () const final
 
bool is_destroyed () const final
 
- Public Member Functions inherited from neolib::lifetime< Base >
 lifetime (lifetime_state aState=lifetime_state::Alive)
 
virtual ~lifetime ()
 
lifetime_state object_state () const final
 
std::shared_ptr< std::atomic< lifetime_state > > object_state_ptr () const final
 
bool is_creating () const final
 
bool is_destroying () const final
 
void set_alive () override
 
- Public Member Functions inherited from neolib::i_lifetime
virtual ~i_lifetime ()=default
 
- Public Member Functions inherited from neogfx::i_properties
uint32_t count () const
 
std::string name (uint32_t aIndex) const
 
const i_propertyproperty (uint32_t aIndex) const
 
i_propertyproperty (uint32_t aIndex)
 
- Public Member Functions inherited from neogfx::i_skinnable_item
virtual ~i_skinnable_item ()=default
 

Static Public Member Functions

static dimension width (scrollbar_style aStyle)
 

Additional Inherited Members

- Public Types inherited from neolib::lifetime< Base >
typedef neolib::destroyed_flag destroyed_flag
 
- Protected Member Functions inherited from neogfx::i_properties
neogfx::property_mapproperty_map ()
 

Detailed Description

Definition at line 34 of file scrollbar.hpp.

Constructor & Destructor Documentation

◆ scrollbar()

neogfx::scrollbar::scrollbar ( i_scrollbar_container aContainer,
scrollbar_orientation  aOrientation,
scrollbar_style  aStyle = scrollbar_style::Normal,
bool  aIntegerPositions = true 
)

◆ ~scrollbar()

neogfx::scrollbar::~scrollbar ( )

Member Function Documentation

◆ always_hidden()

bool neogfx::scrollbar::always_hidden ( ) const
override

◆ always_visible()

bool neogfx::scrollbar::always_visible ( ) const
override

◆ as_widget() [1/2]

i_widget & neogfx::scrollbar::as_widget ( )

◆ as_widget() [2/2]

const i_widget & neogfx::scrollbar::as_widget ( ) const
finalvirtual

◆ auto_hidden()

bool neogfx::scrollbar::auto_hidden ( ) const
override

◆ auto_hide()

bool neogfx::scrollbar::auto_hide ( ) const
override

◆ clear_transition()

void neogfx::scrollbar::clear_transition ( )
override

◆ click_element()

void neogfx::scrollbar::click_element ( scrollbar_element  aElement)
override

◆ clicked_element()

scrollbar_element neogfx::scrollbar::clicked_element ( ) const
override

◆ container()

i_scrollbar_container & neogfx::scrollbar::container ( ) const
override

◆ effective_position()

value_type neogfx::scrollbar::effective_position ( ) const
override

◆ element_at()

scrollbar_element neogfx::scrollbar::element_at ( const point aPosition) const
override

◆ element_geometry()

rect neogfx::scrollbar::element_geometry ( scrollbar_element  aElement) const
override

◆ element_rect()

rect neogfx::scrollbar::element_rect ( skin_element  aElement) const
overridevirtual

◆ hide()

void neogfx::scrollbar::hide ( )
override

◆ hover_element()

void neogfx::scrollbar::hover_element ( scrollbar_element  aElement)
override

◆ hovering_element()

scrollbar_element neogfx::scrollbar::hovering_element ( ) const
override

◆ is_widget()

bool neogfx::scrollbar::is_widget ( ) const
finalvirtual

◆ lock()

void neogfx::scrollbar::lock ( value_type  aPosition)
override

◆ locked()

bool neogfx::scrollbar::locked ( ) const
override

◆ maximum()

value_type neogfx::scrollbar::maximum ( ) const
override

◆ maximum_position()

value_type neogfx::scrollbar::maximum_position ( ) const
override

◆ minimum()

value_type neogfx::scrollbar::minimum ( ) const
override

◆ orientation()

scrollbar_orientation neogfx::scrollbar::orientation ( ) const
override

◆ page()

value_type neogfx::scrollbar::page ( ) const
override

◆ pause()

void neogfx::scrollbar::pause ( )
override

◆ pop_zone()

scrollbar_zone neogfx::scrollbar::pop_zone ( )
override

◆ position()

value_type neogfx::scrollbar::position ( ) const
override

◆ push_zone()

void neogfx::scrollbar::push_zone ( )
override

◆ render()

void neogfx::scrollbar::render ( i_graphics_context aGc) const
override

◆ resume()

void neogfx::scrollbar::resume ( )
override

◆ set_auto_hide()

void neogfx::scrollbar::set_auto_hide ( bool  aAutoHide)
override

◆ set_maximum()

void neogfx::scrollbar::set_maximum ( value_type  aMaximum)
override

◆ set_minimum()

void neogfx::scrollbar::set_minimum ( value_type  aMinimum)
override

◆ set_page()

void neogfx::scrollbar::set_page ( value_type  aPage)
override

◆ set_position()

bool neogfx::scrollbar::set_position ( value_type  aPosition)
override

◆ set_step()

void neogfx::scrollbar::set_step ( value_type  aStep)
override

◆ set_style()

void neogfx::scrollbar::set_style ( scrollbar_style  aStyle)
override

◆ set_transition()

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

◆ show()

void neogfx::scrollbar::show ( )
override

◆ step()

value_type neogfx::scrollbar::step ( ) const
override

◆ style()

scrollbar_style neogfx::scrollbar::style ( ) const
override

◆ track()

void neogfx::scrollbar::track ( )
override

◆ transition_set()

bool neogfx::scrollbar::transition_set ( ) const
overridenoexcept

◆ type()

scrollbar_style neogfx::scrollbar::type ( ) const
override

◆ unclick_element()

void neogfx::scrollbar::unclick_element ( )
override

◆ unhover_element()

void neogfx::scrollbar::unhover_element ( )
override

◆ unlock()

void neogfx::scrollbar::unlock ( )
override

◆ untrack()

void neogfx::scrollbar::untrack ( )
override

◆ update()

void neogfx::scrollbar::update ( const update_params_t &  aUpdateParams = update_params_t())
override

◆ visible()

bool neogfx::scrollbar::visible ( ) const
override

◆ width() [1/2]

dimension neogfx::scrollbar::width ( ) const
override

◆ width() [2/2]

static dimension neogfx::scrollbar::width ( scrollbar_style  aStyle)
static

◆ zone()

scrollbar_zone neogfx::scrollbar::zone ( ) const
override

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