Crazy Eddie's GUI System 0.8.7
Loading...
Searching...
No Matches
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
42namespace CEGUI
43{
48class CEGUIEXPORT ComboDropList : public Listbox
49{
50public:
51 static const String EventNamespace;
52 static const String WidgetTypeName;
53
54
55 /*************************************************************************
56 Constants
57 *************************************************************************/
58 // Event names
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
158protected:
159 /*************************************************************************
160 New event handlers
161 *************************************************************************/
167
168
169 /*************************************************************************
170 Overridden Event handling
171 *************************************************************************/
172 virtual void onMouseMove(MouseEventArgs& e);
179
180 /*************************************************************************
181 Implementation Data
182 *************************************************************************/
184 bool d_armed;
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_
EventArgs based class that is used for Activated and Deactivated window events.
Definition InputEvent.h:330
Base class for the combo box drop down list. This is a specialisation of the Listbox class.
Definition ComboDropList.h:49
void onListSelectionAccepted(WindowEventArgs &e)
Handler for when list selection is confirmed.
ListboxItem * d_lastClickSelected
Item last accepted by user.
Definition ComboDropList.h:185
virtual ~ComboDropList(void)
Destructor for ComboDropList base class.
virtual void onCaptureLost(WindowEventArgs &e)
Handler called when this window loses capture of mouse inputs.
virtual void onMouseMove(MouseEventArgs &e)
Handler called when the mouse cursor has been moved within this window's area.
virtual void onActivated(ActivationEventArgs &e)
Handler called when this window has become the active window.
void setArmed(bool setting)
Set whether the drop-list is 'armed' for selection.
Definition ComboDropList.h:98
static const String WidgetTypeName
Window factory name.
Definition ComboDropList.h:52
virtual void onSelectionChanged(WindowEventArgs &e)
Handler called internally when the currently selected item or items changes.
bool isArmed(void) const
Return the 'armed' state of the ComboDropList.
Definition ComboDropList.h:111
ComboDropList(const String &type, const String &name)
Constructor for ComboDropList base class.
bool d_armed
true when item selection has been armed.
Definition ComboDropList.h:184
bool d_autoArm
true if the box auto-arms when the mouse enters it.
Definition ComboDropList.h:183
void setAutoArmEnabled(bool setting)
Set the mode of operation for the ComboDropList.
Definition ComboDropList.h:125
virtual void onMouseButtonDown(MouseEventArgs &e)
Handler called when a mouse button has been depressed within this window's area.
virtual void onMouseButtonUp(MouseEventArgs &e)
Handler called when a mouse button has been released within this window's area.
static const String EventNamespace
Namespace for global events.
Definition ComboDropList.h:51
void resizeToContent(bool fit_width, bool fit_height)
resize the widget such that the content is shown without scrollbars.
static const String EventListSelectionAccepted
Definition ComboDropList.h:64
bool isAutoArmEnabled(void) const
returns the mode of operation for the drop-list
Definition ComboDropList.h:136
virtual void initialiseComponents(void)
Initialise the Window based object ready for use.
virtual void onListContentsChanged(WindowEventArgs &e)
Handler called internally when the list contents are changed.
Base class for list box items.
Definition ListboxItem.h:53
Base class for standard Listbox widget.
Definition widgets/Listbox.h:82
EventArgs based class that is used for objects passed to input event handlers concerning mouse input.
Definition InputEvent.h:281
String class used within the GUI system.
Definition String.h:64
EventArgs based class that is used for objects passed to handlers triggered for events concerning som...
Definition InputEvent.h:252
Main namespace for Crazy Eddie's GUI Library.
Definition arch_overview.dox:1