LibreOffice Module vcl (master)  1
idle.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_IDLE_HXX
21 #define INCLUDED_VCL_IDLE_HXX
22 
23 #include <vcl/timer.hxx>
24 
30 class VCL_DLLPUBLIC Idle : public Timer
31 {
32 private:
33  // Delete all timeout specific functions, we don't want in an Idle
34  void SetTimeout( sal_uInt64 nTimeoutMs ) = delete;
35  sal_uInt64 GetTimeout() const = delete;
36 
37 protected:
38  virtual sal_uInt64 UpdateMinPeriod( sal_uInt64 nTimeNow ) const override;
39 
40  Idle( bool bAuto, const sal_Char *pDebugName );
41 
42 public:
43  Idle( const sal_Char *pDebugName = nullptr );
44 
45  virtual void Start() override;
46 };
47 
57 class VCL_DLLPUBLIC AutoIdle : public Idle
58 {
59 public:
60  AutoIdle( const sal_Char *pDebugName );
61 };
62 
63 
64 #endif // INCLUDED_VCL_IDLE_HXX
65 
66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
virtual sal_uInt64 UpdateMinPeriod(sal_uInt64 nTimeNow) const override
How long (in MS) until the Task is ready to be dispatched?
Definition: timer.cxx:32
#define VCL_DLLPUBLIC
Definition: dllapi.h:29
char sal_Char
An auto-idle is long running task processing small chunks of data, which is re-scheduled multiple tim...
Definition: idle.hxx:57
sal_uInt64 GetTimeout() const
Definition: timer.hxx:60
virtual void Start() override
Activates the timer task.
Definition: timer.cxx:83
void SetTimeout(sal_uInt64 nTimeoutMs)
Definition: timer.cxx:89
Definition: timer.hxx:26
An idle is a timer to be scheduled immediately.
Definition: idle.hxx:30