include/vcl/throbber.hxx

   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 INCLUDED_VCL_THROBBER_HXX
  21 #define INCLUDED_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(vcl::Window* i_parentWindow, WinBits i_style, const ImageSet i_imageSet = IMAGES_AUTO);
  50     virtual ~Throbber();
  51     virtual void dispose() SAL_OVERRIDE;
  52
  53     // Properties
  54     void            setStepTime( sal_Int32 nStepTime )  { mnStepTime = nStepTime; }
  55     sal_Int32       getStepTime() const                 { return mnStepTime; }
  56
  57     void            setRepeat( bool bRepeat )       { mbRepeat = bRepeat; }
  58     bool        getRepeat() const                   { return mbRepeat; }
  59
  60     // animation control
  61     void start();
  62     void stop();
  63     bool isRunning() const;
  64
  65     void setImageList( const css::uno::Sequence< css::uno::Reference< css::graphic::XGraphic > >& ImageList );
  66     void setImageList( ::std::vector< Image > const& i_images );
  67
  68     // default images
  69     static ::std::vector< OUString >
  70         getDefaultImageURLs( const ImageSet i_imageSet );
  71
  72 protected:
  73     // Window overridables
  74     virtual void        Resize() SAL_OVERRIDE;
  75
  76 private:
  77     SAL_DLLPRIVATE void initImages();
  78
  79 private:
  80     ::std::vector< Image >  maImageList;
  81
  82     bool    mbRepeat;
  83     sal_Int32   mnStepTime;
  84     sal_Int32   mnCurStep;
  85     sal_Int32   mnStepCount;
  86     AutoTimer   maWaitTimer;
  87     ImageSet    meImageSet;
  88
  89     DECL_LINK_TYPED( TimeOutHdl, Timer*, void );
  90 };
  91
  92 #endif // INCLUDED_VCL_THROBBER_HXX
  93
  94 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */