dba34b: outsourced the Throbber_Impl from toolkit to VCL, promoted to a 'real' control

6 files changed, 409 insertions, 16 deletions

diff --git a/vcl/inc/vcl/imgctrl.hxx b/vcl/inc/vcl/imgctrl.hxx
index fa3b01463f34..83bd300379d6 100644
--- a/vcl/inc/vcl/imgctrl.hxx
+++ b/vcl/inc/vcl/imgctrl.hxx
@@ -46,6 +46,7 @@ private:
 
 public:
                     ImageControl( Window* pParent, WinBits nStyle = 0 );
+                    ImageControl( Window* pParent, const ResId& rResId );
 
     // set/get the scale mode. This is one of the css.awt.ImageScaleMode constants
     void            SetScaleMode( const ::sal_Int16 _nMode );
diff --git a/vcl/inc/vcl/throbber.hxx b/vcl/inc/vcl/throbber.hxx
new file mode 100644
index 000000000000..f86a9944e28f
--- /dev/null
+++ b/vcl/inc/vcl/throbber.hxx
@@ -0,0 +1,103 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org 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 version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org.  If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef VCL_THROBBER_HXX
+#define VCL_THROBBER_HXX
+
+#include "vcl/dllapi.h"
+#include "vcl/imgctrl.hxx"
+#include "vcl/timer.hxx"
+
+#include <vos/mutex.hxx>
+
+#include <com/sun/star/graphic/XGraphic.hpp>
+
+#include <vector>
+
+class VCL_DLLPUBLIC Throbber : public ImageControl
+{
+public:
+    enum ImageSet
+    {
+        /// no (default) images at all
+        IMAGES_NONE,
+        /// automatically decide between different image sets, depending on what fits best the actual size
+        IMAGES_AUTO,
+        /// default images, 16x16 pixels
+        IMAGES_16_PX,
+        /// default images, 32x32 pixels
+        IMAGES_32_PX,
+        /// default images, 64x64 pixels
+        IMAGES_64_PX,
+    };
+
+public:
+                    Throbber( Window* i_parentWindow, WinBits i_style, const ImageSet i_imageSet = IMAGES_AUTO );
+                    Throbber( Window* i_parentWindow, const ResId& i_resId, const ImageSet i_imageSet = IMAGES_AUTO );
+                    ~Throbber();
+
+    // Properties
+    void            setStepTime( sal_Int32 nStepTime )  { mnStepTime = nStepTime; }
+    sal_Int32       getStepTime() const                 { return mnStepTime; }
+
+    void            setRepeat( sal_Bool bRepeat )       { mbRepeat = bRepeat; }
+    sal_Bool        getRepeat() const                   { return mbRepeat; }
+
+    // animation control
+    void start();
+    void stop();
+    bool isRunning() const;
+
+    void setImageList( const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::graphic::XGraphic > >& ImageList );
+    void setImageList( ::std::vector< Image > const& i_images );
+
+    // default images
+    static ::std::vector< ::rtl::OUString >
+        getDefaultImageURLs( const ImageSet i_imageSet );
+
+protected:
+    // Window overridables
+    virtual void        Resize();
+
+private:
+    SAL_DLLPRIVATE void initImages();
+
+private:
+    ::std::vector< Image >  maImageList;
+
+    sal_Bool    mbRepeat;
+    sal_Int32   mnStepTime;
+    sal_Int32   mnCurStep;
+    sal_Int32   mnStepCount;
+    AutoTimer   maWaitTimer;
+    ImageSet    meImageSet;
+
+    DECL_LINK( TimeOutHdl, void* );
+};
+
+#endif // VCL_THROBBER_HXX
+
diff --git a/vcl/prj/d.lst b/vcl/prj/d.lst
index 59efccb8ee02..6af056eec45b 100644
--- a/vcl/prj/d.lst
+++ b/vcl/prj/d.lst
@@ -58,6 +58,7 @@ mkdir: %_DEST%\inc%_EXT%\vcl
 ..\inc\vcl\image.hxx %_DEST%\inc%_EXT%\vcl\image.hxx
 ..\inc\vcl\imagerepository.hxx %_DEST%\inc%_EXT%\vcl\imagerepository.hxx
 ..\inc\vcl\imgctrl.hxx %_DEST%\inc%_EXT%\vcl\imgctrl.hxx
+..\inc\vcl\throbber.hxx %_DEST%\inc%_EXT%\vcl\throbber.hxx
 ..\inc\vcl\impdel.hxx %_DEST%\inc%_EXT%\vcl\impdel.hxx
 ..\inc\vcl\inputctx.hxx %_DEST%\inc%_EXT%\vcl\inputctx.hxx
 ..\inc\vcl\javachild.hxx %_DEST%\inc%_EXT%\vcl\javachild.hxx
diff --git a/vcl/source/control/imgctrl.cxx b/vcl/source/control/imgctrl.cxx
index 075a8b1b95e2..d0ed042db354 100644
--- a/vcl/source/control/imgctrl.cxx
+++ b/vcl/source/control/imgctrl.cxx
@@ -30,6 +30,7 @@
 
 #include <vcl/event.hxx>
 #include <vcl/imgctrl.hxx>
+#include <tools/rcid.h>
 
 #include <com/sun/star/awt/ImageScaleMode.hdl>
 
@@ -37,10 +38,18 @@ namespace ImageScaleMode = ::com::sun::star::awt::ImageScaleMode;
 
 // -----------------------------------------------------------------------
 
-ImageControl::ImageControl( Window* pParent, WinBits nStyle ) :
-    FixedImage( pParent, nStyle )
+ImageControl::ImageControl( Window* pParent, WinBits nStyle )
+    :FixedImage( pParent, nStyle )
+    ,mnScaleMode( ImageScaleMode::Anisotropic )
+{
+}
+
+// -----------------------------------------------------------------------
+
+ImageControl::ImageControl( Window* pParent, const ResId& rResId )
+    :FixedImage( pParent, rResId )
+    ,mnScaleMode( ImageScaleMode::Anisotropic )
 {
-    mnScaleMode = ImageScaleMode::Anisotropic;
 }
 
 // -----------------------------------------------------------------------
diff --git a/vcl/source/control/makefile.mk b/vcl/source/control/makefile.mk
index b1644e58ccd9..3c0a364499ad 100644
--- a/vcl/source/control/makefile.mk
+++ b/vcl/source/control/makefile.mk
@@ -43,16 +43,21 @@ CDEFS+=-D_STD_NO_NAMESPACE -D_VOS_NO_NAMESPACE -D_UNO_NO_NAMESPACE
 
 # --- Files --------------------------------------------------------
 
-SLOFILES=	$(SLO)$/button.obj		\
+EXCEPTIONSFILES=					\
+            $(SLO)$/button.obj		\
             $(SLO)$/ctrl.obj		\
-            $(SLO)$/combobox.obj	\
             $(SLO)$/edit.obj		\
-            $(SLO)$/field.obj		\
             $(SLO)$/field2.obj		\
+            $(SLO)$/ilstbox.obj		\
+            $(SLO)$/tabctrl.obj		\
+            $(SLO)$/throbber.obj
+
+SLOFILES=	$(EXCEPTIONSFILES)      \
+            $(SLO)$/combobox.obj	\
+            $(SLO)$/field.obj		\
             $(SLO)$/fixbrd.obj		\
             $(SLO)$/fixed.obj		\
             $(SLO)$/group.obj		\
-            $(SLO)$/ilstbox.obj 	\
             $(SLO)$/imgctrl.obj 	\
             $(SLO)$/longcurr.obj	\
             $(SLO)$/lstbox.obj		\
@@ -62,17 +67,8 @@ SLOFILES=	$(SLO)$/button.obj		\
             $(SLO)$/slider.obj		\
             $(SLO)$/spinfld.obj 	\
             $(SLO)$/spinbtn.obj 	\
-            $(SLO)$/tabctrl.obj     \
             $(SLO)$/quickselectionengine.obj
 
-EXCEPTIONSFILES=					\
-            $(SLO)$/button.obj		\
-            $(SLO)$/ctrl.obj		\
-            $(SLO)$/edit.obj		\
-            $(SLO)$/field2.obj		\
-            $(SLO)$/ilstbox.obj		\
-            $(SLO)$/tabctrl.obj
-
 # --- Targets ------------------------------------------------------
 
 .INCLUDE :	target.mk
diff --git a/vcl/source/control/throbber.cxx b/vcl/source/control/throbber.cxx
new file mode 100644
index 000000000000..eab39b735b4d
--- /dev/null
+++ b/vcl/source/control/throbber.cxx
@@ -0,0 +1,283 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org 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 version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org.  If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#include "precompiled_vcl.hxx"
+
+#include "vcl/throbber.hxx"
+#include "vcl/svapp.hxx"
+
+#include <com/sun/star/graphic/XGraphicProvider.hpp>
+#include <com/sun/star/awt/ImageScaleMode.hpp>
+
+#include <comphelper/componentcontext.hxx>
+#include <comphelper/namedvaluecollection.hxx>
+#include <comphelper/processfactory.hxx>
+#include <rtl/ustrbuf.hxx>
+#include <tools/diagnose_ex.h>
+
+using ::com::sun::star::uno::Sequence;
+using ::com::sun::star::uno::Reference;
+using ::com::sun::star::graphic::XGraphic;
+using ::com::sun::star::graphic::XGraphicProvider;
+using ::com::sun::star::uno::UNO_QUERY_THROW;
+using ::com::sun::star::uno::UNO_QUERY;
+using ::com::sun::star::uno::Exception;
+namespace ImageScaleMode = ::com::sun::star::awt::ImageScaleMode;
+
+//--------------------------------------------------------------------
+Throbber::Throbber( Window* i_parentWindow, WinBits i_style, const ImageSet i_imageSet )
+    :ImageControl( i_parentWindow, i_style )
+    ,mbRepeat( sal_True )
+    ,mnStepTime( 100 )
+    ,mnCurStep( 0 )
+    ,mnStepCount( 0 )
+    ,meImageSet( i_imageSet )
+{
+    maWaitTimer.SetTimeout( mnStepTime );
+    maWaitTimer.SetTimeoutHdl( LINK( this, Throbber, TimeOutHdl ) );
+
+    SetScaleMode( ImageScaleMode::None );
+    initImages();
+}
+
+//--------------------------------------------------------------------
+Throbber::Throbber( Window* i_parentWindow, const ResId& i_resId, const ImageSet i_imageSet )
+    :ImageControl( i_parentWindow, i_resId )
+    ,mbRepeat( sal_True )
+    ,mnStepTime( 100 )
+    ,mnCurStep( 0 )
+    ,mnStepCount( 0 )
+    ,meImageSet( i_imageSet )
+{
+    maWaitTimer.SetTimeout( mnStepTime );
+    maWaitTimer.SetTimeoutHdl( LINK( this, Throbber, TimeOutHdl ) );
+
+    SetScaleMode( ImageScaleMode::None );
+    initImages();
+}
+
+//--------------------------------------------------------------------
+Throbber::~Throbber()
+{
+    maWaitTimer.Stop();
+}
+
+//--------------------------------------------------------------------
+namespace
+{
+    ::std::vector< Image > lcl_loadImageSet( const Throbber::ImageSet i_imageSet )
+    {
+        ::std::vector< Image > aImages;
+        ENSURE_OR_RETURN( i_imageSet != Throbber::IMAGES_NONE, "lcl_loadImageSet: illegal image set", aImages );
+
+        const ::comphelper::ComponentContext aContext( ::comphelper::getProcessServiceFactory() );
+        const Reference< XGraphicProvider > xGraphicProvider( aContext.createComponent( "com.sun.star.graphic.GraphicProvider" ), UNO_QUERY_THROW );
+
+        ::std::vector< ::rtl::OUString > aImageURLs( Throbber::getDefaultImageURLs( i_imageSet ) );
+        aImages.reserve( aImageURLs.size() );
+
+        ::comphelper::NamedValueCollection aMediaProperties;
+        for (   ::std::vector< ::rtl::OUString >::const_iterator imageURL = aImageURLs.begin();
+                imageURL != aImageURLs.end();
+                ++imageURL
+            )
+        {
+            aMediaProperties.put( "URL", *imageURL );
+            const Reference< XGraphic > xGraphic( xGraphicProvider->queryGraphic( aMediaProperties.getPropertyValues() ), UNO_QUERY );
+            aImages.push_back( Image( xGraphic ) );
+        }
+
+        return aImages;
+    }
+}
+
+//--------------------------------------------------------------------
+void Throbber::Resize()
+{
+    ImageControl::Resize();
+
+    if ( meImageSet == IMAGES_AUTO )
+        initImages();
+}
+
+//--------------------------------------------------------------------
+void Throbber::initImages()
+{
+    if ( meImageSet == IMAGES_NONE )
+        return;
+
+    try
+    {
+        ::std::vector< ::std::vector< Image > > aImageSets;
+        if ( meImageSet == IMAGES_AUTO )
+        {
+            aImageSets.push_back( lcl_loadImageSet( IMAGES_16_PX ) );
+            aImageSets.push_back( lcl_loadImageSet( IMAGES_32_PX ) );
+            aImageSets.push_back( lcl_loadImageSet( IMAGES_64_PX ) );
+        }
+        else
+        {
+            aImageSets.push_back( lcl_loadImageSet( meImageSet ) );
+        }
+
+        // find the best matching image set (size-wise)
+        const ::Size aWindowSizePixel = GetSizePixel();
+        size_t nPreferredSet = 0;
+        if ( aImageSets.size() > 1 )
+        {
+            long nMinimalDistance = ::std::numeric_limits< long >::max();
+            for (   ::std::vector< ::std::vector< Image > >::const_iterator check = aImageSets.begin();
+                    check != aImageSets.end();
+                    ++check
+                )
+            {
+                ENSURE_OR_CONTINUE( !check->empty(), "Throbber::initImages: illegal image!" );
+                const Size aImageSize = (*check)[0].GetSizePixel();
+                const sal_Int64 distance =
+                        ( aWindowSizePixel.Width() - aImageSize.Width() ) * ( aWindowSizePixel.Width() - aImageSize.Width() )
+                    +   ( aWindowSizePixel.Height() - aImageSize.Height() ) * ( aWindowSizePixel.Height() - aImageSize.Height() );
+                if ( distance < nMinimalDistance )
+                {
+                    nMinimalDistance = distance;
+                    nPreferredSet = check - aImageSets.begin();
+                }
+            }
+        }
+
+        if ( nPreferredSet < aImageSets.size() )
+            setImageList( aImageSets[nPreferredSet] );
+    }
+    catch( const Exception& )
+    {
+        DBG_UNHANDLED_EXCEPTION();
+    }
+}
+
+//--------------------------------------------------------------------
+void Throbber::start()
+{
+    maWaitTimer.Start();
+}
+
+//--------------------------------------------------------------------
+void Throbber::stop()
+{
+    maWaitTimer.Stop();
+}
+
+//--------------------------------------------------------------------
+bool Throbber::isRunning() const
+{
+    return maWaitTimer.IsActive();
+}
+
+//--------------------------------------------------------------------
+void Throbber::setImageList( ::std::vector< Image > const& i_images )
+{
+    maImageList = i_images;
+
+    mnStepCount = maImageList.size();
+    const Image aInitialImage( mnStepCount ? maImageList[ 0 ] : Image() );
+    SetBitmap( aInitialImage.GetBitmapEx() );
+}
+
+//--------------------------------------------------------------------
+void Throbber::setImageList( const Sequence< Reference< XGraphic > >& rImageList )
+{
+    ::std::vector< Image > aImages( rImageList.getLength() );
+    ::std::copy(
+        rImageList.getConstArray(),
+        rImageList.getConstArray() + rImageList.getLength(),
+        aImages.begin()
+    );
+    setImageList( aImages );
+}
+
+// -----------------------------------------------------------------------
+::std::vector< ::rtl::OUString > Throbber::getDefaultImageURLs( const ImageSet i_imageSet )
+{
+    ::std::vector< ::rtl::OUString > aImageURLs;
+
+    sal_Char const* const pResolutions[] = { "16", "32", "64" };
+    size_t const nImageCounts[] = { 6, 12, 12 };
+
+    size_t index = 0;
+    switch ( i_imageSet )
+    {
+    case IMAGES_16_PX:  index = 0;  break;
+    case IMAGES_32_PX:  index = 1;  break;
+    case IMAGES_64_PX:  index = 2;  break;
+    case IMAGES_NONE:
+    case IMAGES_AUTO:
+        OSL_ENSURE( false, "Throbber::getDefaultImageURLs: illegal image set!" );
+        return aImageURLs;
+    }
+
+    aImageURLs.reserve( nImageCounts[index] );
+    for ( size_t i=0; i<nImageCounts[index]; ++i )
+    {
+        ::rtl::OUStringBuffer aURL;
+        aURL.appendAscii( "private:graphicrepository/res/shared/spinner-" );
+        aURL.appendAscii( pResolutions[index] );
+        aURL.appendAscii( "-" );
+        if ( i < 9 )
+            aURL.appendAscii( "0" );
+        aURL.append     ( sal_Int32( i + 1 ) );
+        aURL.appendAscii( ".png" );
+
+        aImageURLs.push_back( aURL.makeStringAndClear() );
+    }
+
+    return aImageURLs;
+}
+
+// -----------------------------------------------------------------------
+IMPL_LINK( Throbber, TimeOutHdl, void*, EMPTYARG )
+{
+    ::vos::OGuard aGuard( Application::GetSolarMutex() );
+    if ( maImageList.empty() )
+        return 0;
+
+    if ( mnCurStep < mnStepCount - 1 )
+        mnCurStep += 1;
+    else
+    {
+        if ( mbRepeat )
+        {
+            // start over
+            mnCurStep = 0;
+        }
+        else
+        {
+            stop();
+        }
+    }
+
+    SetBitmap( maImageList[ mnCurStep ].GetBitmapEx() );
+
+    return 0;
+}