Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members

UScrollbar Class Reference

Scrollbar gadget. More...

#include <uscrollbar.hpp>

Inheritance diagram for UScrollbar:

UBox UGroup 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 UStylegetStyle (UContext *) const
 returns the contextual UStyle of this object.
bool isHorizontal () const
bool isVertical () const
float getValue () const
UFloatvalue () 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
 corresponding Ubit UStyle

Protected Member Functions

virtual UBoxcreateRail (const UArgs &=UArgs::none)
virtual UBoxcreateSlider (const UArgs &=UArgs::none)
virtual UBoxcreateLessScroller (const UArgs &=UArgs::none)
virtual UBoxcreateMoreScroller (const UArgs &=UArgs::none)

Friends

UScrollbaruscrollbar (const UOrient &, const UArgs &a=UArgs::none)
 shortcut creator: see constructor.
UScrollbaruhscrollbar (const UArgs &a=UArgs::none)
 shortcut creator: creates a new horizontal scrollbar
UScrollbaruvscrollbar (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

const UStyle & UScrollbar::getStyle UContext *   )  const [virtual]
 

returns the contextual UStyle of this object.

This virtual function calls the makeStyle() static function that was redefined for this specific class

Reimplemented from UBox.

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:
Generated on Sun Jul 3 23:15:52 2005 for Ubit[Eric.Lecolinet@enst.fr] by  doxygen 1.4.3-20050530