ElementScroll.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 ROCKETCOREELEMENTSCROLL_H
00029 #define ROCKETCOREELEMENTSCROLL_H
00030 
00031 #include <Rocket/Core/Header.h>
00032 #include <Rocket/Core/EventListener.h>
00033 
00034 namespace Rocket {
00035 namespace Core {
00036 
00037 class Element;
00038 class WidgetSliderScroll;
00039 
00046 class ROCKETCORE_API ElementScroll : public EventListener
00047 {
00048 public:
00049         enum Orientation
00050         {
00051                 VERTICAL = 0,
00052                 HORIZONTAL = 1
00053         };
00054 
00055         ElementScroll(Element* element);
00056         virtual ~ElementScroll();
00057 
00059         void Update();
00060 
00064         void EnableScrollbar(Orientation orientation, float element_width);
00067         void DisableScrollbar(Orientation orientation);
00068 
00071         void UpdateScrollbar(Orientation orientation);
00072 
00076         Element* GetScrollbar(Orientation orientation);
00080         float GetScrollbarSize(Orientation orientation);
00081 
00083         void FormatScrollbars();
00084 
00085 protected:
00087         void ProcessEvent(Event& event);
00088 
00089 private:
00090         struct Scrollbar
00091         {
00092                 Scrollbar();
00093                 ~Scrollbar();
00094 
00095                 Element* element;
00096                 WidgetSliderScroll* widget;
00097                 bool enabled;
00098                 float size;
00099         };
00100 
00101         // Creates one of the scroll component's scrollbar.
00102         bool CreateScrollbar(Orientation orientation);
00103         // Creates the scrollbar corner.
00104         bool CreateCorner();
00105 
00106         Element* element;
00107 
00108         Scrollbar scrollbars[2];
00109         Element* corner;
00110 };
00111 
00112 }
00113 }
00114 
00115 #endif