//##################################################################################################
//
//   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 <QString>
#include <QWidget>

#include "cafPdmUiDragDropInterface.h"

class QVBoxLayout;
class QTreeView;
class QItemSelection;
class QMenu;
class QModelIndex;
class QLineEdit;
class QSortFilterProxyModel;
class QAction;

namespace caf
{
class PdmUiItem;
class PdmUiTreeViewEditor;
class PdmObjectHandle;
class PdmUiTreeOrdering;

//==================================================================================================
///
//==================================================================================================

class PdmUiTreeView : public QWidget
{
    Q_OBJECT
public:
    PdmUiTreeView( QWidget* parent = nullptr, Qt::WindowFlags f = Qt::WindowFlags() );
    ~PdmUiTreeView() override;

    void enableDefaultContextMenu( bool enable );
    void enableSelectionManagerUpdating( bool enable ); // TODO: rename
    void enableAppendOfClassNameToUiItemText( bool enable );

    void setUiConfigurationName( QString uiConfigName );
    void setPdmItem( caf::PdmUiItem* object );

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

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

    // QModelIndex access
    // Use this translation only when it is inconvenient to traverse
    // the Pdm model directly.
    PdmUiItem*  uiItemFromModelIndex( const QModelIndex& index ) const;
    QModelIndex findModelIndex( const PdmUiItem* object ) const;
    void        updateSubTree( const QModelIndex& index );

    PdmUiTreeOrdering* uiTreeOrderingFromModelIndex( const QModelIndex& index ) const;

    void setDragDropInterface( PdmUiDragDropInterface* dragDropInterface );

    void storeTreeViewStateToString( QString& treeViewState ) const;

signals:
    void selectionChanged();
    // Convenience signal for use with PdmUiPropertyView
    void selectedObjectChanged( caf::PdmObjectHandle* object ); // Signal/Slot system needs caf:: prefix in some cases

public slots:
    void treeVisibilityChanged( bool visible );

private slots:
    void slotOnSelectionChanged();
    void slotOnClearSearchBox();
    void slotOnSearchTextChanged();

private:
    PdmUiTreeViewEditor* m_treeViewEditor;
    QString              m_uiConfigName;
    QVBoxLayout*         m_layout;
    QLineEdit*           m_searchBox;
    QString              m_treeStateString;
    QAction*             m_clearAction;
};

} // End of namespace caf