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
231
232
233
234
235
236
237
238
|
/*
* Copyright (C) 2005-2018 Team Kodi
* This file is part of Kodi - https://kodi.tv
*
* SPDX-License-Identifier: GPL-2.0-or-later
* See LICENSES/README.md for more information.
*/
#pragma once
/*!
\file GUIListContainer.h
\brief
*/
#include "GUIAction.h"
#include "IGUIContainer.h"
#include "utils/Stopwatch.h"
#include <list>
#include <memory>
#include <utility>
#include <vector>
/*!
\ingroup controls
\brief
*/
class IListProvider;
class TiXmlNode;
class CGUIListItemLayout;
class CGUIBaseContainer : public IGUIContainer
{
public:
CGUIBaseContainer(int parentID, int controlID, float posX, float posY, float width, float height, ORIENTATION orientation, const CScroller& scroller, int preloadItems);
explicit CGUIBaseContainer(const CGUIBaseContainer& other);
~CGUIBaseContainer(void) override;
bool OnAction(const CAction &action) override;
void OnDown() override;
void OnUp() override;
void OnLeft() override;
void OnRight() override;
bool OnMouseOver(const CPoint &point) override;
bool CanFocus() const override;
bool OnMessage(CGUIMessage& message) override;
void SetFocus(bool bOnOff) override;
void AllocResources() override;
void FreeResources(bool immediately = false) override;
void UpdateVisibility(const CGUIListItem *item = NULL) override;
virtual unsigned int GetRows() const;
virtual bool HasNextPage() const;
virtual bool HasPreviousPage() const;
void SetPageControl(int id);
std::string GetDescription() const override;
void SaveStates(std::vector<CControlState> &states) override;
virtual int GetSelectedItem() const;
void DoProcess(unsigned int currentTime, CDirtyRegionList &dirtyregions) override;
void Process(unsigned int currentTime, CDirtyRegionList &dirtyregions) override;
void LoadLayout(TiXmlElement *layout);
void LoadListProvider(TiXmlElement *content, int defaultItem, bool defaultAlways);
CGUIListItemPtr GetListItem(int offset, unsigned int flag = 0) const override;
bool GetCondition(int condition, int data) const override;
std::string GetLabel(int info) const override;
/*! \brief Set the list provider for this container (for python).
\param provider the list provider to use for this container.
*/
void SetListProvider(std::unique_ptr<IListProvider> provider);
/*! \brief Set the offset of the first item in the container from the container's position
Useful for lists/panels where the focused item may be larger than the non-focused items and thus
normally cut off from the clipping window defined by the container's position + size.
\param offset CPoint holding the offset in skin coordinates.
*/
void SetRenderOffset(const CPoint &offset);
void SetClickActions(const CGUIAction& clickActions) { m_clickActions = clickActions; }
void SetFocusActions(const CGUIAction& focusActions) { m_focusActions = focusActions; }
void SetUnFocusActions(const CGUIAction& unfocusActions) { m_unfocusActions = unfocusActions; }
void SetAutoScrolling(const TiXmlNode *node);
void ResetAutoScrolling();
void UpdateAutoScrolling(unsigned int currentTime);
#ifdef _DEBUG
void DumpTextureUse() override;
#endif
protected:
EVENT_RESULT OnMouseEvent(const CPoint &point, const CMouseEvent &event) override;
bool OnClick(int actionID);
virtual void ProcessItem(float posX, float posY, CGUIListItemPtr& item, bool focused, unsigned int currentTime, CDirtyRegionList &dirtyregions);
void Render() override;
virtual void RenderItem(float posX, float posY, CGUIListItem *item, bool focused);
virtual void Scroll(int amount);
virtual bool MoveDown(bool wrapAround);
virtual bool MoveUp(bool wrapAround);
virtual bool GetOffsetRange(int &minOffset, int &maxOffset) const;
virtual void ValidateOffset();
virtual int CorrectOffset(int offset, int cursor) const;
virtual void UpdateLayout(bool refreshAllItems = false);
virtual void SetPageControlRange();
virtual void UpdatePageControl(int offset);
virtual void CalculateLayout();
virtual void SelectItem(int item) {}
virtual bool SelectItemFromPoint(const CPoint& point) { return false; }
virtual int GetCursorFromPoint(const CPoint& point, CPoint* itemPoint = NULL) const { return -1; }
virtual void Reset();
virtual size_t GetNumItems() const { return m_items.size(); }
virtual int GetCurrentPage() const;
bool InsideLayout(const CGUIListItemLayout *layout, const CPoint &point) const;
void OnFocus() override;
void OnUnFocus() override;
void UpdateListProvider(bool forceRefresh = false);
int ScrollCorrectionRange() const;
inline float Size() const;
void FreeMemory(int keepStart, int keepEnd);
void GetCurrentLayouts();
CGUIListItemLayout *GetFocusedLayout() const;
CPoint m_renderOffset; ///< \brief render offset of the first item in the list \sa SetRenderOffset
float m_analogScrollCount;
unsigned int m_lastHoldTime;
ORIENTATION m_orientation;
int m_itemsPerPage;
std::vector< CGUIListItemPtr > m_items;
typedef std::vector<CGUIListItemPtr> ::iterator iItems;
CGUIListItemPtr m_lastItem;
int m_pageControl;
std::list<CGUIListItemLayout> m_layouts;
std::list<CGUIListItemLayout> m_focusedLayouts;
CGUIListItemLayout* m_layout{nullptr};
CGUIListItemLayout* m_focusedLayout{nullptr};
bool m_layoutCondition = false;
bool m_focusedLayoutCondition = false;
void ScrollToOffset(int offset);
void SetContainerMoving(int direction);
void UpdateScrollOffset(unsigned int currentTime);
CScroller m_scroller;
std::unique_ptr<IListProvider> m_listProvider;
bool m_wasReset; // true if we've received a Reset message until we've rendered once. Allows
// us to make sure we don't tell the infomanager that we've been moving when
// the "movement" was simply due to the list being repopulated (thus cursor position
// changing around)
void UpdateScrollByLetter();
void GetCacheOffsets(int &cacheBefore, int &cacheAfter) const;
int GetCacheCount() const { return m_cacheItems; }
bool ScrollingDown() const { return m_scroller.IsScrollingDown(); }
bool ScrollingUp() const { return m_scroller.IsScrollingUp(); }
void OnNextLetter();
void OnPrevLetter();
void OnJumpLetter(const std::string& letter, bool skip = false);
void OnJumpSMS(int letter);
std::vector< std::pair<int, std::string> > m_letterOffsets;
/*! \brief Set the cursor position
Should be used by all base classes rather than directly setting it, as
this also marks the control as dirty (if needed)
*/
virtual void SetCursor(int cursor);
inline int GetCursor() const { return m_cursor; }
/*! \brief Set the container offset
Should be used by all base classes rather than directly setting it, as
this also marks the control as dirty (if needed)
*/
void SetOffset(int offset);
/*! \brief Returns the index of the first visible row
returns the first row. This may be outside of the range of available items. Use GetItemOffset() to retrieve the first visible item in the list.
\sa GetItemOffset
*/
inline int GetOffset() const { return m_offset; }
/*! \brief Returns the index of the first visible item
returns the first visible item. This will always be in the range of available items. Use GetOffset() to retrieve the first visible row in the list.
\sa GetOffset
*/
inline int GetItemOffset() const { return CorrectOffset(GetOffset(), 0); }
// autoscrolling
INFO::InfoPtr m_autoScrollCondition;
int m_autoScrollMoveTime; // time between to moves
unsigned int m_autoScrollDelayTime; // current offset into the delay
bool m_autoScrollIsReversed; // scroll backwards
unsigned int m_lastRenderTime;
private:
bool OnContextMenu();
int m_cursor;
int m_offset;
int m_cacheItems;
CStopWatch m_scrollTimer;
CStopWatch m_lastScrollStartTimer;
CStopWatch m_pageChangeTimer;
CGUIAction m_clickActions;
CGUIAction m_focusActions;
CGUIAction m_unfocusActions;
// letter match searching
CStopWatch m_matchTimer;
std::string m_match;
float m_scrollItemsPerFrame;
static const int letter_match_timeout = 1000;
bool m_gestureActive = false;
// early inertial scroll cancellation
bool m_waitForScrollEnd = false;
float m_lastScrollValue = 0.0f;
};
|
