WidgetSlider.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 ROCKETCONTROLSWIDGETSLIDER_H
00029 #define ROCKETCONTROLSWIDGETSLIDER_H
00030 
00031 #include <Rocket/Core/EventListener.h>
00032 
00033 namespace Rocket {
00034 namespace Controls {
00035 
00036 class ElementFormControl;
00037 
00044 class WidgetSlider : public Core::EventListener
00045 {
00046 public:
00047         enum Orientation
00048         {
00049                 VERTICAL,
00050                 HORIZONTAL
00051         };
00052 
00053         WidgetSlider(ElementFormControl* parent);
00054         virtual ~WidgetSlider();
00055 
00057         bool Initialise();
00058 
00060         void Update();
00061 
00064         void SetBarPosition(float bar_position);
00067         float GetBarPosition();
00068 
00071         void SetOrientation(Orientation orientation);
00074         Orientation GetOrientation() const;
00075 
00078         void GetDimensions(Rocket::Core::Vector2f& dimensions) const;
00079 
00080 protected:
00085         void FormatElements(const Rocket::Core::Vector2f& containing_block, float slider_length, float bar_length = -1);
00088         void FormatBar(float bar_length = -1);
00089 
00091         Core::Element* GetParent() const;
00092 
00094         virtual void ProcessEvent(Core::Event& event);
00095 
00099         virtual float OnBarChange(float bar_position) = 0;
00103         virtual float OnLineIncrement() = 0;
00107         virtual float OnLineDecrement() = 0;
00112         virtual float OnPageIncrement(float click_position) = 0;
00117         virtual float OnPageDecrement(float click_position) = 0;
00118 
00119 private:
00120         void PositionBar();
00121 
00122         ElementFormControl* parent;
00123 
00124         Orientation orientation;
00125 
00126         // The background track element, across which the bar slides.
00127         Core::Element* track;
00128         // The bar element. This is the element that is dragged across the trough.
00129         Core::Element* bar;
00130         // The two (optional) buttons for incrementing and decrementing the slider.
00131         Core::Element* arrows[2];
00132 
00133         // A number from 0 to 1, indicating how far along the track the bar is.
00134         float bar_position;
00135         // If the bar is being dragged, this is the pixel offset from the start of the bar to where it was picked up.
00136         int bar_drag_anchor;
00137 
00138         // Set to the auto-repeat timer if either of the arrow buttons have been pressed, -1 if they haven't.
00139         float arrow_timers[2];
00140         float last_update_time;
00141 };
00142 
00143 }
00144 }
00145 
00146 #endif