summaryrefslogtreecommitdiffstats
path: root/framework/inc/uielement/progressbarwrapper.hxx
blob: 78dad538fe04a2ec7d6341f48c84e06280215008 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */

#ifndef INCLUDED_FRAMEWORK_INC_UIELEMENT_PROGRESSBARWRAPPER_HXX
#define INCLUDED_FRAMEWORK_INC_UIELEMENT_PROGRESSBARWRAPPER_HXX

#include <helper/uielementwrapperbase.hxx>

#include <com/sun/star/awt/XWindow.hpp>

#include <cppuhelper/weakref.hxx>

namespace framework{

class ProgressBarWrapper final : public UIElementWrapperBase
{
    public:

        //  constructor / destructor

        ProgressBarWrapper();
        virtual ~ProgressBarWrapper() override;

        // public interfaces
        void setStatusBar( const css::uno::Reference< css::awt::XWindow >& rStatusBar, bool bOwnsInstance = false );
        css::uno::Reference< css::awt::XWindow > getStatusBar() const;

        // wrapped methods of css::task::XStatusIndicator
        /// @throws css::uno::RuntimeException
        void start( const OUString& Text, ::sal_Int32 Range );
        /// @throws css::uno::RuntimeException
        void end();
        /// @throws css::uno::RuntimeException
        void setText( const OUString& Text );
        /// @throws css::uno::RuntimeException
        void setValue( ::sal_Int32 Value );
        /// @throws css::uno::RuntimeException
        void reset();

        // UNO interfaces
        // XComponent
        virtual void SAL_CALL dispose() override;

        // XInitialization
        virtual void SAL_CALL initialize( const css::uno::Sequence< css::uno::Any >& aArguments ) override;

        // XUpdatable
        virtual void SAL_CALL update() override;

        // XUIElement
        virtual css::uno::Reference< css::uno::XInterface > SAL_CALL getRealInterface() override;

    //  variables
    //  (should be private everyway!)

    private:
        css::uno::Reference< css::awt::XWindow >         m_xStatusBar;    // Reference to our status bar XWindow
        css::uno::WeakReference< css::uno::XInterface >  m_xProgressBarIfacWrapper;
        bool                                             m_bOwnsInstance; // Indicator that we are owner of the XWindow
        sal_Int32                                        m_nRange;
        sal_Int32                                        m_nValue;
        OUString                                         m_aText;
};      //  class ProgressBarWrapper

}       //  namespace framework

#endif // INCLUDED_FRAMEWORK_INC_UIELEMENT_PROGRESSBARWRAPPER_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */