430 lines
15 KiB
C++
430 lines
15 KiB
C++
/*************************************************************************
|
|
*
|
|
* $RCSfile: statusindicatorfactory.hxx,v $
|
|
*
|
|
* $Revision: 1.11 $
|
|
*
|
|
* last change: $Author: obo $ $Date: 2005-08-12 16:23:52 $
|
|
*
|
|
* The Contents of this file are made available subject to the terms of
|
|
* either of the following licenses
|
|
*
|
|
* - GNU Lesser General Public License Version 2.1
|
|
* - Sun Industry Standards Source License Version 1.1
|
|
*
|
|
* Sun Microsystems Inc., October, 2000
|
|
*
|
|
* GNU Lesser General Public License Version 2.1
|
|
* =============================================
|
|
* Copyright 2000 by Sun Microsystems, Inc.
|
|
* 901 San Antonio Road, Palo Alto, CA 94303, USA
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License version 2.1, as published by the Free Software Foundation.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
|
* MA 02111-1307 USA
|
|
*
|
|
*
|
|
* Sun Industry Standards Source License Version 1.1
|
|
* =================================================
|
|
* The contents of this file are subject to the Sun Industry Standards
|
|
* Source License Version 1.1 (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.openoffice.org/license.html.
|
|
*
|
|
* Software provided under this License is provided on an "AS IS" basis,
|
|
* WITHOUT WARRUNTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING,
|
|
* WITHOUT LIMITATION, WARRUNTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
|
|
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
|
|
* See the License for the specific provisions governing your rights and
|
|
* obligations concerning the Software.
|
|
*
|
|
* The Initial Developer of the Original Code is: Sun Microsystems, Inc..
|
|
*
|
|
* Copyright: 2000 by Sun Microsystems, Inc.
|
|
*
|
|
* All Rights Reserved.
|
|
*
|
|
* Contributor(s): _______________________________________
|
|
*
|
|
*
|
|
************************************************************************/
|
|
|
|
#ifndef __FRAMEWORK_HELPER_STATUSINDICATORFACTORY_HXX_
|
|
#define __FRAMEWORK_HELPER_STATUSINDICATORFACTORY_HXX_
|
|
|
|
// Attention: stl headers must(!) be included at first. Otherwhise it can make trouble
|
|
// with solaris headers ...
|
|
#include <vector>
|
|
|
|
//_______________________________________________
|
|
// include files of own module
|
|
|
|
#ifndef __FRAMEWORK_HELPER_WAKEUPTHREAD_HXX_
|
|
#include <helper/wakeupthread.hxx>
|
|
#endif
|
|
|
|
#ifndef __FRAMEWORK_THREADHELP_THREADHELPBASE_HXX_
|
|
#include <threadhelp/threadhelpbase.hxx>
|
|
#endif
|
|
|
|
#ifndef __FRAMEWORK_MACROS_XINTERFACE_HXX_
|
|
#include <macros/xinterface.hxx>
|
|
#endif
|
|
|
|
#ifndef __FRAMEWORK_MACROS_XTYPEPROVIDER_HXX_
|
|
#include <macros/xtypeprovider.hxx>
|
|
#endif
|
|
|
|
#ifndef __FRAMEWORK_MACROS_XSERVICEINFO_HXX_
|
|
#include <macros/xserviceinfo.hxx>
|
|
#endif
|
|
|
|
#ifndef __FRAMEWORK_MACROS_DEBUG_HXX_
|
|
#include <macros/debug.hxx>
|
|
#endif
|
|
|
|
#ifndef __FRAMEWORK_MACROS_GENERIC_HXX_
|
|
#include <macros/generic.hxx>
|
|
#endif
|
|
|
|
#ifndef __FRAMEWORK_GENERAL_H_
|
|
#include <general.h>
|
|
#endif
|
|
|
|
//_______________________________________________
|
|
// include uno interfaces
|
|
|
|
#ifndef _COM_SUN_STAR_LANG_XTYPEPROVIDER_HPP_
|
|
#include <com/sun/star/lang/XTypeProvider.hpp>
|
|
#endif
|
|
|
|
#ifndef _COM_SUN_STAR_LANG_XSERVICEINFO_HPP_
|
|
#include <com/sun/star/lang/XServiceInfo.hpp>
|
|
#endif
|
|
|
|
#ifndef _COM_SUN_STAR_LANG_XINITIALIZATION_HPP_
|
|
#include <com/sun/star/lang/XInitialization.hpp>
|
|
#endif
|
|
|
|
#ifndef _COM_SUN_STAR_LANG_XEVENTLISTENER_HPP_
|
|
#include <com/sun/star/lang/XEventListener.hpp>
|
|
#endif
|
|
|
|
#ifndef _COM_SUN_STAR_TASK_XSTATUSINDICATORFACTORY_HPP_
|
|
#include <com/sun/star/task/XStatusIndicatorFactory.hpp>
|
|
#endif
|
|
|
|
#ifndef _COM_SUN_STAR_TASK_XSTATUSINDICATOR_HPP_
|
|
#include <com/sun/star/task/XStatusIndicator.hpp>
|
|
#endif
|
|
|
|
#ifndef _COM_SUN_STAR_AWT_XWINDOW_HPP_
|
|
#include <com/sun/star/awt/XWindow.hpp>
|
|
#endif
|
|
|
|
#ifndef _COM_SUN_STAR_AWT_XWINDOWLISTENER_HPP_
|
|
#include <com/sun/star/awt/XWindowListener.hpp>
|
|
#endif
|
|
|
|
#ifndef _COM_SUN_STAR_LANG_EVENTOBJECT_HPP_
|
|
#include <com/sun/star/lang/EventObject.hpp>
|
|
#endif
|
|
|
|
#ifndef _COM_SUN_STAR_AWT_WINDOWEVENT_HPP_
|
|
#include <com/sun/star/awt/WindowEvent.hpp>
|
|
#endif
|
|
|
|
#ifndef _COM_SUN_STAR_LANG_XMULTISERVICEFACTORY_HPP_
|
|
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
|
|
#endif
|
|
|
|
#ifndef _COM_SUN_STAR_FRAME_XFRAME_HPP_
|
|
#include <com/sun/star/frame/XFrame.hpp>
|
|
#endif
|
|
|
|
#ifndef _COM_SUN_STAR_URTIL_XUPDATABLE_HPP_
|
|
#include <com/sun/star/util/XUpdatable.hpp>
|
|
#endif
|
|
|
|
//_______________________________________________
|
|
// include others
|
|
|
|
#ifndef _SV_STATUS_HXX
|
|
#include <vcl/status.hxx>
|
|
#endif
|
|
|
|
#ifndef _CPPUHELPER_WEAK_HXX_
|
|
#include <cppuhelper/weak.hxx>
|
|
#endif
|
|
|
|
#ifndef _THREAD_HXX_
|
|
#include <osl/thread.hxx>
|
|
#endif
|
|
|
|
//_______________________________________________
|
|
// namespace
|
|
|
|
namespace framework{
|
|
|
|
//_______________________________________________
|
|
// definitions
|
|
|
|
//===============================================
|
|
/**
|
|
@descr This struct hold some informations about all currently running progress proccesses.
|
|
Because the can be used on a stack, we must cache her states but must paint only
|
|
the top most one.
|
|
*/
|
|
struct IndicatorInfo
|
|
{
|
|
//-------------------------------------------
|
|
// member
|
|
public:
|
|
|
|
/** @short points to the indicator child, where we hold its states
|
|
alive here. */
|
|
css::uno::Reference< css::task::XStatusIndicator > m_xIndicator;
|
|
|
|
/** @short the last set text for this indicator */
|
|
::rtl::OUString m_sText;
|
|
|
|
/** @short the max range for this indicator. */
|
|
sal_Int32 m_nRange;
|
|
|
|
/** @short the last set value for this indicator */
|
|
sal_Int32 m_nValue;
|
|
|
|
//-------------------------------------------
|
|
// interface
|
|
public:
|
|
|
|
//---------------------------------------
|
|
/** @short initialize new instance of this class
|
|
|
|
@param xIndicator
|
|
the new child indiactor of our factory.
|
|
|
|
@param sText
|
|
its initial text.
|
|
|
|
@param nRange
|
|
the max range for this indicator.
|
|
*/
|
|
IndicatorInfo(const css::uno::Reference< css::task::XStatusIndicator >& xIndicator,
|
|
const ::rtl::OUString& sText ,
|
|
sal_Int32 nRange )
|
|
{
|
|
m_xIndicator = xIndicator;
|
|
m_sText = sText ;
|
|
m_nRange = nRange ;
|
|
m_nValue = 0 ;
|
|
}
|
|
|
|
//---------------------------------------
|
|
/** @short Don't forget to free used references!
|
|
*/
|
|
~IndicatorInfo()
|
|
{
|
|
m_xIndicator.clear();
|
|
}
|
|
|
|
//---------------------------------------------------------------------------------------------------------
|
|
/** @short Used to locate an info struct inside a stl structure ...
|
|
|
|
@descr The indicator object itself is used as key. Its values
|
|
are not interesting then. Because mor then one child
|
|
indicator can use the same values ...
|
|
*/
|
|
sal_Bool operator==(const css::uno::Reference< css::task::XStatusIndicator >& xIndicator)
|
|
{
|
|
return (m_xIndicator == xIndicator);
|
|
}
|
|
};
|
|
/*
|
|
//---------------------------------------------------------------------------------------------------------
|
|
// norm nValue to fit range of 0..100%
|
|
sal_Int32 calcPercentage()
|
|
{
|
|
return ::std::min( (( m_nValue * 100 )/ ::std::max( m_nRange, (sal_Int32)1 ) ), (sal_Int32)100 );
|
|
}
|
|
*/
|
|
|
|
//===============================================
|
|
/** @descr Define a lits of child indicator objects and her data. */
|
|
typedef ::std::vector< IndicatorInfo > IndicatorStack;
|
|
|
|
//===============================================
|
|
/** @short implement a factory service to create new status indicator objects
|
|
|
|
@descr Internaly it uses:
|
|
- a vcl based
|
|
- or an uno based and by the frame layouted
|
|
progress implementation.
|
|
|
|
This factory create different indicators and control his access
|
|
to a shared output device! Only the last activated component
|
|
can write his state to this device. All other requests will be
|
|
cached only.
|
|
|
|
@devstatus ready to use
|
|
@threadsafe yes
|
|
*/
|
|
class StatusIndicatorFactory : public css::lang::XTypeProvider
|
|
, public css::lang::XServiceInfo
|
|
, public css::lang::XInitialization
|
|
, public css::task::XStatusIndicatorFactory
|
|
, public css::util::XUpdatable
|
|
, private ThreadHelpBase
|
|
, public ::cppu::OWeakObject // => XInterface
|
|
{
|
|
//-------------------------------------------
|
|
// member
|
|
private:
|
|
|
|
/** stack with all current indicator childs. */
|
|
IndicatorStack m_aStack;
|
|
|
|
/** uno service manager to create own needed uno resources. */
|
|
css::uno::Reference< css::lang::XMultiServiceFactory > m_xSMGR;
|
|
|
|
/** most active indicator child, which could work with our shared indicator window only. */
|
|
css::uno::Reference< css::task::XStatusIndicator > m_xActiveChild;
|
|
|
|
/** used to show the progress on the frame (layouted!) or
|
|
as a plugged vcl window. */
|
|
css::uno::Reference< css::task::XStatusIndicator > m_xProgress;
|
|
|
|
/** points to the frame, where we show the progress (in case
|
|
m_xProgress points to a frame progress. */
|
|
css::uno::WeakReference< css::frame::XFrame > m_xFrame;
|
|
|
|
/** points to an outside window, where we show the progress (in case
|
|
we are plugged into such window). */
|
|
css::uno::WeakReference< css::awt::XWindow > m_xPluggWindow;
|
|
|
|
/** Notify us if a fix time is over. We use it to implement an
|
|
intelligent "Reschedule" ... */
|
|
WakeUpThread* m_pWakeUp;
|
|
|
|
/** Our WakeUpThread calls us in our interface method "XUpdatable::update().
|
|
There we set this member m_bAllowReschedule to TRUE. Next time if our impl_reschedule()
|
|
method is called, we know, that an Application::Reschedule() should be made.
|
|
Because the last made Reschedule can be was taken long time ago ... may be.*/
|
|
sal_Bool m_bAllowReschedule;
|
|
|
|
/** enable/disable automatic showing of our parent window. */
|
|
sal_Bool m_bAllowParentShow;
|
|
|
|
/** enable/disable rescheduling. Default=enabled*/
|
|
sal_Bool m_bDisableReschedule;
|
|
|
|
/** prevent recursive calling of Application::Reschedule(). */
|
|
static sal_Int32 m_nInReschedule;
|
|
|
|
/** time where there last start call was made. */
|
|
sal_Int32 m_nStartTime;
|
|
|
|
//-------------------------------------------
|
|
// interface
|
|
|
|
public:
|
|
|
|
//---------------------------------------
|
|
// ctor
|
|
StatusIndicatorFactory(const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR);
|
|
|
|
//---------------------------------------
|
|
// XInterface, XTypeProvider, XServiceInfo
|
|
DECLARE_XINTERFACE
|
|
DECLARE_XTYPEPROVIDER
|
|
DECLARE_XSERVICEINFO
|
|
|
|
//---------------------------------------
|
|
// XInitialization
|
|
virtual void SAL_CALL initialize(const css::uno::Sequence< css::uno::Any >& lArguments)
|
|
throw(css::uno::Exception ,
|
|
css::uno::RuntimeException);
|
|
|
|
//---------------------------------------
|
|
// XStatusIndicatorFactory
|
|
virtual css::uno::Reference< css::task::XStatusIndicator > SAL_CALL createStatusIndicator()
|
|
throw(css::uno::RuntimeException);
|
|
|
|
//---------------------------------------
|
|
// XUpdatable
|
|
virtual void SAL_CALL update()
|
|
throw(css::uno::RuntimeException);
|
|
|
|
//---------------------------------------
|
|
// similar (XStatusIndicator)
|
|
virtual void start(const css::uno::Reference< css::task::XStatusIndicator >& xChild,
|
|
const ::rtl::OUString& sText ,
|
|
sal_Int32 nRange);
|
|
|
|
virtual void SAL_CALL reset(const css::uno::Reference< css::task::XStatusIndicator >& xChild);
|
|
|
|
virtual void SAL_CALL end(const css::uno::Reference< css::task::XStatusIndicator >& xChild);
|
|
|
|
virtual void SAL_CALL setText(const css::uno::Reference< css::task::XStatusIndicator >& xChild,
|
|
const ::rtl::OUString& sText );
|
|
|
|
virtual void SAL_CALL setValue(const css::uno::Reference< css::task::XStatusIndicator >& xChild,
|
|
sal_Int32 nValue);
|
|
|
|
//-------------------------------------------
|
|
// specials
|
|
|
|
protected:
|
|
|
|
virtual ~StatusIndicatorFactory();
|
|
|
|
//-------------------------------------------
|
|
// helper
|
|
private:
|
|
|
|
/** @short show the parent window of this progress ...
|
|
if it's allowed to do so.
|
|
|
|
|
|
@descr By default we show the parent window automaticly
|
|
if this progress is used.
|
|
If that isn't a valid operation, the user of this
|
|
progress can suppress this feature by initializaing
|
|
us with a special parameter.
|
|
|
|
@seealso initialize()
|
|
*/
|
|
void implts_makeParentVisibleIfAllowed();
|
|
|
|
/** @short creates a new internal used progress.
|
|
@descr This factory does not paint the progress itself.
|
|
It uses helper for that. They can be vcl based or
|
|
layouted by the frame and provided as an uno interface.
|
|
*/
|
|
void impl_createProgress();
|
|
|
|
/** @short try to "share the current thread in an intelligent manner" :-)
|
|
|
|
@param Overwrites our algorithm for Reschedule and force it to be shure
|
|
that our progress was painted right.
|
|
*/
|
|
void impl_reschedule(sal_Bool bForceUpdate);
|
|
|
|
void impl_startWakeUpThread();
|
|
void impl_stopWakeUpThread();
|
|
|
|
}; // class StatusIndicatorFactory
|
|
|
|
} // namespace framework
|
|
|
|
#endif // #ifndef __FRAMEWORK_HELPER_STATUSINDICATORFACTORY_HXX_
|