combobox.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 ** Harry Storbacka
28 ** Kenneth Gangstoe
29 */
30 
31 
32 #pragma once
33 
34 #include "../api_gui.h"
35 #include "../gui_component.h"
36 #include "../../Core/Signals/callback_v0.h"
37 #include "../../Core/Signals/callback_v1.h"
38 #include "../../Core/Signals/callback_1.h"
39 
40 namespace clan
41 {
44 
45 class Sprite;
46 class ComboBox_Impl;
47 class PopupMenu;
48 
50 class CL_API_GUI ComboBox : public GUIComponent
51 {
54 public:
58  ComboBox(GUIComponent *parent);
59 
60  virtual ~ComboBox();
61 
65 public:
67 
71  static ComboBox *get_named_item(GUIComponent *reference_component, const std::string &id);
72 
76  bool is_editable() const;
77 
81  int get_dropdown_height() const;
82 
86  int get_selected_item() const;
87 
91  std::string get_text() const;
92 
98  std::string get_item(int index) const;
99 
103 public:
107  void set_editable(bool enable = true);
108 
112  void set_dropdown_height(int height);
113 
117  void set_dropdown_minimum_width(int min_width);
118 
122  void set_text(const std::string &text);
123 
127  void set_selected_item(int index);
128 
132  void set_popup_menu(PopupMenu &menu);
133 
137 public:
141  Callback_v0 &func_dropdown_opened();
142 
146  Callback_v0 &func_dropdown_closed();
147 
151  Callback_v0 &func_enter_pressed();
152 
156  Callback_v0 &func_before_edit_changed();
157 
161  Callback_v0 &func_after_edit_changed();
162 
166  Callback_v1<int> &func_item_selected();
167 
171  Callback_v1<int> &func_selection_changed();
172 
176 private:
177  std::shared_ptr<ComboBox_Impl> impl;
179 };
180 
181 }
182 
Combo box component.
Definition: combobox.h:50
GUI base component class.
Definition: gui_component.h:81
GUIComponent * get_named_item(const std::string &id)
Find child component with the specified component ID name.
Pop-up menu.
Definition: popupmenu.h:49
Callback_v1.
Definition: callback_v1.h:156
Callback_v0.
Definition: callback_v0.h:152