desktop/source/deployment/inc/dp_interact.h

   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: dp_interact.h,v $
  10  * $Revision: 1.7 $
  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 #if ! defined INCLUDED_DP_INTERACT_H
  32 #define INCLUDED_DP_INTERACT_H
  33
  34 #include "rtl/ref.hxx"
  35 #include "cppuhelper/implbase1.hxx"
  36 #include "com/sun/star/uno/XComponentContext.hpp"
  37 #include "com/sun/star/ucb/XCommandEnvironment.hpp"
  38 #include "com/sun/star/task/XAbortChannel.hpp"
  39 #include "dp_misc_api.hxx"
  40
  41 namespace css = ::com::sun::star;
  42
  43 namespace dp_misc
  44 {
  45
  46 inline void progressUpdate(
  47     ::rtl::OUString const & status,
  48     css::uno::Reference<css::ucb::XCommandEnvironment> const & xCmdEnv )
  49 {
  50     if (xCmdEnv.is()) {
  51         css::uno::Reference<css::ucb::XProgressHandler> xProgressHandler(
  52             xCmdEnv->getProgressHandler() );
  53         if (xProgressHandler.is()) {
  54             xProgressHandler->update( css::uno::makeAny(status) );
  55         }
  56     }
  57 }
  58
  59 //==============================================================================
  60 class ProgressLevel
  61 {
  62     css::uno::Reference<css::ucb::XProgressHandler> m_xProgressHandler;
  63
  64 public:
  65     inline ~ProgressLevel();
  66     inline ProgressLevel(
  67         css::uno::Reference<css::ucb::XCommandEnvironment> const & xCmdEnv,
  68         ::rtl::OUString const & status );
  69
  70     inline void update( ::rtl::OUString const & status ) const;
  71     inline void update( css::uno::Any const & status ) const;
  72 };
  73
  74 //______________________________________________________________________________
  75 inline ProgressLevel::ProgressLevel(
  76     css::uno::Reference< css::ucb::XCommandEnvironment > const & xCmdEnv,
  77     ::rtl::OUString const & status )
  78 {
  79     if (xCmdEnv.is())
  80         m_xProgressHandler = xCmdEnv->getProgressHandler();
  81     if (m_xProgressHandler.is())
  82         m_xProgressHandler->push( css::uno::makeAny(status) );
  83 }
  84
  85 //______________________________________________________________________________
  86 inline ProgressLevel::~ProgressLevel()
  87 {
  88     if (m_xProgressHandler.is())
  89         m_xProgressHandler->pop();
  90 }
  91
  92 //______________________________________________________________________________
  93 inline void ProgressLevel::update( ::rtl::OUString const & status ) const
  94 {
  95     if (m_xProgressHandler.is())
  96         m_xProgressHandler->update( css::uno::makeAny(status) );
  97 }
  98
  99 //______________________________________________________________________________
 100 inline void ProgressLevel::update( css::uno::Any const & status ) const
 101 {
 102     if (m_xProgressHandler.is())
 103         m_xProgressHandler->update( status );
 104 }
 105
 106 //##############################################################################
 107
 108 /** @return true if ia handler is present and any selection has been chosen
 109  */
 110 DESKTOP_DEPLOYMENTMISC_DLLPUBLIC bool interactContinuation(
 111     css::uno::Any const & request,
 112     css::uno::Type const & continuation,
 113     css::uno::Reference<css::ucb::XCommandEnvironment> const & xCmdEnv,
 114     bool * pcont, bool * pabort );
 115
 116 //##############################################################################
 117
 118 //==============================================================================
 119 class DESKTOP_DEPLOYMENTMISC_DLLPUBLIC AbortChannel :
 120     public ::cppu::WeakImplHelper1<css::task::XAbortChannel>
 121 {
 122     bool m_aborted;
 123     css::uno::Reference<css::task::XAbortChannel> m_xNext;
 124
 125 public:
 126     inline AbortChannel() : m_aborted( false ) {}
 127     inline static AbortChannel * get(
 128         css::uno::Reference<css::task::XAbortChannel> const & xAbortChannel )
 129         { return static_cast<AbortChannel *>(xAbortChannel.get()); }
 130
 131     inline bool isAborted() const { return m_aborted; }
 132
 133     // XAbortChannel
 134     virtual void SAL_CALL sendAbort() throw (css::uno::RuntimeException);
 135
 136     class SAL_DLLPRIVATE Chain
 137     {
 138         const ::rtl::Reference<AbortChannel> m_abortChannel;
 139     public:
 140         inline Chain(
 141             ::rtl::Reference<AbortChannel> const & abortChannel,
 142             css::uno::Reference<css::task::XAbortChannel> const & xNext )
 143             : m_abortChannel( abortChannel )
 144             { if (m_abortChannel.is()) m_abortChannel->m_xNext = xNext; }
 145         inline ~Chain()
 146             { if (m_abortChannel.is()) m_abortChannel->m_xNext.clear(); }
 147     };
 148     friend class Chain;
 149 };
 150
 151 }
 152
 153 #endif