framework/inc/interaction/quietinteraction.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: stillinteraction.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __FRAMEWORK_INTERACTION_QUIETINTERACTION_HXX_
  32 #define __FRAMEWORK_INTERACTION_QUIETINTERACTION_HXX_
  33
  34 //_________________________________________________________________________________________________________________
  35 //      my own includes
  36 //_________________________________________________________________________________________________________________
  37
  38 #include <threadhelp/threadhelpbase.hxx>
  39 #include <macros/xinterface.hxx>
  40 #include <macros/xtypeprovider.hxx>
  41 #include <general.h>
  42
  43 //_________________________________________________________________________________________________________________
  44 //      interface includes
  45 //_________________________________________________________________________________________________________________
  46 #include <com/sun/star/task/XInteractionHandler.hpp>
  47 #include <com/sun/star/task/XInteractionRequest.hpp>
  48
  49 //_________________________________________________________________________________________________________________
  50 //      other includes
  51 //_________________________________________________________________________________________________________________
  52 #include <cppuhelper/weak.hxx>
  53
  54 //_________________________________________________________________________________________________________________
  55 //      namespace
  56 //_________________________________________________________________________________________________________________
  57
  58 namespace framework{
  59
  60 //_________________________________________________________________________________________________________________
  61 //      exported const
  62 //_________________________________________________________________________________________________________________
  63
  64 //_________________________________________________________________________________________________________________
  65 //      exported definitions
  66 //_________________________________________________________________________________________________________________
  67
  68 /**
  69     @short      handle interactions non visible
  70     @descr      Sometimes it's neccessary to use a non visible interaction handler.
  71                 He can't do anything, which a visible one can handle.
  72                 But it can be used to intercept problems e.g. during loading of documents.
  73
  74                 In current implementation we solve conflicts for following situations only:
  75                     - AmbigousFilterRequest
  76                     - InteractiveIOException
  77                     - InteractiveAugmentedIOException
  78                 All other requests will be aborted.
  79
  80     @modified   12.07.2002 14:06
  81     @by         Andreas Schlüns
  82  */
  83 class QuietInteraction : public  css::lang::XTypeProvider
  84                        , public  css::task::XInteractionHandler
  85                        , private ThreadHelpBase
  86                        , public  ::cppu::OWeakObject
  87 {
  88     //_____________________________________
  89     // member
  90     private:
  91
  92         /// in case an unknown interaction was aborted - we save it for our external user!
  93         css::uno::Any m_aRequest;
  94
  95     //_____________________________________
  96     // uno interface
  97     public:
  98
  99         // XInterface, XTypeProvider
 100         FWK_DECLARE_XINTERFACE
 101         FWK_DECLARE_XTYPEPROVIDER
 102
 103         //_________________________________
 104         /**
 105             @interface  XInteractionHandler
 106             @short      called from outside to handle a problem
 107             @descr      The only interaction we can handle here is to
 108                         decide which of two ambigous filters should be realy used.
 109                         We use the user selected one every time.
 110                         All other request will be aborted and can break the code,
 111                         which use this interaction handler.
 112
 113                         But you can use another method of this class to check for
 114                         some special interactions too: IO Exceptions
 115                         May a ComponentLoader needs that to throw suitable exception
 116                         on his own interface.
 117
 118             @threadsafe yes
 119         */
 120         virtual void SAL_CALL handle( const css::uno::Reference< css::task::XInteractionRequest >& xRequest ) throw( css::uno::RuntimeException );
 121
 122     //_____________________________________
 123     // c++ interface
 124     public:
 125
 126         //_________________________________
 127         /**
 128             @short      ctor to guarantee right initialized instances of this class
 129             @descr      -
 130
 131             @threadsafe not neccessary
 132         */
 133         QuietInteraction();
 134
 135         //_________________________________
 136         /**
 137             @short      return the handled interaction request
 138             @descr      We saved any getted interaction request internaly.
 139                         May the outside user of this class is interessted
 140                         on that. Especialy we gotted an unknown interaction
 141                         and aborted it hard.
 142
 143             @return     [com.sun.star.uno.Any]
 144                             the packed interaction request
 145                             Can be empty if no interaction was used!
 146
 147             @threadsafe yes
 148         */
 149         css::uno::Any getRequest() const;
 150
 151         //_________________________________
 152         /**
 153             @short      returns information if interaction was used
 154             @descr      It can be usefully to know the reason for a failed operation.
 155
 156             @return     [boolean]
 157                             <TRUE/> for used interaction
 158                             <FALSE/> otherwhise
 159
 160             @threadsafe yes
 161         */
 162         sal_Bool wasUsed() const;
 163 };
 164
 165 } // namespace framework
 166
 167 #endif // #ifndef __FRAMEWORK_INTERACTION_STILLINTERACTION_HXX_