framework/inc/uielement/progressbarwrapper.hxx

   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 #ifndef INCLUDED_FRAMEWORK_INC_UIELEMENT_PROGRESSBARWRAPPER_HXX
  21 #define INCLUDED_FRAMEWORK_INC_UIELEMENT_PROGRESSBARWRAPPER_HXX
  22
  23 #include <helper/uielementwrapperbase.hxx>
  24 #include <macros/generic.hxx>
  25 #include <macros/xinterface.hxx>
  26 #include <macros/xtypeprovider.hxx>
  27
  28 #include <com/sun/star/task/XStatusIndicator.hpp>
  29 #include <com/sun/star/awt/XWindow.hpp>
  30
  31 #include <cppuhelper/weak.hxx>
  32 #include <cppuhelper/weakref.hxx>
  33
  34 namespace framework{
  35
  36 class ProgressBarWrapper : public UIElementWrapperBase
  37 {
  38     public:
  39
  40         //  constructor / destructor
  41
  42         ProgressBarWrapper();
  43         virtual ~ProgressBarWrapper();
  44
  45         // public interfaces
  46         void setStatusBar( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow >& rStatusBar, bool bOwnsInstance = false );
  47         ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow > getStatusBar() const;
  48
  49         // wrapped methods of ::com::sun::star::task::XStatusIndicator
  50         void start( const OUString& Text, ::sal_Int32 Range ) throw (css::uno::RuntimeException, std::exception);
  51         void end() throw (css::uno::RuntimeException, std::exception);
  52         void setText( const OUString& Text ) throw (css::uno::RuntimeException, std::exception);
  53         void setValue( ::sal_Int32 Value ) throw (css::uno::RuntimeException, std::exception);
  54         void reset() throw (css::uno::RuntimeException, std::exception);
  55
  56         // UNO interfaces
  57         // XComponent
  58         virtual void SAL_CALL dispose() throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
  59
  60         // XInitialization
  61         virtual void SAL_CALL initialize( const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& aArguments ) throw (::com::sun::star::uno::Exception, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
  62
  63         // XUpdatable
  64         virtual void SAL_CALL update() throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
  65
  66         // XUIElement
  67         virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL getRealInterface() throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
  68
  69     //  variables
  70     //  (should be private everyway!)
  71
  72     private:
  73         ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow >         m_xStatusBar;    // Reference to our status bar XWindow
  74         ::com::sun::star::uno::WeakReference< ::com::sun::star::uno::XInterface >  m_xProgressBarIfacWrapper;
  75         bool                                                                   m_bOwnsInstance; // Indicator that we are owner of the XWindow
  76         sal_Int32                                                                  m_nRange;
  77         sal_Int32                                                                  m_nValue;
  78         OUString                                                              m_aText;
  79 };      //  class ProgressBarWrapper
  80
  81 }       //  namespace framework
  82
  83 #endif // INCLUDED_FRAMEWORK_INC_UIELEMENT_PROGRESSBARWRAPPER_HXX
  84
  85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */