office-gobmx/include/framework/interaction.hxx
Noel Grandin e859bf8c4d loplugin:constmethod
Change-Id: I7913fd8144d521b8293ac43036d0fad82e457cd1
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/115145
Tested-by: Jenkins
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
2021-05-05 18:50:51 +02:00

105 lines
4.1 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 .
*/
#ifndef INCLUDED_FRAMEWORK_INTERACTION_HXX
#define INCLUDED_FRAMEWORK_INTERACTION_HXX
#include <config_options.h>
#include <rtl/ref.hxx>
#include <rtl/ustring.hxx>
#include <com/sun/star/uno/Reference.hxx>
#include <framework/fwkdllapi.h>
namespace com::sun::star::task
{
class XInteractionContinuation;
}
namespace com::sun::star::task
{
class XInteractionRequest;
}
namespace com::sun::star::uno
{
template <class E> class Sequence;
}
namespace framework
{
/*-************************************************************************************************************
@short special request for interaction to ask user for right filter
@descr These helper can be used to ask user for right filter, if filter detection failed.
It capsulate communication with any interaction handler and supports an easy
access on interaction results for user of these class.
Use it and forget complex mechanism of interaction ...
@example RequestFilterSelect* pRequest = new RequestFilterSelect;
Reference< XInteractionRequest > xRequest ( pRequest );
xInteractionHandler->handle( xRequest );
if( ! pRequest.isAbort() )
{
OUString sFilter = pRequest->getFilter();
}
@implements XInteractionRequest
@devstatus ready to use
@threadsafe no (used on once position only!)
*/ /*-*************************************************************************************************************/
class RequestFilterSelect_Impl;
class UNLESS_MERGELIBS(FWK_DLLPUBLIC) RequestFilterSelect
{
rtl::Reference<RequestFilterSelect_Impl> mxImpl;
public:
RequestFilterSelect(const OUString& sURL);
~RequestFilterSelect();
RequestFilterSelect& operator=(RequestFilterSelect const&) = delete; // MSVC2019 workaround
RequestFilterSelect(RequestFilterSelect const&) = delete; // MSVC2019 workaround
bool isAbort() const;
OUString getFilter() const;
css::uno::Reference<css::task::XInteractionRequest> GetRequest() const;
};
/*-************************************************************************************************************
@short special request for interaction
@descr User must decide between a preselected and another detected filter.
It capsulate communication with any interaction handler and supports an easy
access on interaction results for user of these class.
@implements XInteractionRequest
@devstatus ready to use
@threadsafe no (used on once position only!)
*/ /*-*************************************************************************************************************/
class FWK_DLLPUBLIC InteractionRequest
{
public:
static css::uno::Reference<css::task::XInteractionRequest> CreateRequest(
const css::uno::Any& aRequest,
const css::uno::Sequence<css::uno::Reference<css::task::XInteractionContinuation>>&
lContinuations);
};
} // namespace framework
#endif // #define INCLUDED_FRAMEWORK_INTERACTION_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */