| /************************************************************** |
| * |
| * 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 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #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> |
| |
| //_________________________________________________________________________________________________________________ |
| // includes of other projects |
| //_________________________________________________________________________________________________________________ |
| #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 ::rtl::OUString& sURL ); |
| ~RequestFilterSelect(); |
| sal_Bool isAbort () const; |
| ::rtl::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 ); |
| }; |
| |
| /*-************************************************************************************************************//** |
| @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 RequestAmbigousFilter_Impl; |
| class RequestAmbigousFilter // seems to be unused currently |
| { |
| RequestAmbigousFilter_Impl* pImp; |
| |
| // c++ interface |
| public: |
| RequestAmbigousFilter( const ::rtl::OUString& sURL, |
| const ::rtl::OUString& sSelectedFilter , |
| const ::rtl::OUString& sDetectedFilter ); |
| ~RequestAmbigousFilter(); |
| sal_Bool isAbort () const; |
| ::rtl::OUString getFilter() const; |
| com::sun::star::uno::Reference < ::com::sun::star::task::XInteractionRequest > GetRequest(); |
| }; |
| */ |
| |
| } // namespace framework |
| |
| #endif // #define __FRAMEWORK_DISPATCH_INTERACTION_HXX_ |
