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             : #ifndef VCL_THROBBER_HXX
      21             : #define VCL_THROBBER_HXX
      22             : 
      23             : #include "vcl/dllapi.h"
      24             : #include "vcl/imgctrl.hxx"
      25             : #include "vcl/timer.hxx"
      26             : 
      27             : #include <com/sun/star/graphic/XGraphic.hpp>
      28             : 
      29             : #include <vector>
      30             : 
      31             : class VCL_DLLPUBLIC Throbber : public ImageControl
      32             : {
      33             : public:
      34             :     enum ImageSet
      35             :     {
      36             :         /// no (default) images at all
      37             :         IMAGES_NONE,
      38             :         /// automatically decide between different image sets, depending on what fits best the actual size
      39             :         IMAGES_AUTO,
      40             :         /// default images, 16x16 pixels
      41             :         IMAGES_16_PX,
      42             :         /// default images, 32x32 pixels
      43             :         IMAGES_32_PX,
      44             :         /// default images, 64x64 pixels
      45             :         IMAGES_64_PX,
      46             :     };
      47             : 
      48             : public:
      49             :                     Throbber( Window* i_parentWindow, WinBits i_style, const ImageSet i_imageSet = IMAGES_AUTO );
      50             :                     Throbber( Window* i_parentWindow, const ResId& i_resId, const ImageSet i_imageSet = IMAGES_AUTO );
      51             :                     ~Throbber();
      52             : 
      53             :     // Properties
      54           0 :     void            setStepTime( sal_Int32 nStepTime )  { mnStepTime = nStepTime; }
      55           0 :     sal_Int32       getStepTime() const                 { return mnStepTime; }
      56             : 
      57           0 :     void            setRepeat( sal_Bool bRepeat )       { mbRepeat = bRepeat; }
      58           0 :     sal_Bool        getRepeat() const                   { return mbRepeat; }
      59             : 
      60             :     // animation control
      61             :     void start();
      62             :     void stop();
      63             :     bool isRunning() const;
      64             : 
      65             :     void setImageList( const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::graphic::XGraphic > >& ImageList );
      66             :     void setImageList( ::std::vector< Image > const& i_images );
      67             : 
      68             :     // default images
      69             :     static ::std::vector< ::rtl::OUString >
      70             :         getDefaultImageURLs( const ImageSet i_imageSet );
      71             : 
      72             : protected:
      73             :     // Window overridables
      74             :     virtual void        Resize();
      75             : 
      76             : private:
      77             :     SAL_DLLPRIVATE void initImages();
      78             : 
      79             : private:
      80             :     ::std::vector< Image >  maImageList;
      81             : 
      82             :     sal_Bool    mbRepeat;
      83             :     sal_Int32   mnStepTime;
      84             :     sal_Int32   mnCurStep;
      85             :     sal_Int32   mnStepCount;
      86             :     AutoTimer   maWaitTimer;
      87             :     ImageSet    meImageSet;
      88             : 
      89             :     DECL_LINK( TimeOutHdl, void* );
      90             : };
      91             : 
      92             : #endif // VCL_THROBBER_HXX
      93             : 
      94             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */