tab.h

Go to the documentation of this file.
00001 /*
00002 **  ClanLib SDK
00003 **  Copyright (c) 1997-2011 The ClanLib Team
00004 **
00005 **  This software is provided 'as-is', without any express or implied
00006 **  warranty.  In no event will the authors be held liable for any damages
00007 **  arising from the use of this software.
00008 **
00009 **  Permission is granted to anyone to use this software for any purpose,
00010 **  including commercial applications, and to alter it and redistribute it
00011 **  freely, subject to the following restrictions:
00012 **
00013 **  1. The origin of this software must not be misrepresented; you must not
00014 **     claim that you wrote the original software. If you use this software
00015 **     in a product, an acknowledgment in the product documentation would be
00016 **     appreciated but is not required.
00017 **  2. Altered source versions must be plainly marked as such, and must not be
00018 **     misrepresented as being the original software.
00019 **  3. This notice may not be removed or altered from any source distribution.
00020 **
00021 **  Note: Some of the libraries ClanLib may link to may have additional
00022 **  requirements or restrictions.
00023 **
00024 **  File Author(s):
00025 **
00026 **    Magnus Norddahl
00027 **    Harry Storbacka
00028 */
00029 
00032 
00033 #pragma once
00034 
00035 #include "../api_gui.h"
00036 #include "../gui_component.h"
00037 
00038 class CL_Tab_Impl;
00039 class CL_TabHeader;
00040 class CL_TabPage;
00041 class CL_DomElement;
00042 
00046 class CL_API_GUI CL_Tab : public CL_GUIComponent
00047 {
00050 
00051 public:
00052 
00056         CL_Tab(CL_GUIComponent *parent);
00057 
00058         virtual ~CL_Tab();
00059 
00063 
00064 public:
00065         using CL_GUIComponent::get_named_item;
00066 
00070         static CL_Tab *get_named_item(CL_GUIComponent *reference_component, const CL_StringRef &id);
00071 
00077         CL_TabPage *get_page(int index) const;
00078 
00084         CL_TabPage *get_page_by_id(int id) const;
00085 
00089         int get_current_page_index() const;
00090 
00094         int get_current_page_id() const;
00095 
00099         CL_Size get_preferred_size() const;
00100 
00102         int get_page_count() const;
00103 
00107 
00108 public:
00110         CL_TabPage *add_page(const CL_StringRef &label, int id=0);
00111 
00113         void show_page(int index);
00114 
00116         void show_page_by_id(int id);
00117 
00119         void remove_page(int index);
00120 
00122 
00124         void remove_page_by_id(int id);
00125 
00127         void set_label(int index, const CL_StringRef &new_label);
00128 
00130         void set_label_by_id(int id, const CL_StringRef &new_label);
00131 
00135 
00136 private:
00137         CL_SharedPtr<CL_Tab_Impl> impl;
00138 
00140 };
00141