WidgetDropDown.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 ROCKETCONTROLSWIDGETDROPDOWN_H
00029 #define ROCKETCONTROLSWIDGETDROPDOWN_H
00030 
00031 #include <Rocket/Core/String.h>
00032 #include <Rocket/Core/EventListener.h>
00033 #include <Rocket/Controls/SelectOption.h>
00034 #include <vector>
00035 
00036 namespace Rocket {
00037 namespace Controls {
00038 
00039 class ElementFormControl;
00040 
00046 class WidgetDropDown : public Core::EventListener
00047 {
00048 public:
00049         WidgetDropDown(ElementFormControl* element);
00050         virtual ~WidgetDropDown();
00051 
00053         void OnRender();
00055         void OnLayout();
00056 
00059         void SetValue(const Rocket::Core::String& value);
00062         const Rocket::Core::String& GetValue() const;
00063 
00067         void SetSelection(int selection, bool force = false);
00070         int GetSelection() const;
00071 
00079         int AddOption(const Rocket::Core::String& rml, const Rocket::Core::String& value, int before, bool select, bool selectable = true);
00082         void RemoveOption(int index);
00084         void ClearOptions();
00085 
00089         SelectOption* GetOption(int index);
00092         int GetNumOptions() const;
00093 
00095         virtual void ProcessEvent(Core::Event& event);
00096 
00097 private:
00098         typedef std::vector< SelectOption > OptionList;
00099 
00100         // Shows or hides the selection box.
00101         void ShowSelectBox(bool show);
00102 
00103         // Parent element that holds this widget
00104         ElementFormControl* parent_element;
00105 
00106         // The elements making up the drop-down process.
00107         Core::Element* button_element;
00108         Core::Element* selection_element;
00109         Core::Element* value_element;
00110 
00111         // The options in the drop down.
00112         OptionList options;
00113         int selected_option;
00114 
00115         // The current value of the widget.
00116         Rocket::Core::String value;
00117 
00118         bool box_layout_dirty;
00119         bool value_layout_dirty;
00120 };
00121 
00122 }
00123 }
00124 
00125 #endif