2013-09-13 22:20:20 +08:00
|
|
|
/****************************************************************************
|
2014-01-07 11:47:11 +08:00
|
|
|
Copyright (c) 2013-2014 Chukong Technologies Inc.
|
|
|
|
|
|
|
|
http://www.cocos2d-x.org
|
|
|
|
|
|
|
|
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 OR COPYRIGHT HOLDERS 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.
|
|
|
|
****************************************************************************/
|
2013-09-13 22:20:20 +08:00
|
|
|
|
2013-11-06 16:04:06 +08:00
|
|
|
|
2013-09-13 22:20:20 +08:00
|
|
|
#ifndef __UILISTVIEW_H__
|
|
|
|
#define __UILISTVIEW_H__
|
|
|
|
|
2014-03-11 17:13:54 +08:00
|
|
|
#include "ui/UIScrollView.h"
|
2013-09-13 22:20:20 +08:00
|
|
|
|
2013-12-23 15:02:52 +08:00
|
|
|
NS_CC_BEGIN
|
|
|
|
|
2014-02-24 18:56:45 +08:00
|
|
|
namespace ui{
|
2013-11-06 16:04:06 +08:00
|
|
|
|
2014-05-12 09:51:23 +08:00
|
|
|
CC_DEPRECATED_ATTRIBUTE typedef enum
|
2013-11-08 20:29:49 +08:00
|
|
|
{
|
2014-03-11 11:53:44 +08:00
|
|
|
LISTVIEW_ONSELECTEDITEM_START,
|
|
|
|
LISTVIEW_ONSELECTEDITEM_END
|
2013-11-08 20:29:49 +08:00
|
|
|
}ListViewEventType;
|
|
|
|
|
2014-05-12 09:51:23 +08:00
|
|
|
CC_DEPRECATED_ATTRIBUTE typedef void (Ref::*SEL_ListViewEvent)(Ref*,ListViewEventType);
|
2013-11-08 20:29:49 +08:00
|
|
|
#define listvieweventselector(_SELECTOR) (SEL_ListViewEvent)(&_SELECTOR)
|
2013-09-13 22:20:20 +08:00
|
|
|
|
2013-12-23 15:02:52 +08:00
|
|
|
class ListView : public ScrollView
|
2013-09-13 22:20:20 +08:00
|
|
|
{
|
2014-03-04 16:51:35 +08:00
|
|
|
|
|
|
|
DECLARE_CLASS_GUI_INFO
|
2013-11-06 16:04:06 +08:00
|
|
|
|
2013-09-13 22:20:20 +08:00
|
|
|
public:
|
2014-05-12 09:51:23 +08:00
|
|
|
enum class Gravity
|
|
|
|
{
|
|
|
|
LEFT,
|
|
|
|
RIGHT,
|
|
|
|
CENTER_HORIZONTAL,
|
|
|
|
TOP,
|
|
|
|
BOTTOM,
|
|
|
|
CENTER_VERTICAL
|
|
|
|
};
|
|
|
|
|
|
|
|
enum class EventType
|
|
|
|
{
|
|
|
|
ON_SELECTED_ITEM_START,
|
|
|
|
ON_SELECTED_ITEM_END
|
|
|
|
};
|
|
|
|
|
|
|
|
typedef std::function<void(Ref*, EventType)> ccListViewCallback;
|
2013-11-06 16:04:06 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Default constructor
|
|
|
|
*/
|
2013-12-23 15:02:52 +08:00
|
|
|
ListView();
|
2013-09-13 22:20:20 +08:00
|
|
|
|
|
|
|
/**
|
2013-11-06 16:04:06 +08:00
|
|
|
* Default destructor
|
2013-09-13 22:20:20 +08:00
|
|
|
*/
|
2013-12-23 15:02:52 +08:00
|
|
|
virtual ~ListView();
|
2013-11-06 16:04:06 +08:00
|
|
|
|
2013-09-13 22:20:20 +08:00
|
|
|
/**
|
2013-11-06 16:04:06 +08:00
|
|
|
* Allocates and initializes.
|
2013-09-13 22:20:20 +08:00
|
|
|
*/
|
2013-12-23 15:02:52 +08:00
|
|
|
static ListView* create();
|
2013-11-06 16:04:06 +08:00
|
|
|
|
2013-09-13 22:20:20 +08:00
|
|
|
/**
|
2013-11-06 16:04:06 +08:00
|
|
|
* Sets a item model for listview
|
|
|
|
*
|
|
|
|
* A model will be cloned for adding default item.
|
|
|
|
*
|
|
|
|
* @param model item model for listview
|
2013-09-13 22:20:20 +08:00
|
|
|
*/
|
2013-12-23 15:02:52 +08:00
|
|
|
void setItemModel(Widget* model);
|
2013-09-13 22:20:20 +08:00
|
|
|
|
2013-11-06 16:04:06 +08:00
|
|
|
/**
|
|
|
|
* Push back a default item(create by a cloned model) into listview.
|
|
|
|
*/
|
|
|
|
void pushBackDefaultItem();
|
2013-09-13 22:20:20 +08:00
|
|
|
|
|
|
|
/**
|
2013-11-06 16:04:06 +08:00
|
|
|
* Insert a default item(create by a cloned model) into listview.
|
2013-09-13 22:20:20 +08:00
|
|
|
*/
|
2013-12-28 14:34:52 +08:00
|
|
|
void insertDefaultItem(ssize_t index);
|
2013-09-13 22:20:20 +08:00
|
|
|
|
|
|
|
/**
|
2013-11-06 16:04:06 +08:00
|
|
|
* Push back custom item into listview.
|
2013-09-13 22:20:20 +08:00
|
|
|
*/
|
2013-12-23 15:02:52 +08:00
|
|
|
void pushBackCustomItem(Widget* item);
|
2013-11-06 16:04:06 +08:00
|
|
|
|
2013-09-13 22:20:20 +08:00
|
|
|
/**
|
2013-11-06 16:04:06 +08:00
|
|
|
* Insert custom item into listview.
|
2013-09-13 22:20:20 +08:00
|
|
|
*/
|
2013-12-28 14:34:52 +08:00
|
|
|
void insertCustomItem(Widget* item, ssize_t index);
|
2013-09-13 22:20:20 +08:00
|
|
|
|
|
|
|
/**
|
2013-11-06 16:04:06 +08:00
|
|
|
* Removes the last item of listview.
|
2013-09-13 22:20:20 +08:00
|
|
|
*/
|
2013-11-06 16:04:06 +08:00
|
|
|
void removeLastItem();
|
|
|
|
|
2013-09-13 22:20:20 +08:00
|
|
|
/**
|
2013-11-06 16:04:06 +08:00
|
|
|
* Removes a item whose index is same as the parameter.
|
|
|
|
*
|
|
|
|
* @param index of item.
|
2013-09-13 22:20:20 +08:00
|
|
|
*/
|
2013-12-28 14:34:52 +08:00
|
|
|
void removeItem(ssize_t index);
|
2013-11-06 16:04:06 +08:00
|
|
|
|
2013-12-27 16:01:03 +08:00
|
|
|
void removeAllItems();
|
|
|
|
|
2013-09-13 22:20:20 +08:00
|
|
|
/**
|
2013-11-06 16:04:06 +08:00
|
|
|
* Returns a item whose index is same as the parameter.
|
|
|
|
*
|
|
|
|
* @param index of item.
|
|
|
|
*
|
|
|
|
* @return the item widget.
|
2013-09-13 22:20:20 +08:00
|
|
|
*/
|
2014-05-27 10:40:20 +08:00
|
|
|
Widget* getItem(ssize_t index)const;
|
2013-11-06 16:04:06 +08:00
|
|
|
|
2013-09-13 22:20:20 +08:00
|
|
|
/**
|
2013-11-06 16:04:06 +08:00
|
|
|
* Returns the item container.
|
2013-09-13 22:20:20 +08:00
|
|
|
*/
|
2013-12-23 15:02:52 +08:00
|
|
|
Vector<Widget*>& getItems();
|
2013-09-13 22:20:20 +08:00
|
|
|
|
|
|
|
/**
|
2013-11-06 16:04:06 +08:00
|
|
|
* Returns the index of item.
|
|
|
|
*
|
|
|
|
* @param item the item which need to be checked.
|
|
|
|
*
|
|
|
|
* @return the index of item.
|
2013-09-13 22:20:20 +08:00
|
|
|
*/
|
2013-12-28 14:34:52 +08:00
|
|
|
ssize_t getIndex(Widget* item) const;
|
2013-11-06 16:04:06 +08:00
|
|
|
|
2013-09-13 22:20:20 +08:00
|
|
|
/**
|
2013-11-06 16:04:06 +08:00
|
|
|
* Changes the gravity of listview.
|
|
|
|
* @see ListViewGravity
|
2013-09-13 22:20:20 +08:00
|
|
|
*/
|
2014-05-12 09:51:23 +08:00
|
|
|
void setGravity(Gravity gravity);
|
2013-09-13 22:20:20 +08:00
|
|
|
|
|
|
|
/**
|
2013-11-06 16:04:06 +08:00
|
|
|
* Changes the margin between each item.
|
|
|
|
*
|
|
|
|
* @param margin
|
2013-09-13 22:20:20 +08:00
|
|
|
*/
|
2013-11-06 16:04:06 +08:00
|
|
|
void setItemsMargin(float margin);
|
2013-09-13 22:20:20 +08:00
|
|
|
|
2014-05-27 10:40:20 +08:00
|
|
|
float getItemsMargin()const;
|
2014-03-01 22:34:25 +08:00
|
|
|
|
2014-06-04 10:51:32 +08:00
|
|
|
virtual void doLayout() override;
|
|
|
|
|
2014-05-22 17:49:19 +08:00
|
|
|
virtual void addChild(Node * child) override;
|
|
|
|
virtual void addChild(Node * child, int zOrder) override;
|
|
|
|
virtual void addChild(Node* child, int zOrder, int tag) override;
|
|
|
|
virtual void removeAllChildren() override;
|
|
|
|
virtual void removeAllChildrenWithCleanup(bool cleanup) override;
|
|
|
|
virtual void removeChild(Node* child, bool cleaup = true) override;
|
2013-09-23 19:16:20 +08:00
|
|
|
|
2013-12-28 14:34:52 +08:00
|
|
|
ssize_t getCurSelectedIndex() const;
|
2013-11-08 20:29:49 +08:00
|
|
|
|
2014-05-12 09:51:23 +08:00
|
|
|
CC_DEPRECATED_ATTRIBUTE void addEventListenerListView(Ref* target, SEL_ListViewEvent selector);
|
2014-05-14 16:14:28 +08:00
|
|
|
void addEventListener(const ccListViewCallback& callback);
|
2013-11-08 20:29:49 +08:00
|
|
|
|
2013-09-17 17:59:20 +08:00
|
|
|
/**
|
2013-11-06 16:04:06 +08:00
|
|
|
* Changes scroll direction of scrollview.
|
|
|
|
*
|
|
|
|
* @see SCROLLVIEW_DIR SCROLLVIEW_DIR_VERTICAL means vertical scroll, SCROLLVIEW_DIR_HORIZONTAL means horizontal scroll
|
|
|
|
*
|
|
|
|
* @param SCROLLVIEW_DIR
|
2013-09-17 17:59:20 +08:00
|
|
|
*/
|
2014-05-12 11:08:10 +08:00
|
|
|
virtual void setDirection(Direction dir) override;
|
2013-11-06 16:04:06 +08:00
|
|
|
|
2013-12-23 15:02:52 +08:00
|
|
|
virtual std::string getDescription() const override;
|
2013-11-06 16:04:06 +08:00
|
|
|
|
2013-12-26 14:57:30 +08:00
|
|
|
void requestRefreshView();
|
2014-03-06 17:21:09 +08:00
|
|
|
void refreshView();
|
2014-03-21 13:44:29 +08:00
|
|
|
|
|
|
|
CC_CONSTRUCTOR_ACCESS:
|
|
|
|
virtual bool init() override;
|
|
|
|
|
2013-09-13 22:20:20 +08:00
|
|
|
protected:
|
2014-05-22 17:49:19 +08:00
|
|
|
|
2013-11-06 16:04:06 +08:00
|
|
|
void updateInnerContainerSize();
|
2013-12-23 15:02:52 +08:00
|
|
|
void remedyLayoutParameter(Widget* item);
|
2013-11-14 13:42:10 +08:00
|
|
|
virtual void onSizeChanged() override;
|
2013-12-23 15:02:52 +08:00
|
|
|
virtual Widget* createCloneInstance() override;
|
|
|
|
virtual void copySpecialProperties(Widget* model) override;
|
|
|
|
virtual void copyClonedWidgetChildren(Widget* model) override;
|
2014-05-22 15:23:13 +08:00
|
|
|
void selectedItemEvent(TouchEventType event);
|
|
|
|
virtual void interceptTouchEvent(Widget::TouchEventType event,Widget* sender,const Vec2 &touchPoint) override;
|
2013-09-13 22:20:20 +08:00
|
|
|
protected:
|
2013-11-06 16:04:06 +08:00
|
|
|
|
2013-12-23 15:02:52 +08:00
|
|
|
Widget* _model;
|
|
|
|
Vector<Widget*> _items;
|
2014-05-12 09:51:23 +08:00
|
|
|
Gravity _gravity;
|
2013-11-06 16:04:06 +08:00
|
|
|
float _itemsMargin;
|
2014-05-12 09:51:23 +08:00
|
|
|
|
2014-02-20 10:53:49 +08:00
|
|
|
Ref* _listViewEventListener;
|
2014-05-12 09:51:23 +08:00
|
|
|
#if defined(__GNUC__) && ((__GNUC__ >= 4) || ((__GNUC__ == 3) && (__GNUC_MINOR__ >= 1)))
|
|
|
|
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
|
|
|
|
#elif _MSC_VER >= 1400 //vs 2005 or higher
|
|
|
|
#pragma warning (push)
|
|
|
|
#pragma warning (disable: 4996)
|
|
|
|
#endif
|
2013-11-08 20:29:49 +08:00
|
|
|
SEL_ListViewEvent _listViewEventSelector;
|
2014-05-12 09:51:23 +08:00
|
|
|
#if defined(__GNUC__) && ((__GNUC__ >= 4) || ((__GNUC__ == 3) && (__GNUC_MINOR__ >= 1)))
|
|
|
|
#pragma GCC diagnostic warning "-Wdeprecated-declarations"
|
|
|
|
#elif _MSC_VER >= 1400 //vs 2005 or higher
|
|
|
|
#pragma warning (pop)
|
|
|
|
#endif
|
|
|
|
ccListViewCallback _eventCallback;
|
|
|
|
|
2013-12-28 14:34:52 +08:00
|
|
|
ssize_t _curSelectedIndex;
|
2013-12-23 15:02:52 +08:00
|
|
|
bool _refreshViewDirty;
|
2013-09-13 22:20:20 +08:00
|
|
|
};
|
|
|
|
|
2013-10-15 18:00:03 +08:00
|
|
|
}
|
2013-12-23 15:02:52 +08:00
|
|
|
NS_CC_END
|
2013-09-13 22:20:20 +08:00
|
|
|
|
2013-12-23 15:02:52 +08:00
|
|
|
#endif /* defined(__ListView__) */
|