Line data Source code
1 : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 : /*
3 : * This file is part of the LibreOffice project.
4 : *
5 : * This Source Code Form is subject to the terms of the Mozilla Public
6 : * License, v. 2.0. If a copy of the MPL was not distributed with this
7 : * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 : *
9 : * This file incorporates work covered by the following license notice:
10 : *
11 : * Licensed to the Apache Software Foundation (ASF) under one or more
12 : * contributor license agreements. See the NOTICE file distributed
13 : * with this work for additional information regarding copyright
14 : * ownership. The ASF licenses this file to you under the Apache
15 : * License, Version 2.0 (the "License"); you may not use this file
16 : * except in compliance with the License. You may obtain a copy of
17 : * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 : */
19 :
20 : #include "vcl/throbber.hxx"
21 : #include "vcl/svapp.hxx"
22 :
23 : #include <com/sun/star/uno/XComponentContext.hpp>
24 : #include <com/sun/star/graphic/GraphicProvider.hpp>
25 : #include <com/sun/star/graphic/XGraphicProvider.hpp>
26 : #include <com/sun/star/awt/ImageScaleMode.hpp>
27 :
28 : #include <comphelper/namedvaluecollection.hxx>
29 : #include <comphelper/processfactory.hxx>
30 : #include <rtl/ustrbuf.hxx>
31 : #include <tools/diagnose_ex.h>
32 : #include <tools/urlobj.hxx>
33 :
34 : #include <limits>
35 :
36 : using ::com::sun::star::uno::Sequence;
37 : using ::com::sun::star::uno::Reference;
38 : using ::com::sun::star::graphic::XGraphic;
39 : using ::com::sun::star::graphic::XGraphicProvider;
40 : using ::com::sun::star::uno::UNO_QUERY_THROW;
41 : using ::com::sun::star::uno::UNO_QUERY;
42 : using ::com::sun::star::uno::Exception;
43 : namespace ImageScaleMode = ::com::sun::star::awt::ImageScaleMode;
44 :
45 0 : Throbber::Throbber( vcl::Window* i_parentWindow, WinBits i_style, const ImageSet i_imageSet )
46 : :ImageControl( i_parentWindow, i_style )
47 : ,mbRepeat( true )
48 : ,mnStepTime( 100 )
49 : ,mnCurStep( 0 )
50 : ,mnStepCount( 0 )
51 0 : ,meImageSet( i_imageSet )
52 : {
53 0 : maWaitTimer.SetTimeout( mnStepTime );
54 0 : maWaitTimer.SetTimeoutHdl( LINK( this, Throbber, TimeOutHdl ) );
55 :
56 0 : SetScaleMode( ImageScaleMode::NONE );
57 0 : initImages();
58 0 : }
59 :
60 0 : Throbber::~Throbber()
61 : {
62 0 : disposeOnce();
63 0 : }
64 :
65 0 : void Throbber::dispose()
66 : {
67 0 : maWaitTimer.Stop();
68 0 : ImageControl::dispose();
69 0 : }
70 :
71 : namespace
72 : {
73 0 : ::std::vector< Image > lcl_loadImageSet( const Throbber::ImageSet i_imageSet )
74 : {
75 0 : ::std::vector< Image > aImages;
76 0 : ENSURE_OR_RETURN( i_imageSet != Throbber::IMAGES_NONE, "lcl_loadImageSet: illegal image set", aImages );
77 :
78 0 : const Reference< com::sun::star::uno::XComponentContext > aContext( ::comphelper::getProcessComponentContext() );
79 0 : const Reference< XGraphicProvider > xGraphicProvider( com::sun::star::graphic::GraphicProvider::create(aContext) );
80 :
81 0 : ::std::vector< OUString > aImageURLs( Throbber::getDefaultImageURLs( i_imageSet ) );
82 0 : aImages.reserve( aImageURLs.size() );
83 :
84 0 : ::comphelper::NamedValueCollection aMediaProperties;
85 0 : for ( ::std::vector< OUString >::const_iterator imageURL = aImageURLs.begin();
86 0 : imageURL != aImageURLs.end();
87 : ++imageURL
88 : )
89 : {
90 0 : Reference< XGraphic > xGraphic;
91 0 : aMediaProperties.put( "URL", *imageURL );
92 0 : xGraphic.set( xGraphicProvider->queryGraphic( aMediaProperties.getPropertyValues() ), UNO_QUERY );
93 0 : aImages.push_back( Image( xGraphic ) );
94 0 : }
95 :
96 0 : return aImages;
97 : }
98 : }
99 :
100 0 : void Throbber::Resize()
101 : {
102 0 : ImageControl::Resize();
103 :
104 0 : if ( meImageSet == IMAGES_AUTO )
105 0 : initImages();
106 0 : }
107 :
108 0 : void Throbber::initImages()
109 : {
110 0 : if ( meImageSet == IMAGES_NONE )
111 0 : return;
112 :
113 : try
114 : {
115 0 : ::std::vector< ::std::vector< Image > > aImageSets;
116 0 : if ( meImageSet == IMAGES_AUTO )
117 : {
118 0 : aImageSets.push_back( lcl_loadImageSet( IMAGES_16_PX ) );
119 0 : aImageSets.push_back( lcl_loadImageSet( IMAGES_32_PX ) );
120 0 : aImageSets.push_back( lcl_loadImageSet( IMAGES_64_PX ) );
121 : }
122 : else
123 : {
124 0 : aImageSets.push_back( lcl_loadImageSet( meImageSet ) );
125 : }
126 :
127 : // find the best matching image set (size-wise)
128 0 : const ::Size aWindowSizePixel = GetSizePixel();
129 0 : size_t nPreferredSet = 0;
130 0 : if ( aImageSets.size() > 1 )
131 : {
132 0 : long nMinimalDistance = ::std::numeric_limits< long >::max();
133 0 : for ( ::std::vector< ::std::vector< Image > >::const_iterator check = aImageSets.begin();
134 0 : check != aImageSets.end();
135 : ++check
136 : )
137 : {
138 0 : if ( check->empty() )
139 : {
140 : SAL_WARN( "vcl.control", "Throbber::initImages: illegal image!" );
141 0 : continue;
142 : }
143 :
144 0 : const Size aImageSize = (*check)[0].GetSizePixel();
145 :
146 0 : if ( ( aImageSize.Width() > aWindowSizePixel.Width() )
147 0 : || ( aImageSize.Height() > aWindowSizePixel.Height() )
148 : )
149 : // do not use an image set which doesn't fit into the window
150 0 : continue;
151 :
152 : const sal_Int64 distance =
153 0 : ( aWindowSizePixel.Width() - aImageSize.Width() ) * ( aWindowSizePixel.Width() - aImageSize.Width() )
154 0 : + ( aWindowSizePixel.Height() - aImageSize.Height() ) * ( aWindowSizePixel.Height() - aImageSize.Height() );
155 0 : if ( distance < nMinimalDistance )
156 : {
157 0 : nMinimalDistance = distance;
158 0 : nPreferredSet = check - aImageSets.begin();
159 : }
160 : }
161 : }
162 :
163 0 : if ( nPreferredSet < aImageSets.size() )
164 0 : setImageList( aImageSets[nPreferredSet] );
165 : }
166 0 : catch( const Exception& )
167 : {
168 : }
169 : }
170 :
171 0 : void Throbber::start()
172 : {
173 0 : maWaitTimer.Start();
174 0 : }
175 :
176 0 : void Throbber::stop()
177 : {
178 0 : maWaitTimer.Stop();
179 0 : }
180 :
181 0 : bool Throbber::isRunning() const
182 : {
183 0 : return maWaitTimer.IsActive();
184 : }
185 :
186 0 : void Throbber::setImageList( ::std::vector< Image > const& i_images )
187 : {
188 0 : maImageList = i_images;
189 :
190 0 : mnStepCount = maImageList.size();
191 0 : const Image aInitialImage( mnStepCount ? maImageList[ 0 ] : Image() );
192 0 : SetImage( aInitialImage );
193 0 : }
194 :
195 0 : void Throbber::setImageList( const Sequence< Reference< XGraphic > >& rImageList )
196 : {
197 0 : ::std::vector< Image > aImages( rImageList.getLength() );
198 0 : for (sal_Int32 i = 0; i < rImageList.getLength(); ++i)
199 : {
200 0 : aImages[i] = Image(rImageList[i]);
201 : }
202 0 : setImageList( aImages );
203 0 : }
204 :
205 3 : ::std::vector< OUString > Throbber::getDefaultImageURLs( const ImageSet i_imageSet )
206 : {
207 3 : ::std::vector< OUString > aImageURLs;
208 :
209 3 : sal_Char const* const pResolutions[] = { "16", "32", "64" };
210 3 : size_t const nImageCounts[] = { 6, 12, 12 };
211 :
212 3 : size_t index = 0;
213 3 : switch ( i_imageSet )
214 : {
215 1 : case IMAGES_16_PX: index = 0; break;
216 1 : case IMAGES_32_PX: index = 1; break;
217 1 : case IMAGES_64_PX: index = 2; break;
218 : case IMAGES_NONE:
219 : case IMAGES_AUTO:
220 : OSL_ENSURE( false, "Throbber::getDefaultImageURLs: illegal image set!" );
221 0 : return aImageURLs;
222 : }
223 :
224 3 : aImageURLs.reserve( nImageCounts[index] );
225 33 : for ( size_t i=0; i<nImageCounts[index]; ++i )
226 : {
227 30 : OUStringBuffer aURL;
228 30 : aURL.appendAscii( "private:graphicrepository/vcl/res/spinner-" );
229 30 : aURL.appendAscii( pResolutions[index] );
230 30 : aURL.appendAscii( "-" );
231 30 : if ( i < 9 )
232 24 : aURL.appendAscii( "0" );
233 30 : aURL.append ( sal_Int32( i + 1 ) );
234 30 : aURL.appendAscii( ".png" );
235 :
236 30 : aImageURLs.push_back( aURL.makeStringAndClear() );
237 30 : }
238 :
239 3 : return aImageURLs;
240 : }
241 :
242 0 : IMPL_LINK_NOARG_TYPED(Throbber, TimeOutHdl, Timer *, void)
243 : {
244 0 : SolarMutexGuard aGuard;
245 0 : if ( maImageList.empty() )
246 0 : return;
247 :
248 0 : if ( mnCurStep < mnStepCount - 1 )
249 0 : mnCurStep += 1;
250 : else
251 : {
252 0 : if ( mbRepeat )
253 : {
254 : // start over
255 0 : mnCurStep = 0;
256 : }
257 : else
258 : {
259 0 : stop();
260 : }
261 : }
262 :
263 0 : SetImage( maImageList[ mnCurStep ] );
264 801 : }
265 :
266 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|