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