interceptedinteraction.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_UCBHELPER_INTERCEPTEDINTERACTION_HXX
#define INCLUDED_UCBHELPER_INTERCEPTEDINTERACTION_HXX
 
#include <vector>
 
#include <com/sun/star/task/XInteractionHandler.hpp>
 
#include <cppuhelper/implbase.hxx>
#include <ucbhelper/ucbhelperdllapi.h>
 
namespace com::sun::star::task { class XInteractionRequest; }
 
 
namespace ucbhelper{
 
 
// extra struct to work around MSVC linking issue
struct InterceptedInteraction_Base : public ::cppu::WeakImplHelper< css::task::XInteractionHandler > {};
 
class UCBHELPER_DLLPUBLIC InterceptedInteraction : public InterceptedInteraction_Base
{
 
    // types
    public:
 
        struct InterceptedRequest
        {
 
            static const sal_Int32 INVALID_HANDLE = -1;
 
 
            css::uno::Any Request;
 
 
            css::uno::Type Continuation;
 
 
            sal_Int32 Handle;
 
 
            InterceptedRequest()
            {
                Handle     = INVALID_HANDLE;
            }
            InterceptedRequest(css::uno::Any Request_, css::uno::Type Continuation_, sal_Int32 Handle_)
                : Request(std::move(Request_)), Continuation(std::move(Continuation_)), Handle(Handle_)
            {
            }
 
        };
 
 
        enum EInterceptionState
        {
            E_NOT_INTERCEPTED,
            E_NO_CONTINUATION_FOUND,
            E_INTERCEPTED
        };
 
 
    // member
    protected:
 
 
        css::uno::Reference< css::task::XInteractionHandler > m_xInterceptedHandler;
 
 
        ::std::vector< InterceptedRequest > m_lInterceptions;
 
 
    // native interface
    public:
 
 
        InterceptedInteraction();
 
 
        void setInterceptedHandler(const css::uno::Reference< css::task::XInteractionHandler >& xInterceptedHandler);
 
 
        void setInterceptions(::std::vector< InterceptedRequest >&& lInterceptions);
 
 
        static css::uno::Reference< css::task::XInteractionContinuation > extractContinuation(
                    const css::uno::Sequence< css::uno::Reference< css::task::XInteractionContinuation > >& lContinuations,
                    const css::uno::Type&                                                                                             aType         );
 
 
    // usable for derived classes
    protected:
 
 
        virtual EInterceptionState intercepted(const InterceptedRequest&                                                             rRequest   ,
                                               const css::uno::Reference< css::task::XInteractionRequest >& xOrgRequest);
 
 
    // uno interface
    public:
 
 
        virtual void SAL_CALL handle(const css::uno::Reference< css::task::XInteractionRequest >& xRequest) override;
 
 
    // helper
    private:
 
 
        UCBHELPER_DLLPRIVATE void impl_handleDefault(const css::uno::Reference< css::task::XInteractionRequest >& xRequest);
 
 
        UCBHELPER_DLLPRIVATE EInterceptionState impl_interceptRequest(const css::uno::Reference< css::task::XInteractionRequest >& xRequest);
};
 
} // namespace ucbhelper
 
#endif // INCLUDED_UCBHELPER_INTERCEPTEDINTERACTION_HXX
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */