basctl/source/inc/bastype2.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
  20 #ifndef INCLUDED_BASCTL_SOURCE_INC_BASTYPE2_HXX
  21 #define INCLUDED_BASCTL_SOURCE_INC_BASTYPE2_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <memory>
  26
  27 #include "doceventnotifier.hxx"
  28
  29 #include <svtools/treelistbox.hxx>
  30 #include <basic/sbstar.hxx>
  31 #include "sbxitem.hxx"
  32 #include "basobj.hxx"
  33 #include <o3tl/typed_flags_set.hxx>
  34
  35 class SbModule;
  36 class SvTreeListEntry;
  37 class SbxVariable;
  38
  39 enum class BrowseMode
  40 {
  41     Modules  = 0x01,
  42     Subs     = 0x02,
  43     Dialogs  = 0x04,
  44     All      = Modules | Subs | Dialogs,
  45 };
  46 namespace o3tl {
  47     template<> struct typed_flags<BrowseMode> : is_typed_flags<BrowseMode, 0x7> {};
  48 }
  49
  50 namespace basctl
  51 {
  52
  53 enum EntryType
  54 {
  55     OBJ_TYPE_UNKNOWN,
  56     OBJ_TYPE_DOCUMENT,
  57     OBJ_TYPE_LIBRARY,
  58     OBJ_TYPE_MODULE,
  59     OBJ_TYPE_DIALOG,
  60     OBJ_TYPE_METHOD,
  61     OBJ_TYPE_DOCUMENT_OBJECTS,
  62     OBJ_TYPE_USERFORMS,
  63     OBJ_TYPE_NORMAL_MODULES,
  64     OBJ_TYPE_CLASS_MODULES
  65 };
  66
  67 class Entry
  68 {
  69 private:
  70     EntryType m_eType;
  71
  72 public:
  73     explicit Entry(EntryType eType)
  74         : m_eType(eType)
  75     {
  76     }
  77
  78     virtual ~Entry();
  79
  80     EntryType GetType () const { return m_eType; }
  81 };
  82
  83 class DocumentEntry : public Entry
  84 {
  85 private:
  86     ScriptDocument      m_aDocument;
  87     LibraryLocation     m_eLocation;
  88
  89 public:
  90     DocumentEntry (
  91         ScriptDocument const& rDocument,
  92         LibraryLocation eLocation,
  93         EntryType eType = OBJ_TYPE_DOCUMENT
  94     );
  95     virtual ~DocumentEntry () override;
  96
  97     ScriptDocument const& GetDocument() const { return m_aDocument; }
  98     LibraryLocation GetLocation() const { return m_eLocation; }
  99 };
 100
 101 class LibEntry : public DocumentEntry
 102 {
 103 private:
 104     OUString m_aLibName;
 105
 106 public:
 107     LibEntry (
 108         ScriptDocument const& rDocument,
 109         LibraryLocation eLocation,
 110         OUString       const& rLibName
 111     );
 112     virtual ~LibEntry () override;
 113
 114     OUString const& GetLibName () const { return m_aLibName; }
 115 };
 116
 117 class EntryDescriptor
 118 {
 119     ScriptDocument   m_aDocument;
 120     LibraryLocation  m_eLocation;
 121     OUString         m_aLibName;
 122     OUString         m_aLibSubName;  // for vba entry:  Document Objects, Class Modules, Forms and Normal Modules
 123     OUString         m_aName;
 124     OUString         m_aMethodName;
 125     EntryType        m_eType;
 126
 127 public:
 128     EntryDescriptor ();
 129     EntryDescriptor (
 130         ScriptDocument const& rDocument,
 131         LibraryLocation eLocation,
 132         OUString      const& rLibName,
 133         OUString      const& rLibSubName,
 134         OUString      const& rName,
 135         EntryType eType
 136     );
 137     EntryDescriptor (
 138         ScriptDocument const& rDocument,
 139         LibraryLocation eLocation,
 140         OUString      const& rLibName,
 141         OUString      const& rLibSubName,
 142         OUString      const& rName,
 143         OUString      const& rMethodName,
 144         EntryType eType
 145     );
 146
 147     ScriptDocument const&   GetDocument() const { return m_aDocument; }
 148
 149     LibraryLocation         GetLocation() const { return m_eLocation; }
 150
 151     const OUString&         GetLibName() const { return m_aLibName; }
 152
 153     const OUString&         GetLibSubName() const { return m_aLibSubName; }
 154
 155     const OUString&         GetName() const { return m_aName; }
 156
 157     const OUString&         GetMethodName() const { return m_aMethodName; }
 158     void                    SetMethodName( const OUString& aMethodName ) { m_aMethodName = aMethodName; }
 159
 160     EntryType               GetType() const { return m_eType; }
 161     void                    SetType( EntryType eType ) { m_eType = eType; }
 162 };
 163
 164
 165 /*
 166     Classification of types and pointers in the Entries:
 167
 168     OBJ_TYPE_DOCUMENT        DocumentEntry
 169     OBJ_TYPE_LIBRARY         Entry
 170     OBJ_TYPE_MODULE          Entry
 171     OBJ_TYPE_DIALOG          Entry
 172     OBJ_TYPE_METHOD          Entry
 173
 174 */
 175
 176 class TreeListBox : public SvTreeListBox, public DocumentEventListener
 177 {
 178 private:
 179     BrowseMode            nMode;
 180     DocumentEventNotifier m_aNotifier;
 181     void            SetEntryBitmaps( SvTreeListEntry * pEntry, const Image& rImage );
 182     virtual void    MouseButtonDown( const MouseEvent& rMEvt ) override;
 183
 184 protected:
 185     virtual void            RequestingChildren( SvTreeListEntry* pParent ) override;
 186     virtual void            ExpandedHdl() override;
 187     virtual SvTreeListEntry*    CloneEntry( SvTreeListEntry* pSource ) override;
 188     virtual bool            ExpandingHdl() override;
 189     virtual void            KeyInput( const KeyEvent& rEvt ) override;
 190
 191     bool                    OpenCurrent();
 192     void                    ImpCreateLibEntries( SvTreeListEntry* pShellRootEntry, const ScriptDocument& rDocument, LibraryLocation eLocation );
 193     void                    ImpCreateLibSubEntries( SvTreeListEntry* pLibRootEntry, const ScriptDocument& rDocument, const OUString& rLibName );
 194     void                    ImpCreateLibSubEntriesInVBAMode( SvTreeListEntry* pLibRootEntry, const ScriptDocument& rDocument, const OUString& rLibName );
 195     void                    ImpCreateLibSubSubEntriesInVBAMode( SvTreeListEntry* pLibSubRootEntry, const ScriptDocument& rDocument, const OUString& rLibName );
 196     SvTreeListEntry*            ImpFindEntry( SvTreeListEntry* pParent, const OUString& rText );
 197
 198     // DocumentEventListener
 199     virtual void onDocumentCreated( const ScriptDocument& _rDocument ) override;
 200     virtual void onDocumentOpened( const ScriptDocument& _rDocument ) override;
 201     virtual void onDocumentSave( const ScriptDocument& _rDocument ) override;
 202     virtual void onDocumentSaveDone( const ScriptDocument& _rDocument ) override;
 203     virtual void onDocumentSaveAs( const ScriptDocument& _rDocument ) override;
 204     virtual void onDocumentSaveAsDone( const ScriptDocument& _rDocument ) override;
 205     virtual void onDocumentClosed( const ScriptDocument& _rDocument ) override;
 206     virtual void onDocumentTitleChanged( const ScriptDocument& _rDocument ) override;
 207     virtual void onDocumentModeChanged( const ScriptDocument& _rDocument ) override;
 208
 209 public:
 210     TreeListBox(vcl::Window* pParent, WinBits nStyle);
 211     virtual ~TreeListBox() override;
 212     virtual void    dispose() override;
 213
 214     void            ScanEntry( const ScriptDocument& rDocument, LibraryLocation eLocation );
 215     void            ScanAllEntries();
 216     void            UpdateEntries();
 217
 218     bool            IsEntryProtected( SvTreeListEntry* pEntry );
 219
 220     void            SetMode( BrowseMode nM ) { nMode = nM; }
 221     BrowseMode      GetMode() const { return nMode; }
 222
 223     SbModule*       FindModule( SvTreeListEntry* pEntry );
 224     SbxVariable*    FindVariable( SvTreeListEntry* pEntry );
 225     SvTreeListEntry*    FindRootEntry( const ScriptDocument& rDocument, LibraryLocation eLocation );
 226     SvTreeListEntry*    FindEntry( SvTreeListEntry* pParent, const OUString& rText, EntryType eType );
 227
 228     EntryDescriptor GetEntryDescriptor( SvTreeListEntry* pEntry );
 229
 230     static ItemType ConvertType (EntryType eType);
 231     bool            IsValidEntry( SvTreeListEntry* pEntry );
 232
 233     SvTreeListEntry*    AddEntry(
 234         const OUString& rText, const Image& rImage,
 235         SvTreeListEntry* pParent, bool bChildrenOnDemand,
 236         std::unique_ptr<Entry> && aUserData
 237     );
 238     void            RemoveEntry (SvTreeListEntry const *);
 239     void            RemoveEntry (ScriptDocument const&);
 240
 241     OUString        GetRootEntryName( const ScriptDocument& rDocument, LibraryLocation eLocation ) const;
 242     static void     GetRootEntryBitmaps( const ScriptDocument& rDocument, Image& rImage );
 243
 244     void            SetCurrentEntry (EntryDescriptor const &);
 245
 246 private:
 247     LibraryType     GetLibraryType() const;
 248 };
 249
 250 } // namespace basctl
 251
 252 #endif // INCLUDED_BASCTL_SOURCE_INC_BASTYPE2_HXX
 253
 254 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */