docmacromode.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 .
 */
 
#ifndef INCLUDED_SFX2_DOCMACROMODE_HXX
#define INCLUDED_SFX2_DOCMACROMODE_HXX
 
#include <sfx2/dllapi.h>
#include <sfx2/signaturestate.hxx>
 
#include <com/sun/star/uno/Reference.hxx>
 
#include <memory>
 
namespace com::sun::star::document { class XEmbeddedScripts; }
namespace com::sun::star::embed { class XStorage; }
namespace com::sun::star::script { class XLibraryContainer; }
namespace com::sun::star::task { class XInteractionHandler; }
 
 
namespace sfx2
{
 
 
    //= IMacroDocumentAccess
 
    class SAL_NO_VTABLE IMacroDocumentAccess
    {
    public:
        virtual sal_Int16
                    getCurrentMacroExecMode() const = 0;
 
        virtual void
                    setCurrentMacroExecMode( sal_uInt16 ) = 0;
 
        virtual OUString
                    getDocumentLocation() const = 0;
 
        virtual bool
                    documentStorageHasMacros() const = 0;
 
        virtual bool
                    macroCallsSeenWhileLoading() const = 0;
 
        virtual css::uno::Reference< css::document::XEmbeddedScripts >
                    getEmbeddedDocumentScripts() const = 0;
 
        virtual SignatureState
                    getScriptingSignatureState() = 0;
 
        virtual bool
                    hasTrustedScriptingSignature( bool bAllowUIToAddAuthor ) = 0;
 
    protected:
        ~IMacroDocumentAccess() {}
    };
 
 
    //= DocumentMacroMode
 
    struct DocumentMacroMode_Data;
 
    class SFX2_DLLPUBLIC DocumentMacroMode
    {
    public:
        DocumentMacroMode( IMacroDocumentAccess& _rDocumentAccess );
 
        bool    allowMacroExecution();
 
        bool    disallowMacroExecution();
 
        bool    adjustMacroMode(
                    const css::uno::Reference< css::task::XInteractionHandler >& _rxInteraction,
                    bool bHasValidContentSignature = false
                );
 
        bool    isMacroExecutionDisallowed() const;
 
        bool    hasMacroLibrary() const;
 
        bool hasUnsignedContentError() const;
 
        static bool storageHasMacros( const css::uno::Reference< css::embed::XStorage >& _rxStorage );
 
        static bool containerHasBasicMacros( const css::uno::Reference< css::script::XLibraryContainer >& xContainer );
        bool
                checkMacrosOnLoading(
                    const css::uno::Reference< css::task::XInteractionHandler >& _rxInteraction,
                    bool bHasValidContentSignature = false
                );
 
    private:
        std::shared_ptr< DocumentMacroMode_Data >   m_xData;
    };
 
 
} // namespace sfx2
 
 
#endif // INCLUDED_SFX2_DOCMACROMODE_HXX
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */