vcl/inc/saltimer.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_INC_SALTIMER_HXX
  21 #define INCLUDED_VCL_INC_SALTIMER_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <vcl/dllapi.h>
  26
  27 #include <salwtype.hxx>
  28
  29 /*
  30  * note: there will be only a single instance of SalTimer
  31  * SalTimer originally had only static methods, but
  32  * this needed to be virtualized for the sal plugin migration
  33  */
  34
  35 class VCL_PLUGIN_PUBLIC SalTimer
  36 {
  37     SALTIMERPROC        m_pProc;
  38 public:
  39     SalTimer() : m_pProc( nullptr ) {}
  40     virtual ~SalTimer();
  41
  42     // AutoRepeat and Restart
  43     virtual void            Start( sal_uLong nMS ) = 0;
  44     virtual void            Stop() = 0;
  45
  46     // Callbacks (indepen in \sv\source\app\timer.cxx)
  47     void            SetCallback( SALTIMERPROC pProc )
  48     {
  49         m_pProc = pProc;
  50     }
  51
  52     void            CallCallback( bool idle )
  53     {
  54         if( m_pProc )
  55             m_pProc( idle );
  56     }
  57 };
  58
  59 class Task;
  60
  61 // Internal scheduler record holding intrusive linked list pieces
  62 struct ImplSchedulerData
  63 {
  64     ImplSchedulerData  *mpNext;        // Pointer to the next element in list
  65     Task               *mpTask;        // Pointer to VCL Task instance
  66     bool                mbDelete;      // Destroy this task?
  67     bool                mbInScheduler; // Task currently processed?
  68     sal_uInt64          mnUpdateTime;  // Last Update Time
  69
  70     void Invoke();
  71
  72     const char *GetDebugName() const;
  73 };
  74
  75 #endif // INCLUDED_VCL_INC_SALTIMER_HXX
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */