WidgetSliderScroll.h

00001 /*
00002  * This source file is part of libRocket, the HTML/CSS Interface Middleware
00003  *
00004  * For the latest information, see http://www.librocket.com
00005  *
00006  * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
00007  *
00008  * Permission is hereby granted, free of charge, to any person obtaining a copy
00009  * of this software and associated documentation files (the "Software"), to deal
00010  * in the Software without restriction, including without limitation the rights
00011  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00012  * copies of the Software, and to permit persons to whom the Software is
00013  * furnished to do so, subject to the following conditions:
00014  *
00015  * The above copyright notice and this permission notice shall be included in
00016  * all copies or substantial portions of the Software.
00017  * 
00018  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00019  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00020  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00021  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00022  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00023  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
00024  * THE SOFTWARE.
00025  *
00026  */
00027 
00028 #ifndef ROCKETCOREWIDGETSLIDERSCROLL_H
00029 #define ROCKETCOREWIDGETSLIDERSCROLL_H
00030 
00031 #include "WidgetSlider.h"
00032 
00033 namespace Rocket {
00034 namespace Core {
00035 
00040 class WidgetSliderScroll : public WidgetSlider
00041 {
00042 public:
00043         WidgetSliderScroll(Element* parent);
00044         virtual ~WidgetSliderScroll();
00045 
00050         void SetTrackLength(float track_length, bool force_resize = true);
00056         void SetBarLength(float bar_length, bool force_resize = true);
00057 
00060         void SetLineHeight(float line_height);
00061 
00065         void FormatElements(const Vector2f& containing_block, float slider_length);
00066 
00067 protected:
00071         virtual float OnBarChange(float bar_position);
00075         virtual float OnLineIncrement();
00079         virtual float OnLineDecrement();
00083         virtual float OnPageIncrement(float click_position);
00087         virtual float OnPageDecrement(float click_position);
00088 
00089 private:
00090         // Returns the bar position after scrolling for a number of pixels.
00091         float Scroll(float distance);
00092 
00093         float track_length;
00094         float bar_length;
00095         float line_height;
00096 };
00097 
00098 }
00099 }
00100 
00101 #endif