LibreOffice Module vcl (master) 1
saltimer.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_INC_SALTIMER_HXX
21#define INCLUDED_VCL_INC_SALTIMER_HXX
22
23#include <sal/config.h>
24#include <vcl/dllapi.h>
25#include "salwtype.hxx"
26
27/*
28 * note: there will be only a single instance of SalTimer
29 * SalTimer originally had only static methods, but
30 * this needed to be virtualized for the sal plugin migration
31 */
32
34{
36
37public:
38 SalTimer() : m_pProc( nullptr ) {}
39 virtual ~SalTimer() COVERITY_NOEXCEPT_FALSE;
40
41 // AutoRepeat and Restart
42 virtual void Start( sal_uInt64 nMS ) = 0;
43 virtual void Stop() = 0;
44
45 // Callbacks (indepen in \sv\source\app\timer.cxx)
46 void SetCallback( SALTIMERPROC pProc )
47 {
48 m_pProc = pProc;
49 }
50
52 {
53 if( m_pProc )
54 m_pProc();
55 }
56};
57
59{
65 sal_Int32 m_nEventVersion;
67
68public:
70
72 {
74 m_bIsValidVersion = true;
75 return m_nEventVersion;
76 }
77
79 {
81 {
84 else
86 m_bIsValidVersion = false;
87 }
88 }
89
90 bool ExistsValidEvent() const
91 {
92 return m_bIsValidVersion;
93 }
94
95 bool IsValidEventVersion( const sal_Int32 nEventVersion ) const
96 {
97 return m_bIsValidVersion && nEventVersion == m_nEventVersion;
98 }
99};
100
101#endif // INCLUDED_VCL_INC_SALTIMER_HXX
102
103/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
void CallCallback()
Definition: saltimer.hxx:51
SalTimer()
Definition: saltimer.hxx:38
SALTIMERPROC m_pProc
Definition: saltimer.hxx:35
void InvalidateEvent()
Definition: saltimer.hxx:78
sal_Int32 GetNextEventVersion()
Definition: saltimer.hxx:71
bool IsValidEventVersion(const sal_Int32 nEventVersion) const
Definition: saltimer.hxx:95
bool m_bIsValidVersion
Definition: saltimer.hxx:66
bool ExistsValidEvent() const
Definition: saltimer.hxx:90
sal_Int32 m_nEventVersion
The "additional event data" members on macOS are integers, so we can't use an unsigned integer and re...
Definition: saltimer.hxx:65
#define VCL_PLUGIN_PUBLIC
Definition: dllapi.h:40
void(* SALTIMERPROC)()
Definition: salwtype.hxx:266
#define SAL_MAX_INT32