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 INCLUDED_VCL_TIMER_HXX
      21             : #define INCLUDED_VCL_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             : /// Base-class for timers - usually a simple, one-shot timeout
      31             : class VCL_DLLPUBLIC Timer
      32             : {
      33             : protected:
      34             :     ImplTimerData*  mpTimerData;
      35             :     sal_uLong       mnTimeout;
      36             :     bool            mbActive;
      37             :     bool            mbAuto;
      38             :     Link            maTimeoutHdl;
      39             : 
      40             : public:
      41             :                     Timer();
      42             :                     Timer( const Timer& rTimer );
      43             :     virtual         ~Timer();
      44             : 
      45             :     virtual void    Timeout();
      46             : 
      47             :     void            Start();
      48             :     void            Stop();
      49             : 
      50             :     /// set the timeout in milliseconds
      51             :     void            SetTimeout( sal_uLong nTimeoutMs );
      52       74328 :     sal_uLong       GetTimeout() const { return mnTimeout; }
      53     3285618 :     bool            IsActive() const { return mbActive; }
      54             : 
      55             :     /// Make it possible to associate a callback with this timeout
      56      653757 :     void            SetTimeoutHdl( const Link& rLink ) { maTimeoutHdl = rLink; }
      57       17799 :     const Link&     GetTimeoutHdl() const { return maTimeoutHdl; }
      58             : 
      59             :     Timer&          operator=( const Timer& rTimer );
      60             : 
      61             :     static void ImplDeInitTimer();
      62             :     static void ImplTimerCallbackProc();
      63             : };
      64             : 
      65             : /// An auto-timer is a multi-shot timer re-emitting itself at
      66             : /// interval until destroyed.
      67       57675 : class VCL_DLLPUBLIC AutoTimer : public Timer
      68             : {
      69             : public:
      70             :                     AutoTimer();
      71             :                     AutoTimer( const AutoTimer& rTimer );
      72             : 
      73             :     AutoTimer&      operator=( const AutoTimer& rTimer );
      74             : };
      75             : 
      76             : #endif // INCLUDED_VCL_TIMER_HXX
      77             : 
      78             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */