include/framework/interaction.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_FRAMEWORK_INTERACTION_HXX
  21 #define INCLUDED_FRAMEWORK_INTERACTION_HXX
  22
  23 #include <rtl/ref.hxx>
  24 #include <rtl/ustring.hxx>
  25 #include <com/sun/star/uno/Reference.hxx>
  26 #include <framework/fwedllapi.h>
  27
  28 namespace com::sun::star::task { class XInteractionContinuation; }
  29 namespace com::sun::star::task { class XInteractionRequest; }
  30 namespace com::sun::star::uno { template <class E> class Sequence; }
  31
  32 namespace framework{
  33
  34 /*-************************************************************************************************************
  35     @short          special request for interaction to ask user for right filter
  36     @descr          These helper can be used to ask user for right filter, if filter detection failed.
  37                     It capsulate communication with any interaction handler and supports an easy
  38                     access on interaction results for user of these class.
  39                     Use it and forget complex mechanism of interaction ...
  40
  41     @example        RequestFilterSelect*             pRequest = new RequestFilterSelect;
  42                     Reference< XInteractionRequest > xRequest ( pRequest );
  43                     xInteractionHandler->handle( xRequest );
  44                     if( ! pRequest.isAbort() )
  45                     {
  46                         OUString sFilter = pRequest->getFilter();
  47                     }
  48
  49     @implements     XInteractionRequest
  50
  51     @devstatus      ready to use
  52     @threadsafe     no (used on once position only!)
  53 *//*-*************************************************************************************************************/
  54 class RequestFilterSelect_Impl;
  55 class FWE_DLLPUBLIC RequestFilterSelect
  56 {
  57     rtl::Reference<RequestFilterSelect_Impl> mxImpl;
  58
  59 public:
  60     RequestFilterSelect( const OUString& sURL );
  61     ~RequestFilterSelect();
  62     bool     isAbort  () const;
  63     OUString getFilter() const;
  64     css::uno::Reference < css::task::XInteractionRequest > GetRequest();
  65 };
  66
  67 /*-************************************************************************************************************
  68     @short          special request for interaction
  69     @descr          User must decide between a preselected and another detected filter.
  70                     It capsulate communication with any interaction handler and supports an easy
  71                     access on interaction results for user of these class.
  72
  73     @implements     XInteractionRequest
  74
  75     @devstatus      ready to use
  76     @threadsafe     no (used on once position only!)
  77 *//*-*************************************************************************************************************/
  78 class FWE_DLLPUBLIC InteractionRequest
  79 {
  80 public:
  81     static css::uno::Reference < css::task::XInteractionRequest > CreateRequest(
  82         const css::uno::Any& aRequest,
  83         const css::uno::Sequence< css::uno::Reference< css::task::XInteractionContinuation > >& lContinuations );
  84 };
  85
  86
  87 }       //  namespace framework
  88
  89 #endif  // #define INCLUDED_FRAMEWORK_INTERACTION_HXX
  90
  91 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */