Crazy Eddie's GUI System  0.8.4
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
ComboDropList.h
1 /***********************************************************************
2  created: 13/6/2004
3  author: Paul D Turner
4 
5  purpose: Interface for the Combobox Drop-List widget base class
6 *************************************************************************/
7 /***************************************************************************
8  * Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
9  *
10  * Permission is hereby granted, free of charge, to any person obtaining
11  * a copy of this software and associated documentation files (the
12  * "Software"), to deal in the Software without restriction, including
13  * without limitation the rights to use, copy, modify, merge, publish,
14  * distribute, sublicense, and/or sell copies of the Software, and to
15  * permit persons to whom the Software is furnished to do so, subject to
16  * the following conditions:
17  *
18  * The above copyright notice and this permission notice shall be
19  * included in all copies or substantial portions of the Software.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
22  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
23  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
24  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
25  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
26  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
27  * OTHER DEALINGS IN THE SOFTWARE.
28  ***************************************************************************/
29 #ifndef _CEGUIComboDropList_h_
30 #define _CEGUIComboDropList_h_
31 
32 #include "./Listbox.h"
33 
34 
35 #if defined(_MSC_VER)
36 # pragma warning(push)
37 # pragma warning(disable : 4251)
38 #endif
39 
40 
41 // Start of CEGUI namespace section
42 namespace CEGUI
43 {
48 class CEGUIEXPORT ComboDropList : public Listbox
49 {
50 public:
51  static const String EventNamespace;
52  static const String WidgetTypeName;
53 
54 
55  /*************************************************************************
56  Constants
57  *************************************************************************/
58  // Event names
64  static const String EventListSelectionAccepted;
65 
66 
77  virtual void initialiseComponents(void);
78 
79 
98  void setArmed(bool setting) { d_armed = setting; }
99 
100 
111  bool isArmed(void) const { return d_armed; }
112 
113 
125  void setAutoArmEnabled(bool setting) { d_autoArm = setting; }
126 
127 
136  bool isAutoArmEnabled(void) const { return d_autoArm; }
137 
139  void resizeToContent(bool fit_width, bool fit_height);
140 
141  /*************************************************************************
142  Constructor & Destructor
143  *************************************************************************/
148  ComboDropList(const String& type, const String& name);
149 
150 
155  virtual ~ComboDropList(void);
156 
157 
158 protected:
159  /*************************************************************************
160  New event handlers
161  *************************************************************************/
166  void onListSelectionAccepted(WindowEventArgs& e);
167 
168 
169  /*************************************************************************
170  Overridden Event handling
171  *************************************************************************/
172  virtual void onMouseMove(MouseEventArgs& e);
173  virtual void onMouseButtonDown(MouseEventArgs& e);
174  virtual void onMouseButtonUp(MouseEventArgs& e);
175  virtual void onCaptureLost(WindowEventArgs& e);
176  virtual void onActivated(ActivationEventArgs& e);
177  virtual void onListContentsChanged(WindowEventArgs& e);
178  virtual void onSelectionChanged(WindowEventArgs& e);
179 
180  /*************************************************************************
181  Implementation Data
182  *************************************************************************/
183  bool d_autoArm;
184  bool d_armed;
185  ListboxItem* d_lastClickSelected;
186 };
187 
188 } // End of CEGUI namespace section
189 
190 #if defined(_MSC_VER)
191 # pragma warning(pop)
192 #endif
193 
194 #endif // end of guard _CEGUIComboDropList_h_