include/vcl/timer.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 _SV_TIMER_HXX
  21 #define _SV_TIMER_HXX
  22
  23 #include <tools/link.hxx>
  24 #include <tools/solar.h>
  25 #include <vcl/dllapi.h>
  26
  27 struct ImplTimerData;
  28 struct ImplSVData;
  29
  30 // ---------
  31 // - Timer -
  32 // ---------
  33
  34 class VCL_DLLPUBLIC Timer
  35 {
  36 protected:
  37     ImplTimerData*  mpTimerData;
  38     sal_uLong           mnTimeout;
  39     sal_Bool            mbActive;
  40     sal_Bool            mbAuto;
  41     Link            maTimeoutHdl;
  42
  43 public:
  44                     Timer();
  45                     Timer( const Timer& rTimer );
  46     virtual         ~Timer();
  47
  48     virtual void    Timeout();
  49
  50     void            Start();
  51     void            Stop();
  52
  53     void            SetTimeout( sal_uLong nTimeout );
  54     sal_uLong           GetTimeout() const { return mnTimeout; }
  55     sal_Bool            IsActive() const { return mbActive; }
  56
  57     void            SetTimeoutHdl( const Link& rLink ) { maTimeoutHdl = rLink; }
  58     const Link&     GetTimeoutHdl() const { return maTimeoutHdl; }
  59
  60     Timer&          operator=( const Timer& rTimer );
  61
  62     static void ImplDeInitTimer();
  63     static void ImplTimerCallbackProc();
  64 };
  65
  66 // -------------
  67 // - AutoTimer -
  68 // -------------
  69
  70 class VCL_DLLPUBLIC AutoTimer : public Timer
  71 {
  72 public:
  73                     AutoTimer();
  74                     AutoTimer( const AutoTimer& rTimer );
  75
  76     AutoTimer&      operator=( const AutoTimer& rTimer );
  77 };
  78
  79 #endif // _SV_TIMER_HXX
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */