Crazy Eddie's GUI System  0.8.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
ScrolledItemListBase.h
1 /************************************************************************
2  filename: CEGUIIScrolledItemListBase.h
3  created: Sat Oct 29 2005
4  author: Tomas Lindquist Olsen
5 *************************************************************************/
6 /***************************************************************************
7  * Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
8  *
9  * Permission is hereby granted, free of charge, to any person obtaining
10  * a copy of this software and associated documentation files (the
11  * "Software"), to deal in the Software without restriction, including
12  * without limitation the rights to use, copy, modify, merge, publish,
13  * distribute, sublicense, and/or sell copies of the Software, and to
14  * permit persons to whom the Software is furnished to do so, subject to
15  * the following conditions:
16  *
17  * The above copyright notice and this permission notice shall be
18  * included in all copies or substantial portions of the Software.
19  *
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
23  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
24  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
25  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
26  * OTHER DEALINGS IN THE SOFTWARE.
27  ***************************************************************************/
28 #ifndef _CEGUIScrolledItemListBase_h_
29 #define _CEGUIScrolledItemListBase_h_
30 
31 #include "./ItemListBase.h"
32 #include "./Scrollbar.h"
33 
34 #if defined(_MSC_VER)
35 # pragma warning(push)
36 # pragma warning(disable : 4251)
37 #endif
38 // begin CEGUI namespace
39 namespace CEGUI
40 {
41 
46 class CEGUIEXPORT ScrolledItemListBase : public ItemListBase
47 {
48 public:
49  static const String EventNamespace;
50 
51  /************************************************************************
52  Constants
53  *************************************************************************/
54  static const String VertScrollbarName;
55  static const String HorzScrollbarName;
56  static const String ContentPaneName;
57 
63  static const String EventVertScrollbarModeChanged;
69  static const String EventHorzScrollbarModeChanged;
70 
71  /************************************************************************
72  Accessors
73  *************************************************************************/
78  bool isVertScrollbarAlwaysShown(void) const {return d_forceVScroll;}
79 
84  bool isHorzScrollbarAlwaysShown(void) const {return d_forceHScroll;}
85 
90  Scrollbar* getVertScrollbar() const;
91 
96  Scrollbar* getHorzScrollbar() const;
97 
98  /************************************************************************
99  Manipulators
100  *************************************************************************/
105  void setShowVertScrollbar(bool mode);
106 
111  void setShowHorzScrollbar(bool mode);
112 
126  void ensureItemIsVisibleVert(const ItemEntry& item);
127 
141  void ensureItemIsVisibleHorz(const ItemEntry& item);
142 
143  /************************************************************************
144  Object Construction and Destruction
145  *************************************************************************/
150  ScrolledItemListBase(const String& type, const String& name);
151 
156  virtual ~ScrolledItemListBase(void);
157 
158  // overridden from ItemListBase
159  virtual void initialiseComponents(void);
160 
161 protected:
162  /************************************************************************
163  Implementation functions
164  ************************************************************************/
169  void configureScrollbars(const Sizef& doc_size);
170 
171  /************************************************************************
172  New event handlers
173  ************************************************************************/
174  virtual void onVertScrollbarModeChanged(WindowEventArgs& e);
175  virtual void onHorzScrollbarModeChanged(WindowEventArgs& e);
176 
177  /************************************************************************
178  Overridden event handlers
179  ************************************************************************/
180  virtual void onMouseWheel(MouseEventArgs& e);
181 
182  /************************************************************************
183  Event subscribers
184  ************************************************************************/
185  bool handle_VScroll(const EventArgs& e);
186  bool handle_HScroll(const EventArgs& e);
187 
188  /************************************************************************
189  Implementation data
190  ************************************************************************/
191  bool d_forceVScroll;
192  bool d_forceHScroll;
193 
194 private:
195  void addScrolledItemListBaseProperties(void);
196 };
197 
198 } // end CEGUI namespace
199 
200 #if defined(_MSC_VER)
201 # pragma warning(pop)
202 #endif
203 
204 #endif // end of guard _CEGUIScrolledItemListBase_h_