sw/source/uibase/inc/conttree.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_SW_SOURCE_UIBASE_INC_CONTTREE_HXX
  20 #define INCLUDED_SW_SOURCE_UIBASE_INC_CONTTREE_HXX
  21
  22 #include <svl/lstner.hxx>
  23 #include <ndarr.hxx>
  24 #include "swcont.hxx"
  25
  26 #include <map>
  27 #include <memory>
  28
  29 #include <o3tl/enumarray.hxx>
  30 #include <o3tl/typed_flags_set.hxx>
  31
  32 class SwWrtShell;
  33 class SwContentType;
  34 class SwNavigationPI;
  35 class SwNavigationConfig;
  36 class Menu;
  37 class ToolBox;
  38 class SwGlblDocContents;
  39 class SwGlblDocContent;
  40 class SfxObjectShell;
  41 class SdrObject;
  42
  43 enum class EditEntryMode
  44 {
  45     EDIT          = 0,
  46     UPD_IDX       = 1,
  47     RMV_IDX       = 2,
  48     UNPROTECT_TABLE    = 3,
  49     DELETE        = 4,
  50     RENAME        = 5,
  51 };
  52
  53 // Flags for PopupMenu-enable/disable
  54 enum class MenuEnableFlags {
  55     NONE        = 0x0000,
  56     InsertIdx   = 0x0001,
  57     InsertFile  = 0x0002,
  58     InsertText  = 0x0004,
  59     Edit        = 0x0008,
  60     Delete      = 0x0010,
  61     Update      = 0x0020,
  62     UpdateSel   = 0x0040,
  63     EditLink    = 0x0080
  64 };
  65 namespace o3tl {
  66     template<> struct typed_flags<MenuEnableFlags> : is_typed_flags<MenuEnableFlags, 0x00ff> {};
  67 }
  68
  69 class SwContentTree;
  70
  71 class SwContentTreeDropTarget : public DropTargetHelper
  72 {
  73 private:
  74     SwContentTree& m_rTreeView;
  75
  76     virtual sal_Int8 AcceptDrop( const AcceptDropEvent& rEvt ) override;
  77     virtual sal_Int8 ExecuteDrop( const ExecuteDropEvent& rEvt ) override;
  78
  79 public:
  80     SwContentTreeDropTarget(SwContentTree& rTreeView);
  81 };
  82
  83 /** TreeListBox for content indicator */
  84 class SwContentTree final : public SfxListener
  85 {
  86     std::unique_ptr<weld::TreeView> m_xTreeView;
  87     std::unique_ptr<weld::TreeIter> m_xScratchIter;
  88     SwContentTreeDropTarget m_aDropTargetHelper;
  89     VclPtr<SwNavigationPI> m_xDialog;
  90     OUString            m_sSpace;
  91     AutoTimer           m_aUpdTimer;
  92
  93     o3tl::enumarray<ContentTypeId,std::unique_ptr<SwContentType>>  m_aActiveContentArr;
  94     o3tl::enumarray<ContentTypeId,std::unique_ptr<SwContentType>>  m_aHiddenContentArr;
  95     OUString            m_aContextStrings[CONTEXT_COUNT + 1];
  96     OUString            m_sInvisible;
  97
  98     SwWrtShell*         m_pHiddenShell;   // dropped Doc
  99     SwWrtShell*         m_pActiveShell;   // the active or a const. open view
 100     SwNavigationConfig* m_pConfig;
 101
 102     std::map< void*, bool > mOutLineNodeMap;
 103
 104     sal_Int32           m_nActiveBlock;
 105     sal_Int32           m_nHiddenBlock;
 106     size_t              m_nEntryCount;
 107     ContentTypeId       m_nRootType;
 108     ContentTypeId       m_nLastSelType;
 109     sal_uInt8           m_nOutlineLevel;
 110
 111     sal_uInt32          m_nOutlineTracking = 1;
 112
 113     enum class State { ACTIVE, CONSTANT, HIDDEN } m_eState;
 114
 115     bool                m_bIsRoot             :1;
 116     bool                m_bIsIdleClear        :1;
 117     bool                m_bIsLastReadOnly     :1;
 118     bool                m_bIsOutlineMoveable  :1;
 119     bool                m_bViewHasChanged     :1;
 120
 121     // outline root mode drag & drop
 122     std::vector<std::unique_ptr<weld::TreeIter>> m_aDndOutlinesSelected;
 123
 124     bool m_bIgnoreViewChange = false;
 125
 126     /**
 127      * Before any data will be deleted, the last active entry has to be found.
 128      * After this the UserData will be deleted
 129      */
 130     void                FindActiveTypeAndRemoveUserData();
 131
 132     void insert(const weld::TreeIter* pParent, const OUString& rStr, const OUString& rId,
 133                 bool bChildrenOnDemand, weld::TreeIter* pRet);
 134
 135     void remove(const weld::TreeIter& rIter);
 136
 137     SwNavigationPI* GetParentWindow();
 138
 139     bool        FillTransferData( TransferDataContainer& rTransfer,
 140                                             sal_Int8& rDragMode );
 141
 142     /** Check if the displayed content is valid. */
 143     bool            HasContentChanged();
 144
 145     size_t          GetAbsPos(const weld::TreeIter& rIter);
 146
 147     void            EditEntry(const weld::TreeIter& rEntry, EditEntryMode nMode);
 148
 149     void            GotoContent(const SwContent* pCnt);
 150
 151     void            ExecuteContextMenuAction(const OString& rSelectedPopupEntry);
 152
 153     void DeleteOutlineSelections();
 154
 155     size_t GetEntryCount() const;
 156
 157     size_t GetChildCount(const weld::TreeIter& rParent) const;
 158
 159     std::unique_ptr<weld::TreeIter> GetEntryAtAbsPos(size_t nAbsPos) const;
 160
 161     void Expand(const weld::TreeIter& rParent, std::vector<std::unique_ptr<weld::TreeIter>>* pNodesToExpand);
 162
 163     void MoveOutline(SwOutlineNodes::size_type nTargetPos);
 164
 165     void UpdateLastSelType();
 166
 167     /** Expand - Remember the state for content types */
 168     DECL_LINK(ExpandHdl, const weld::TreeIter&, bool);
 169     /** Collapse - Remember the state for content types. */
 170     DECL_LINK(CollapseHdl, const weld::TreeIter&, bool);
 171     DECL_LINK(ContentDoubleClickHdl, weld::TreeView&, bool);
 172     DECL_LINK(SelectHdl, weld::TreeView&, void);
 173     DECL_LINK(FocusHdl, weld::Widget&, void);
 174     DECL_LINK(KeyInputHdl, const KeyEvent&, bool);
 175     DECL_LINK(CommandHdl, const CommandEvent&, bool);
 176     DECL_LINK(QueryTooltipHdl, const weld::TreeIter&, OUString);
 177     DECL_LINK(DragBeginHdl, bool&, bool);
 178     DECL_LINK(TimerUpdate, Timer *, void);
 179
 180 public:
 181     SwContentTree(std::unique_ptr<weld::TreeView> xTreeView, SwNavigationPI* pDialog);
 182     ~SwContentTree();
 183     SdrObject*      GetDrawingObjectsByContent(const SwContent *pCnt);
 184
 185     /** Switch the display to Root */
 186     void            ToggleToRoot();
 187     void            SetRootType(ContentTypeId nType);
 188
 189     /** Show the file */
 190     void            Display( bool bActiveView );
 191     /** In the clear the content types have to be deleted, also. */
 192     void            clear();
 193
 194     /** After a file is dropped on the Navigator, the new shell will be set */
 195     void            SetHiddenShell(SwWrtShell* pSh);
 196     void            ShowHiddenShell();
 197     void            ShowActualView();
 198
 199     /** Document change - set new Shell */
 200     void            SetActiveShell(SwWrtShell* pSh);
 201
 202     /** Set an open view as active. */
 203     void            SetConstantShell(SwWrtShell* pSh);
 204
 205     SwWrtShell*     GetWrtShell()
 206         { return State::HIDDEN == m_eState ? m_pHiddenShell : m_pActiveShell; }
 207
 208     bool            IsInDrag() const;
 209
 210     sal_uInt8       GetOutlineLevel()const {return m_nOutlineLevel;}
 211     void            SetOutlineLevel(sal_uInt8 nSet);
 212
 213     /** Execute commands of the Navigator */
 214     void            ExecCommand(const OString& rCmd, bool bModifier);
 215
 216     void            ShowTree();
 217     void            HideTree();
 218
 219     bool            IsConstantView() const { return State::CONSTANT == m_eState; }
 220     bool            IsActiveView() const   { return State::ACTIVE == m_eState; }
 221     bool            IsHiddenView() const   { return State::HIDDEN == m_eState; }
 222
 223     const SwWrtShell*   GetActiveWrtShell() const {return m_pActiveShell;}
 224     SwWrtShell*         GetHiddenWrtShell() {return m_pHiddenShell;}
 225
 226     void Select();
 227
 228     void UpdateTracking();
 229     void SelectOutlinesWithSelection();
 230
 231     // return true if it has any children
 232     bool RequestingChildren(const weld::TreeIter& rParent);
 233
 234     virtual void Notify(SfxBroadcaster& rBC, SfxHint const& rHint) override;
 235
 236     sal_Int8 AcceptDrop(const AcceptDropEvent& rEvt);
 237     sal_Int8 ExecuteDrop(const ExecuteDropEvent& rEvt);
 238
 239     bool IsDropFormatSupported(SotClipboardFormatId nFormat)
 240     {
 241         return m_aDropTargetHelper.IsDropFormatSupported(nFormat);
 242     }
 243
 244     void set_accessible_name(const OUString& rName)
 245     {
 246         m_xTreeView->set_accessible_name(rName);
 247     }
 248
 249     void grab_focus()
 250     {
 251         m_xTreeView->grab_focus();
 252     }
 253
 254     OUString get_selected_text() const
 255     {
 256         return m_xTreeView->get_selected_text();
 257     }
 258
 259     int count_selected_rows() const
 260     {
 261         return m_xTreeView->count_selected_rows();
 262     }
 263
 264     void set_selection_mode(SelectionMode eMode)
 265     {
 266         m_xTreeView->set_selection_mode(eMode);
 267     }
 268
 269     weld::TreeView& get_widget()
 270     {
 271         return *m_xTreeView;
 272     }
 273 };
 274
 275 namespace sfx2 { class DocumentInserter; }
 276 namespace sfx2 { class FileDialogHelper; }
 277
 278 class SwGlobalTree;
 279
 280 class SwGlobalTreeDropTarget : public DropTargetHelper
 281 {
 282 private:
 283     SwGlobalTree& m_rTreeView;
 284
 285     virtual sal_Int8 AcceptDrop( const AcceptDropEvent& rEvt ) override;
 286     virtual sal_Int8 ExecuteDrop( const ExecuteDropEvent& rEvt ) override;
 287
 288 public:
 289     SwGlobalTreeDropTarget(SwGlobalTree& rTreeView);
 290 };
 291
 292 class SwGlobalTree final
 293 {
 294 private:
 295     std::unique_ptr<weld::TreeView> m_xTreeView;
 296     SwGlobalTreeDropTarget  m_aDropTargetHelper;
 297     VclPtr<SwNavigationPI>  m_xDialog;
 298     AutoTimer               m_aUpdateTimer;
 299     OUString                m_aContextStrings[GLOBAL_CONTEXT_COUNT];
 300
 301     SwWrtShell*             m_pActiveShell;
 302     std::unique_ptr<SwGlblDocContents> m_pSwGlblDocContents; // array with sorted content
 303
 304     std::unique_ptr<SwGlblDocContent>       m_pDocContent;
 305     std::unique_ptr<sfx2::DocumentInserter> m_pDocInserter;
 306
 307     static const SfxObjectShell* pShowShell;
 308
 309     void        InsertRegion( const SwGlblDocContent* _pContent,
 310                               const css::uno::Sequence< OUString >& _rFiles );
 311
 312     DECL_LINK(  DialogClosedHdl, sfx2::FileDialogHelper*, void );
 313
 314     void Select();
 315
 316     DECL_LINK(Timeout, Timer*, void);
 317     DECL_LINK(DoubleClickHdl, weld::TreeView&, bool);
 318     DECL_LINK(SelectHdl, weld::TreeView&, void);
 319     DECL_LINK(FocusInHdl, weld::Widget&, void);
 320     DECL_LINK(KeyInputHdl, const KeyEvent&, bool);
 321     DECL_LINK(CommandHdl, const CommandEvent&, bool);
 322     DECL_LINK(QueryTooltipHdl, const weld::TreeIter&, OUString);
 323
 324     SwNavigationPI* GetParentWindow();
 325
 326     void            OpenDoc(const SwGlblDocContent*);
 327     void            GotoContent(const SwGlblDocContent*);
 328     MenuEnableFlags GetEnableFlags() const;
 329
 330     static void     SetShowShell(const SfxObjectShell*pSet) {pShowShell = pSet;}
 331     DECL_STATIC_LINK(SwGlobalTree, ShowFrameHdl, void*, void);
 332
 333 public:
 334     SwGlobalTree(std::unique_ptr<weld::TreeView> xTreeView, SwNavigationPI* pDialog);
 335     ~SwGlobalTree();
 336
 337     bool get_visible() const { return m_xTreeView->get_visible(); }
 338
 339     void set_accessible_name(const OUString& rName)
 340     {
 341         m_xTreeView->set_accessible_name(rName);
 342     }
 343
 344     void grab_focus()
 345     {
 346         m_xTreeView->grab_focus();
 347     }
 348
 349     void set_selection_mode(SelectionMode eMode)
 350     {
 351         m_xTreeView->set_selection_mode(eMode);
 352     }
 353
 354     weld::TreeView& get_widget()
 355     {
 356         return *m_xTreeView;
 357     }
 358
 359     void MoveSelectionTo(const weld::TreeIter* pDropTarget);
 360
 361     void                TbxMenuHdl(const OString& rCommand, weld::Menu& rMenu);
 362     void                InsertRegion( const SwGlblDocContent* pCont,
 363                                         const OUString* pFileName = nullptr );
 364     void                EditContent(const SwGlblDocContent* pCont );
 365
 366     void                ShowTree();
 367     void                HideTree();
 368
 369     void                ExecCommand(const OString& rCmd);
 370
 371     void                Display(bool bOnlyUpdateUserData = false);
 372
 373     bool                Update(bool bHard);
 374
 375     void                ExecuteContextMenuAction(const OString& rSelectedPopupEntry);
 376
 377     const SwWrtShell*   GetActiveWrtShell() const {return m_pActiveShell;}
 378 };
 379
 380 #endif
 381
 382 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */