loadenv.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 <loadenv/actionlockguard.hxx>
 
#include <com/sun/star/frame/XComponentLoader.hpp>
#include <com/sun/star/frame/XFrame.hpp>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <com/sun/star/util/URL.hpp>
#include <rtl/ref.hxx>
#include <unotools/mediadescriptor.hxx>
#include <o3tl/typed_flags_set.hxx>
 
 
enum class LoadEnvFeatures
{
    NONE = 0,
    WorkWithUI = 1,
    AllowContentHandler = 2
};
namespace o3tl {
    template<> struct typed_flags<LoadEnvFeatures> : is_typed_flags<LoadEnvFeatures, 0x3> {};
}
 
 
namespace framework {
 
class QuietInteraction;
 
class LoadEnv
{
public:
    enum EContentType
    {
        E_UNSUPPORTED_CONTENT,
        E_CAN_BE_HANDLED,
        E_CAN_BE_LOADED,
        E_CAN_BE_SET
    };
 
private:
    mutable osl::Mutex m_mutex;
 
    css::uno::Reference< css::uno::XComponentContext > m_xContext;
 
    css::uno::Reference< css::frame::XFrame > m_xBaseFrame;
 
    css::uno::Reference< css::frame::XFrame > m_xTargetFrame;
 
    OUString m_sTarget;
 
    sal_Int32 m_nSearchFlags;
 
    utl::MediaDescriptor m_lMediaDescriptor;
 
    css::util::URL m_aURL;
 
    LoadEnvFeatures m_eFeature;
 
    EContentType m_eContentType;
 
    bool m_bCloseFrameOnError;
 
    bool m_bReactivateControllerOnError;
 
    css::uno::Reference< css::uno::XInterface > m_xAsynchronousJob;
 
    bool m_bLoaded;
 
    bool m_bFocusedAndToFront = false;
 
    ActionLockGuard m_aTargetLock;
 
    rtl::Reference<QuietInteraction> m_pQuietInteraction;
 
public:
 
    LoadEnv(css::uno::Reference< css::uno::XComponentContext >  xContext);
 
    ~LoadEnv();
 
    static css::uno::Reference< css::lang::XComponent > loadComponentFromURL(const css::uno::Reference< css::frame::XComponentLoader >&    xLoader,
                                                                             const css::uno::Reference< css::uno::XComponentContext >&     xContext,
                                                                             const OUString&                                        sURL   ,
                                                                             const OUString&                                        sTarget,
                                                                                   sal_Int32                                               nFlags ,
                                                                             const css::uno::Sequence< css::beans::PropertyValue >&        lArgs  );
 
    void startLoading(const OUString&                                           sURL            ,
                           const css::uno::Sequence< css::beans::PropertyValue >&    lMediaDescriptor,
                           const css::uno::Reference< css::frame::XFrame >&          xBaseFrame      ,
                           const OUString&                                           sTarget         ,
                                 sal_Int32                                           nSearchFlags    ,
                                 LoadEnvFeatures                                     eFeature        = LoadEnvFeatures::NONE);
 
    bool waitWhileLoading(sal_uInt32 nTimeout = 0);
 
    css::uno::Reference< css::lang::XComponent > getTargetComponent() const;
 
public:
 
    static EContentType classifyContent(const OUString&                                 sURL            ,
                                        const css::uno::Sequence< css::beans::PropertyValue >& lMediaDescriptor);
 
    static  void initializeUIDefaults(
                const css::uno::Reference< css::uno::XComponentContext >& i_rxContext,
                utl::MediaDescriptor& io_lMediaDescriptor,
                const bool _bUIMode,
                rtl::Reference<QuietInteraction>* o_ppQuiteInteraction
            );
 
    void impl_setResult(bool bResult);
 
    css::uno::Reference< css::uno::XInterface > impl_searchLoader();
 
    void impl_reactForLoadingState();
 
private:
    void start();
 
    void impl_detectTypeAndFilter();
 
    bool impl_handleContent();
 
    bool impl_loadContent();
 
    css::uno::Reference< css::frame::XFrame > impl_searchAlreadyLoaded();
 
    css::uno::Reference< css::frame::XFrame > impl_searchRecycleTarget();
 
    void impl_makeFrameWindowVisible(const css::uno::Reference< css::awt::XWindow >& xWindow      ,
                                           bool                                  bForceToFront);
 
    bool impl_isFrameAlreadyUsedForLoading(const css::uno::Reference< css::frame::XFrame >& xFrame) const;
 
    void impl_applyPersistentWindowState(const css::uno::Reference< css::awt::XWindow >& xWindow);
 
    bool impl_furtherDocsAllowed();
 
    void impl_jumpToMark(const css::uno::Reference< css::frame::XFrame >& xFrame,
                         const css::util::URL&                            aURL  );
 
    bool impl_filterHasInteractiveDialog() const;
 
    bool shouldFocusAndToFront() const;
};
 
} // namespace framework
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */