desktop/source/deployment/gui/dp_gui_updatability.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: dp_gui_updatability.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 INCLUDED_DESKTOP_SOURCE_DEPLOYMENT_GUI_DP_GUI_UPDATABILITY_HXX
  32 #define INCLUDED_DESKTOP_SOURCE_DEPLOYMENT_GUI_DP_GUI_UPDATABILITY_HXX
  33
  34 #include "sal/config.h"
  35 #include "com/sun/star/uno/Reference.hxx"
  36 #include "com/sun/star/uno/Sequence.hxx"
  37 #include "rtl/ref.hxx"
  38
  39 /// @HTML
  40
  41 class Window;
  42 namespace com { namespace sun { namespace star {
  43     namespace deployment { class XPackageManager; }
  44     namespace uno { class XComponentContext; }
  45 } } }
  46
  47 namespace dp_gui {
  48
  49 /**
  50    Asynchronously determine whether <code>dp_gui::DialogImpl</code>'s
  51    &ldquo;Check for Updates...&rdquo; button shall be enabled (which
  52    theoretically can take some time).
  53
  54    <p>Note that, due to the asynchronous operation, the button may be enabled
  55    even if there are no updatable extensions.</p>
  56
  57    <p>Each instance of this class must be called from a single thread in order
  58    to adhere to the following protocol: <code>stop</code> must be called exactly
  59    once, with no intervening calls to <code>start</code>, before the destructor
  60    is called.</p>
  61 */
  62 class Updatability {
  63 public:
  64     /**
  65        Create an instance.
  66
  67        @param packageManagers
  68        a list of non-null package managers
  69
  70        @param enabled
  71        <code>dp_gui::DialogImpl</code>'s &ldquo;Check for Updates...&rdquo;
  72        button; will only be accessed with the solar mutex locked
  73     */
  74     Updatability(
  75          com::sun::star::uno::Sequence< com::sun::star::uno::Reference<
  76             com::sun::star::deployment::XPackageManager > > const &
  77             packageManagers,
  78         Window & enabled);
  79
  80     ~Updatability();
  81
  82     /**
  83        (Re-)start determining whether <code>dp_gui::DialogImpl</code>'s
  84        &ldquo;Check for Updates...&rdquo; button shall be enabled.
  85     */
  86     void start();
  87
  88     /**
  89        Orderly shut down this instance.
  90     */
  91     void stop();
  92
  93 private:
  94     Updatability(Updatability &); // not defined
  95     void operator =(Updatability &); // not defined
  96
  97     class Thread;
  98
  99     rtl::Reference< Thread > m_thread;
 100 };
 101
 102 }
 103
 104 #endif