111 lines
3.9 KiB
C++
111 lines
3.9 KiB
C++
/* -*- 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_HELPER_STATUSINDICATOR_HXX
|
|
#define INCLUDED_FRAMEWORK_INC_HELPER_STATUSINDICATOR_HXX
|
|
|
|
// include files of own module
|
|
|
|
#include <helper/statusindicatorfactory.hxx>
|
|
#include <macros/xinterface.hxx>
|
|
#include <macros/xtypeprovider.hxx>
|
|
#include <macros/generic.hxx>
|
|
|
|
// include UNO interfaces
|
|
#include <com/sun/star/task/XStatusIndicator.hpp>
|
|
|
|
// include all others
|
|
#include <cppuhelper/implbase1.hxx>
|
|
#include <cppuhelper/weakref.hxx>
|
|
|
|
namespace framework{
|
|
|
|
/**
|
|
@short implement a status indicator object
|
|
|
|
@descr With this indicator you can show a message and a progress ...
|
|
but you share the output device with other indicator objects,
|
|
if this instances was created by the same factory.
|
|
Then the last created object has full access to device.
|
|
All others change her internal data structure only.
|
|
|
|
All objects of this StatusIndicator class calls a c++ interface
|
|
on the StatusIndicatorFactory (where they was created).
|
|
The factory holds all data structures and paints the progress.
|
|
|
|
@devstatus ready to use
|
|
@threadsafe yes
|
|
*/
|
|
class StatusIndicator : public ::cppu::WeakImplHelper1< css::task::XStatusIndicator >
|
|
{
|
|
|
|
// member
|
|
private:
|
|
|
|
/** @short weak reference to our factory
|
|
@descr All our interface calls will be forwarded
|
|
to a suitable c++ interface on this factory.
|
|
But we dont hold our factory alive. They
|
|
correspond with e.g. with a Frame service and
|
|
will be owned by him. If the frame will be closed
|
|
he close our factory too ...
|
|
*/
|
|
css::uno::WeakReference< css::task::XStatusIndicatorFactory > m_xFactory;
|
|
|
|
// c++ interface
|
|
public:
|
|
|
|
/** @short initialize new instance of this class.
|
|
|
|
@param pFactory
|
|
pointer to our factory
|
|
*/
|
|
StatusIndicator(StatusIndicatorFactory* pFactory);
|
|
|
|
/** @short does nothing real ....
|
|
*/
|
|
virtual ~StatusIndicator();
|
|
|
|
// uno interface
|
|
public:
|
|
|
|
// XStatusIndicator
|
|
virtual void SAL_CALL start(const OUString& sText ,
|
|
sal_Int32 nRange)
|
|
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
virtual void SAL_CALL end()
|
|
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
virtual void SAL_CALL reset()
|
|
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
virtual void SAL_CALL setText(const OUString& sText)
|
|
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
virtual void SAL_CALL setValue(sal_Int32 nValue)
|
|
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
}; // class StatusIndicator
|
|
|
|
} // namespace framework
|
|
|
|
#endif // INCLUDED_FRAMEWORK_INC_HELPER_STATUSINDICATOR_HXX
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|