tab.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
**    Harry Storbacka
*/


#pragma once

#include "../api_gui.h"
#include "../gui_component.h"

class CL_Tab_Impl;
class CL_TabHeader;
class CL_TabPage;
class CL_DomElement;

class CL_API_GUI CL_Tab : public CL_GUIComponent
{

public:

        CL_Tab(CL_GUIComponent *parent);

        virtual ~CL_Tab();


public:

        CL_TabPage *get_page(int index) const;

        CL_TabPage *get_page_by_id(int id) const;

        int get_current_page_index() const;

        int get_current_page_id() const;

        CL_Size get_preferred_size() const;

        int get_page_count() const;


public:
        CL_TabPage *add_page(const CL_StringRef &label, int id=0);

        void show_page(int index);

        void show_page_by_id(int id);

        void remove_page(int index);


        void remove_page_by_id(int id);

        void set_label(int index, const CL_StringRef &new_label);

        void set_label_by_id(int id, const CL_StringRef &new_label);


private:
        CL_SharedPtr<CL_Tab_Impl> impl;

};

---