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 <vector>
  28
  29 class VCL_DLLPUBLIC Throbber : public ImageControl
  30 {
  31 public:
  32     enum class ImageSet
  33     {
  34         /// default images, 16x16 pixels
  35         N16px,
  36         /// default images, 32x32 pixels
  37         N32px,
  38         /// default images, 64x64 pixels
  39         N64px,
  40     };
  41
  42 public:
  43     Throbber(vcl::Window* i_parentWindow, WinBits i_style);
  44     virtual ~Throbber() override;
  45     virtual void dispose() override;
  46
  47     // Properties
  48     void            setStepTime( sal_Int32 nStepTime )  { mnStepTime = nStepTime; }
  49     sal_Int32       getStepTime() const                 { return mnStepTime; }
  50
  51     void            setRepeat( bool bRepeat )       { mbRepeat = bRepeat; }
  52     bool        getRepeat() const                   { return mbRepeat; }
  53
  54     // animation control
  55     void start();
  56     void stop();
  57     bool isRunning() const;
  58
  59     void setImageList( ::std::vector< Image > const& i_images );
  60
  61     // default images
  62     static ::std::vector< OUString >
  63         getDefaultImageURLs( const ImageSet i_imageSet );
  64
  65 protected:
  66     // Window overridables
  67     virtual void        Resize() override;
  68
  69 private:
  70     SAL_DLLPRIVATE void initImages();
  71
  72 private:
  73     ::std::vector< Image >  maImageList;
  74
  75     bool    mbRepeat;
  76     sal_Int32   mnStepTime;
  77     sal_Int32   mnCurStep;
  78     AutoTimer   maWaitTimer;
  79
  80     DECL_LINK( TimeOutHdl, Timer*, void );
  81 };
  82
  83 #endif // INCLUDED_VCL_THROBBER_HXX
  84
  85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */