LibreOffice Module vcl (master) 1
timer.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_TIMER_HXX
21#define INCLUDED_VCL_TIMER_HXX
22
23#include <tools/link.hxx>
24#include <vcl/task.hxx>
25
26class VCL_DLLPUBLIC Timer : public Task
27{
29 sal_uInt64 mnTimeout;
30 const bool mbAuto;
31
32protected:
33 virtual void SetDeletionFlags() override;
34 virtual sal_uInt64 UpdateMinPeriod( sal_uInt64 nTimeNow ) const override;
35
36 Timer( bool bAuto, const char *pDebugName );
37
38public:
39 Timer( const char *pDebugName );
40 Timer( const Timer& rTimer );
41 virtual ~Timer() override;
42 Timer& operator=( const Timer& rTimer );
43
47 virtual void Invoke() override;
55 void Invoke( Timer *arg );
56 void SetInvokeHandler( const Link<Timer *, void>& rLink ) { maInvokeHandler = rLink; }
57 void ClearInvokeHandler() { SetInvokeHandler( Link<Timer *, void>() ); }
58
59 void SetTimeout( sal_uInt64 nTimeoutMs );
60 sal_uInt64 GetTimeout() const { return mnTimeout; }
61 virtual void Start(bool bStartTimer = true) override;
62};
63
67{
68public:
69 AutoTimer( const char *pDebugName );
70};
71
73#define EDIT_UPDATEDATA_TIMEOUT 350
74
75#endif // INCLUDED_VCL_TIMER_HXX
76
77/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
An auto-timer is a multi-shot timer re-emitting itself at interval until destroyed or stopped.
Definition: timer.hxx:67
Definition: task.hxx:43
virtual sal_uInt64 UpdateMinPeriod(sal_uInt64 nTimeNow) const =0
How long (in MS) until the Task is ready to be dispatched?
Task & operator=(const Task &rTask)
Definition: scheduler.cxx:613
virtual void Start(bool bStartTimer=true)
Schedules the task for execution.
Definition: scheduler.cxx:551
virtual void Invoke()=0
virtual void SetDeletionFlags()
Definition: scheduler.cxx:546
Definition: timer.hxx:27
Link< Timer *, void > maInvokeHandler
Callback Link.
Definition: timer.hxx:28
sal_uInt64 mnTimeout
Definition: timer.hxx:29
void SetInvokeHandler(const Link< Timer *, void > &rLink)
Definition: timer.hxx:56
const bool mbAuto
Definition: timer.hxx:30
void ClearInvokeHandler()
Definition: timer.hxx:57
sal_uInt64 GetTimeout() const
Definition: timer.hxx:60
#define VCL_DLLPUBLIC
Definition: dllapi.h:29