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 :
21 : #include "vcl/throbber.hxx"
22 : #include "vcl/svapp.hxx"
23 :
24 : #include <com/sun/star/uno/XComponentContext.hpp>
25 : #include <com/sun/star/graphic/GraphicProvider.hpp>
26 : #include <com/sun/star/graphic/XGraphicProvider.hpp>
27 : #include <com/sun/star/awt/ImageScaleMode.hpp>
28 :
29 : #include <comphelper/componentcontext.hxx>
30 : #include <comphelper/namedvaluecollection.hxx>
31 : #include <comphelper/processfactory.hxx>
32 : #include <rtl/ustrbuf.hxx>
33 : #include <tools/diagnose_ex.h>
34 : #include <tools/urlobj.hxx>
35 :
36 : #include <limits>
37 :
38 : using ::com::sun::star::uno::Sequence;
39 : using ::com::sun::star::uno::Reference;
40 : using ::com::sun::star::graphic::XGraphic;
41 : using ::com::sun::star::graphic::XGraphicProvider;
42 : using ::com::sun::star::uno::UNO_QUERY_THROW;
43 : using ::com::sun::star::uno::UNO_QUERY;
44 : using ::com::sun::star::uno::Exception;
45 : namespace ImageScaleMode = ::com::sun::star::awt::ImageScaleMode;
46 :
47 : //----------------------------------------------------------------------------------------------------------------------
48 0 : Throbber::Throbber( Window* i_parentWindow, WinBits i_style, const ImageSet i_imageSet )
49 : :ImageControl( i_parentWindow, i_style )
50 : ,mbRepeat( sal_True )
51 : ,mnStepTime( 100 )
52 : ,mnCurStep( 0 )
53 : ,mnStepCount( 0 )
54 0 : ,meImageSet( i_imageSet )
55 : {
56 0 : maWaitTimer.SetTimeout( mnStepTime );
57 0 : maWaitTimer.SetTimeoutHdl( LINK( this, Throbber, TimeOutHdl ) );
58 :
59 0 : SetScaleMode( ImageScaleMode::None );
60 0 : initImages();
61 0 : }
62 :
63 : //--------------------------------------------------------------------
64 0 : Throbber::Throbber( Window* i_parentWindow, const ResId& i_resId, const ImageSet i_imageSet )
65 : :ImageControl( i_parentWindow, i_resId )
66 : ,mbRepeat( sal_True )
67 : ,mnStepTime( 100 )
68 : ,mnCurStep( 0 )
69 : ,mnStepCount( 0 )
70 0 : ,meImageSet( i_imageSet )
71 : {
72 0 : maWaitTimer.SetTimeout( mnStepTime );
73 0 : maWaitTimer.SetTimeoutHdl( LINK( this, Throbber, TimeOutHdl ) );
74 :
75 0 : SetScaleMode( ImageScaleMode::None );
76 0 : initImages();
77 0 : }
78 :
79 : //----------------------------------------------------------------------------------------------------------------------
80 0 : Throbber::~Throbber()
81 : {
82 0 : maWaitTimer.Stop();
83 0 : }
84 :
85 : //----------------------------------------------------------------------------------------------------------------------
86 : namespace
87 : {
88 : //..................................................................................................................
89 0 : ::rtl::OUString lcl_getHighContrastURL( ::rtl::OUString const& i_imageURL )
90 : {
91 0 : INetURLObject aURL( i_imageURL );
92 0 : if ( aURL.GetProtocol() != INET_PROT_PRIV_SOFFICE )
93 : {
94 0 : OSL_VERIFY( aURL.insertName( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "hicontrast" ) ), false, 0 ) );
95 0 : return aURL.GetMainURL( INetURLObject::NO_DECODE );
96 : }
97 : // the private: scheme is not considered to be hierarchical by INetURLObject, so manually insert the
98 : // segment
99 0 : const sal_Int32 separatorPos = i_imageURL.indexOf( '/' );
100 0 : ENSURE_OR_RETURN( separatorPos != -1, "lcl_getHighContrastURL: unsipported URL scheme - cannot automatically determine HC version!", i_imageURL );
101 :
102 0 : ::rtl::OUStringBuffer composer;
103 0 : composer.append( i_imageURL.copy( 0, separatorPos ) );
104 0 : composer.appendAscii( "/hicontrast" );
105 0 : composer.append( i_imageURL.copy( separatorPos ) );
106 0 : return composer.makeStringAndClear();
107 : }
108 :
109 : //..................................................................................................................
110 0 : ::std::vector< Image > lcl_loadImageSet( const Throbber::ImageSet i_imageSet, const bool i_isHiContrast )
111 : {
112 0 : ::std::vector< Image > aImages;
113 0 : ENSURE_OR_RETURN( i_imageSet != Throbber::IMAGES_NONE, "lcl_loadImageSet: illegal image set", aImages );
114 :
115 0 : const Reference< com::sun::star::uno::XComponentContext > aContext( ::comphelper::getProcessComponentContext() );
116 0 : const Reference< XGraphicProvider > xGraphicProvider( com::sun::star::graphic::GraphicProvider::create(aContext) );
117 :
118 0 : ::std::vector< ::rtl::OUString > aImageURLs( Throbber::getDefaultImageURLs( i_imageSet ) );
119 0 : aImages.reserve( aImageURLs.size() );
120 :
121 0 : ::comphelper::NamedValueCollection aMediaProperties;
122 0 : for ( ::std::vector< ::rtl::OUString >::const_iterator imageURL = aImageURLs.begin();
123 0 : imageURL != aImageURLs.end();
124 : ++imageURL
125 : )
126 : {
127 0 : Reference< XGraphic > xGraphic;
128 0 : if ( i_isHiContrast )
129 : {
130 0 : aMediaProperties.put( "URL", lcl_getHighContrastURL( *imageURL ) );
131 0 : xGraphic.set( xGraphicProvider->queryGraphic( aMediaProperties.getPropertyValues() ), UNO_QUERY );
132 : }
133 0 : if ( !xGraphic.is() )
134 : {
135 0 : aMediaProperties.put( "URL", *imageURL );
136 0 : xGraphic.set( xGraphicProvider->queryGraphic( aMediaProperties.getPropertyValues() ), UNO_QUERY );
137 : }
138 0 : aImages.push_back( Image( xGraphic ) );
139 0 : }
140 :
141 0 : return aImages;
142 : }
143 : }
144 :
145 : //----------------------------------------------------------------------------------------------------------------------
146 0 : void Throbber::Resize()
147 : {
148 0 : ImageControl::Resize();
149 :
150 0 : if ( meImageSet == IMAGES_AUTO )
151 0 : initImages();
152 0 : }
153 :
154 : //----------------------------------------------------------------------------------------------------------------------
155 0 : void Throbber::initImages()
156 : {
157 0 : if ( meImageSet == IMAGES_NONE )
158 0 : return;
159 :
160 : try
161 : {
162 0 : ::std::vector< ::std::vector< Image > > aImageSets;
163 0 : const bool isHiContrast = GetSettings().GetStyleSettings().GetHighContrastMode();
164 0 : if ( meImageSet == IMAGES_AUTO )
165 : {
166 0 : aImageSets.push_back( lcl_loadImageSet( IMAGES_16_PX, isHiContrast ) );
167 0 : aImageSets.push_back( lcl_loadImageSet( IMAGES_32_PX, isHiContrast ) );
168 0 : aImageSets.push_back( lcl_loadImageSet( IMAGES_64_PX, isHiContrast ) );
169 : }
170 : else
171 : {
172 0 : aImageSets.push_back( lcl_loadImageSet( meImageSet, isHiContrast ) );
173 : }
174 :
175 : // find the best matching image set (size-wise)
176 0 : const ::Size aWindowSizePixel = GetSizePixel();
177 0 : size_t nPreferredSet = 0;
178 0 : if ( aImageSets.size() > 1 )
179 : {
180 0 : long nMinimalDistance = ::std::numeric_limits< long >::max();
181 0 : for ( ::std::vector< ::std::vector< Image > >::const_iterator check = aImageSets.begin();
182 0 : check != aImageSets.end();
183 : ++check
184 : )
185 : {
186 0 : if ( check->empty() )
187 : {
188 : SAL_WARN( "vcl.control", "Throbber::initImages: illegal image!" );
189 0 : continue;
190 : }
191 :
192 0 : const Size aImageSize = (*check)[0].GetSizePixel();
193 :
194 0 : if ( ( aImageSize.Width() > aWindowSizePixel.Width() )
195 0 : || ( aImageSize.Height() > aWindowSizePixel.Height() )
196 : )
197 : // do not use an image set which doesn't fit into the window
198 0 : continue;
199 :
200 : const sal_Int64 distance =
201 0 : ( aWindowSizePixel.Width() - aImageSize.Width() ) * ( aWindowSizePixel.Width() - aImageSize.Width() )
202 0 : + ( aWindowSizePixel.Height() - aImageSize.Height() ) * ( aWindowSizePixel.Height() - aImageSize.Height() );
203 0 : if ( distance < nMinimalDistance )
204 : {
205 0 : nMinimalDistance = distance;
206 0 : nPreferredSet = check - aImageSets.begin();
207 : }
208 : }
209 : }
210 :
211 0 : if ( nPreferredSet < aImageSets.size() )
212 0 : setImageList( aImageSets[nPreferredSet] );
213 : }
214 0 : catch( const Exception& )
215 : {
216 : DBG_UNHANDLED_EXCEPTION();
217 : }
218 : }
219 :
220 : //----------------------------------------------------------------------------------------------------------------------
221 0 : void Throbber::start()
222 : {
223 0 : maWaitTimer.Start();
224 0 : }
225 :
226 : //----------------------------------------------------------------------------------------------------------------------
227 0 : void Throbber::stop()
228 : {
229 0 : maWaitTimer.Stop();
230 0 : }
231 :
232 : //----------------------------------------------------------------------------------------------------------------------
233 0 : bool Throbber::isRunning() const
234 : {
235 0 : return maWaitTimer.IsActive();
236 : }
237 :
238 : //----------------------------------------------------------------------------------------------------------------------
239 0 : void Throbber::setImageList( ::std::vector< Image > const& i_images )
240 : {
241 0 : maImageList = i_images;
242 :
243 0 : mnStepCount = maImageList.size();
244 0 : const Image aInitialImage( mnStepCount ? maImageList[ 0 ] : Image() );
245 0 : SetImage( aInitialImage );
246 0 : }
247 :
248 : //----------------------------------------------------------------------------------------------------------------------
249 0 : void Throbber::setImageList( const Sequence< Reference< XGraphic > >& rImageList )
250 : {
251 0 : ::std::vector< Image > aImages( rImageList.getLength() );
252 : ::std::copy(
253 : rImageList.getConstArray(),
254 0 : rImageList.getConstArray() + rImageList.getLength(),
255 : aImages.begin()
256 0 : );
257 0 : setImageList( aImages );
258 0 : }
259 :
260 : //----------------------------------------------------------------------------------------------------------------------
261 0 : ::std::vector< ::rtl::OUString > Throbber::getDefaultImageURLs( const ImageSet i_imageSet )
262 : {
263 0 : ::std::vector< ::rtl::OUString > aImageURLs;
264 :
265 0 : sal_Char const* const pResolutions[] = { "16", "32", "64" };
266 0 : size_t const nImageCounts[] = { 6, 12, 12 };
267 :
268 0 : size_t index = 0;
269 0 : switch ( i_imageSet )
270 : {
271 0 : case IMAGES_16_PX: index = 0; break;
272 0 : case IMAGES_32_PX: index = 1; break;
273 0 : case IMAGES_64_PX: index = 2; break;
274 : case IMAGES_NONE:
275 : case IMAGES_AUTO:
276 : OSL_ENSURE( false, "Throbber::getDefaultImageURLs: illegal image set!" );
277 : return aImageURLs;
278 : }
279 :
280 0 : aImageURLs.reserve( nImageCounts[index] );
281 0 : for ( size_t i=0; i<nImageCounts[index]; ++i )
282 : {
283 0 : ::rtl::OUStringBuffer aURL;
284 0 : aURL.appendAscii( "private:graphicrepository/shared/spinner-" );
285 0 : aURL.appendAscii( pResolutions[index] );
286 0 : aURL.appendAscii( "-" );
287 0 : if ( i < 9 )
288 0 : aURL.appendAscii( "0" );
289 0 : aURL.append ( sal_Int32( i + 1 ) );
290 0 : aURL.appendAscii( ".png" );
291 :
292 0 : aImageURLs.push_back( aURL.makeStringAndClear() );
293 0 : }
294 :
295 0 : return aImageURLs;
296 : }
297 :
298 : //----------------------------------------------------------------------------------------------------------------------
299 0 : IMPL_LINK_NOARG(Throbber, TimeOutHdl)
300 : {
301 0 : SolarMutexGuard aGuard;
302 0 : if ( maImageList.empty() )
303 0 : return 0;
304 :
305 0 : if ( mnCurStep < mnStepCount - 1 )
306 0 : mnCurStep += 1;
307 : else
308 : {
309 0 : if ( mbRepeat )
310 : {
311 : // start over
312 0 : mnCurStep = 0;
313 : }
314 : else
315 : {
316 0 : stop();
317 : }
318 : }
319 :
320 0 : SetImage( maImageList[ mnCurStep ] );
321 :
322 0 : return 0;
323 : }
324 :
325 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
