UScrollbar Class Reference

Scrollbar gadget. More...

#include <uscrollbar.hpp>

List of all members.

Public Types
enum	Modes { STANDARD = 1, TRANSP = 1<<1, WITH_RAIL = 1<<2, WITH_FEEDBACK = 1<<3 }
Public Member Functions
	UScrollbar (const UArgs &=UArgs::none)
	UScrollbar (const class UOrient &, const UArgs &=UArgs::none)
	UScrollbar (UFloat &value, const class UOrient &, const UArgs &=UArgs::none)
	constructors (default orientation is UOrient::Vertical) constructor: see also shortcut creator uscrollbar() and UGroup::~UGroup()
virtual const UStyle &	getStyle (UContext *) const
bool	isHorizontal () const
bool	isVertical () const
float	getValue () const
UFloat &	value () const
void	setValue (const UFloat &percent)
void	setValue (float percent, bool update_pane=true)
	gets/sets scrollbar value (float between 0 and 100)
float	getScrollerIncrement () const
void	setScrollerIncrement (float percent)
	get/sets value increment when clicking on a Scroller (float between 0 and 100).
float	getBackgroundIncrement () const
void	setBackgroundIncrement (float percent)
	get/sets value increment when clicking on the background of the scrollbar (float between 0 and 100).
void	setUpdateOnDrag (bool state=true)
	update on drag is the default.
bool	isTransparent () const
void	setTransparent (bool state)
void	setPane (class UPane *)
	[impl] attaches the scrollbar to a UPane or a UScrollpane.
Static Public Attributes
static class UScrollbarStyle *	style
Protected Member Functions
virtual UBox &	createRail (const UArgs &=UArgs::none)
virtual UBox &	createSlider (const UArgs &=UArgs::none)
virtual UBox &	createLessScroller (const UArgs &=UArgs::none)
virtual UBox &	createMoreScroller (const UArgs &=UArgs::none)
Friends
UScrollbar &	uscrollbar (const UOrient &, const UArgs &a=UArgs::none)
	shortcut creator: see constructor.
UScrollbar &	uhscrollbar (const UArgs &a=UArgs::none)
	shortcut creator: creates a new horizontal scrollbar
UScrollbar &	uvscrollbar (const UArgs &a=UArgs::none)
	shortcut creator: creates a new vertical scrollbar

---

Detailed Description

Scrollbar gadget.

UOn::change callbacks are activated when the scrollbar value is changed.

---

Constructor & Destructor Documentation

UScrollbar::UScrollbar (  UFloat &  value, const class UOrient &  , const UArgs &  = UArgs::none )

constructors (default orientation is UOrient::Vertical) constructor: see also shortcut creator uscrollbar() and UGroup::~UGroup() 'orient' can be UOrient::horizontal or UOrient::vertical.

---

Member Function Documentation

void UScrollbar::setValue (  float  percent, bool  update_pane = true )

gets/sets scrollbar value (float between 0 and 100) Note: UOn::change callbacks are activated when the value is changed.

---

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

• uscrollbar.hpp
• uuscrollbar.cpp

---