basctl/source/inc/basobj.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 #pragma once
  20
  21 #include <basctl/basctldllpublic.hxx>
  22 #include <basctl/scriptdocument.hxx>
  23 #include <tools/long.hxx>
  24
  25 class SbMethod;
  26 class SbModule;
  27 class SbxVariable;
  28 class StarBASIC;
  29 class SfxUInt16Item;
  30 class SfxBindings;
  31 class SfxDispatcher;
  32 namespace weld { class Widget; class Window; }
  33
  34 namespace basctl
  35 {
  36     void            Organize(weld::Window* pParent, const css::uno::Reference<css::frame::XFrame>& xDocFrame, sal_Int16 tabId);
  37
  38     // help methods for the general use:
  39     SbMethod*       CreateMacro( SbModule* pModule, const OUString& rMacroName );
  40     void            RunMethod( SbMethod const * pMethod );
  41
  42     StarBASIC*      FindBasic( const SbxVariable* pVar );
  43     void            StopBasic();
  44     tools::Long            HandleBasicError( StarBASIC const * pBasic );
  45     void            BasicStopped( bool* pbAppWindowDisabled = nullptr, bool* pbDispatcherLocked = nullptr, sal_uInt16* pnWaitCount = nullptr,
  46                             SfxUInt16Item** ppSWActionCount = nullptr, SfxUInt16Item** ppSWLockViewCount = nullptr );
  47
  48     SAL_RET_MAYBENULL BasicManager*   FindBasicManager( StarBASIC const * pLib );
  49
  50     SAL_RET_MAYBENULL SfxBindings*    GetBindingsPtr();
  51
  52     void            InvalidateDebuggerSlots();
  53
  54     // libraries
  55
  56     css::uno::Sequence< OUString > GetMergedLibraryNames(
  57         const css::uno::Reference< css::script::XLibraryContainer >& xModLibContainer,
  58         const css::uno::Reference< css::script::XLibraryContainer >& xDlgLibContainer );
  59
  60     /** renames a module
  61
  62         Will show an error message when renaming fails because the new name is already used.
  63     */
  64     bool            RenameModule(
  65         weld::Widget* pErrorParent, const ScriptDocument& rDocument,
  66         const OUString& rLibName, const OUString& rOldName, const OUString& rNewName );
  67
  68     // new methods for macros
  69
  70     OUString        ChooseMacro(weld::Window* pParent,
  71         const css::uno::Reference< css::frame::XModel >& rxLimitToDocument, const css::uno::Reference< css::frame::XFrame >& xDocFrame,
  72         bool bChooseOnly );
  73     inline OUString ChooseMacro(weld::Window* pParent, const css::uno::Reference<css::frame::XModel>& rLimitToDocument)
  74     { return ChooseMacro(pParent, rLimitToDocument, css::uno::Reference< css::frame::XFrame >(), false/*bChooseOnly*/); }
  75
  76     /// @throws css::container::NoSuchElementException
  77     /// @throws css::uno::RuntimeException
  78     css::uno::Sequence< OUString > GetMethodNames(
  79         const ScriptDocument& rDocument, const OUString& rLibName, const OUString& rModName );
  80
  81     bool            HasMethod(
  82         const ScriptDocument& rDocument, const OUString& rLibName, const OUString& rModName, const OUString& rMethName );
  83
  84     // new methods for dialogs
  85
  86     /** renames a dialog
  87
  88         Will show an error message when renaming fails because the new name is already used.
  89
  90         @throws css::container::ElementExistException
  91         @throws css::container::NoSuchElementException
  92         @throws css::uno::RuntimeException
  93     */
  94     bool            RenameDialog(weld::Widget* pErrorParent, const ScriptDocument& rDocument, const OUString& rLibName, const OUString& rOldName, const OUString& rNewName);
  95
  96     bool            RemoveDialog( const ScriptDocument& rDocument, const OUString& rLibName, const OUString& rDlgName );
  97
  98 } // namespace basctl
  99
 100 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */