Scroller Class Reference

#include <scroller.h>

Inheritance diagram for Scroller:

Public Member Functions
void	setRangeValues (int max, int visible, int min=0)
int	scrollPosition (void)
void	setScrollPosition (int pos)
void	setThumbColor (const GFXColor &c, const GFXColor &outline)
void	setButtonColor (const GFXColor &c)
virtual void	draw (void)
virtual void	setRect (const Rect &r)
virtual void	setColor (const GFXColor &c)
virtual void	setTextColor (const GFXColor &c)
virtual bool	processCommand (const EventCommandId &command, Control *control)
	Scroller (void)
virtual	~Scroller (void)
Public Member Functions inherited from GroupControl
virtual bool	hasGroupChildren (void)
void	addChild (Control *child)
bool	deleteControl (Control *c)
Control *	removeControlFromGroup (Control *c)
Control *	findControlById (const std::string &id)
int	childCount (void)
Control *	childAt (int index)
virtual bool	processMouseDown (const InputEvent &event)
virtual bool	processMouseUp (const InputEvent &event)
virtual bool	processMouseMove (const InputEvent &event)
virtual bool	processMouseDrag (const InputEvent &event)
	GroupControl (void)
virtual	~GroupControl (void)
Public Member Functions inherited from Control
virtual Rect	rect (void)
virtual bool	hitTest (const Point &p)
virtual bool	hidden (void)
virtual void	setHidden (bool h=true)
virtual const std::string &	id (void)
virtual void	setId (const std::string &newId)
virtual GFXColor	color (void)
virtual GFXColor	outlineColor (void)
virtual void	setOutlineColor (const GFXColor &c)
virtual GFXColor	textColor (void)
virtual Font	font (void)
virtual void	setFont (const Font &f)
	Control (void)
virtual	~Control (void)
Public Member Functions inherited from EventResponder
virtual bool	processKeyDown (const InputEvent &event)
virtual bool	processKeyUp (const InputEvent &event)
virtual void	processUnfocus (const InputEvent &event)
virtual void	sendCommand (const EventCommandId &command, Control *control)
virtual void	setCommandTarget (EventResponder *responder)
virtual void	setModal (bool modal)
	EventResponder (void)
virtual	~EventResponder (void)

Protected Member Functions
void	calcLayout (void)
void	createControls (void)

Protected Attributes
int	m_minValue
int	m_maxValue
int	m_visible
int	m_scrollPosition
GFXColor	m_thumbColor
GFXColor	m_thumbOutlineColor
bool	m_needLayout
Protected Attributes inherited from GroupControl
std::vector< Control * >	m_controls
Protected Attributes inherited from Control
Rect	m_rect
std::string	m_id
GFXColor	m_color
GFXColor	m_outlineColor
GFXColor	m_textColor
Font	m_font
bool	m_hidden
Protected Attributes inherited from EventResponder
bool	m_modal
EventResponder *	m_commandTarget

Detailed Description

Definition at line 36 of file scroller.h.

Constructor & Destructor Documentation

Scroller::Scroller

(

void

)

Definition at line 294 of file scroller.cpp.

References createControls().

                         :
    m_minValue( 0 )
    , m_maxValue( 10 )
    , m_visible( 1 )
    , m_scrollPosition( m_minValue )
    , m_thumbColor( GUI_CLEAR )
    , m_thumbOutlineColor( GUI_CLEAR )
    , m_needLayout( true )
{
    createControls();
}

virtual Scroller::~Scroller ( void  )

inlinevirtual

Definition at line 76 of file scroller.h.

{}

Member Function Documentation

void Scroller::calcLayout ( void  )

protected

Definition at line 191 of file scroller.cpp.

References CHILD_CONTROL_COUNT, GroupControl::childAt(), GroupControl::childCount(), Rect::copyAndInset(), ScrollerButton::DOWN_ARROW, DOWN_BUTTON_INDEX, Size::height, ScrollerButton::LEFT_ARROW, Control::m_rect, Rect::origin, Control::rect(), Rect::right(), ScrollerButton::RIGHT_ARROW, ScrollerButton::setArrowType(), NewButton::setCommand(), Control::setRect(), Rect::size, SLIDER_INDEX, Rect::top(), ScrollerButton::UP_ARROW, UP_BUTTON_INDEX, Size::width, Point::x, and Point::y.

Referenced by draw().

{
    assert( childCount() == CHILD_CONTROL_COUNT );

    //Make the buttons slightly smaller than the scroller.
    static const Size BUTTON_INSET = Size( .005, .005 );

    //Get pointers to the buttons.
    ScrollerButton   *downButton   = static_cast< ScrollerButton* > ( childAt( DOWN_BUTTON_INDEX ) );
    ScrollerButton   *upButton     = static_cast< ScrollerButton* > ( childAt( UP_BUTTON_INDEX ) );
    //Make the buttons square, and at the bottom/right of the scroller.
    if (m_rect.size.height >= m_rect.size.width) {
        //This is a vertical scroller.
        Rect rect = m_rect;
        rect.size.height = rect.size.width;
        downButton->setRect( rect.copyAndInset( BUTTON_INSET ) );
        downButton->setCommand( "LineDown" );
        downButton->setArrowType( ScrollerButton::DOWN_ARROW );

        rect.origin.y += rect.size.height;
        upButton->setRect( rect.copyAndInset( BUTTON_INSET ) );
        upButton->setCommand( "LineUp" );
        upButton->setArrowType( ScrollerButton::UP_ARROW );

        Rect thumbRect = m_rect;
        thumbRect.origin.y     = rect.top();
        thumbRect.size.height -= thumbRect.origin.y-m_rect.origin.y;
        childAt( SLIDER_INDEX )->setRect( thumbRect );
    } else {
        //This is a horizontal scroller.
        //Need to flip the button commands -- "line up" does lower values.
        Rect rect = m_rect;
        rect.size.width = rect.size.height;
        downButton->setRect( rect.copyAndInset( BUTTON_INSET ) );
        downButton->setCommand( "LineUp" );
        downButton->setArrowType( ScrollerButton::LEFT_ARROW );

        rect.origin.x += rect.size.width;
        upButton->setRect( rect.copyAndInset( BUTTON_INSET ) );
        upButton->setCommand( "LineDown" );
        upButton->setArrowType( ScrollerButton::RIGHT_ARROW );

        Rect thumbRect = m_rect;
        thumbRect.origin.x    = rect.right();
        thumbRect.size.width -= thumbRect.origin.x-m_rect.origin.x;
        childAt( SLIDER_INDEX )->setRect( thumbRect );
    }
}

void Scroller::createControls ( void  )

protected

Definition at line 241 of file scroller.cpp.

References GroupControl::addChild(), Control::color(), GUI_CLEAR(), Slider::setColor(), Control::setColor(), NewButton::setCommand(), EventResponder::setCommandTarget(), Control::setTextColor(), Slider::setThumbColorBasedOnColor(), Control::textColor(), and up.

Referenced by Scroller().

{
    //"Scroll Down" button.
    NewButton *down = new ScrollerButton;
    down->setCommand( "LineDown" );
    down->setColor( color() );
    down->setTextColor( textColor() );     //Arrow color.
    down->setCommandTarget( this );
    addChild( down );

    //"Scroll Up" button.
    NewButton *up = new ScrollerButton;
    up->setCommand( "LineUp" );
    up->setColor( color() );
    up->setTextColor( textColor() );     //Arrow color.
    up->setCommandTarget( this );
    addChild( up );

    //Slider control.
    Slider *slider = new Slider;
    slider->setColor( GUI_CLEAR );
    slider->setThumbColorBasedOnColor( color() );
    slider->setCommandTarget( this );
    addChild( slider );
}

void Scroller::draw ( void  )

virtual

Reimplemented from GroupControl.

Definition at line 268 of file scroller.cpp.

References calcLayout(), GroupControl::draw(), Control::drawBackground(), and m_needLayout.

{
    drawBackground();
    if (m_needLayout)
        calcLayout();
    GroupControl::draw();
}

bool Scroller::processCommand ( const EventCommandId &  command, Control *  control  )

virtual

Reimplemented from EventResponder.

Definition at line 277 of file scroller.cpp.

References GroupControl::childAt(), Slider::position(), EventResponder::processCommand(), scrollPosition(), setScrollPosition(), and SLIDER_INDEX.

{
    if (command == "LineUp") {
        setScrollPosition( scrollPosition()-1 );
        return true;
    } else if (command == "LineDown") {
        setScrollPosition( scrollPosition()+1 );
        return true;
    } else if (command == "Slider::PositionChanged") {
        Slider *slider = static_cast< Slider* > ( childAt( SLIDER_INDEX ) );
        setScrollPosition( slider->position() );
        return true;
    }
    return GroupControl::processCommand( command, control );
}

int Scroller::scrollPosition ( void  )

inline

Definition at line 45 of file scroller.h.

References m_scrollPosition.

Referenced by processCommand(), StaticDisplay::processCommand(), Picker::processCommand(), StaticDisplay::processMouseDown(), and Picker::processMouseDown().

    {
        return m_scrollPosition;
    }

void Scroller::setButtonColor

(

const GFXColor &

c)

Definition at line 109 of file scroller.cpp.

References CHILD_CONTROL_COUNT, GroupControl::childAt(), GroupControl::childCount(), DOWN_BUTTON_INDEX, Control::setColor(), and UP_BUTTON_INDEX.

Referenced by NavComputer::constructControls(), BaseComputer::constructControls(), and ListQuestionDialog::CreateControlsForListWindow().

{
    assert( childCount() == CHILD_CONTROL_COUNT );
    childAt( DOWN_BUTTON_INDEX )->setColor( c );
    childAt( UP_BUTTON_INDEX )->setColor( c );
}

void Scroller::setColor ( const GFXColor &  c)

virtual

Reimplemented from Control.

Definition at line 87 of file scroller.cpp.

References CHILD_CONTROL_COUNT, GroupControl::childAt(), GroupControl::childCount(), DOWN_BUTTON_INDEX, isClear(), m_thumbColor, Control::setColor(), Slider::setThumbColorBasedOnColor(), SLIDER_INDEX, and UP_BUTTON_INDEX.

Referenced by NavComputer::constructControls(), BaseComputer::constructControls(), and ListQuestionDialog::CreateControlsForListWindow().

{
    assert( childCount() == CHILD_CONTROL_COUNT );
    childAt( DOWN_BUTTON_INDEX )->setColor( c );
    childAt( UP_BUTTON_INDEX )->setColor( c );
    if ( isClear( m_thumbColor ) ) {
        //If we don't have an explicit thumb color, calculate it.
        Slider *slider = static_cast< Slider* > ( childAt( SLIDER_INDEX ) );
        slider->setThumbColorBasedOnColor( c );
    }
    GroupControl::setColor( c );
}

void Scroller::setRangeValues	(	int	max,
		int	visible,
		int	min = 0
	)

Definition at line 60 of file scroller.cpp.

References GroupControl::childAt(), guiMax, m_maxValue, m_minValue, m_needLayout, m_visible, min(), Slider::setMaxMin(), Slider::setPageSize(), Slider::setThumbLength(), and SLIDER_INDEX.

Referenced by StaticDisplay::draw(), and Picker::recalcDisplay().

{
    const int newMax = guiMax( min, max-visible+1 );
    if (newMax != m_maxValue || min != m_minValue || visible != m_visible) {
        m_maxValue   = newMax;
        m_minValue   = min;
        m_visible    = visible;
        m_needLayout = true;

        Slider     *slider = static_cast< Slider* > ( childAt( SLIDER_INDEX ) );
        slider->setMaxMin( newMax, min );
        const float thumbLength = (max > min) ? (float) visible/(max-min+1) : -1.;
        //Note that impossible thumb lengths turn off the thumb.
        slider->setThumbLength( thumbLength );
        slider->setPageSize( guiMax( 1, visible-1 ) );
    }
}

void Scroller::setRect ( const Rect &  r)

virtual

Reimplemented from Control.

Definition at line 79 of file scroller.cpp.

References m_needLayout, Control::m_rect, and Control::setRect().

Referenced by NavComputer::constructControls(), BaseComputer::constructControls(), and ListQuestionDialog::CreateControlsForListWindow().

{
    if (m_rect != r)
        m_needLayout = true;
    GroupControl::setRect( r );
}

void Scroller::setScrollPosition

(

int

pos)

Definition at line 42 of file scroller.cpp.

References GroupControl::childAt(), m_maxValue, m_minValue, m_scrollPosition, EventResponder::sendCommand(), Slider::setPosition(), and SLIDER_INDEX.

Referenced by StaticDisplay::draw(), processCommand(), StaticDisplay::processMouseDown(), Picker::processMouseDown(), Picker::recalcDisplay(), and Picker::scrollToCell().

{
    int newScrollPosition = pos;
    if (pos > m_maxValue)
        newScrollPosition = m_maxValue;
    else if (pos < m_minValue)
        newScrollPosition = m_minValue;
    if (m_scrollPosition != newScrollPosition) {
        m_scrollPosition = newScrollPosition;

        Slider *slider = static_cast< Slider* > ( childAt( SLIDER_INDEX ) );
        slider->setPosition( m_scrollPosition );

        sendCommand( "Scroller::PositionChanged", this );
    }
}

void Scroller::setTextColor ( const GFXColor &  c)

virtual

Reimplemented from Control.

Definition at line 117 of file scroller.cpp.

References CHILD_CONTROL_COUNT, GroupControl::childAt(), GroupControl::childCount(), DOWN_BUTTON_INDEX, Control::setTextColor(), and UP_BUTTON_INDEX.

Referenced by NavComputer::constructControls(), BaseComputer::constructControls(), and ListQuestionDialog::CreateControlsForListWindow().

{
    assert( childCount() == CHILD_CONTROL_COUNT );
    childAt( DOWN_BUTTON_INDEX )->setTextColor( c );
    childAt( UP_BUTTON_INDEX )->setTextColor( c );

    GroupControl::setTextColor( c );
}

void Scroller::setThumbColor	(	const GFXColor &	c,
		const GFXColor &	outline
	)

Definition at line 101 of file scroller.cpp.

References CHILD_CONTROL_COUNT, GroupControl::childAt(), GroupControl::childCount(), Slider::setThumbColor(), and SLIDER_INDEX.

Referenced by NavComputer::constructControls(), BaseComputer::constructControls(), and ListQuestionDialog::CreateControlsForListWindow().

{
    assert( childCount() == CHILD_CONTROL_COUNT );
    Slider *slider = static_cast< Slider* > ( childAt( SLIDER_INDEX ) );
    slider->setThumbColor( c, outline );
}

Member Data Documentation

int Scroller::m_maxValue

protected

Definition at line 90 of file scroller.h.

Referenced by setRangeValues(), and setScrollPosition().

int Scroller::m_minValue

protected

Definition at line 89 of file scroller.h.

Referenced by setRangeValues(), and setScrollPosition().

bool Scroller::m_needLayout

protected

Definition at line 96 of file scroller.h.

Referenced by draw(), setRangeValues(), and setRect().

int Scroller::m_scrollPosition

protected

Definition at line 92 of file scroller.h.

Referenced by scrollPosition(), and setScrollPosition().

GFXColor Scroller::m_thumbColor

protected

Definition at line 93 of file scroller.h.

Referenced by setColor().

GFXColor Scroller::m_thumbOutlineColor

protected

Definition at line 94 of file scroller.h.

int Scroller::m_visible

protected

Definition at line 91 of file scroller.h.

Referenced by setRangeValues().

---

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

• src/gui/scroller.h
• src/gui/scroller.cpp