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