/*
 * Copyright 2006, 2023, Haiku.
 * Distributed under the terms of the MIT License.
 *
 * Authors:
 *              Stephan Aßmus <superstippi@gmx.de>
 *              Zardshard
 */

#ifndef LIST_VIEWS_H
#define LIST_VIEWS_H

#include <ListItem.h>
#include <ListView.h>
#include <Message.h>

#include "MouseWheelFilter.h"
#include "Observer.h"

// portion of the listviews height that triggers autoscrolling
// when the mouse is over it with a dragmessage
#define SCROLL_AREA                     0.1

class BMessageFilter;
class BMessageRunner;
class BScrollView;
class Selectable;
class Selection;

// SimpleItem
class SimpleItem : public BStringItem
{
 public:
                                                        SimpleItem(const char* name);
                virtual                         ~SimpleItem();

                virtual void            DrawItem(BView*, BRect, bool even = false);
                virtual void            DrawBackground(BView*, BRect, bool even);
};


class DragSortableListView : public BListView,
        public MouseWheelTarget, public Observer {
 public:
                                                        DragSortableListView(BRect frame,
                                                                const char* name,
                                                                list_view_type type = B_SINGLE_SELECTION_LIST,
                                                                uint32 resizingMode
                                                                        = B_FOLLOW_LEFT | B_FOLLOW_TOP,
                                                                uint32 flags = B_WILL_DRAW | B_NAVIGABLE
                                                                        | B_FRAME_EVENTS);
        virtual                                 ~DragSortableListView();

        // BListView interface
        virtual void                    AttachedToWindow();
        virtual void                    DetachedFromWindow();
        virtual void                    FrameResized(float width, float height);
//      virtual void                    MakeFocus(bool focused);
        virtual void                    TargetedByScrollView(BScrollView*);
        virtual void                    MessageReceived(BMessage* message);
        virtual void                    KeyDown(const char* bytes, int32 numBytes);
        virtual void                    MouseDown(BPoint where);
        virtual void                    MouseMoved(BPoint where, uint32, const BMessage*);
        virtual void                    MouseUp(BPoint where);
        virtual void                    WindowActivated(bool active);

        // MouseWheelTarget interface
        virtual bool                    MouseWheelChanged(float x, float y);

        // Observer interface (watching Selection)
        virtual void                    ObjectChanged(const Observable* object);

        // DragSortableListView
        virtual void                    SetDragCommand(uint32 command);
        virtual void                    ModifiersChanged();     // called by window
        virtual void                    DoubleClicked(int32 index) {}

        virtual void                    SetItemFocused(int32 index);

        virtual bool                    AcceptDragMessage(const BMessage* message) const;
        virtual bool                    HandleDropMessage(const BMessage* message,
                                                                int32 dropIndex);
        virtual void                    SetDropTargetRect(const BMessage* message,
                                                                BPoint where);

                        bool                    DoesAutoScrolling() const;
                        BScrollView*    ScrollView() const
                                                                { return fScrollView; }

        virtual void                    MoveItems(BList& items, int32 toIndex);
        virtual void                    CopyItems(BList& items, int32 toIndex);
        virtual void                    RemoveItemList(BList& indices);
                        void                    RemoveSelected(); // uses RemoveItemList()
        virtual bool                    DeleteItem(int32 index);

                                                        // selection
                        void                    SetSelection(Selection* selection);

        virtual int32                   IndexOfSelectable(Selectable* selectable) const;
        virtual Selectable*             SelectableFor(BListItem* item) const;

                        void                    SetDeselectAllInGlobalSelection(bool deselect);

                        void                    SelectAll();
                        int32                   CountSelectedItems() const;
        virtual void                    SelectionChanged();

        virtual BListItem*              CloneItem(int32 atIndex) const = 0;
        virtual void                    MakeDragMessage(BMessage* message) const = 0;

 protected:
                        void                    InvalidateDropRect();
                        void                    SetDragMessage(const BMessage* message);

        BRect                                   fDropRect;
        BMessage                                fDragMessageCopy;
        BMessageFilter*                 fMouseWheelFilter;
        BMessageRunner*                 fScrollPulse;
        BPoint                                  fLastMousePos;

 protected:
                        void                    SetDropRect(BRect rect);
                        void                    SetDropIndex(int32 index);

        int32                                   fDropIndex;
        BListItem*                              fLastClickedItem;
        BScrollView*                    fScrollView;
        uint32                                  fDragCommand;
        int32                                   fFocusedIndex;

        Selection*                              fSelection;
        bool                                    fSyncingToSelection;
        bool                                    fModifyingSelection;
};

// SimpleListView
class SimpleListView : public DragSortableListView {
 public:
                                                        SimpleListView(BRect frame,
                                                                BMessage* selectionChanged = NULL);
                                                        SimpleListView(BRect frame, const char* name,
                                                                BMessage* selectionChanged = NULL,
                                                                list_view_type type
                                                                        = B_MULTIPLE_SELECTION_LIST,
                                                                uint32 resizingMode = B_FOLLOW_ALL_SIDES,
                                                                uint32 flags = B_WILL_DRAW | B_NAVIGABLE
                                                                        | B_FRAME_EVENTS | B_FULL_UPDATE_ON_RESIZE);
                                                        ~SimpleListView();

                                                        // BListView
        virtual void                    DetachedFromWindow();
        virtual void                    Draw(BRect updateRect);
        virtual bool                    InitiateDrag(BPoint, int32, bool);
        virtual void                    MessageReceived(BMessage* message);

        virtual BListItem*              CloneItem(int32 atIndex) const;

        /*! Archive the selected items.
                The information should be sufficient for \c InstantiateSelection to
                create a new copy of the objects without relying on the original object.
        */
        virtual status_t                ArchiveSelection(BMessage*, bool = true) const = 0;
        /*! Put a copy of the items archived by \c ArchiveSelection into the list.
                This method should ensure whether the item is truly meant for the list
                view.
        */
        virtual bool                    InstantiateSelection(const BMessage*, int32) = 0;

        virtual void                    MakeDragMessage(BMessage* message) const;
        virtual bool                    HandleDropMessage(const BMessage* message,
                                                                int32 dropIndex);
                        bool                    HandlePaste(const BMessage* archive);

 protected:
                        void                    _MakeEmpty();

 private:

        BMessage*                               fSelectionChangeMessage;
};

#endif // LIST_VIEWS_H