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( 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( Window* i_parentWindow, const ResId& i_resId, const ImageSet i_imageSet )
61 : :ImageControl( i_parentWindow, i_resId )
62 : ,mbRepeat( true )
63 : ,mnStepTime( 100 )
64 : ,mnCurStep( 0 )
65 : ,mnStepCount( 0 )
66 0 : ,meImageSet( i_imageSet )
67 : {
68 0 : maWaitTimer.SetTimeout( mnStepTime );
69 0 : maWaitTimer.SetTimeoutHdl( LINK( this, Throbber, TimeOutHdl ) );
70 :
71 0 : SetScaleMode( ImageScaleMode::NONE );
72 0 : initImages();
73 0 : }
74 :
75 0 : Throbber::~Throbber()
76 : {
77 0 : maWaitTimer.Stop();
78 0 : }
79 :
80 : namespace
81 : {
82 0 : ::std::vector< Image > lcl_loadImageSet( const Throbber::ImageSet i_imageSet )
83 : {
84 0 : ::std::vector< Image > aImages;
85 0 : ENSURE_OR_RETURN( i_imageSet != Throbber::IMAGES_NONE, "lcl_loadImageSet: illegal image set", aImages );
86 :
87 0 : const Reference< com::sun::star::uno::XComponentContext > aContext( ::comphelper::getProcessComponentContext() );
88 0 : const Reference< XGraphicProvider > xGraphicProvider( com::sun::star::graphic::GraphicProvider::create(aContext) );
89 :
90 0 : ::std::vector< OUString > aImageURLs( Throbber::getDefaultImageURLs( i_imageSet ) );
91 0 : aImages.reserve( aImageURLs.size() );
92 :
93 0 : ::comphelper::NamedValueCollection aMediaProperties;
94 0 : for ( ::std::vector< OUString >::const_iterator imageURL = aImageURLs.begin();
95 0 : imageURL != aImageURLs.end();
96 : ++imageURL
97 : )
98 : {
99 0 : Reference< XGraphic > xGraphic;
100 0 : aMediaProperties.put( "URL", *imageURL );
101 0 : xGraphic.set( xGraphicProvider->queryGraphic( aMediaProperties.getPropertyValues() ), UNO_QUERY );
102 0 : aImages.push_back( Image( xGraphic ) );
103 0 : }
104 :
105 0 : return aImages;
106 : }
107 : }
108 :
109 0 : void Throbber::Resize()
110 : {
111 0 : ImageControl::Resize();
112 :
113 0 : if ( meImageSet == IMAGES_AUTO )
114 0 : initImages();
115 0 : }
116 :
117 0 : void Throbber::initImages()
118 : {
119 0 : if ( meImageSet == IMAGES_NONE )
120 0 : return;
121 :
122 : try
123 : {
124 0 : ::std::vector< ::std::vector< Image > > aImageSets;
125 0 : if ( meImageSet == IMAGES_AUTO )
126 : {
127 0 : aImageSets.push_back( lcl_loadImageSet( IMAGES_16_PX ) );
128 0 : aImageSets.push_back( lcl_loadImageSet( IMAGES_32_PX ) );
129 0 : aImageSets.push_back( lcl_loadImageSet( IMAGES_64_PX ) );
130 : }
131 : else
132 : {
133 0 : aImageSets.push_back( lcl_loadImageSet( meImageSet ) );
134 : }
135 :
136 : // find the best matching image set (size-wise)
137 0 : const ::Size aWindowSizePixel = GetSizePixel();
138 0 : size_t nPreferredSet = 0;
139 0 : if ( aImageSets.size() > 1 )
140 : {
141 0 : long nMinimalDistance = ::std::numeric_limits< long >::max();
142 0 : for ( ::std::vector< ::std::vector< Image > >::const_iterator check = aImageSets.begin();
143 0 : check != aImageSets.end();
144 : ++check
145 : )
146 : {
147 0 : if ( check->empty() )
148 : {
149 : SAL_WARN( "vcl.control", "Throbber::initImages: illegal image!" );
150 0 : continue;
151 : }
152 :
153 0 : const Size aImageSize = (*check)[0].GetSizePixel();
154 :
155 0 : if ( ( aImageSize.Width() > aWindowSizePixel.Width() )
156 0 : || ( aImageSize.Height() > aWindowSizePixel.Height() )
157 : )
158 : // do not use an image set which doesn't fit into the window
159 0 : continue;
160 :
161 : const sal_Int64 distance =
162 0 : ( aWindowSizePixel.Width() - aImageSize.Width() ) * ( aWindowSizePixel.Width() - aImageSize.Width() )
163 0 : + ( aWindowSizePixel.Height() - aImageSize.Height() ) * ( aWindowSizePixel.Height() - aImageSize.Height() );
164 0 : if ( distance < nMinimalDistance )
165 : {
166 0 : nMinimalDistance = distance;
167 0 : nPreferredSet = check - aImageSets.begin();
168 : }
169 : }
170 : }
171 :
172 0 : if ( nPreferredSet < aImageSets.size() )
173 0 : setImageList( aImageSets[nPreferredSet] );
174 : }
175 0 : catch( const Exception& )
176 : {
177 : }
178 : }
179 :
180 0 : void Throbber::start()
181 : {
182 0 : maWaitTimer.Start();
183 0 : }
184 :
185 0 : void Throbber::stop()
186 : {
187 0 : maWaitTimer.Stop();
188 0 : }
189 :
190 0 : bool Throbber::isRunning() const
191 : {
192 0 : return maWaitTimer.IsActive();
193 : }
194 :
195 0 : void Throbber::setImageList( ::std::vector< Image > const& i_images )
196 : {
197 0 : maImageList = i_images;
198 :
199 0 : mnStepCount = maImageList.size();
200 0 : const Image aInitialImage( mnStepCount ? maImageList[ 0 ] : Image() );
201 0 : SetImage( aInitialImage );
202 0 : }
203 :
204 0 : void Throbber::setImageList( const Sequence< Reference< XGraphic > >& rImageList )
205 : {
206 0 : ::std::vector< Image > aImages( rImageList.getLength() );
207 0 : for (sal_Int32 i = 0; i < rImageList.getLength(); ++i)
208 : {
209 0 : aImages[i] = Image(rImageList[i]);
210 : }
211 0 : setImageList( aImages );
212 0 : }
213 :
214 0 : ::std::vector< OUString > Throbber::getDefaultImageURLs( const ImageSet i_imageSet )
215 : {
216 0 : ::std::vector< OUString > aImageURLs;
217 :
218 0 : sal_Char const* const pResolutions[] = { "16", "32", "64" };
219 0 : size_t const nImageCounts[] = { 6, 12, 12 };
220 :
221 0 : size_t index = 0;
222 0 : switch ( i_imageSet )
223 : {
224 0 : case IMAGES_16_PX: index = 0; break;
225 0 : case IMAGES_32_PX: index = 1; break;
226 0 : case IMAGES_64_PX: index = 2; break;
227 : case IMAGES_NONE:
228 : case IMAGES_AUTO:
229 : OSL_ENSURE( false, "Throbber::getDefaultImageURLs: illegal image set!" );
230 0 : return aImageURLs;
231 : }
232 :
233 0 : aImageURLs.reserve( nImageCounts[index] );
234 0 : for ( size_t i=0; i<nImageCounts[index]; ++i )
235 : {
236 0 : OUStringBuffer aURL;
237 0 : aURL.appendAscii( "private:graphicrepository/vcl/res/spinner-" );
238 0 : aURL.appendAscii( pResolutions[index] );
239 0 : aURL.appendAscii( "-" );
240 0 : if ( i < 9 )
241 0 : aURL.appendAscii( "0" );
242 0 : aURL.append ( sal_Int32( i + 1 ) );
243 0 : aURL.appendAscii( ".png" );
244 :
245 0 : aImageURLs.push_back( aURL.makeStringAndClear() );
246 0 : }
247 :
248 0 : return aImageURLs;
249 : }
250 :
251 0 : IMPL_LINK_NOARG(Throbber, TimeOutHdl)
252 : {
253 0 : SolarMutexGuard aGuard;
254 0 : if ( maImageList.empty() )
255 0 : return 0;
256 :
257 0 : if ( mnCurStep < mnStepCount - 1 )
258 0 : mnCurStep += 1;
259 : else
260 : {
261 0 : if ( mbRepeat )
262 : {
263 : // start over
264 0 : mnCurStep = 0;
265 : }
266 : else
267 : {
268 0 : stop();
269 : }
270 : }
271 :
272 0 : SetImage( maImageList[ mnCurStep ] );
273 :
274 0 : return 0;
275 : }
276 :
277 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|