basctl/source/inc/basobj.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: basobj.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef _BASOBJ_HXX
  31 #define _BASOBJ_HXX
  32
  33 #include "scriptdocument.hxx"
  34 #include <tools/string.hxx>
  35 #include <svtools/lstner.hxx>
  36
  37 #ifndef _COM_SUN_STAR_IO_XINPUTSTREAMPROVIDER_HXX_
  38 #include <com/sun/star/io/XInputStreamProvider.hpp>
  39 #endif
  40 #include <com/sun/star/script/XLibraryContainer.hpp>
  41 #include <com/sun/star/frame/XModel.hpp>
  42
  43 class SfxMacro;
  44 class SbMethod;
  45 class SbModule;
  46 class SbxObject;
  47 class SbxVariable;
  48 class StarBASIC;
  49 class BasicManager;
  50 class SfxUInt16Item;
  51 class SfxBindings;
  52 class Window;
  53 struct BasicIDE_Impl;
  54
  55 namespace BasicIDE
  56 {
  57     void                        Organize( INT16 tabId );
  58
  59
  60     // Hilfsmethoden fuer den allg. Gebrauch:
  61     SbMethod*   CreateMacro( SbModule* pModule, const String& rMacroName );
  62     void                        RunMethod( SbMethod* pMethod );
  63
  64     StarBASIC*  FindBasic( const SbxVariable* pVar );
  65     void                        StopBasic();
  66     long         HandleBasicError( StarBASIC* pBasic );
  67     void                        BasicStopped( BOOL* pbAppWindowDisabled = 0, BOOL* pbDispatcherLocked = 0, USHORT* pnWaitCount = 0,
  68                             SfxUInt16Item** ppSWActionCount = 0, SfxUInt16Item** ppSWLockViewCount = 0 );
  69
  70     BOOL                        IsValidSbxName( const String& rName );
  71
  72     BasicManager*               FindBasicManager( StarBASIC* pLib );
  73
  74     SfxBindings*                GetBindingsPtr();
  75
  76     void                        InvalidateDebuggerSlots();
  77
  78     // libraries
  79
  80     ::com::sun::star::uno::Sequence< ::rtl::OUString > GetMergedLibraryNames(
  81         const ::com::sun::star::uno::Reference< ::com::sun::star::script::XLibraryContainer >& xModLibContainer,
  82         const ::com::sun::star::uno::Reference< ::com::sun::star::script::XLibraryContainer >& xDlgLibContainer );
  83
  84     // new methods for modules
  85
  86     ::rtl::OUString             GetModule(
  87         const ScriptDocument& rDocument, const String& rLibName, const String& rModName )
  88         throw( ::com::sun::star::container::NoSuchElementException );
  89
  90     /** renames a module
  91
  92         Will show an error message when renaming fails because the new name is already used.
  93     */
  94     bool                 RenameModule(
  95         Window* pErrorParent, const ScriptDocument& rDocument,
  96         const String& rLibName, const String& rOldName, const String& rNewName );
  97
  98     // new methods for macros
  99
 100     ::rtl::OUString             ChooseMacro( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& rxLimitToDocument,
 101         BOOL bChooseOnly, const ::rtl::OUString& rMacroDesc );
 102
 103     ::com::sun::star::uno::Sequence< ::rtl::OUString > GetMethodNames(
 104         const ScriptDocument& rDocument, const String& rLibName, const String& rModName )
 105         throw( ::com::sun::star::container::NoSuchElementException );
 106
 107     BOOL                                        HasMethod(
 108         const ScriptDocument& rDocument, const String& rLibName, const String& rModName, const String& rMethName );
 109
 110     // new methods for dialogs
 111
 112     ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStreamProvider > GetDialog(
 113         const ScriptDocument& rDocument, const String& rLibName, const String& rDlgName )
 114         throw( ::com::sun::star::container::NoSuchElementException );
 115
 116     /** renames a dialog
 117
 118         Will show an error message when renaming fails because the new name is already used.
 119     */
 120     bool                 RenameDialog(
 121         Window* pErrorParent, const ScriptDocument& rDocument, const String& rLibName, const String& rOldName, const String& rNewName )
 122         throw( ::com::sun::star::container::ElementExistException, ::com::sun::star::container::NoSuchElementException );
 123
 124     bool                 RemoveDialog(
 125         const ScriptDocument& rDocument, const String& rLibName, const String& rDlgName );
 126
 127     void                                MarkDocumentModified( const ScriptDocument& rDocument );
 128 }
 129
 130 #endif  // _BASOBJ_HXX