scriptdocument.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
#pragma once
 
#include <com/sun/star/script/XLibraryContainer.hpp>
#include <com/sun/star/frame/XModel.hpp>
#include <com/sun/star/task/XStatusIndicator.hpp>
#include <com/sun/star/io/XInputStreamProvider.hpp>
 
#include <memory>
#include <vector>
 
class SfxListener;
 
class BasicManager;
 
 
namespace basctl
{
 
    enum LibraryContainerType
    {
        E_SCRIPTS,
        E_DIALOGS
    };
 
    enum LibraryLocation
    {
        LIBRARY_LOCATION_UNKNOWN,
        LIBRARY_LOCATION_USER,
        LIBRARY_LOCATION_SHARE,
        LIBRARY_LOCATION_DOCUMENT
    };
 
    enum class LibraryType
    {
        Module,
        Dialog,
        All
    };
 
    class ScriptDocument;
    typedef std::vector< ScriptDocument >  ScriptDocuments;
 
    class ScriptDocument
    {
    private:
        class Impl;
        std::shared_ptr<Impl> m_pImpl;
 
    private:
                    ScriptDocument();
 
    public:
        enum SpecialDocument { NoDocument };
        explicit    ScriptDocument( SpecialDocument _eType );
 
        explicit    ScriptDocument( const css::uno::Reference< css::frame::XModel >& _rxDocument );
 
        static const ScriptDocument&
                    getApplicationScriptDocument();
 
        static ScriptDocument
                    getDocumentForBasicManager( const BasicManager* _pManager );
 
        static ScriptDocument
                    getDocumentWithURLOrCaption( std::u16string_view _rUrlOrCaption );
 
        enum ScriptDocumentList
        {
            AllWithApplication,
            DocumentsSorted
        };
 
        static ScriptDocuments
                    getAllScriptDocuments( ScriptDocumentList _eListType );
 
        // comparison
                bool operator==( const ScriptDocument& _rhs ) const;
        bool operator!=( const ScriptDocument& _rhs ) const { return !( *this == _rhs ); }
 
        sal_Int32   hashCode() const;
 
        bool        isValid() const;
 
        bool        isAlive() const;
 
        bool        isInVBAMode() const;
        BasicManager*
                    getBasicManager() const;
 
        css::uno::Reference< css::frame::XModel >
                    getDocument() const;
 
        css::uno::Reference< css::frame::XModel >
                    getDocumentOrNull() const;
 
        css::uno::Reference< css::script::XLibraryContainer >
                    getLibraryContainer( LibraryContainerType _eType ) const;
 
        bool        hasLibrary( LibraryContainerType _eType, const OUString& _rLibName ) const;
 
        css::uno::Reference< css::container::XNameContainer >
                    getLibrary( LibraryContainerType _eType, const OUString& _rLibName, bool _bLoadLibrary ) const;
 
        css::uno::Reference< css::container::XNameContainer >
                    getOrCreateLibrary( LibraryContainerType _eType, const OUString& _rLibName ) const;
 
        css::uno::Sequence< OUString >
                    getObjectNames( LibraryContainerType _eType, const OUString& _rLibName ) const;
 
        OUString    createObjectName( LibraryContainerType _eType, const OUString& _rLibName ) const;
 
        void        loadLibraryIfExists( LibraryContainerType _eType, const OUString& _rLibrary );
 
        css::uno::Sequence< OUString >
                    getLibraryNames() const;
 
        bool        removeModule( const OUString& _rLibName, const OUString& _rModuleName ) const;
 
        bool        createModule( const OUString& _rLibName, const OUString& _rModName, bool _bCreateMain, OUString& _out_rNewModuleCode ) const;
 
        bool        insertModule( const OUString& _rLibName, const OUString& _rModName, const OUString& _rModuleCode ) const;
 
        bool        updateModule( const OUString& _rLibName, const OUString& _rModName, const OUString& _rModuleCode ) const;
 
        bool        hasModule( const OUString& _rLibName, const OUString& _rModName ) const;
 
        bool        getModule( const OUString& _rLibName, const OUString& _rModName, OUString& _rModuleSource ) const;
 
        bool        renameModule( const OUString& _rLibName, const OUString& _rOldName, const OUString& _rNewName ) const;
 
        bool        removeDialog( const OUString& _rLibName, const OUString& _rDialogName ) const;
 
        bool        hasDialog( const OUString& _rLibName, const OUString& _rDialogName ) const;
 
        bool        getDialog(
                        const OUString& _rLibName,
                        const OUString& _rDialogName,
                        css::uno::Reference< css::io::XInputStreamProvider >& _out_rDialogProvider
                    ) const;
 
        bool        renameDialog(
                        const OUString& _rLibName,
                        const OUString& _rOldName,
                        const OUString& _rNewName,
                        const css::uno::Reference< css::container::XNameContainer >& _rxExistingDialogModel
                    ) const;
 
        bool        createDialog(
                        const OUString& _rLibName,
                        const OUString& _rDialogName,
                        css::uno::Reference< css::io::XInputStreamProvider >& _out_rDialogProvider
                    ) const;
 
        bool        insertDialog(
                        const OUString& _rLibName,
                        const OUString& _rDialogName,
                        const css::uno::Reference< css::io::XInputStreamProvider >& _rDialogProvider
                    ) const;
 
        bool        isReadOnly() const;
 
        bool        isApplication() const;
 
        bool        isDocument() const { return isValid() && !isApplication(); }
 
        void        setDocumentModified() const;
 
        bool        isDocumentModified() const;
 
        void        saveDocument(
                        const css::uno::Reference< css::task::XStatusIndicator >& _rxStatusIndicator
                    ) const;
 
        LibraryLocation
                    getLibraryLocation( const OUString& _rLibName ) const;
 
        OUString    getTitle( LibraryLocation _eLocation, LibraryType _eType = LibraryType::All ) const;
 
        OUString    getTitle() const;
 
        bool        isActive() const;
 
        bool    allowMacros() const;
    };
 
 
} // namespace basctl
 
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */