toolbar.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 #include "../../Core/Signals/callback_v0.h"
00038 
00039 class CL_Sprite;
00040 class CL_ToolBarItem;
00041 class CL_ToolBar_Impl;
00042 
00046 class CL_API_GUI CL_ToolBar : public CL_GUIComponent
00047 {
00050 
00051 public:
00052 
00056         CL_ToolBar(CL_GUIComponent *parent);
00057 
00058         virtual ~CL_ToolBar();
00059 
00063 
00064 public:
00065 
00066         using CL_GUIComponent::get_named_item;
00067 
00071         static CL_ToolBar *get_named_item(CL_GUIComponent *reference_component, const CL_StringRef &id);
00072 
00076         CL_Size get_preferred_size() const;
00077 
00083         CL_ToolBarItem get_item_by_id(int id);
00084 
00090         CL_ToolBarItem get_item(int index);
00091 
00097         int get_item_index(int id);
00098 
00102         int get_item_count() const;
00103 
00107 
00108 public:
00109 
00118         CL_ToolBarItem add_item(const CL_Sprite &icon, int frame, const CL_StringRef &text, int id);
00119 
00129         CL_ToolBarItem insert_item(const CL_Sprite &icon, int frame, const CL_StringRef &text, int id = -1, int index = -1);
00130 
00136         CL_ToolBarItem insert_separator(int index = -1);
00137 
00141         void delete_item(int index);
00142 
00146         void set_single_selection(bool value);
00147 
00149         void clear_selection();
00150 
00154 
00155 public:
00156         CL_Callback_v1<CL_ToolBarItem> &func_item_clicked();
00157 
00158         CL_Callback_v1<CL_ToolBarItem> &func_item_selected();
00159 
00160         CL_Callback_v1<CL_ToolBarItem> &func_item_unselected();
00161 
00164         CL_Callback_v2<CL_Point, int> &func_mouse_right_up();
00165 
00169 
00170 private:
00171         CL_SharedPtr<CL_ToolBar_Impl> impl;
00173 };
00174