INTEGRATION: CWS basmgr02 (1.1.2); FILE ADDED

2007/02/21 09:32:02 fs 1.1.2.1: #i73331# moved herein from ../../inc, to be able to include files from there (not exported to outside the module, so there's no need for it to reside in $(PRJ)/inc)

2 files changed, 613 insertions, 0 deletions

diff --git a/basctl/source/inc/sbxitem.hxx b/basctl/source/inc/sbxitem.hxx
new file mode 100644
index 000000000000..6287da96c71a
--- /dev/null
+++ b/basctl/source/inc/sbxitem.hxx
@@ -0,0 +1,87 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: sbxitem.hxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: obo $ $Date: 2007-03-15 16:03:07 $
+ *
+ *  The Contents of this file are made available subject to
+ *  the terms of GNU Lesser General Public License Version 2.1.
+ *
+ *
+ *    GNU Lesser General Public License Version 2.1
+ *    =============================================
+ *    Copyright 2005 by Sun Microsystems, Inc.
+ *    901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *    This library is free software; you can redistribute it and/or
+ *    modify it under the terms of the GNU Lesser General Public
+ *    License version 2.1, as published by the Free Software Foundation.
+ *
+ *    This library is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *    Lesser General Public License for more details.
+ *
+ *    You should have received a copy of the GNU Lesser General Public
+ *    License along with this library; if not, write to the Free Software
+ *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *    MA  02111-1307  USA
+ *
+ ************************************************************************/
+#ifndef _SBXITEM_HXX
+#define _SBXITEM_HXX
+
+#include "scriptdocument.hxx"
+
+#ifndef _SFXPOOLITEM_HXX //autogen
+#include <svtools/poolitem.hxx>
+#endif
+
+const USHORT BASICIDE_TYPE_UNKNOWN  =   0;
+const USHORT BASICIDE_TYPE_SHELL    =   1;
+const USHORT BASICIDE_TYPE_LIBRARY  =   2;
+const USHORT BASICIDE_TYPE_MODULE   =   3;
+const USHORT BASICIDE_TYPE_DIALOG   =   4;
+const USHORT BASICIDE_TYPE_METHOD   =   5;
+
+
+class SbxItem : public SfxPoolItem
+{
+    ScriptDocument          m_aDocument;
+    String                  m_aLibName;
+    String                  m_aName;
+    String                  m_aMethodName;
+    USHORT                  m_nType;
+
+public:
+    TYPEINFO();
+    SbxItem( USHORT nWhich, const ScriptDocument& rDocument, const String& aLibName, const String& aName, USHORT nType );
+    SbxItem( USHORT nWhich, const ScriptDocument& rDocument, const String& aLibName, const String& aName, const String& aMethodName, USHORT nType );
+    SbxItem( const SbxItem& );
+
+    virtual SfxPoolItem*    Clone( SfxItemPool *pPool = 0 ) const;
+    virtual int             operator==( const SfxPoolItem& ) const;
+
+    const ScriptDocument&
+                            GetDocument() const { return m_aDocument; }
+    void                    SetDocument( const ScriptDocument& rDocument ) { m_aDocument = rDocument; }
+
+    const String&           GetLibName() const { return m_aLibName; }
+    void                    SetLibName( const String& aLibName ) { m_aLibName = aLibName; }
+
+    const String&           GetName() const { return m_aName; }
+    void                    SetName( const String& aName ) { m_aName = aName; }
+
+    const String&           GetMethodName() const { return m_aMethodName; }
+    void                    SetMethodName( const String& aMethodName ) { m_aMethodName = aMethodName; }
+
+    USHORT                  GetType() const { return m_nType; }
+    void                    SetType( USHORT nType ) { m_nType = nType; }
+};
+
+
+#endif
diff --git a/basctl/source/inc/scriptdocument.hxx b/basctl/source/inc/scriptdocument.hxx
new file mode 100644
index 000000000000..2f5bde175d3d
--- /dev/null
+++ b/basctl/source/inc/scriptdocument.hxx
@@ -0,0 +1,526 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: scriptdocument.hxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: obo $ $Date: 2007-03-15 16:03:22 $
+ *
+ *  The Contents of this file are made available subject to
+ *  the terms of GNU Lesser General Public License Version 2.1.
+ *
+ *
+ *    GNU Lesser General Public License Version 2.1
+ *    =============================================
+ *    Copyright 2005 by Sun Microsystems, Inc.
+ *    901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *    This library is free software; you can redistribute it and/or
+ *    modify it under the terms of the GNU Lesser General Public
+ *    License version 2.1, as published by the Free Software Foundation.
+ *
+ *    This library is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *    Lesser General Public License for more details.
+ *
+ *    You should have received a copy of the GNU Lesser General Public
+ *    License along with this library; if not, write to the Free Software
+ *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *    MA  02111-1307  USA
+ *
+ ************************************************************************/
+
+#ifndef SCRIPTDOCUMENT_HXX
+#define SCRIPTDOCUMENT_HXX
+
+/** === begin UNO includes === **/
+#ifndef _COM_SUN_STAR_SCRIPT_XLIBRARYCONTAINER_HPP_
+#include <com/sun/star/script/XLibraryContainer.hpp>
+#endif
+#ifndef _COM_SUN_STAR_FRAME_XMODEL_HPP_
+#include <com/sun/star/frame/XModel.hpp>
+#endif
+#ifndef _COM_SUN_STAR_TASK_XSTATUSINDICATORFACTORY_HPP_
+#include <com/sun/star/task/XStatusIndicator.hpp>
+#endif
+#ifndef _COM_SUN_STAR_IO_XINPUTSTREAMPROVIDER_HPP_
+#include <com/sun/star/io/XInputStreamProvider.hpp>
+#endif
+/** === end UNO includes === **/
+
+#include <boost/shared_ptr.hpp>
+#include <vector>
+
+class SfxObjectShell;
+class BasicManager;
+class SfxListener;
+
+//........................................................................
+namespace basctl
+{
+//........................................................................
+
+    //====================================================================
+    //= LibraryContainerType
+    //====================================================================
+    enum LibraryContainerType
+    {
+        E_SCRIPTS,
+        E_DIALOGS
+    };
+
+    enum LibraryLocation
+    {
+        LIBRARY_LOCATION_UNKNOWN,
+        LIBRARY_LOCATION_USER,
+        LIBRARY_LOCATION_SHARE,
+        LIBRARY_LOCATION_DOCUMENT
+    };
+
+    enum LibraryType
+    {
+        LIBRARY_TYPE_UNKNOWN,
+        LIBRARY_TYPE_MODULE,
+        LIBRARY_TYPE_DIALOG,
+        LIBRARY_TYPE_ALL
+    };
+
+    //====================================================================
+    //= ScriptDocument
+    //====================================================================
+    class ScriptDocument_Impl;
+
+    class ScriptDocument;
+    typedef ::std::vector< ScriptDocument >  ScriptDocuments;
+
+    /** encapsulates a document which contains Basic scripts and dialogs
+    */
+    class ScriptDocument
+    {
+    private:
+        ::boost::shared_ptr< ScriptDocument_Impl > m_pImpl;
+
+    private:
+        /** creates a ScriptDocument instance which operates on the application-wide
+            scripts and dialogs
+        */
+                    ScriptDocument();
+
+    public:
+        enum SpecialDocument { NoDocument };
+        /** creates a ScriptDocument instance which does refers to neither the application-wide,
+            nor a specific real document's scripts.
+
+            This constructor might come handy when you need some kind of uninitialized
+            ScriptDocument, which you do not want to operate on (yet), but initialize later
+            by assignment.
+
+            <member>isValid</member> will return <FALSE/> for a ScriptDocument constructed
+            this way.
+        */
+        explicit    ScriptDocument( SpecialDocument _eType );
+
+        /** creates a ScriptDocument instance which refers to a document given as
+            SfxObjectShell
+        */
+        explicit    ScriptDocument( SfxObjectShell& _rShell );
+
+        /** creates a ScriptDocument instance which refers to a document given as
+            XModel
+
+            @param _rxDocument
+                the document. Must not be <NULL/>.
+        */
+        explicit    ScriptDocument( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& _rxDocument );
+
+        /// copy constructor
+                    ScriptDocument( const ScriptDocument& _rSource );
+
+        /// destructor
+                    ~ScriptDocument();
+
+        /** returns a reference to a shared ScriptDocument instance which
+            operates on the application-wide scripts and dialogs
+        */
+        static const ScriptDocument&
+                    getApplicationScriptDocument();
+
+        /** returns a (newly created) ScriptDocument instance for the document to
+            which a given BasicManager belongs
+
+            If the basic manager is the application's basic manager, then the (shared)
+            ScriptDocument instance which is responsible for the application is returned.
+
+            @see getApplicationScriptDocument
+        */
+        static ScriptDocument
+                    getDocumentForBasicManager( const BasicManager* _pManager );
+
+        /** returns a (newly created) ScriptDocument instance for the document
+            with a given caption
+
+            If there is no document with the given caption, then the (shared)
+            ScriptDocument instance which is responsible for the application is returned.
+
+            @see getApplicationScriptDocument
+        */
+        static ScriptDocument
+                    getDocumentWithCaption( const ::rtl::OUString& _rCaption );
+
+        /** returns the set of ScriptDocument instances, one for each open document which
+            contains Basic/Dialog containers; plus an additional instance for
+            the application, if desired
+
+            Documents which are not visible - i.e. do not have a visible frame.
+
+            @param _bIncludingApplication
+                <TRUE/> if the application-wide scripts/dialogs should also be represented
+                by a ScriptDocument
+        */
+        static ScriptDocuments
+                    getAllScriptDocuments( bool _bIncludingApplication );
+
+        // comparison
+                bool operator==( const ScriptDocument& _rhs ) const;
+        inline  bool operator!=( const ScriptDocument& _rhs ) const { return !( *this == _rhs ); }
+
+        /// retrieves a (pretty simple) hash code for the document
+        sal_Int32   hashCode() const;
+
+        /** determines whether the document is actually able to contain
+            Basic/Dialog libraries
+
+            @return
+                <TRUE/> if the instance refers to a document which contains Basic/Dialog libraries,
+                or the application as a whole, <FALSE/> otherwise.
+        */
+        bool        isValid() const;
+
+        /// returns the BasicManager associated with this instance
+        BasicManager*
+                    getBasicManager() const;
+
+        /** returns the UNO component representing the document which the instance operates on
+
+            Must not be used when the instance operates on the application-wide
+            Basic/Dialog libraries.
+        */
+        ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >
+                    getDocument() const;
+
+        /** returns the UNO component representing the document which the instance operates on
+
+            May be used when the instance operates on the application-wide
+            Basic/Dialog libraries, in this case it returns <NULL/>.
+        */
+        ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >
+                    getDocumentOrNull() const;
+
+        /** returns the Basic or Dialog library container of the document
+
+            If the document is not valid, <NULL/> is returned.
+            @see isValid
+        */
+        ::com::sun::star::uno::Reference< ::com::sun::star::script::XLibraryContainer >
+                    getLibraryContainer( LibraryContainerType _eType ) const;
+
+        /** determines whether there exists a library of the given type, with the given name
+        */
+        bool        hasLibrary( LibraryContainerType _eType, const ::rtl::OUString& _rLibName ) const;
+
+        /** returns a script or dialog library given by name
+
+            @param _eType
+                the type of library to load
+            @param _rLibName
+                the name of the script library
+            @param _bLoadLibrary
+                <TRUE/> if and only if the library should be loaded.
+
+            @throws NoSuchElementException
+                if there is no script library with the given name
+        */
+        ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameContainer >
+                    getLibrary( LibraryContainerType _eType, const ::rtl::OUString& _rLibName, bool _bLoadLibrary ) const
+                        SAL_THROW((::com::sun::star::container::NoSuchElementException));
+
+        /** creates a script or dialog library in the document, or returns an existing one
+
+            If <code>_rLibName</code> denotes an existing library which does not need to be created,
+            then this library will automatically be loaded, and then returned.
+        */
+        ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameContainer >
+                    getOrCreateLibrary( LibraryContainerType _eType, const ::rtl::OUString& _rLibName ) const;
+
+        /** returns the names of the modules in a given script or dialog library of the document
+        */
+        ::com::sun::star::uno::Sequence< ::rtl::OUString >
+                    getObjectNames( LibraryContainerType _eType, const ::rtl::OUString& _rLibName ) const;
+
+        /** retrieves a name for a newly to be created module or dialog
+        */
+        ::rtl::OUString
+                    createObjectName( LibraryContainerType _eType, const ::rtl::OUString& _rLibName ) const;
+
+        /** loads a script or dialog library given by name, if there is such a library
+        */
+        void        loadLibraryIfExists( LibraryContainerType _eType, const ::rtl::OUString& _rLibrary );
+
+        /// retrieves the (combined) names of all script and dialog libraries
+        ::com::sun::star::uno::Sequence< ::rtl::OUString >
+                    getLibraryNames() const;
+
+        /** removes a given script module from the document
+
+            @return
+                <TRUE/> if and only if the removal was successful. When <FALSE/> is returned,
+                this will reported as assertion in a non-product build.
+        */
+        bool        removeModule( const ::rtl::OUString& _rLibName, const ::rtl::OUString& _rModuleName ) const;
+
+        /** creates a module with the given name in the given library
+            @param  _rLibName
+                the library name
+            @param  _rModName
+                the name of the to-be-created module
+            @param  _bCreateMain
+                determines whether or not a function Main should be created
+            @param  _out_rNewModuleCode
+                the source code of the newly created module
+            @return
+                <TRUE/> if and only if the creation was successful
+        */
+        bool        createModule( const ::rtl::OUString& _rLibName, const ::rtl::OUString& _rModName, bool _bCreateMain, ::rtl::OUString& _out_rNewModuleCode ) const;
+
+        /** inserts a given piece as code as module
+            @param  _rLibName
+                the name of the library to insert the module into. If a library with this name does
+                not yet exist, it will be created.
+            @param  _rModName
+                the name of the module to insert the code as. Must denote a name which is not yet
+                used in the module library.
+            @param  _rModuleCode
+                the code of the new module
+            @return
+                <TRUE/> if and only if the insertion was successful.
+        */
+        bool        insertModule( const ::rtl::OUString& _rLibName, const ::rtl::OUString& _rModName, const ::rtl::OUString& _rModuleCode ) const;
+
+        /** updates a given module with new code
+            @param  _rLibName
+                the name of the library the modules lives in. Must denote an existing module library.
+            @param  _rModName
+                the name of the module to update. Must denote an existing module in the given library.
+            @param  _rModuleCode
+                the new module code.
+            @return
+                <TRUE/> if and only if the insertion was successful.
+        */
+        bool        updateModule( const ::rtl::OUString& _rLibName, const ::rtl::OUString& _rModName, const ::rtl::OUString& _rModuleCode ) const;
+
+        /// determines whether a module with the given name exists in the given library
+        bool        hasModule( const ::rtl::OUString& _rLibName, const ::rtl::OUString& _rModName ) const;
+
+        /** retrieves a module's source
+            @param  _rLibName
+                the library name where the module is located
+            @param  _rModName
+                the module name
+            @param  _out_rModuleSource
+                takes the module's source upon successful return
+            @return
+                <TRUE/> if and only if the code could be successfully retrieved, <FALSE/> otherwise
+        */
+        bool        getModule( const ::rtl::OUString& _rLibName, const ::rtl::OUString& _rModName, ::rtl::OUString& _rModuleSource ) const;
+
+        /** renames a module
+            @param  _rLibName
+                the library where the module lives in. Must denote an existing library.
+            @param  _rOldName
+                the old module name. Must denote an existing module.
+            @param  _rNewName
+                the new module name
+            @return
+                <TRUE/> if and only if renaming was successful.
+        */
+        bool        renameModule( const ::rtl::OUString& _rLibName, const ::rtl::OUString& _rOldName, const ::rtl::OUString& _rNewName ) const;
+
+        /** removes a given dialog from the document
+
+            @return
+                <TRUE/> if and only if the removal was successful. When <FALSE/> is returned,
+                this will reported as assertion in a non-product build.
+        */
+        bool        removeDialog( const ::rtl::OUString& _rLibName, const ::rtl::OUString& _rDialogName ) const;
+
+        /// determines whether a dialog with the given name exists in the given library
+        bool        hasDialog( const ::rtl::OUString& _rLibName, const ::rtl::OUString& _rDialogName ) const;
+
+        /** retrieves a dialog
+            @param  _rLibName
+                the library name where the module is located
+            @param  _rDialogName
+                the dialog's name
+            @param  _out_rDialogSource
+                takes the provider for the dialog's desription, upon successful return
+            @return
+                <TRUE/> if and only if the dialog could be successfully retrieved, <FALSE/> otherwise
+        */
+        bool        getDialog(
+                        const ::rtl::OUString& _rLibName,
+                        const ::rtl::OUString& _rDialogName,
+                        ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStreamProvider >& _out_rDialogProvider
+                    ) const;
+
+        /** renames a dialog
+            @param  _rLibName
+                the library where the dialog lives in. Must denote an existing library.
+            @param  _rOldName
+                the old dialog name. Must denote an existing dialog.
+            @param  _rNewName
+                the new dialog name
+            @param _rxExistingDialogModel
+                the existing model of the dialog, if already loaded in the IDE
+            @return
+                <TRUE/> if and only if renaming was successful.
+        */
+        bool        renameDialog(
+                        const ::rtl::OUString& _rLibName,
+                        const ::rtl::OUString& _rOldName,
+                        const ::rtl::OUString& _rNewName,
+                        const ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameContainer >& _rxExistingDialogModel
+                    ) const;
+
+        /** create a dialog
+            @param  _rLibName
+                the library name where the module is located
+            @param  _rDialogName
+                the dialog's name
+            @param  _out_rDialogSource
+                takes the provider for the dialog's desription, upon successful return
+            @return
+                <TRUE/> if and only if the dialog could be successfully retrieved, <FALSE/> otherwise
+        */
+        bool        createDialog(
+                        const ::rtl::OUString& _rLibName,
+                        const ::rtl::OUString& _rDialogName,
+                        ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStreamProvider >& _out_rDialogProvider
+                    ) const;
+
+        /** inserts a given dialog into a given library
+
+            @param  _rLibName
+                the name of the library to insert the dialog into. If a library with this name does
+                not yet exist, it will be created.
+            @param  _rModName
+                the name of the dialog to insert. Must denote a name which is not yet
+                used in the dialog library.
+            @param  _rDialogProvider
+                the provider of the dialog's description
+            @return
+                <TRUE/> if and only if the insertion was successful.
+        */
+        bool        insertDialog(
+                        const ::rtl::OUString& _rLibName,
+                        const ::rtl::OUString& _rDialogName,
+                        const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStreamProvider >& _rDialogProvider
+                    ) const;
+
+        /** determines whether the document is read-only
+
+            cannot be called if the document operates on the application-wide scripts
+        */
+        bool        isReadOnly() const;
+
+        /** determines whether the ScriptDocument instance operates on the whole application,
+            as opposed to a real document
+        */
+        bool        isApplication() const;
+
+        /** determines whether the ScriptDocument instance operates on a real document,
+            as opposed to the whole application
+        */
+        bool        isDocument() const { return !isApplication(); }
+
+        /** marks the document as modified
+            @precond
+                the instance operates on a real document, not on the application
+            @see isDocument
+        */
+        void        setDocumentModified() const;
+
+        /** determines whether the document is modified
+            @precond
+                the instance operates on a real document, not on the application
+            @see isDocument
+        */
+        bool        isDocumentModified() const;
+
+        /** saves the document, if the instance refers to a real document
+            @precond
+                <code>isApplication</code> returns <FALSE/>
+        */
+        bool        saveDocument(
+                        const ::com::sun::star::uno::Reference< ::com::sun::star::task::XStatusIndicator >& _rxStatusIndicator
+                    ) const;
+
+        /// returns the location of a library given by name
+        LibraryLocation
+                    getLibraryLocation( const ::rtl::OUString& _rLibName ) const;
+
+        /// returns the title for the document
+        ::rtl::OUString
+                    getTitle( LibraryLocation _eLocation, LibraryType _eType = LIBRARY_TYPE_ALL ) const;
+
+        /// determines whether the document is currently being closed
+        bool        isClosing() const;
+
+        /** determines whether the document is currently the one-and-only application-wide active document
+        */
+        bool        isActive() const;
+
+        /// signs the scripting content inside the document
+        void        signScriptingContent() const;
+        /// retrieves the state of the signature of the scripting content inside the document
+        sal_uInt16  getScriptingSignatureState() const;
+        /// ???
+        void        adjustMacroMode( const ::rtl::OUString& _rScriptType ) const;
+        /** retrives the current macro execution mode
+            only to be called for real documents (->isDocument)
+        */
+        sal_Int16   getMacroMode() const;
+
+        // legacy functionality, to be removed when the whole thing has been
+        // migrated to XModel instead of SfxObjectShell
+               void LEGACY_startDocumentListening( SfxListener& _rListener ) const;
+        static void LEGACY_setWorkingDocument( const ScriptDocument& _rxDocument );
+        static void LEGACY_resetWorkingDocument();
+        static ScriptDocument
+                    LEGACY_getWorkingDocument();
+    };
+
+//........................................................................
+} // namespace basctl
+//........................................................................
+
+// convenience ... better would be all classes in the project are in
+// the same namespace ...
+using ::basctl::ScriptDocument;
+using ::basctl::ScriptDocuments;
+using ::basctl::E_SCRIPTS;
+using ::basctl::E_DIALOGS;
+using ::basctl::LibraryLocation;
+using ::basctl::LIBRARY_LOCATION_UNKNOWN;
+using ::basctl::LIBRARY_LOCATION_USER;
+using ::basctl::LIBRARY_LOCATION_SHARE;
+using ::basctl::LIBRARY_LOCATION_DOCUMENT;
+using ::basctl::LibraryType;
+using ::basctl::LIBRARY_TYPE_UNKNOWN;
+using ::basctl::LIBRARY_TYPE_MODULE;
+using ::basctl::LIBRARY_TYPE_DIALOG;
+using ::basctl::LIBRARY_TYPE_ALL;
+
+#endif // SCRIPTDOCUMENT_HXX