framework/source/fwe/dispatch/interaction.cxx

   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 #include <comphelper/interaction.hxx>
  21 #include <framework/interaction.hxx>
  22 #include <general.h>
  23
  24 using namespace ::com::sun::star;
  25
  26 namespace framework{
  27
  28 /*-************************************************************************************************************//**
  29     @short          declaration of special continuation for filter selection
  30     @descr          Sometimes filter detection during loading document failed. Then we need a possibility
  31                     to ask user for his decision. These continuation transport selected filter by user to
  32                     code user of interaction.
  33
  34     @attention      This implementation could be used one times only. We don't support a resetable continuation yet!
  35                     Why? Normaly interaction should show a filter selection dialog and ask user for his decision.
  36                     He can select any filter - then instances of these class will be called by handler ... or user
  37                     close dialog without any selection. Then another continuation should be slected by handler to
  38                     abort continuations ... Retrying isn't very useful here ... I think.
  39
  40     @implements     XInteractionFilterSelect
  41
  42     @base           ImplInheritanceHelper1
  43                     ContinuationBase
  44
  45     @devstatus      ready to use
  46     @threadsafe     no (used on once position only!)
  47 *//*-*************************************************************************************************************/
  48 class ContinuationFilterSelect : public comphelper::OInteraction< ::com::sun::star::document::XInteractionFilterSelect >
  49 {
  50     // c++ interface
  51     public:
  52         ContinuationFilterSelect();
  53
  54     // uno interface
  55     public:
  56         virtual void            SAL_CALL setFilter( const OUString& sFilter ) throw( ::com::sun::star::uno::RuntimeException );
  57         virtual OUString SAL_CALL getFilter(                                ) throw( ::com::sun::star::uno::RuntimeException );
  58
  59     // member
  60     private:
  61         OUString m_sFilter;
  62
  63 };  // class ContinuationFilterSelect
  64
  65
  66 //---------------------------------------------------------------------------------------------------------
  67 // initialize continuation with right start values
  68 //---------------------------------------------------------------------------------------------------------
  69 ContinuationFilterSelect::ContinuationFilterSelect()
  70     : m_sFilter( OUString() )
  71 {
  72 }
  73
  74 //---------------------------------------------------------------------------------------------------------
  75 // handler should use it after selection to set user specified filter for transport
  76 //---------------------------------------------------------------------------------------------------------
  77 void SAL_CALL ContinuationFilterSelect::setFilter( const OUString& sFilter ) throw( css::uno::RuntimeException )
  78 {
  79     m_sFilter = sFilter;
  80 }
  81
  82 //---------------------------------------------------------------------------------------------------------
  83 // read access to transported filter
  84 //---------------------------------------------------------------------------------------------------------
  85 OUString SAL_CALL ContinuationFilterSelect::getFilter() throw( css::uno::RuntimeException )
  86 {
  87     return m_sFilter;
  88 }
  89
  90 class RequestFilterSelect_Impl : public ::cppu::WeakImplHelper1< ::com::sun::star::task::XInteractionRequest >
  91 {
  92 public:
  93     RequestFilterSelect_Impl( const OUString& sURL );
  94     sal_Bool        isAbort  () const;
  95     OUString getFilter() const;
  96
  97 public:
  98     virtual ::com::sun::star::uno::Any SAL_CALL getRequest() throw( ::com::sun::star::uno::RuntimeException );
  99     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > > SAL_CALL getContinuations() throw( ::com::sun::star::uno::RuntimeException );
 100
 101 private:
 102     ::com::sun::star::uno::Any                                                                                                 m_aRequest      ;
 103     ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > >    m_lContinuations;
 104     comphelper::OInteractionAbort* m_pAbort;
 105     ContinuationFilterSelect* m_pFilter;
 106 };
 107
 108 //---------------------------------------------------------------------------------------------------------
 109 // initialize instance with all necessary information
 110 // We use it without any further checks on our member then ...!
 111 //---------------------------------------------------------------------------------------------------------
 112 RequestFilterSelect_Impl::RequestFilterSelect_Impl( const OUString& sURL )
 113 {
 114     OUString temp;
 115     css::uno::Reference< css::uno::XInterface > temp2;
 116     css::document::NoSuchFilterRequest aFilterRequest( temp                             ,
 117                                                        temp2                            ,
 118                                                        sURL                                          );
 119     m_aRequest <<= aFilterRequest;
 120
 121     m_pAbort  = new comphelper::OInteractionAbort;
 122     m_pFilter = new ContinuationFilterSelect;
 123
 124     m_lContinuations.realloc( 2 );
 125     m_lContinuations[0] = css::uno::Reference< css::task::XInteractionContinuation >( m_pAbort  );
 126     m_lContinuations[1] = css::uno::Reference< css::task::XInteractionContinuation >( m_pFilter );
 127 }
 128
 129 //---------------------------------------------------------------------------------------------------------
 130 // return abort state of interaction
 131 // If it is true, return value of method "getFilter()" will be unspecified then!
 132 //---------------------------------------------------------------------------------------------------------
 133 sal_Bool RequestFilterSelect_Impl::isAbort() const
 134 {
 135     return m_pAbort->wasSelected();
 136 }
 137
 138 //---------------------------------------------------------------------------------------------------------
 139 // return user selected filter
 140 // Return value valid for non aborted interaction only. Please check "isAbort()" before you call these ony!
 141 //---------------------------------------------------------------------------------------------------------
 142 OUString RequestFilterSelect_Impl::getFilter() const
 143 {
 144     return m_pFilter->getFilter();
 145 }
 146
 147 //---------------------------------------------------------------------------------------------------------
 148 // handler call it to get type of request
 149 // Is hard coded to "please select filter" here. see ctor for further information.
 150 //---------------------------------------------------------------------------------------------------------
 151 css::uno::Any SAL_CALL RequestFilterSelect_Impl::getRequest() throw( css::uno::RuntimeException )
 152 {
 153     return m_aRequest;
 154 }
 155
 156 //---------------------------------------------------------------------------------------------------------
 157 // handler call it to get possible continuations
 158 // We support "abort/select_filter" only here.
 159 // After interaction we support read access on these continuations on our c++ interface to
 160 // return user decision.
 161 //---------------------------------------------------------------------------------------------------------
 162 css::uno::Sequence< css::uno::Reference< css::task::XInteractionContinuation > > SAL_CALL RequestFilterSelect_Impl::getContinuations() throw( css::uno::RuntimeException )
 163 {
 164     return m_lContinuations;
 165 }
 166
 167
 168 RequestFilterSelect::RequestFilterSelect( const OUString& sURL )
 169 {
 170     pImp = new RequestFilterSelect_Impl( sURL );
 171     pImp->acquire();
 172 }
 173
 174 RequestFilterSelect::~RequestFilterSelect()
 175 {
 176     pImp->release();
 177 }
 178
 179
 180 //---------------------------------------------------------------------------------------------------------
 181 // return abort state of interaction
 182 // If it is true, return value of method "getFilter()" will be unspecified then!
 183 //---------------------------------------------------------------------------------------------------------
 184 sal_Bool RequestFilterSelect::isAbort() const
 185 {
 186     return pImp->isAbort();
 187 }
 188
 189 //---------------------------------------------------------------------------------------------------------
 190 // return user selected filter
 191 // Return value valid for non aborted interaction only. Please check "isAbort()" before you call these ony!
 192 //---------------------------------------------------------------------------------------------------------
 193 OUString RequestFilterSelect::getFilter() const
 194 {
 195     return pImp->getFilter();
 196 }
 197
 198 uno::Reference < task::XInteractionRequest > RequestFilterSelect::GetRequest()
 199 {
 200     return uno::Reference < task::XInteractionRequest > (pImp);
 201 }
 202
 203 class InteractionRequest_Impl : public ::cppu::WeakImplHelper1< ::com::sun::star::task::XInteractionRequest >
 204 {
 205     uno::Any m_aRequest;
 206     uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > > m_lContinuations;
 207
 208 public:
 209     InteractionRequest_Impl( const ::com::sun::star::uno::Any& aRequest,
 210         const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > > lContinuations )
 211     {
 212         m_aRequest = aRequest;
 213         m_lContinuations = lContinuations;
 214     }
 215
 216     virtual uno::Any SAL_CALL getRequest() throw( uno::RuntimeException );
 217     virtual uno::Sequence< uno::Reference< task::XInteractionContinuation > > SAL_CALL getContinuations()
 218             throw( uno::RuntimeException );
 219 };
 220
 221 uno::Any SAL_CALL InteractionRequest_Impl::getRequest() throw( uno::RuntimeException )
 222 {
 223     return m_aRequest;
 224 }
 225
 226 uno::Sequence< uno::Reference< task::XInteractionContinuation > > SAL_CALL InteractionRequest_Impl::getContinuations()
 227     throw( uno::RuntimeException )
 228 {
 229     return m_lContinuations;
 230 }
 231
 232 uno::Reference < task::XInteractionRequest > InteractionRequest::CreateRequest(
 233     const uno::Any& aRequest, const uno::Sequence< uno::Reference< task::XInteractionContinuation > > lContinuations )
 234 {
 235     return new InteractionRequest_Impl( aRequest, lContinuations );
 236 }
 237
 238 }       //  namespace framework
 239
 240 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */