/usr/include/CEGUI/elements/CEGUIScrolledItemListBase.h is in libcegui-mk2-dev 0.7.6-2ubuntu4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | /************************************************************************
filename: CEGUIIScrolledItemListBase.h
created: Sat Oct 29 2005
author: Tomas Lindquist Olsen
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
***************************************************************************/
#ifndef _CEGUIScrolledItemListBase_h_
#define _CEGUIScrolledItemListBase_h_
#include "CEGUIItemListBase.h"
#include "CEGUIScrollbar.h"
#include "CEGUIScrolledItemListBaseProperties.h"
#if defined(_MSC_VER)
# pragma warning(push)
# pragma warning(disable : 4251)
#endif
// begin CEGUI namespace
namespace CEGUI
{
/*!
\brief
ScrolledItemListBase window class
*/
class CEGUIEXPORT ScrolledItemListBase : public ItemListBase
{
public:
static const String EventNamespace; //!< Namespace for global events
/************************************************************************
Constants
*************************************************************************/
static const String VertScrollbarNameSuffix; //!< Name suffix for vertical scrollbar component
static const String HorzScrollbarNameSuffix; //!< Name suffix for horizontal scrollbar component
static const String ContentPaneNameSuffix; //!< Name suffix for the content pane component
/** Event fired when the vertical scroll bar mode changes.
* Handlers are passed a const WindowEventArgs reference with
* WindowEventArgs::window set to the ScrolledItemListBase whose vertical
* scroll bar mode has been changed.
*/
static const String EventVertScrollbarModeChanged;
/** Event fired when the horizontal scroll bar mode change.
* Handlers are passed a const WindowEventArgs reference with
* WindowEventArgs::window set to the ScrolledItemListBase whose horizontal
* scroll bar mode has been changed.
*/
static const String EventHorzScrollbarModeChanged;
/************************************************************************
Accessors
*************************************************************************/
/*!
\brief
Returns whether the vertical scrollbar is being forced visible. Despite content size.
*/
bool isVertScrollbarAlwaysShown(void) const {return d_forceVScroll;}
/*!
\brief
Returns whether the horizontal scrollbar is being forced visible. Despite content size.
*/
bool isHorzScrollbarAlwaysShown(void) const {return d_forceHScroll;}
/*!
\brief
Get the vertical scrollbar component attached to this window.
*/
Scrollbar* getVertScrollbar() const;
/*!
\brief
Get the horizontal scrollbar component attached to this window.
*/
Scrollbar* getHorzScrollbar() const;
/************************************************************************
Manipulators
*************************************************************************/
/*!
\brief
Sets whether the vertical scrollbar should be forced visible. Despite content size.
*/
void setShowVertScrollbar(bool mode);
/*!
\brief
Sets whether the horizontal scrollbar should be forced visible. Despite content size.
*/
void setShowHorzScrollbar(bool mode);
/*!
\brief
Scroll the vertical list position if needed to ensure that the ItemEntry
\a item is, if possible, fully visible witin the ScrolledItemListBase
viewable area.
\param item
const reference to an ItemEntry attached to this ScrolledItemListBase
that should be made visible in the view area.
\return
Nothing.
*/
void ensureItemIsVisibleVert(const ItemEntry& item);
/*!
\brief
Scroll the horizontal list position if needed to ensure that the
ItemEntry \a item is, if possible, fully visible witin the
ScrolledItemListBase viewable area.
\param item
const reference to an ItemEntry attached to this ScrolledItemListBase
that should be made visible in the view area.
\return
Nothing.
*/
void ensureItemIsVisibleHorz(const ItemEntry& item);
/************************************************************************
Object Construction and Destruction
*************************************************************************/
/*!
\brief
Constructor for the ScrolledItemListBase base class constructor
*/
ScrolledItemListBase(const String& type, const String& name);
/*!
\brief
Destructor for the ScrolledItemListBase base class.
*/
virtual ~ScrolledItemListBase(void);
// overridden from ItemListBase
virtual void initialiseComponents(void);
protected:
/************************************************************************
Implementation functions
************************************************************************/
/*!
\brief
Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.
\param class_name
The class name that is to be checked.
\return
true if this window was inherited from \a class_name. false if not.
*/
virtual bool testClassName_impl(const String& class_name) const
{
if (class_name=="ScrolledItemListBase")
{
return true;
}
return ItemListBase::testClassName_impl(class_name);
}
/*!
\brief
Configure scrollbars
*/
void configureScrollbars(const Size& doc_size);
/************************************************************************
New event handlers
************************************************************************/
virtual void onVertScrollbarModeChanged(WindowEventArgs& e);
virtual void onHorzScrollbarModeChanged(WindowEventArgs& e);
/************************************************************************
Overridden event handlers
************************************************************************/
virtual void onMouseWheel(MouseEventArgs& e);
/************************************************************************
Event subscribers
************************************************************************/
bool handle_VScroll(const EventArgs& e);
bool handle_HScroll(const EventArgs& e);
/************************************************************************
Implementation data
************************************************************************/
bool d_forceVScroll;
bool d_forceHScroll;
private:
/************************************************************************
Static Properties for this class
************************************************************************/
static ScrolledItemListBaseProperties::ForceVertScrollbar d_forceVertScrollbarProperty;
static ScrolledItemListBaseProperties::ForceHorzScrollbar d_forceHorzScrollbarProperty;
void addScrolledItemListBaseProperties(void);
};
} // end CEGUI namespace
#if defined(_MSC_VER)
# pragma warning(pop)
#endif
#endif // end of guard _CEGUIScrolledItemListBase_h_
|