cui/source/inc/MacroManagerDialog.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
   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
  10 #pragma once
  11
  12 #include <sal/config.h>
  13
  14 #include <vector>
  15 #include <basctl/scriptdocument.hxx>
  16 #include <svx/passwd.hxx>
  17 #include <svl/lstner.hxx>
  18
  19 #include <com/sun/star/beans/XPropertySet.hpp>
  20 #include <com/sun/star/frame/DispatchInformation.hpp>
  21 #include <com/sun/star/script/browse/XBrowseNode.hpp>
  22 #include <com/sun/star/task/InteractionHandler.hpp>
  23
  24 struct ScriptContainerInfo
  25 {
  26     css::script::browse::XBrowseNode* pBrowseNode;
  27
  28     ScriptContainerInfo(css::script::browse::XBrowseNode* pObj)
  29         : pBrowseNode(pObj)
  30     {
  31     }
  32 };
  33
  34 struct ScriptInfo
  35 {
  36     css::script::browse::XBrowseNode* pBrowseNode;
  37     OUString sURL;
  38     OUString sDescription;
  39
  40     ScriptInfo(css::script::browse::XBrowseNode* pObj, const OUString& rsUrl,
  41                const OUString& rsDesc)
  42         : pBrowseNode(pObj)
  43         , sURL(rsUrl)
  44         , sDescription(rsDesc)
  45     {
  46     }
  47 };
  48
  49 typedef std::vector<std::unique_ptr<ScriptInfo>> ScriptInfoArr;
  50
  51 // inspired by class CuiConfigFunctionListBox
  52 // cui/source/inc/cfgutil.hxx
  53 class ScriptsListBox
  54 {
  55     friend class ScriptContainersListBox; // for access to aArr
  56
  57     ScriptInfoArr aArr;
  58
  59     std::unique_ptr<weld::TreeView> m_xTreeView;
  60     std::unique_ptr<weld::TreeIter> m_xScratchIter;
  61
  62     DECL_LINK(QueryTooltip, const weld::TreeIter& rIter, OUString);
  63
  64 public:
  65     ScriptsListBox(std::unique_ptr<weld::TreeView> xTreeView);
  66     ~ScriptsListBox();
  67
  68     void ClearAll();
  69     static OUString GetDescriptionText(const OUString& rId);
  70     OUString GetSelectedScriptName();
  71
  72     void connect_changed(const Link<weld::TreeView&, void>& rLink)
  73     {
  74         m_xTreeView->connect_selection_changed(rLink);
  75     }
  76     void connect_popup_menu(const Link<const CommandEvent&, bool>& rLink)
  77     {
  78         m_xTreeView->connect_popup_menu(rLink);
  79     }
  80     void connect_row_activated(const Link<weld::TreeView&, bool>& rLink)
  81     {
  82         m_xTreeView->connect_row_activated(rLink);
  83     }
  84     void freeze() { m_xTreeView->freeze(); }
  85     void thaw() { m_xTreeView->thaw(); }
  86     void append(const OUString& rId, const OUString& rStr, const OUString& rImage,
  87                 const weld::TreeIter* pParent = nullptr)
  88     {
  89         m_xTreeView->insert(pParent, -1, &rStr, &rId, nullptr, nullptr, false,
  90                             m_xScratchIter.get());
  91         m_xTreeView->set_image(*m_xScratchIter, rImage);
  92     }
  93     int n_children() const { return m_xTreeView->n_children(); }
  94     std::unique_ptr<weld::TreeIter> make_iterator(const weld::TreeIter* pOrig = nullptr) const
  95     {
  96         return m_xTreeView->make_iterator(pOrig);
  97     }
  98     OUString get_id(const weld::TreeIter& rIter) const { return m_xTreeView->get_id(rIter); }
  99     bool get_selected(weld::TreeIter* pIter) const { return m_xTreeView->get_selected(pIter); }
 100     OUString get_selected_id() const
 101     {
 102         if (!m_xTreeView->get_selected(m_xScratchIter.get()))
 103             return OUString();
 104         return m_xTreeView->get_id(*m_xScratchIter);
 105     }
 106     void select(int pos) { m_xTreeView->select(pos); }
 107     weld::TreeView& get_widget() { return *m_xTreeView; }
 108
 109     void Remove(const weld::TreeIter& rEntry);
 110 };
 111
 112 enum class ScriptContainerType
 113 {
 114     LOCATION,
 115     LANGUAGE,
 116     LIBRARY,
 117     MODULEORDIALOG
 118 };
 119
 120 class MacroManagerDialog;
 121
 122 // locations, libraries, modules, and dialogs
 123 class ScriptContainersListBox
 124 {
 125     friend class MacroManagerDialog;
 126
 127     ScriptsListBox* m_pScriptsListBox;
 128
 129     css::uno::Reference<css::uno::XComponentContext> m_xContext;
 130     css::uno::Reference<css::frame::XFrame> m_xFrame;
 131
 132     std::unique_ptr<weld::TreeView> m_xTreeView;
 133
 134     void Remove(const weld::TreeIter* pEntryIter, bool bRemoveEntryIter);
 135     void Fill(const weld::TreeIter* pEntryIter);
 136     basctl::ScriptDocument GetScriptDocument(const weld::TreeIter* pIter = nullptr);
 137
 138     DECL_LINK(ExpandingHdl, const weld::TreeIter&, bool);
 139     DECL_LINK(QueryTooltip, const weld::TreeIter& rIter, OUString);
 140
 141     // for weld::WaitObject which seems not to always behave as expected without the
 142     // dialog window as a parent
 143     MacroManagerDialog* m_pMacroManagerDialog;
 144
 145 public:
 146     ScriptContainersListBox(std::unique_ptr<weld::TreeView> xTreeView,
 147                             MacroManagerDialog* pMacroManagerDialog);
 148     ~ScriptContainersListBox();
 149
 150     void connect_changed(const Link<weld::TreeView&, void>& rLink)
 151     {
 152         m_xTreeView->connect_selection_changed(rLink);
 153     }
 154     weld::TreeView& get_widget() { return *m_xTreeView; }
 155     void ClearAll();
 156
 157     void Init(const css::uno::Reference<css::uno::XComponentContext>& xContext,
 158               const css::uno::Reference<css::frame::XFrame>& xFrame);
 159     void SetScriptsListBox(ScriptsListBox* pBox) { m_pScriptsListBox = pBox; }
 160     void ScriptContainerSelected();
 161
 162     void Insert(const css::uno::Reference<css::script::browse::XBrowseNode>& xInsertNode,
 163                 const weld::TreeIter* pParentEntry, const OUString& rsUiName,
 164                 const OUString& rsImage, bool bChildOnDemand = false, int nPos = -1,
 165                 weld::TreeIter* pRet = nullptr);
 166
 167     OUString GetContainerName(const weld::TreeIter& rIter,
 168                               const ScriptContainerType eScriptContainerType);
 169     OUString GetSelectedEntryContainerName(ScriptContainerType eScriptContainerType);
 170 };
 171
 172 enum class InputDialogMode;
 173
 174 class MacroManagerDialog : public weld::GenericDialogController, public SfxListener
 175 {
 176     OUString m_aScriptsListBoxLabelBaseStr;
 177
 178     // For forwarding to Assign dialog
 179     css::uno::Reference<css::frame::XFrame> m_xDocumentFrame;
 180
 181     std::unique_ptr<weld::Label> m_xDialogDescription;
 182     std::unique_ptr<ScriptContainersListBox> m_xScriptContainersListBox;
 183     std::unique_ptr<ScriptsListBox> m_xScriptsListBox;
 184     std::unique_ptr<weld::Label> m_xScriptContainersListBoxLabel;
 185     std::unique_ptr<weld::Label> m_xScriptsListBoxLabel;
 186     std::unique_ptr<weld::Button> m_xRunButton;
 187     std::unique_ptr<weld::Button> m_xCloseButton;
 188     std::unique_ptr<weld::TextView> m_xDescriptionText;
 189     std::unique_ptr<weld::Frame> m_xDescriptionFrame;
 190     std::unique_ptr<weld::Button> m_xNewLibraryButton;
 191     std::unique_ptr<weld::Button> m_xNewModuleButton;
 192     std::unique_ptr<weld::Button> m_xNewDialogButton;
 193     std::unique_ptr<weld::Button> m_xLibraryModuleDialogEditButton;
 194     std::unique_ptr<weld::Button> m_xLibraryModuleDialogRenameButton;
 195     std::unique_ptr<weld::Button> m_xLibraryModuleDialogDeleteButton;
 196     std::unique_ptr<weld::Button> m_xLibraryPasswordButton;
 197     std::unique_ptr<weld::Button> m_xLibraryImportButton;
 198     std::unique_ptr<weld::Button> m_xLibraryExportButton;
 199     std::unique_ptr<weld::Button> m_xMacroEditButton;
 200     std::unique_ptr<weld::Button> m_xMacroDeleteButton;
 201     std::unique_ptr<weld::Button> m_xMacroCreateButton;
 202     std::unique_ptr<weld::Button> m_xMacroRenameButton;
 203     std::unique_ptr<weld::Button> m_xAssignButton;
 204
 205     DECL_LINK(ClickHdl, weld::Button&, void);
 206     DECL_LINK(SelectHdl, weld::TreeView&, void);
 207     DECL_LINK(FunctionDoubleClickHdl, weld::TreeView&, bool);
 208     DECL_LINK(ContextMenuHdl, const CommandEvent&, bool);
 209     DECL_LINK(CheckPasswordHdl, SvxPasswordDialog*, bool);
 210
 211     void BasicScriptsCreateLibrary(const basctl::ScriptDocument& rDocument);
 212     void BasicScriptsCreateModule(const basctl::ScriptDocument& rDocument);
 213     void BasicScriptsCreateDialog(const basctl::ScriptDocument& rDocument);
 214     void BasicScriptsLibraryModuleDialogEdit(const basctl::ScriptDocument& rDocument);
 215     void BasicScriptsLibraryModuleDialogRename(const basctl::ScriptDocument& rDocument);
 216     void BasicScriptsLibraryModuleDialogDelete(const basctl::ScriptDocument& rDocument);
 217     void BasicScriptsLibraryPassword(const basctl::ScriptDocument& rDocument);
 218     void BasicScriptsMacroEdit(const basctl::ScriptDocument& rDocument);
 219     bool IsLibraryReadOnlyOrFailedPasswordQuery(const basctl::ScriptDocument& rDocument,
 220                                                 weld::TreeIter* pIter);
 221
 222     void ScriptingFrameworkScriptsCreateEntry(InputDialogMode eInputDialogMode);
 223     void ScriptingFrameworkScriptsRenameEntry(weld::TreeView& rTreeView,
 224                                               const weld::TreeIter& rEntry);
 225     void ScriptingFrameworkScriptsDeleteEntry(weld::TreeView& rTreeView,
 226                                               const weld::TreeIter& rEntry);
 227     static bool getBoolProperty(css::uno::Reference<css::beans::XPropertySet> const& xProps,
 228                                 OUString const& propName);
 229     OUString getListOfChildren(const css::uno::Reference<css::script::browse::XBrowseNode>& node,
 230                                int depth);
 231
 232     css::uno::Reference<css::script::browse::XBrowseNode>
 233     getBrowseNode(const weld::TreeView& rTreeView, const weld::TreeIter& rTreeIter);
 234
 235     void UpdateUI();
 236     void CheckButtons();
 237
 238     virtual void Notify(SfxBroadcaster&, const SfxHint& rHint) override;
 239
 240 public:
 241     MacroManagerDialog(weld::Window* pParent,
 242                        const css::uno::Reference<css::frame::XFrame>& xFrame);
 243     virtual ~MacroManagerDialog() override;
 244
 245     OUString GetScriptURL() const;
 246
 247     void SaveLastUsedMacro();
 248     void LoadLastUsedMacro();
 249 };
 250
 251 /* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */