statusindicatorfactory.hxx

Go to the documentation of this file.

/* -*- 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 .
 */
 
#pragma once
 
#include <sal/config.h>
 
#include <vector>
#include <mutex>
 
// include files of own module
#include <helper/wakeupthread.hxx>
 
// include uno interfaces
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/lang/XInitialization.hpp>
#include <com/sun/star/task/XStatusIndicatorFactory.hpp>
#include <com/sun/star/task/XStatusIndicator.hpp>
#include <com/sun/star/awt/XWindow.hpp>
#include <com/sun/star/frame/XFrame.hpp>
#include <com/sun/star/util/XUpdatable.hpp>
#include <com/sun/star/uno/XComponentContext.hpp>
 
#include <cppuhelper/supportsservice.hxx>
#include <cppuhelper/implbase.hxx>
#include <rtl/ref.hxx>
 
namespace framework{
 
struct IndicatorInfo
{
 
    // member
    public:
 
        css::uno::Reference< css::task::XStatusIndicator > m_xIndicator;
 
        OUString m_sText;
 
        sal_Int32 m_nValue;
 
    // interface
    public:
 
        IndicatorInfo(const css::uno::Reference< css::task::XStatusIndicator >& xIndicator,
                      const OUString&                                    sText    )
        {
            m_xIndicator = xIndicator;
            m_sText      = sText;
            m_nValue     = 0;
        }
 
        bool operator==(const css::uno::Reference< css::task::XStatusIndicator >& xIndicator) const
        {
            return (m_xIndicator == xIndicator);
        }
};
 
typedef ::std::vector< IndicatorInfo > IndicatorStack;
 
class StatusIndicatorFactory final : public  ::cppu::WeakImplHelper<
                                             css::lang::XServiceInfo
                                           , css::lang::XInitialization
                                           , css::task::XStatusIndicatorFactory
                                           , css::util::XUpdatable >
{
 
    // member
    private:
        std::mutex m_mutex;
 
        IndicatorStack m_aStack;
 
        css::uno::Reference< css::uno::XComponentContext > m_xContext;
 
        css::uno::Reference< css::task::XStatusIndicator > m_xActiveChild;
 
        css::uno::Reference< css::task::XStatusIndicator > m_xProgress;
 
        css::uno::WeakReference< css::frame::XFrame > m_xFrame;
 
        css::uno::WeakReference< css::awt::XWindow > m_xPluggWindow;
 
        rtl::Reference<WakeUpThread> m_pWakeUp;
 
        bool m_bAllowReschedule;
 
        bool m_bAllowParentShow;
 
        bool m_bDisableReschedule;
 
        static sal_Int32 m_nInReschedule;
 
    // interface
 
    public:
        StatusIndicatorFactory(css::uno::Reference< css::uno::XComponentContext > xContext);
 
        virtual OUString SAL_CALL getImplementationName() override
        {
            return "com.sun.star.comp.framework.StatusIndicatorFactory";
        }
 
        virtual sal_Bool SAL_CALL supportsService(OUString const & ServiceName) override
        {
            return cppu::supportsService(this, ServiceName);
        }
 
        virtual css::uno::Sequence<OUString> SAL_CALL getSupportedServiceNames() override
        {
           return { "com.sun.star.task.StatusIndicatorFactory" };
        }
 
        // XInitialization
        virtual void SAL_CALL initialize(const css::uno::Sequence< css::uno::Any >& lArguments) override;
 
        // XStatusIndicatorFactory
        virtual css::uno::Reference< css::task::XStatusIndicator > SAL_CALL createStatusIndicator() override;
 
        // XUpdatable
        virtual void SAL_CALL update() override;
 
        // similar (XStatusIndicator)
        void start(const css::uno::Reference< css::task::XStatusIndicator >& xChild,
                           const OUString&                                    sText ,
                                 sal_Int32                                           nRange);
 
        void reset(const css::uno::Reference< css::task::XStatusIndicator >& xChild);
 
        void end(const css::uno::Reference< css::task::XStatusIndicator >& xChild);
 
        void setText(const css::uno::Reference< css::task::XStatusIndicator >& xChild,
                                      const OUString&                                    sText );
 
        void setValue(const css::uno::Reference< css::task::XStatusIndicator >& xChild,
                                             sal_Int32                                           nValue);
 
    // specials
 
    private:
 
        virtual ~StatusIndicatorFactory() override;
 
    // helper
 
        void implts_makeParentVisibleIfAllowed();
 
        void impl_createProgress();
 
        void impl_showProgress();
 
        void impl_hideProgress();
 
        void impl_reschedule(bool bForceUpdate);
 
        void impl_startWakeUpThread();
        void impl_stopWakeUpThread();
 
}; // class StatusIndicatorFactory
 
} // namespace framework
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */