ClanLib  2.3.7
combobox.h
Go to the documentation of this file.
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2011 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 
33 
34 #pragma once
35 
36 #include "../api_gui.h"
37 #include "../gui_component.h"
38 #include "../../Core/Signals/callback_v0.h"
39 #include "../../Core/Signals/callback_v1.h"
40 #include "../../Core/Signals/callback_1.h"
41 
42 class CL_Sprite;
43 class CL_ComboBox_Impl;
44 class CL_PopupMenu;
45 
50 {
53 public:
58 
59  virtual ~CL_ComboBox();
60 
64 public:
66 
70  static CL_ComboBox *get_named_item(CL_GUIComponent *reference_component, const CL_StringRef &id);
71 
75  bool is_editable() const;
76 
80  int get_dropdown_height() const;
81 
85  int get_selected_item() const;
86 
90  CL_StringRef get_text() const;
91 
97  CL_StringRef get_item(int index) const;
98 
102 public:
106  void set_editable(bool enable = true);
107 
111  void set_dropdown_height(int height);
112 
116  void set_dropdown_minimum_width(int min_width);
117 
121  void set_text(const CL_StringRef &text);
122 
126  void set_selected_item(int index);
127 
131  void set_popup_menu(CL_PopupMenu &menu);
132 
136 public:
140  CL_Callback_v0 &func_dropdown_opened();
141 
145  CL_Callback_v0 &func_dropdown_closed();
146 
150  CL_Callback_v0 &func_enter_pressed();
151 
155  CL_Callback_v0 &func_before_edit_changed();
156 
160  CL_Callback_v0 &func_after_edit_changed();
161 
165  CL_Callback_v1<int> &func_item_selected();
166 
170  CL_Callback_v1<int> &func_selection_changed();
171 
175 private:
176  CL_SharedPtr<CL_ComboBox_Impl> impl;
178 };
179