office-gobmx/include/framework/interaction.hxx
Bjoern Michaelsen b9337e22ce execute move of global headers
see https://gerrit.libreoffice.org/#/c/3367/
and Change-Id: I00c96fa77d04b33a6f8c8cd3490dfcd9bdc9e84a for details

Change-Id: I199a75bc4042af20817265d5ef85b1134a96ff5a
2013-04-23 22:20:31 +02:00

103 lines
4.5 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 __FRAMEWORK_DISPATCH_INTERACTION_HXX_
#define __FRAMEWORK_DISPATCH_INTERACTION_HXX_
#include <com/sun/star/task/XInteractionRequest.hpp>
#include <com/sun/star/task/XInteractionContinuation.hpp>
#include <com/sun/star/task/XInteractionAbort.hpp>
#include <com/sun/star/task/XInteractionApprove.hpp>
#include <com/sun/star/task/XInteractionDisapprove.hpp>
#include <com/sun/star/task/XInteractionRetry.hpp>
#include <com/sun/star/document/XInteractionFilterSelect.hpp>
#include <com/sun/star/document/NoSuchFilterRequest.hpp>
#include <com/sun/star/document/AmbigousFilterRequest.hpp>
#include <com/sun/star/uno/RuntimeException.hpp>
#include <rtl/ustring.hxx>
#include <cppuhelper/implbase1.hxx>
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/uno/Sequence.hxx>
#include <framework/fwedllapi.h>
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
@base WeakImplHelper1
@devstatus ready to use
@threadsafe no (used on once position only!)
*//*-*************************************************************************************************************/
class RequestFilterSelect_Impl;
class FWE_DLLPUBLIC RequestFilterSelect
{
RequestFilterSelect_Impl* pImp;
public:
RequestFilterSelect( const OUString& sURL );
~RequestFilterSelect();
sal_Bool isAbort () const;
OUString getFilter() const;
com::sun::star::uno::Reference < ::com::sun::star::task::XInteractionRequest > GetRequest();
};
/*-************************************************************************************************************//**
@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
@base WeakImplHelper1
@devstatus ready to use
@threadsafe no (used on once position only!)
*//*-*************************************************************************************************************/
class FWE_DLLPUBLIC InteractionRequest
{
public:
static com::sun::star::uno::Reference < ::com::sun::star::task::XInteractionRequest >
CreateRequest( const ::com::sun::star::uno::Any& aRequest,
const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > > lContinuations );
};
} // namespace framework
#endif // #define __FRAMEWORK_DISPATCH_INTERACTION_HXX_
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */