toolbar.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"
#include "../../Core/Signals/callback_v0.h"

class CL_Sprite;
class CL_ToolBarItem;
class CL_ToolBar_Impl;

class CL_API_GUI CL_ToolBar : public CL_GUIComponent
{

public:

        CL_ToolBar(CL_GUIComponent *parent);

        virtual ~CL_ToolBar();


public:

        CL_Size get_preferred_size() const;

        CL_ToolBarItem get_item_by_id(int id);

        CL_ToolBarItem get_item(int index);

        int get_item_index(int id);

        int get_item_count() const;


public:

        CL_ToolBarItem add_item(const CL_Sprite &icon, int frame, const CL_StringRef &text, int id);

        CL_ToolBarItem insert_item(const CL_Sprite &icon, int frame, const CL_StringRef &text, int id = -1, int index = -1);

        CL_ToolBarItem insert_separator(int index = -1);

        void delete_item(int index);

        void set_single_selection(bool value);

        void clear_selection();


public:
        CL_Callback_v1<CL_ToolBarItem> &func_item_clicked();

        CL_Callback_v1<CL_ToolBarItem> &func_item_selected();

        CL_Callback_v1<CL_ToolBarItem> &func_item_unselected();

        CL_Callback_v2<CL_Point, int> &func_mouse_right_up();


private:
        CL_SharedPtr<CL_ToolBar_Impl> impl;
};

---