helponstartup.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 <sal/config.h>
 
#include <mutex>
#include <string_view>
 
#include <cppuhelper/implbase.hxx>
 
#include <com/sun/star/task/XJob.hpp>
#include <com/sun/star/lang/XEventListener.hpp>
#include <com/sun/star/container/XNameAccess.hpp>
#include <com/sun/star/frame/XDesktop2.hpp>
#include <com/sun/star/frame/XModuleManager2.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/uno/XComponentContext.hpp>
 
namespace framework{
 
class HelpOnStartup final : public ::cppu::WeakImplHelper< css::lang::XServiceInfo,css::lang::XEventListener,css::task::XJob >
{
 
    // member
    private:
        std::mutex m_mutex;
 
        css::uno::Reference< css::uno::XComponentContext > m_xContext;
 
        css::uno::Reference< css::frame::XModuleManager2 > m_xModuleManager;
 
        css::uno::Reference< css::frame::XDesktop2 > m_xDesktop;
 
        css::uno::Reference< css::container::XNameAccess > m_xConfig;
 
        OUString m_sLocale;
 
        OUString m_sSystem;
 
    // native interface
    public:
 
        HelpOnStartup(css::uno::Reference< css::uno::XComponentContext > xContext);
 
        virtual ~HelpOnStartup() override;
 
    // uno interface
    public:
 
        /* interface XServiceInfo */
        virtual OUString SAL_CALL getImplementationName() override;
        virtual sal_Bool SAL_CALL supportsService( const OUString& sServiceName ) override;
        virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
 
        // css.task.XJob
        virtual css::uno::Any SAL_CALL execute(const css::uno::Sequence< css::beans::NamedValue >& lArguments) override;
 
        // css.lang.XEventListener
        virtual void SAL_CALL disposing(const css::lang::EventObject& aEvent) override;
 
    // helper
    private:
 
        OUString its_getModuleIdFromEnv(const css::uno::Sequence< css::beans::NamedValue >& lArguments);
 
        OUString its_getCurrentHelpURL();
 
        bool its_isHelpUrlADefaultOne(std::u16string_view sHelpURL);
 
        OUString its_checkIfHelpEnabledAndGetURL(const OUString& sModule);
 
        static OUString ist_createHelpURL(std::u16string_view sBaseURL,
                                                 std::u16string_view sLocale ,
                                                 std::u16string_view sSystem );
};
 
} // namespace framework
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */