office-gobmx/framework/inc/dispatch/servicehandler.hxx
Vincent LE GARREC 90c978f839 tdf#124176 Use pragma once in f*
filter, forms, fpicker, framework

Change-Id: I55a25ad2dc3749e63465e638e8eeea3c322eabbf
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/112047
Tested-by: Jenkins
Reviewed-by: Ilmari Lauhakangas <ilmari.lauhakangas@libreoffice.org>
2021-03-23 13:07:09 +01:00

100 lines
5.3 KiB
C++

/* -*- 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/frame/XNotifyingDispatch.hpp>
#include <com/sun/star/frame/XDispatch.hpp>
#include <com/sun/star/frame/XDispatchProvider.hpp>
#include <com/sun/star/util/URL.hpp>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/frame/XStatusListener.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <cppuhelper/implbase.hxx>
namespace framework{
/**
@short protocol handler for "service:*" URLs
@descr It's a special dispatch/provider object which is registered for such URL pattern and will
be automatically used by the framework dispatch mechanism if such URL occurred.
His job is to create any registered uno components which must be coded inside
dispatched URL (may with some optional given parameters). After that such created
service must be hold his self alive. Such mechanism can be useful for UI components
(e.g. Dialogs, Wizards) only.
@base OWeakObject
provides XWeak and ref count mechanism
@devstatus ready to use
*/
class ServiceHandler final : public ::cppu::WeakImplHelper<
css::lang::XServiceInfo ,
css::frame::XDispatchProvider ,
css::frame::XNotifyingDispatch > // => XDispatch
{
/* member */
private:
/// reference to global uno service manager which had created us
css::uno::Reference< css::uno::XComponentContext > m_xContext;
/* interface */
public:
// ctor/dtor
ServiceHandler( const css::uno::Reference< css::uno::XComponentContext >& );
virtual ~ServiceHandler( ) override;
/* 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;
// XDispatchProvider
virtual css::uno::Reference< css::frame::XDispatch > SAL_CALL queryDispatch ( const css::util::URL& aURL ,
const OUString& sTarget ,
sal_Int32 nFlags ) override;
virtual css::uno::Sequence< css::uno::Reference< css::frame::XDispatch > > SAL_CALL queryDispatches( const css::uno::Sequence< css::frame::DispatchDescriptor >& lDescriptor ) override;
// XNotifyingDispatch
virtual void SAL_CALL dispatchWithNotification( const css::util::URL& aURL ,
const css::uno::Sequence< css::beans::PropertyValue >& lArguments,
const css::uno::Reference< css::frame::XDispatchResultListener >& xListener ) override;
// XDispatch
virtual void SAL_CALL dispatch ( const css::util::URL& aURL ,
const css::uno::Sequence< css::beans::PropertyValue >& lArguments ) override;
virtual void SAL_CALL addStatusListener ( const css::uno::Reference< css::frame::XStatusListener >& xListener ,
const css::util::URL& aURL ) override;
virtual void SAL_CALL removeStatusListener( const css::uno::Reference< css::frame::XStatusListener >& xListener ,
const css::util::URL& aURL ) override;
/* internal */
private:
/// @throws css::uno::RuntimeException
css::uno::Reference< css::uno::XInterface > implts_dispatch( const css::util::URL& aURL );
}; // class ServiceHandler
} // namespace framework
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */