//##################################################################################################
//
//   Custom Visualization Core library
//   Copyright (C) 2011-2013 Ceetron AS
//
//   This library may be used under the terms of either the GNU General Public License or
//   the GNU Lesser General Public License as follows:
//
//   GNU General Public License Usage
//   This library is free software: you can redistribute it and/or modify
//   it under the terms of the GNU General Public License as published by
//   the Free Software Foundation, either version 3 of the License, or
//   (at your option) any later version.
//
//   This library is distributed in the hope that it will be useful, but WITHOUT ANY
//   WARRANTY; without even the implied warranty of MERCHANTABILITY or
//   FITNESS FOR A PARTICULAR PURPOSE.
//
//   See the GNU General Public License at <<http://www.gnu.org/licenses/gpl.html>>
//   for more details.
//
//   GNU Lesser General Public License Usage
//   This library is free software; you can redistribute it and/or modify
//   it under the terms of the GNU Lesser General Public License as published by
//   the Free Software Foundation; either version 2.1 of the License, or
//   (at your option) any later version.
//
//   This library is distributed in the hope that it will be useful, but WITHOUT ANY
//   WARRANTY; without even the implied warranty of MERCHANTABILITY or
//   FITNESS FOR A PARTICULAR PURPOSE.
//
//   See the GNU Lesser General Public License at <<http://www.gnu.org/licenses/lgpl-2.1.html>>
//   for more details.
//
//##################################################################################################


#pragma once

#include "cafPdmUiTreeEditorHandle.h"
#include "cafPdmUiFieldEditorHandle.h"
#include "cafPdmUiTreeViewModel.h"

#include <QAbstractItemModel>
#include <QPointer>
#include <QWidget>
#include <QItemSelectionModel>
#include <QTreeView>


class MySortFilterProxyModel;

class QGridLayout;
class QMenu;
class QTreeView;
class QVBoxLayout;

namespace caf 
{

class PdmChildArrayFieldHandle;
class PdmUiDragDropInterface;
class PdmUiItem;
class PdmUiTreeViewModel;
class PdmUiTreeViewWidget;

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
class PdmUiTreeViewEditorAttribute : public PdmUiEditorAttribute
{
public:
    PdmUiTreeViewEditorAttribute()
    {
    }

public:
    QStringList columnHeaders;
};

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
class PdmUiTreeViewEditor : public PdmUiTreeEditorHandle
{
    Q_OBJECT
public:
    PdmUiTreeViewEditor();
    ~PdmUiTreeViewEditor();

    void                enableDefaultContextMenu(bool enable);
    void                enableSelectionManagerUpdating(bool enable);
    
    void                enableAppendOfClassNameToUiItemText(bool enable);
    bool                isAppendOfClassNameToUiItemTextEnabled();

    QTreeView*          treeView();
    bool                isTreeItemEditWidgetActive() const;

    void                selectAsCurrentItem(PdmUiItem* uiItem);
    void                selectedUiItems(std::vector<PdmUiItem*>& objects);
    void                setExpanded(const PdmUiItem* uiItem, bool doExpand) const;

    PdmUiItem*          uiItemFromModelIndex(const QModelIndex& index) const;
    QModelIndex         findModelIndex(const PdmUiItem* object) const;

    QWidget*            createWidget(QWidget* parent);

    void                setDragDropInterface(PdmUiDragDropInterface* dragDropInterface);

signals:
    void                selectionChanged();

protected:
    virtual void        configureAndUpdateUi(const QString& uiConfigName);

    virtual void        updateMySubTree(PdmUiItem* uiItem);

    void                updateContextMenuSignals();

private slots:
    void                customMenuRequested(QPoint pos);
    void                slotOnSelectionChanged(const QItemSelection & selected, const QItemSelection & deselected);

private:
    void                uiItemsFromModelIndexList(const QModelIndexList& modelIndexList, std::vector<PdmUiItem*>& objects);
    
    PdmChildArrayFieldHandle* currentChildArrayFieldHandle();

    void                updateSelectionManager();

    virtual bool        eventFilter(QObject *obj, QEvent *event);

private:
    QPointer<QWidget>               m_mainWidget;
    QVBoxLayout*                    m_layout;

    PdmUiTreeViewWidget*            m_treeView;
    PdmUiTreeViewModel*             m_treeViewModel;

    PdmUiTreeViewEditorAttribute    m_editorAttributes;

    bool                            m_useDefaultContextMenu;
    bool                            m_updateSelectionManager;
    bool                            m_appendClassNameToUiItemText;
};



} // end namespace caf