LibreOffice Module vcl (master)  1
throbber.hxx
Go to the documentation of this file.
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 #if !defined(VCL_DLLIMPLEMENTATION) && !defined(TOOLKIT_DLLIMPLEMENTATION)
24 #error "don't use this in new code"
25 #endif
26 
27 #include <vcl/dllapi.h>
28 #include <vcl/toolkit/imgctrl.hxx>
29 #include <vcl/timer.hxx>
30 
31 #include <vector>
32 
33 class VCL_DLLPUBLIC Throbber final : public ImageControl
34 {
35 public:
36  enum class ImageSet
37  {
39  N16px,
41  N32px,
43  N64px,
44  };
45 
46 public:
47  Throbber(vcl::Window* i_parentWindow, WinBits i_style);
48  virtual ~Throbber() override;
49  virtual void dispose() override;
50 
51  // Properties
52  void setStepTime( sal_Int32 nStepTime ) { mnStepTime = nStepTime; }
53  sal_Int32 getStepTime() const { return mnStepTime; }
54 
55  void setRepeat( bool bRepeat ) { mbRepeat = bRepeat; }
56  bool getRepeat() const { return mbRepeat; }
57 
58  // animation control
59  void start();
60  void stop();
61  bool isRunning() const;
62 
63  void setImageList( ::std::vector< Image > const& i_images );
64 
65  // default images
66  static ::std::vector< OUString >
67  getDefaultImageURLs( const ImageSet i_imageSet );
68 
69 private:
70  // Window overridables
71  virtual void Resize() override;
72 
73  SAL_DLLPRIVATE void initImages();
74 
75  ::std::vector< Image > maImageList;
76 
77  bool mbRepeat;
78  sal_Int32 mnStepTime;
79  sal_Int32 mnCurStep;
81 
82  DECL_LINK( TimeOutHdl, Timer*, void );
83 };
84 
85 #endif // INCLUDED_VCL_THROBBER_HXX
86 
87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
sal_Int32 mnCurStep
Definition: throbber.hxx:79
void setRepeat(bool bRepeat)
Definition: throbber.hxx:55
#define VCL_DLLPUBLIC
Definition: dllapi.h:29
sal_Int32 getStepTime() const
Definition: throbber.hxx:53
sal_Int64 WinBits
bool getRepeat() const
Definition: throbber.hxx:56
AutoTimer maWaitTimer
Definition: throbber.hxx:80
sal_Int32 mnStepTime
Definition: throbber.hxx:78
virtual void Resize() override
Definition: imgctrl.cxx:42
An auto-timer is a multi-shot timer re-emitting itself at interval until destroyed or stopped...
Definition: timer.hxx:72
def stop
virtual void dispose() override
This is intended to be used to clear any locally held references to other Window-subclass objects...
Definition: ctrl.cxx:59
void setStepTime(sal_Int32 nStepTime)
Definition: throbber.hxx:52
::std::vector< Image > maImageList
Definition: throbber.hxx:75
bool mbRepeat
Definition: throbber.hxx:77
Definition: timer.hxx:26