1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
|
/*
* This source file is part of libRocket, the HTML/CSS Interface Middleware
*
* For the latest information, see http://www.librocket.com
*
* Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
*/
#ifndef ROCKETCONTROLSELEMENTTABSET_H
#define ROCKETCONTROLSELEMENTTABSET_H
#include "../Core/Element.h"
#include "../Core/EventListener.h"
#include "Header.h"
namespace Rocket {
namespace Controls {
/**
A tabulated set of panels.
@author Lloyd Weehuizen
*/
class ROCKETCONTROLS_API ElementTabSet : public Core::Element, public Core::EventListener
{
public:
ElementTabSet(const Rocket::Core::String& tag);
~ElementTabSet();
/// Sets the specifed tab index's tab title RML.
/// @param[in] tab_index The tab index to set. If it doesn't already exist, it will be created.
/// @param[in] rml The RML to set on the tab title.
void SetTab(int tab_index, const Rocket::Core::String& rml);
/// Sets the specifed tab index's tab panel RML.
/// @param[in] tab_index The tab index to set. If it doesn't already exist, it will be created.
/// @param[in] rml The RML to set on the tab panel.
void SetPanel(int tab_index, const Rocket::Core::String& rml);
/// Set the specifed tab index's title element.
/// @param[in] tab_index The tab index to set. If it doesn't already exist, it will be created.
/// @param[in] element The root of the element tree to set as the tab title.
void SetTab(int tab_index, Core::Element* element);
/// Set the specified tab index's body element.
/// @param[in] tab_index The tab index to set. If it doesn't already exist, it will be created.
/// @param[in] element The root of the element tree to set as the window.
void SetPanel(int tab_index, Core::Element* element);
/// Remove one of the tab set's panels and its corresponding tab.
/// @param[in] tab_index The tab index to remove. If no tab matches this index, nothing will be removed.
void RemoveTab(int tab_index);
/// Retrieve the number of tabs in the tabset.
/// @return The number of tabs.
int GetNumTabs();
/// Sets the currently active (visible) tab index.
/// @param[in] tab_index Index of the tab to display.
void SetActiveTab(int tab_index);
/// Get the current active tab index.
/// @return The index of the active tab.
int GetActiveTab() const;
/// Process the incoming event.
void ProcessEvent(Core::Event& event);
/// Called when the listener has been attached to a new Element
void OnAttach(Element* element);
/// Called when the listener has been detached from a Element
void OnDetach(Element* element);
protected:
// Catch child add/removes so we can correctly set up their events.
virtual void OnChildAdd(Core::Element* child);
virtual void OnChildRemove(Core::Element* child);
private:
Core::Element* GetChildByTag(const Rocket::Core::String& tag);
int active_tab;
};
}
}
#endif
|