src/ui/inc/FUiCtrl_ListViewImpl.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Flora License, Version 1.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://floralicense.org/license/
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an AS IS BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17
  18 /**
  19  * @file                FUiCtrl_ListViewImpl.h
  20  * @brief               This file defines the _ListViewImpl class.
  21  * @version             3.0
  22  *
  23  * This file contains the declarations of _ListViewImpl class.
  24  */
  25
  26 #ifndef _FUI_CTRL_INTERNAL_LIST_VIEW_IMPL_H_
  27 #define _FUI_CTRL_INTERNAL_LIST_VIEW_IMPL_H_
  28
  29 #include <FUiCtrlListView.h>
  30 #include "FUi_ControlImpl.h"
  31 #include "FUi_ITouchLongPressGestureEventListener.h"
  32 #include "FUi_TouchLongPressGestureDetector.h"
  33 #include "FUiCtrl_IFastScrollListener.h"
  34 #include "FUiCtrl_IScrollEventListener.h"
  35 #include "FUiCtrl_IUiListViewItemEventListener.h"
  36 #include "FUiCtrl_ListViewTouchEventHandler.h"
  37 #include "FUiCtrl_TableView.h"
  38
  39 namespace Tizen { namespace Ui { namespace Controls
  40 {
  41
  42 class _FastScrollEvent;
  43 class _Label;
  44 class _ListItemEvent;
  45 class _ListViewItem;
  46 class _PublicLinkEvent;
  47 class _ScrollEvent;
  48
  49 class _ListViewImpl
  50         : public _ControlImpl
  51         , public _IScrollEventListener
  52         , public _ITableViewItemEventListener
  53         , public _ITouchLongPressGestureEventListener
  54         , public _IUiFastScrollListener
  55         , public _IUiListViewItemEventListener
  56         , virtual public Tizen::Base::Runtime::IEventListener
  57 {
  58 public:
  59         virtual ~_ListViewImpl(void);
  60
  61         static _ListViewImpl* CreateListViewImplN(ListView* pControl, bool itemDivider, bool fastScroll);
  62
  63         static _ListViewImpl* CreateListViewImplN(ListView* pControl, bool itemDivider, ListScrollStyle scrollStyle);
  64
  65         virtual const char* GetPublicClassName(void) const;
  66
  67         virtual const ListView& GetPublic(void) const;
  68
  69         virtual ListView& GetPublic(void);
  70
  71         virtual const _TableView& GetCore(void) const;
  72
  73         virtual _TableView& GetCore(void);
  74
  75         result SetItemProvider(IListViewItemProvider& provider);
  76
  77         result SetItemProvider(IListViewItemProviderF& provider);
  78
  79         void AddListViewItemEventListener(IListViewItemEventListener& listener);
  80
  81         void RemoveListViewItemEventListener(IListViewItemEventListener& listener);
  82
  83         void AddFastScrollListener(IFastScrollListener& listener);
  84
  85         void RemoveFastScrollListener(IFastScrollListener& listener);
  86
  87         void AddScrollEventListener(IScrollEventListener& listener);
  88
  89         void AddScrollEventListener(IScrollEventListenerF& listener);
  90
  91         void RemoveScrollEventListener(IScrollEventListener& listener);
  92
  93         void RemoveScrollEventListener(IScrollEventListenerF& listener);
  94
  95         void AddUiLinkEventListener(const Tizen::Ui::IUiLinkEventListener& listener);
  96
  97         void RemoveUiLinkEventListener(const Tizen::Ui::IUiLinkEventListener& listener);
  98
  99         result SetSweepEnabled(bool enable);
 100
 101         result SetFastScrollIndex(const Tizen::Base::String& text, bool useSearchIcon);
 102
 103         int GetTopDrawnItemIndex(void) const;
 104
 105         int GetBottomDrawnItemIndex(void) const;
 106
 107         result ScrollToItem(int index, ListScrollItemAlignment itemAlignment);
 108
 109         result SetItemChecked(int index, bool check);
 110
 111         bool IsItemChecked(int index) const;
 112
 113         result SetItemEnabled(int index, bool enable);
 114
 115         bool IsItemEnabled(int index) const;
 116
 117         int GetItemCount(void) const;
 118
 119         result ShowItemDescriptionText(int index);
 120
 121         result HideItemDescriptionText(int index);
 122
 123         result RefreshList(int index, ListRefreshType type, bool needFlush = true);
 124
 125         result RefreshList(int index, int elementId);
 126
 127         result UpdateList(void);
 128
 129         int GetItemIndexFromPosition(const Tizen::Graphics::FloatPoint& position) const;
 130
 131         result GetItemIndexFromPosition(const Tizen::Graphics::FloatPoint& position, int& itemIndex, int& elementId) const;
 132
 133         result SetItemDividerColor(const Tizen::Graphics::Color& color);
 134
 135         Tizen::Graphics::Color GetItemDividerColor(void) const;
 136
 137         result SetBitmapOfEmptyList(const Tizen::Graphics::Bitmap* pBitmap);
 138
 139         result SetTextOfEmptyList(const Tizen::Base::String& text);
 140
 141         Tizen::Base::String GetTextOfEmptyList(void) const;
 142
 143         result SetTextColorOfEmptyList(const Tizen::Graphics::Color& color);
 144
 145         Tizen::Graphics::Color GetTextColorOfEmptyList(void) const;
 146
 147         result SetListBackgroundColor(const Tizen::Graphics::Color& color);
 148
 149         result SetBackgroundBitmap(const Tizen::Graphics::Bitmap* pBitmap);
 150
 151         result BeginReorderingMode(void);
 152
 153         result EndReorderingMode(void);
 154
 155         bool IsInReorderingMode(void) const;
 156
 157         void SetScrollInputMode(ScrollInputMode mode);
 158
 159         ScrollInputMode GetScrollInputMode(void) const;
 160
 161         result OpenContextItem(int itemIndex);
 162
 163         result CloseContextItem(int itemIndex);
 164
 165         bool IsContextItemOpened(int itemIndex) const;
 166
 167         virtual void OnListViewContextItemStateChanged(Tizen::Ui::_Control& source, int groupIndex, int itemIndex, int elementId,
 168                         Tizen::Ui::Controls::ListContextItemStatus status);
 169
 170         // _ITableViewItemEventListener
 171         virtual void OnTableViewItemStateChanged(Tizen::Ui::Controls::_TableView& tableView, int itemIndex,
 172                         Tizen::Ui::Controls::_TableViewItem* pItem, Tizen::Ui::Controls::TableViewItemStatus status);
 173
 174         virtual void OnTableViewContextItemActivationStateChanged(Tizen::Ui::Controls::_TableView& tableView, int itemIndex,
 175                         Tizen::Ui::Controls::_TableViewItem* pContextItem, bool activated);
 176
 177         virtual void OnTableViewItemReordered(Tizen::Ui::Controls::_TableView& tableView, int itemIndexFrom, int itemIndexTo);
 178
 179         virtual void OnGroupedTableViewGroupItemStateChanged(Tizen::Ui::Controls::_TableView& tableView, int groupIndex,
 180                         Tizen::Ui::Controls::_TableViewItem* pItem, Tizen::Ui::Controls::TableViewItemStatus status) {};
 181
 182         virtual void OnGroupedTableViewItemStateChanged(Tizen::Ui::Controls::_TableView& tableView, int groupIndex, int itemIndex,
 183                         Tizen::Ui::Controls::_TableViewItem* pItem, Tizen::Ui::Controls::TableViewItemStatus status) {};
 184
 185         virtual void OnGroupedTableViewContextItemActivationStateChanged(Tizen::Ui::Controls::_TableView& tableView, int groupIndex,
 186                         int itemIndex, Tizen::Ui::Controls::_TableViewItem* pContextItem, bool activated) {};
 187
 188         virtual void OnGroupedTableViewItemReordered(Tizen::Ui::Controls::_TableView& tableView, int groupIndexFrom, int itemIndexFrom,
 189                         int groupIndexTo, int itemIndexTo) {};
 190
 191         virtual void OnSectionTableViewItemStateChanged(Tizen::Ui::Controls::_TableView& tableView, int sectionIndex, int itemIndex,
 192                         Tizen::Ui::Controls::_TableViewItem* pItem, Tizen::Ui::Controls::TableViewItemStatus status) {};
 193
 194         virtual void OnSectionTableViewContextItemActivationStateChanged(Tizen::Ui::Controls::_TableView& tableView, int sectionIndex,
 195                         int itemIndex, Tizen::Ui::Controls::_TableViewItem* pContextItem, bool activated) {};
 196
 197         virtual void OnTableViewItemSwept(Tizen::Ui::Controls::_TableView& tableView, int groupIndex, int itemIndex,
 198                         Tizen::Ui::Controls::TableViewSweepDirection direction);
 199
 200         // Event handler for _IScrollEventListener
 201         virtual void OnScrollEndReached(Tizen::Ui::_Control& source, ScrollEndEvent type);
 202
 203         virtual void OnScrollPositionChanged(Tizen::Ui::_Control& source, float scrollPosition);
 204
 205         virtual void OnScrollStopped(Tizen::Ui::_Control& source);
 206
 207         // Event handler for _IUiFastScrollListener
 208         virtual void OnUiFastScrollIndexSelected(Tizen::Ui::_Control& source, Tizen::Ui::Controls::_FastScrollIndex& index);
 209
 210         virtual void OnDraw(void);
 211
 212         virtual void OnChangeLayout(_ControlOrientation orientation);
 213
 214         virtual void OnBoundsChanged(void);
 215
 216         virtual void OnFontChanged(Tizen::Graphics::Font* pFont);
 217
 218         virtual void OnFontInfoRequested(unsigned long& style, int& size);
 219
 220         virtual void OnFontInfoRequested(unsigned long& style, float& size);
 221
 222         virtual bool OnTouchPressed(const _ControlImpl& source, const _TouchInfo& touchinfo);
 223
 224         virtual bool OnTouchReleased(const _ControlImpl& source, const _TouchInfo& touchinfo);
 225
 226         virtual bool OnTouchMoved(const _ControlImpl& source, const _TouchInfo& touchinfo);
 227
 228         virtual bool OnTouchCanceled(const _ControlImpl& source, const _TouchInfo& touchinfo);
 229
 230         virtual bool OnLongPressGestureDetected(_TouchLongPressGestureDetector& gesture);
 231
 232         virtual bool OnLongPressGestureCanceled(_TouchLongPressGestureDetector& gesture);
 233
 234         bool GetInputEventConsumeState(void);
 235
 236 public:
 237         static _ListViewImpl* GetInstance(ListView& listView);
 238
 239         static const _ListViewImpl* GetInstance(const ListView& listView);
 240
 241 private:
 242         _ListViewImpl(ListView* pList, _TableView* pCore);
 243
 244         _ListViewImpl(_ListViewImpl& rhs);
 245
 246         _ListViewImpl& operator =(_ListViewImpl& rhs);
 247
 248         result SetItemDescriptionTextShowState(int index, bool show);
 249
 250         void AdjustLayoutOfEmptyList(void);
 251
 252         void CheckEmptyListShowState(void);
 253
 254         Tizen::Graphics::FloatPoint GetCurrentTouchPosition(void);
 255
 256         virtual result OnTouchEventListenerAdded(void);
 257
 258         virtual result OnTouchEventListenerRemoved(void);
 259
 260         void SetItemNeedsLazyDeletion(void);
 261
 262 private:
 263         _ListItemEvent* __pListItemEvent;
 264         _PublicLinkEvent* __pLinkEvent;
 265         _ScrollEvent* __pScrollEvent;
 266         _FastScrollEvent* __pFastScrollEvent;
 267
 268         _Label* __pEmptyBitmap;
 269         _Label* __pEmptyText;
 270         Tizen::Graphics::Color __emptyTextColor;
 271
 272         bool __redrawListView;
 273         bool __isBoundsChanged;
 274         _ListViewItem* __pItemNeedsLazyDeletion;
 275
 276         _ListViewTouchEventHandler* __pTouchEventHandler;
 277         _TouchLongPressGestureDetector* __pLongPressedGesture;
 278 }; // _ListViewImpl
 279
 280 }}} // Tizen::Ui::Controls
 281
 282 #endif  // _FUI_CTRL_INTERNAL_LIST_VIEW_IMPL_H_