/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */

/*

 * This file is part of the LibreOffice project.

 *

 * This Source Code Form is subject to the terms of the Mozilla Public

 * License, v. 2.0. If a copy of the MPL was not distributed with this

 * file, You can obtain one at http://mozilla.org/MPL/2.0/.

 *

 * This file incorporates work covered by the following license notice:

 *

 *   Licensed to the Apache Software Foundation (ASF) under one or more

 *   contributor license agreements. See the NOTICE file distributed

 *   with this work for additional information regarding copyright

 *   ownership. The ASF licenses this file to you under the Apache

 *   License, Version 2.0 (the "License"); you may not use this file

 *   except in compliance with the License. You may obtain a copy of

 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .

 */

#include <memory>

#include <svx/dialmgr.hxx>

#include <svx/fmshell.hxx>

#include <svx/fmmodel.hxx>

#include <svx/fmpage.hxx>

#include <svx/svdpagv.hxx>

#include <svx/svditer.hxx>

#include <helpids.h>

#include <fmexpl.hxx>

#include <fmshimp.hxx>

#include <fmservs.hxx>

#include <fmundo.hxx>

#include <fmpgeimp.hxx>

#include <fmobj.hxx>

#include <fmprop.hxx>

#include <sal/log.hxx>

#include <vcl/svapp.hxx>

#include <sfx2/viewsh.hxx>

#include <sfx2/dispatch.hxx>

#include <sfx2/viewfrm.hxx>

#include <comphelper/processfactory.hxx>

#include <comphelper/property.hxx>

#include <comphelper/types.hxx>

#include <com/sun/star/form/FormComponentType.hpp>

#include <com/sun/star/sdb/CommandType.hpp>

#include <com/sun/star/beans/PropertyAttribute.hpp>

#include <com/sun/star/script/XEventAttacherManager.hpp>

#include <com/sun/star/datatransfer/clipboard/XClipboard.hpp>

#include <com/sun/star/datatransfer/XTransferable.hpp>

#include <com/sun/star/uno/XComponentContext.hpp>

#include <svx/sdrpaintwindow.hxx>

#include <svx/strings.hrc>

#include <comphelper/diagnose_ex.hxx>

#include <svx/svxids.hrc>

#include <bitmaps.hlst>

#include <vcl/commandevent.hxx>

namespace svxform

{

    #define EXPLORER_SYNC_DELAY                 200

        // Time (in ms) until explorer synchronizes the view after select or deselect

    using namespace ::com::sun::star::uno;

    using namespace ::com::sun::star::lang;

    using namespace ::com::sun::star::beans;

    using namespace ::com::sun::star::form;

    using namespace ::com::sun::star::awt;

    using namespace ::com::sun::star::container;

    using namespace ::com::sun::star::script;

    using namespace ::com::sun::star::datatransfer;

    using namespace ::com::sun::star::datatransfer::clipboard;

    using namespace ::com::sun::star::sdb;

    // helper

    typedef ::std::map< Reference< XInterface >, SdrObject* > MapModelToShape;

    static void    collectShapeModelMapping( SdrPage const * _pPage, MapModelToShape& _rMapping )

    {

        OSL_ENSURE( _pPage, "collectShapeModelMapping: invalid arg!" );

        _rMapping.clear();

        SdrObjListIter aIter( _pPage );

        while ( aIter.IsMore() )

        {

            SdrObject* pSdrObject = aIter.Next();

            FmFormObj* pFormObject = FmFormObj::GetFormObject( pSdrObject );

            if ( !pFormObject )

                continue;

            Reference< XInterface > xNormalizedModel( pFormObject->GetUnoControlModel(), UNO_QUERY );

                // note that this is normalized (i.e. queried for XInterface explicitly)

            ::std::pair< MapModelToShape::iterator, bool > aPos =

                  _rMapping.emplace( xNormalizedModel, pSdrObject );

            DBG_ASSERT( aPos.second, "collectShapeModelMapping: model was already existent!" );

                // if this asserts, this would mean we have 2 shapes pointing to the same model

        }

    }

    NavigatorTreeDropTarget::NavigatorTreeDropTarget(NavigatorTree& rTreeView)

        : DropTargetHelper(rTreeView.get_widget().get_drop_target())

        , m_rTreeView(rTreeView)

    {

    }

    sal_Int8 NavigatorTreeDropTarget::AcceptDrop(const AcceptDropEvent& rEvt)

    {

        sal_Int8 nAccept = m_rTreeView.AcceptDrop(rEvt);

        if (nAccept != DND_ACTION_NONE)

        {

            // to enable the autoscroll when we're close to the edges

            weld::TreeView& rWidget = m_rTreeView.get_widget();

            rWidget.get_dest_row_at_pos(rEvt.maPosPixel, nullptr, true);

        }

        return nAccept;

    }

    sal_Int8 NavigatorTreeDropTarget::ExecuteDrop(const ExecuteDropEvent& rEvt)

    {

        return m_rTreeView.ExecuteDrop(rEvt);

    }

    NavigatorTree::NavigatorTree(std::unique_ptr<weld::TreeView> xTreeView)

        :m_xTreeView(std::move(xTreeView))

        ,m_aDropTargetHelper(*this)

        ,m_aSynchronizeTimer("svx NavigatorTree m_aSynchronizeTimer")

        ,nEditEvent(nullptr)

        ,m_sdiState(SDI_DIRTY)

        ,m_nSelectLock(0)

        ,m_nFormsSelected(0)

        ,m_nControlsSelected(0)

        ,m_nHiddenControls(0)

        ,m_bDragDataDirty(false)

        ,m_bPrevSelectionMixed(false)

        ,m_bRootSelected(false)

        ,m_bInitialUpdate(true)

        ,m_bKeyboardCut( false )

        ,m_bEditing( false )

    {

        m_xTreeView->set_help_id(HID_FORM_NAVIGATOR);

        m_xTreeView->set_size_request(200, 200);

        m_xTreeView->set_selection_mode(SelectionMode::Multiple);

        m_pNavModel.reset(new NavigatorTreeModel());

        Clear();

        StartListening( *m_pNavModel );

        m_aSynchronizeTimer.SetInvokeHandler(LINK(this, NavigatorTree, OnSynchronizeTimer));

        m_xTreeView->connect_selection_changed(LINK(this, NavigatorTree, OnEntrySelDesel));

        m_xTreeView->connect_key_press(LINK(this, NavigatorTree, KeyInputHdl));

        m_xTreeView->connect_command(LINK(this, NavigatorTree, PopupMenuHdl));

        m_xTreeView->connect_editing(LINK(this, NavigatorTree, EditingEntryHdl),

                                     LINK(this, NavigatorTree, EditedEntryHdl));

        m_xTreeView->connect_drag_begin(LINK(this, NavigatorTree, DragBeginHdl));

    }

    NavigatorTree::~NavigatorTree()

    {

        if( nEditEvent )

            Application::RemoveUserEvent( nEditEvent );

        if (m_aSynchronizeTimer.IsActive())

            m_aSynchronizeTimer.Stop();

        DBG_ASSERT(GetNavModel() != nullptr, "NavigatorTree::~NavigatorTree : unexpected : no ExplorerModel");

        EndListening( *m_pNavModel );

        Clear();

        m_pNavModel.reset();

    }

    void NavigatorTree::Clear()

    {

        m_pNavModel->Clear();

    }

    void NavigatorTree::UpdateContent( FmFormShell* pFormShell )

    {

        if (m_bInitialUpdate)

        {

            GrabFocus();

            m_bInitialUpdate = false;

        }

        FmFormShell* pOldShell = GetNavModel()->GetFormShell();

        FmFormPage* pOldPage = GetNavModel()->GetFormPage();

        FmFormPage* pNewPage = pFormShell ? pFormShell->GetCurPage() : nullptr;

        if ((pOldShell != pFormShell) || (pOldPage != pNewPage))

        {

            // new shell during editing

            if (IsEditingActive())

            {

                m_xTreeView->end_editing();

                m_bEditing = false;

            }

            m_bDragDataDirty = true;    // as a precaution, although I don't drag

        }

        GetNavModel()->UpdateContent( pFormShell );

        // if there is a form, expand root

        if (m_xRootEntry && !m_xTreeView->get_row_expanded(*m_xRootEntry))

            m_xTreeView->expand_row(*m_xRootEntry);

        // if there is EXACTLY ONE form, expand it too

        if (m_xRootEntry)

        {

            std::unique_ptr<weld::TreeIter> xFirst(m_xTreeView->make_iterator(m_xRootEntry.get()));

            bool bFirst = m_xTreeView->iter_children(*xFirst);

            if (bFirst)

            {

                std::unique_ptr<weld::TreeIter> xSibling(m_xTreeView->make_iterator(xFirst.get()));

                if (!m_xTreeView->iter_next_sibling(*xSibling))

                    m_xTreeView->expand_row(*xFirst);

            }

        }

    }

    bool NavigatorTree::implAllowExchange( sal_Int8 _nAction, bool* _pHasNonHidden )

    {

        bool bCurEntry = m_xTreeView->get_cursor(nullptr);

        if (!bCurEntry)

            return false;

        // Information for AcceptDrop and Execute Drop

        CollectSelectionData(SDI_ALL);

        if (m_arrCurrentSelection.empty())

            // nothing to do

            return false;

        // check whether there are only hidden controls

        // I may add a format to pCtrlExch

        bool bHasNonHidden = std::any_of(m_arrCurrentSelection.begin(), m_arrCurrentSelection.end(),

            [this](const auto& rEntry) {

                FmEntryData* pCurrent = weld::fromId<FmEntryData*>(m_xTreeView->get_id(*rEntry));

                return !IsHiddenControl( pCurrent );

            });

        if ( bHasNonHidden && ( 0 == ( _nAction & DND_ACTION_MOVE ) ) )

            // non-hidden controls need to be moved

            return false;

        if ( _pHasNonHidden )

            *_pHasNonHidden = bHasNonHidden;

        return true;

    }

    bool NavigatorTree::implPrepareExchange( sal_Int8 _nAction )

    {

        bool bHasNonHidden = false;

        if ( !implAllowExchange( _nAction, &bHasNonHidden ) )

            return false;

        m_aControlExchange.prepareDrag();

        m_aControlExchange->setFocusEntry(m_xTreeView->get_cursor(nullptr));

        for (const auto& rpEntry : m_arrCurrentSelection)

            m_aControlExchange->addSelectedEntry(m_xTreeView->make_iterator(rpEntry.get()));

        m_aControlExchange->setFormsRoot( GetNavModel()->GetFormPage()->GetForms() );

        m_aControlExchange->buildPathFormat(m_xTreeView.get(), m_xRootEntry.get());

        if (!bHasNonHidden)

        {

            // create a sequence

            Sequence< Reference< XInterface > > seqIFaces(m_arrCurrentSelection.size());

            Reference< XInterface >* pArray = seqIFaces.getArray();

            for (const auto& rpEntry : m_arrCurrentSelection)

            {

                *pArray = weld::fromId<FmEntryData*>(m_xTreeView->get_id(*rpEntry))->GetElement();

                ++pArray;

            }

            // and the new format

            m_aControlExchange->addHiddenControlsFormat(seqIFaces);

        }

        m_bDragDataDirty = false;

        return true;

    }

    IMPL_LINK(NavigatorTree, DragBeginHdl, bool&, rUnsetDragIcon, bool)

    {

        rUnsetDragIcon = false;

        bool bSuccess = implPrepareExchange(DND_ACTION_COPYMOVE);

        if (bSuccess)

        {

            OControlExchange& rExchange = *m_aControlExchange;

            rtl::Reference<TransferDataContainer> xHelper(&rExchange);

            m_xTreeView->enable_drag_source(xHelper, DND_ACTION_COPYMOVE);

            rExchange.setDragging(true);

        }

        return !bSuccess;

    }

    IMPL_LINK(NavigatorTree, PopupMenuHdl, const CommandEvent&, rEvt, bool)

    {

        bool bHandled = false;

        switch( rEvt.GetCommand() )

        {

            case CommandEventId::ContextMenu:

            {

                // Position of click

                ::Point ptWhere;

                if (rEvt.IsMouseEvent())

                {

                    ptWhere = rEvt.GetMousePosPixel();

                    std::unique_ptr<weld::TreeIter> xClickedOn(m_xTreeView->make_iterator());

                    if (!m_xTreeView->get_dest_row_at_pos(ptWhere, xClickedOn.get(), false))

                        break;

                    if (!m_xTreeView->is_selected(*xClickedOn))

                    {

                        m_xTreeView->unselect_all();

                        m_xTreeView->select(*xClickedOn);

                        m_xTreeView->set_cursor(*xClickedOn);

                    }

                }

                else

                {

                    if (m_arrCurrentSelection.empty()) // only happens with context menu via keyboard

                        break;

                    std::unique_ptr<weld::TreeIter> xCurrent(m_xTreeView->make_iterator());

                    if (!m_xTreeView->get_cursor(xCurrent.get()))

                        break;

                    ptWhere = m_xTreeView->get_row_area(*xCurrent).Center();

                }

                // update my selection data

                CollectSelectionData(SDI_ALL);

                // if there is at least one no-root-entry and the root selected, I deselect root

                if ( (m_arrCurrentSelection.size() > 1) && m_bRootSelected )

                {

                    const std::unique_ptr<weld::TreeIter>& rIter = *m_arrCurrentSelection.begin();

                    m_xTreeView->set_cursor(*rIter);

                    m_xTreeView->unselect(*m_xRootEntry);

                }

                bool bSingleSelection = (m_arrCurrentSelection.size() == 1);

                DBG_ASSERT( (!m_arrCurrentSelection.empty()) || m_bRootSelected, "no entries selected" );

                    // shouldn't happen, because I would have selected one during call to IsSelected,

                    // if there was none before

                // create menu

                FmFormShell* pFormShell = GetNavModel()->GetFormShell();

                FmFormModel* pFormModel = pFormShell ? pFormShell->GetFormModel() : nullptr;

                if( pFormShell && pFormModel )

                {

                    std::unique_ptr<weld::Builder> xBuilder(Application::CreateBuilder(m_xTreeView.get(), u"svx/ui/formnavimenu.ui"_ustr));

                    std::unique_ptr<weld::Menu> xContextMenu(xBuilder->weld_menu(u"menu"_ustr));

                    std::unique_ptr<weld::Menu> xSubMenuNew(xBuilder->weld_menu(u"submenu"_ustr));

                    // menu 'New' only exists, if only the root or only one form is selected

                    bool bShowNew = bSingleSelection && (m_nFormsSelected || m_bRootSelected);

                    if (!bShowNew)

                        xContextMenu->remove(u"new"_ustr);

                    // 'New'\'Form' under the same terms

                    bool bShowForm = bSingleSelection && (m_nFormsSelected || m_bRootSelected);

                    if (bShowForm)

                        xSubMenuNew->append(u"form"_ustr, SvxResId(RID_STR_FORM), RID_SVXBMP_FORM);

                    // 'New'\'hidden...', if exactly one form is selected

                    bool bShowHidden = bSingleSelection && m_nFormsSelected;

                    if (bShowHidden)

                        xSubMenuNew->append(u"hidden"_ustr, SvxResId(RID_STR_HIDDEN), RID_SVXBMP_HIDDEN);

                    // 'Delete': everything which is not root can be removed

                    if (m_bRootSelected)

                        xContextMenu->remove(u"delete"_ustr);

                    // 'Cut', 'Copy' and 'Paste'

                    bool bShowCut = !m_bRootSelected && implAllowExchange(DND_ACTION_MOVE);

                    if (!bShowCut)

                        xContextMenu->remove(u"cut"_ustr);

                    bool bShowCopy = !m_bRootSelected && implAllowExchange(DND_ACTION_COPY);

                    if (!bShowCopy)

                        xContextMenu->remove(u"copy"_ustr);

                    if (!implAcceptPaste())

                        xContextMenu->remove(u"paste"_ustr);

                    // TabDialog, if exactly one form

                    bool bShowTabOrder = bSingleSelection && m_nFormsSelected;

                    if (!bShowTabOrder)

                        xContextMenu->remove(u"taborder"_ustr);

                    bool bShowProps = true;

                    // in XML forms, we don't allow for the properties of a form

                    // #i36484#

                    if (pFormShell->GetImpl()->isEnhancedForm_Lock() && !m_nControlsSelected)

                        bShowProps = false;

                    // if the property browser is already open, we don't allow for the properties, too

                    if (pFormShell->GetImpl()->IsPropBrwOpen_Lock())

                        bShowProps = false;

                    // and finally, if there's a mixed selection of forms and controls, disable the entry, too

                    if (bShowProps && !pFormShell->GetImpl()->IsPropBrwOpen_Lock())

                        bShowProps =

                            (m_nControlsSelected && !m_nFormsSelected) || (!m_nControlsSelected && m_nFormsSelected);

                    if (!bShowProps)

                        xContextMenu->remove(u"props"_ustr);

                    // rename, if one element and no root

                    bool bShowRename = bSingleSelection && !m_bRootSelected;

                    if (!bShowRename)

                        xContextMenu->remove(u"rename"_ustr);

                    if (!m_bRootSelected)

                    {

                        // Readonly-entry is only for root

                        xContextMenu->remove(u"designmode"_ustr);

                        // the same for automatic control focus

                        xContextMenu->remove(u"controlfocus"_ustr);

                    }

                    std::unique_ptr<weld::Menu> xConversionMenu(xBuilder->weld_menu(u"changemenu"_ustr));

                    // ConvertTo-Slots are enabled, if one control is selected

                    // the corresponding slot is disabled

                    if (!m_bRootSelected && !m_nFormsSelected && (m_nControlsSelected == 1))

                    {

                        FmXFormShell::GetConversionMenu_Lock(*xConversionMenu);

#if OSL_DEBUG_LEVEL > 0

                        const std::unique_ptr<weld::TreeIter>& rIter = *m_arrCurrentSelection.begin();

                        FmControlData* pCurrent = weld::fromId<FmControlData*>(m_xTreeView->get_id(*rIter));

                        OSL_ENSURE( pFormShell->GetImpl()->isSolelySelected_Lock( pCurrent->GetFormComponent() ),

                            "NavigatorTree::Command: inconsistency between the navigator selection, and the selection as the shell knows it!" );

#endif

                        pFormShell->GetImpl()->checkControlConversionSlotsForCurrentSelection_Lock(*xConversionMenu);

                    }

                    else

                        xContextMenu->remove(u"change"_ustr);

                    if (m_bRootSelected)

                    {

                        // set OpenReadOnly

                        xContextMenu->set_active(u"designmode"_ustr, pFormModel->GetOpenInDesignMode());

                        xContextMenu->set_active(u"controlfocus"_ustr, pFormModel->GetAutoControlFocus());

                    }

                    OUString sIdent = xContextMenu->popup_at_rect(m_xTreeView.get(), tools::Rectangle(ptWhere, ::Size(1, 1)));

                    if (sIdent == "form")

                    {

                        OUString aStr(SvxResId(RID_STR_FORM));

                        OUString aUndoStr = SvxResId(RID_STR_UNDO_CONTAINER_INSERT).replaceAll("#", aStr);

                        pFormModel->BegUndo(aUndoStr);

                        // slot was only available, if there is only one selected entry,

                        // which is a root or a form

                        const std::unique_ptr<weld::TreeIter>& rIter = *m_arrCurrentSelection.begin();

                        NewForm(*rIter);

                        pFormModel->EndUndo();

                    }

                    else if (sIdent == "hidden")

                    {

                        OUString aStr(SvxResId(RID_STR_CONTROL));

                        OUString aUndoStr = SvxResId(RID_STR_UNDO_CONTAINER_INSERT).replaceAll("#", aStr);

                        pFormModel->BegUndo(aUndoStr);

                        // slot was valid for (exactly) one selected form

                        const std::unique_ptr<weld::TreeIter>& rIter = *m_arrCurrentSelection.begin();

                        NewControl(FM_COMPONENT_HIDDEN, *rIter, true);

                        pFormModel->EndUndo();

                    }

                    else if (sIdent == "cut")

                        doCut();

                    else if (sIdent == "copy")

                        doCopy();

                    else if (sIdent == "paste")

                        doPaste();

                    else if (sIdent == "delete")

                        DeleteSelection();

                    else if (sIdent == "taborder")

                    {

                        // this slot was effective for exactly one selected form

                        const std::unique_ptr<weld::TreeIter>& rSelectedForm = *m_arrCurrentSelection.begin();

                        DBG_ASSERT( IsFormEntry(*rSelectedForm), "NavigatorTree::Command: This entry must be a FormEntry." );

                        FmFormData* pFormData = weld::fromId<FmFormData*>(m_xTreeView->get_id(*rSelectedForm));

                        const Reference< XForm >&  xForm(  pFormData->GetFormIface());

                        Reference< XTabControllerModel >  xTabController(xForm, UNO_QUERY);

                        if( !xTabController.is() )

                            break;

                        GetNavModel()->GetFormShell()->GetImpl()->ExecuteTabOrderDialog_Lock(xTabController);

                    }

                    else if (sIdent == "props")

                        ShowSelectionProperties(true);

                    else if (sIdent == "rename")

                    {

                        // only allowed for one no-root-entry

                        const std::unique_ptr<weld::TreeIter>& rIter = *m_arrCurrentSelection.begin();

                        m_xTreeView->start_editing(*rIter);

                        m_bEditing = true;

                    }

                    else if (sIdent == "designmode")

                    {

                        pFormModel->SetOpenInDesignMode( !pFormModel->GetOpenInDesignMode() );

                        pFormShell->GetViewShell()->GetViewFrame().GetBindings().Invalidate(SID_FM_OPEN_READONLY);

                    }

                    else if (sIdent == "controlfocus")

                    {

                        pFormModel->SetAutoControlFocus( !pFormModel->GetAutoControlFocus() );

                        pFormShell->GetViewShell()->GetViewFrame().GetBindings().Invalidate(SID_FM_AUTOCONTROLFOCUS);

                    }

                    else if (FmXFormShell::isControlConversionSlot(sIdent))

                    {

                        const std::unique_ptr<weld::TreeIter>& rIter = *m_arrCurrentSelection.begin();

                        FmControlData* pCurrent = weld::fromId<FmControlData*>(m_xTreeView->get_id(*rIter));

                        if (pFormShell->GetImpl()->executeControlConversionSlot_Lock(pCurrent->GetFormComponent(), sIdent))

                            ShowSelectionProperties();

                    }

                }

                bHandled = true;

            }

            break;

            default: break;

        }

        return bHandled;

    }

    std::unique_ptr<weld::TreeIter> NavigatorTree::FindEntry(FmEntryData* pEntryData)

    {

        std::unique_ptr<weld::TreeIter> xRet;

        if(!pEntryData)

            return xRet;

        m_xTreeView->all_foreach([this, pEntryData, &xRet](weld::TreeIter& rEntry){

            FmEntryData* pCurEntryData = weld::fromId<FmEntryData*>(m_xTreeView->get_id(rEntry));

            if (pCurEntryData && pCurEntryData->IsEqualWithoutChildren(pEntryData))

            {

                xRet = m_xTreeView->make_iterator(&rEntry);

                return true;

            }

            return false;

        });

        return xRet;

    }

    void NavigatorTree::Notify( SfxBroadcaster& /*rBC*/, const SfxHint& rHint )

    {

        if( rHint.GetId() == SfxHintId::FmNavRemoved )

        {

            auto pRemovedHint = static_cast<const FmNavRemovedHint*>(&rHint);

            FmEntryData* pEntryData = pRemovedHint->GetEntryData();

            Remove( pEntryData );

        }

        else if( rHint.GetId() == SfxHintId::FmNavInserted )

        {

            auto pInsertedHint = static_cast<const FmNavInsertedHint*>(&rHint);

            FmEntryData* pEntryData = pInsertedHint->GetEntryData();

            sal_uInt32 nRelPos = pInsertedHint->GetRelPos();

            Insert( pEntryData, nRelPos );

        }

        else if( rHint.GetId() == SfxHintId::FmNavModelReplaced )

        {

            auto pReplacedHint = static_cast<const FmNavModelReplacedHint*>(&rHint);

            FmEntryData* pData = pReplacedHint->GetEntryData();

            std::unique_ptr<weld::TreeIter> xEntry = FindEntry(pData);

            if (xEntry)

            {

                // reset image

                m_xTreeView->set_image(*xEntry, pData->GetNormalImage());

            }

        }

        else if( rHint.GetId() == SfxHintId::FmNavNameChanged )

        {

            auto pNameChangedHint = static_cast<const FmNavNameChangedHint*>(&rHint);

            std::unique_ptr<weld::TreeIter> xEntry = FindEntry(pNameChangedHint->GetEntryData());

            if (xEntry)

                m_xTreeView->set_text(*xEntry, pNameChangedHint->GetNewName());

        }

        else if( rHint.GetId() == SfxHintId::FmNavCleared )

        {

            m_aCutEntries.clear();

            if (m_aControlExchange.isDataExchangeActive())

                m_aControlExchange.clear();

            m_xTreeView->clear();

            // default-entry "Forms"

            OUString sText(SvxResId(RID_STR_FORMS));

            m_xRootEntry = m_xTreeView->make_iterator();

            m_xTreeView->insert(nullptr, -1, &sText, nullptr, nullptr, nullptr,

                                false, m_xRootEntry.get());

            m_xTreeView->set_image(*m_xRootEntry, RID_SVXBMP_FORMS);

            m_xTreeView->set_sensitive(*m_xRootEntry, true);

        }

        else if (rHint.GetId() == SfxHintId::FmNavRequestSelect)

        {

            auto pSelectHint = static_cast<const FmNavRequestSelectHint*>(&rHint);

            FmEntryDataArray& arredToSelect = const_cast<FmNavRequestSelectHint*>(pSelectHint)->GetItems();

            SynchronizeSelection(arredToSelect);

            if (pSelectHint->IsMixedSelection())

                // in this case I deselect all, although the view had a mixed selection

                // during next selection, I must adapt the navigator to the view

                m_bPrevSelectionMixed = true;

        }

    }

    std::unique_ptr<weld::TreeIter> NavigatorTree::Insert(const FmEntryData* pEntryData, int nRelPos)

    {

        // insert current entry

        std::unique_ptr<weld::TreeIter> xParentEntry = FindEntry( pEntryData->GetParent() );

        std::unique_ptr<weld::TreeIter> xNewEntry(m_xTreeView->make_iterator());

        OUString sId(weld::toId(pEntryData));

        if(!xParentEntry)

        {

            m_xTreeView->insert(m_xRootEntry.get(), nRelPos, &pEntryData->GetText(), &sId,

                                nullptr, nullptr, false, xNewEntry.get());

        }

        else

        {

            m_xTreeView->insert(xParentEntry.get(), nRelPos, &pEntryData->GetText(), &sId,

                                nullptr, nullptr, false, xNewEntry.get());

        }

        m_xTreeView->set_image(*xNewEntry, pEntryData->GetNormalImage());

        m_xTreeView->set_sensitive(*xNewEntry, true);

        // If root-entry, expand root

        if (!xParentEntry)

            m_xTreeView->expand_row(*m_xRootEntry);

        // insert children

        FmEntryDataList* pChildList = pEntryData->GetChildList();

        size_t nChildCount = pChildList->size();

        for( size_t i = 0; i < nChildCount; i++ )

        {

            FmEntryData* pChildData = pChildList->at( i );

            Insert(pChildData, -1);

        }

        return xNewEntry;

    }

    void NavigatorTree::Remove( FmEntryData* pEntryData )

    {

        if( !pEntryData )

            return;

        // entry for the data

        std::unique_ptr<weld::TreeIter> xEntry = FindEntry(pEntryData);

        if (!xEntry)

            return;

        // delete entry from TreeListBox

        // I'm not allowed, to treat the selection, which I trigger:

        // select changes the MarkList of the view, if somebody else does this at the same time

        // and removes a selection, we get a problem

        // e.g. Group controls with open navigator

        LockSelectionHandling();

        // little problem: I remember the selected data, but if somebody deletes one of these entries,

        // I get inconsistent... this would be bad

        m_xTreeView->unselect(*xEntry);

        // selection can be modified during deletion,

        // but because I disabled SelectionHandling, I have to do it later

        auto nExpectedSelectionCount = m_xTreeView->count_selected_rows();

        ModelHasRemoved(xEntry.get());

        m_xTreeView->remove(*xEntry);

        if (nExpectedSelectionCount != m_xTreeView->count_selected_rows())

            SynchronizeSelection();

        // by default I treat the selection of course

        UnlockSelectionHandling();

    }

    bool NavigatorTree::IsFormEntry(const weld::TreeIter& rEntry)

    {

        FmEntryData* pEntryData = weld::fromId<FmEntryData*>(m_xTreeView->get_id(rEntry));

        return !pEntryData || dynamic_cast<const FmFormData*>( pEntryData) !=  nullptr;

    }

    bool NavigatorTree::IsFormComponentEntry(const weld::TreeIter& rEntry)

    {

        FmEntryData* pEntryData = weld::fromId<FmEntryData*>(m_xTreeView->get_id(rEntry));

        return dynamic_cast<const FmControlData*>( pEntryData) != nullptr;

    }

    bool NavigatorTree::implAcceptPaste( )

    {

        auto nSelectedEntries = m_xTreeView->count_selected_rows();

        if (nSelectedEntries != 1)

            // no selected entry, or at least two selected entries

            return false;

        // get the clipboard

        TransferableDataHelper aClipboardContent(TransferableDataHelper::CreateFromClipboard(m_xTreeView->get_clipboard()));

        sal_Int8 nAction = m_aControlExchange.isClipboardOwner() && doingKeyboardCut( ) ? DND_ACTION_MOVE : DND_ACTION_COPY;

        std::unique_ptr<weld::TreeIter> xSelected = m_xTreeView->get_selected();

        return nAction == implAcceptDataTransfer(aClipboardContent.GetDataFlavorExVector(), nAction, xSelected.get(), false);

    }

    sal_Int8 NavigatorTree::implAcceptDataTransfer( const DataFlavorExVector& _rFlavors, sal_Int8 _nAction, const weld::TreeIter* _pTargetEntry, bool _bDnD )

    {

        // no target -> no drop

        if (!_pTargetEntry)

            return DND_ACTION_NONE;

        // format check

        bool bHasDefControlFormat = OControlExchange::hasFieldExchangeFormat( _rFlavors );

        bool bHasControlPathFormat = OControlExchange::hasControlPathFormat( _rFlavors );

        bool bHasHiddenControlsFormat = OControlExchange::hasHiddenControlModelsFormat( _rFlavors );

        if (!bHasDefControlFormat && !bHasControlPathFormat && !bHasHiddenControlsFormat)

            return DND_ACTION_NONE;

        bool bSelfSource = _bDnD ? m_aControlExchange.isDragSource() : m_aControlExchange.isClipboardOwner();

        if ( bHasHiddenControlsFormat )

        {   // bHasHiddenControlsFormat means that only hidden controls are part of the data

            // hidden controls can be copied to a form only

            if (m_xTreeView->iter_compare(*_pTargetEntry, *m_xRootEntry) == 0 || !IsFormEntry(*_pTargetEntry))

                return DND_ACTION_NONE;

            return bSelfSource ? ( DND_ACTION_COPYMOVE & _nAction ) : DND_ACTION_COPY;

        }

        if  ( !bSelfSource )

        {

            // DnD or CnP crossing navigator boundaries

            // The main problem here is that the current API does not allow us to sneak into the content which

            // is to be inserted. So we have to allow it for the moment, but maybe reject later on (in the real drop).

            // TODO: this smart behaviour later on ... at the moment, we disallow data transfer crossing navigator

            // boundaries.

            return DND_ACTION_NONE;

        }

        DBG_ASSERT( _bDnD ? m_aControlExchange.isDragSource() : m_aControlExchange.isClipboardOwner(),

            "NavigatorTree::implAcceptDataTransfer: here only with source=dest!" );

            // somebody changed the logic of this method ...

        // from here on, I can work with m_aControlExchange instead of _rData!

        bool bForeignCollection = m_aControlExchange->getFormsRoot().get() != GetNavModel()->GetFormPage()->GetForms().get();

        if ( bForeignCollection )

        {

            // crossing shell/page boundaries, we can exchange hidden controls only

            // But if we survived the checks above, we do not have hidden controls.

            // -> no data transfer

            DBG_ASSERT( !bHasHiddenControlsFormat, "NavigatorTree::implAcceptDataTransfer: still hidden controls format!" );

                // somebody changed the logic of this method ...

            return DND_ACTION_COPY;

        }

        if (DND_ACTION_MOVE != _nAction) // 'normal' controls within a shell are moved only (never copied)

            return DND_ACTION_NONE;

        if ( m_bDragDataDirty || !bHasDefControlFormat )

        {

            if (!bHasControlPathFormat)

                // I am in the shell/page, which has the controls, but I have no format,

                // which survived the shell change (SVX_FM_CONTROLS_AS_PATH)

                return DND_ACTION_NONE;

            // I must recreate the list of the ExchangeObjects, because the shell was changed during dragging

            // (there are SvLBoxEntries in it, and we lost them during change)

            m_aControlExchange->buildListFromPath(m_xTreeView.get(), m_xRootEntry.get());

            m_bDragDataDirty = false;

        }

        // List of dropped entries from DragServer

        const ListBoxEntrySet& rDropped = m_aControlExchange->selected();

        DBG_ASSERT(!rDropped.empty(), "NavigatorTree::implAcceptDataTransfer: no entries !");

        bool bDropTargetIsComponent = IsFormComponentEntry( *_pTargetEntry );

        // conditions to disallow the drop

        // 0) the root entry is part of the list (can't DnD the root!)

        // 1) one of the dragged entries is to be dropped onto its own parent

        // 2) -               "       - is to be dropped onto itself

        // 3) -               "       - is a Form and to be dropped onto one of its descendants

        // 4) one of the entries is a control and to be dropped onto the root

        // 5) a control or form will be dropped onto a control which is _not_ a sibling (dropping onto a sibling

        //      means moving the control)

        // collect the ancestors of the drop target (speeds up 3)

        SvLBoxEntrySortedArray arrDropAncestors;

        std::unique_ptr<weld::TreeIter> xLoop(m_xTreeView->make_iterator(_pTargetEntry));

        do

        {

            arrDropAncestors.emplace(m_xTreeView->make_iterator(xLoop.get()));

        }

        while (m_xTreeView->iter_parent(*xLoop));

        for (const auto& rCurrent : rDropped)

        {

            // test for 0)

            if (m_xTreeView->iter_compare(*rCurrent, *m_xRootEntry) == 0)

                return DND_ACTION_NONE;

            std::unique_ptr<weld::TreeIter> xCurrentParent(m_xTreeView->make_iterator(rCurrent.get()));

            m_xTreeView->iter_parent(*xCurrentParent);

            // test for 1)

            if (m_xTreeView->iter_compare(*_pTargetEntry, *xCurrentParent) == 0)

                return DND_ACTION_NONE;

            // test for 2)

            if (m_xTreeView->iter_compare(*rCurrent, *_pTargetEntry) == 0)

                return DND_ACTION_NONE;

            // test for 5)

            if (bDropTargetIsComponent)

                return DND_ACTION_NONE;

            // test for 3)

            if (IsFormEntry(*rCurrent))

            {

                auto aIter = std::find_if(arrDropAncestors.begin(), arrDropAncestors.end(),

                                          [this, &rCurrent](const auto& rElem) {

                                            return m_xTreeView->iter_compare(*rElem, *rCurrent) == 0;

                                          });

                if ( aIter != arrDropAncestors.end() )

                    return DND_ACTION_NONE;

            }

            else if (IsFormComponentEntry(*rCurrent))

            {

                // test for 4)

                if (m_xTreeView->iter_compare(*_pTargetEntry, *m_xRootEntry) == 0)

                    return DND_ACTION_NONE;

            }

        }

        return DND_ACTION_MOVE;

    }

    sal_Int8 NavigatorTree::AcceptDrop( const AcceptDropEvent& rEvt )

    {

        ::Point aDropPos = rEvt.maPosPixel;

        std::unique_ptr<weld::TreeIter> xDropTarget(m_xTreeView->make_iterator());

        // get_dest_row_at_pos with false cause we must drop exactly "on" a form to paste a control into it

        if (!m_xTreeView->get_dest_row_at_pos(aDropPos, xDropTarget.get(), false))

            xDropTarget.reset();

        return implAcceptDataTransfer(m_aDropTargetHelper.GetDataFlavorExVector(), rEvt.mnAction, xDropTarget.get(), true);

    }

    sal_Int8 NavigatorTree::implExecuteDataTransfer( const OControlTransferData& _rData, sal_Int8 _nAction, const ::Point& _rDropPos, bool _bDnD )

    {

        std::unique_ptr<weld::TreeIter> xDrop(m_xTreeView->make_iterator());

        // get_dest_row_at_pos with false cause we must drop exactly "on" a form to paste a control into it

        if (!m_xTreeView->get_dest_row_at_pos(_rDropPos, xDrop.get(), false))

            xDrop.reset();

        return implExecuteDataTransfer( _rData, _nAction, xDrop.get(), _bDnD );

    }

    sal_Int8 NavigatorTree::implExecuteDataTransfer( const OControlTransferData& _rData, sal_Int8 _nAction, const weld::TreeIter* _pTargetEntry, bool _bDnD )

    {

        const DataFlavorExVector& rDataFlavors = _rData.GetDataFlavorExVector();

        if ( DND_ACTION_NONE == implAcceptDataTransfer( rDataFlavors, _nAction, _pTargetEntry, _bDnD ) )

            // under some platforms, it may happen that ExecuteDrop is called though AcceptDrop returned DND_ACTION_NONE

            return DND_ACTION_NONE;

        if (!_pTargetEntry)

            // no target -> no drop

            return DND_ACTION_NONE;

        // format checks

#ifdef DBG_UTIL

        bool bHasHiddenControlsFormat = OControlExchange::hasHiddenControlModelsFormat( rDataFlavors );