xref: /aoo41x/main/vcl/inc/saltimer.hxx (revision cdf0e10c)
1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 #ifndef _SV_SALTIMER_HXX
29 #define _SV_SALTIMER_HXX
30 
31 #include <vcl/sv.h>
32 #include <vcl/dllapi.h>
33 #include <salwtype.hxx>
34 
35 // ------------
36 // - SalTimer -
37 // ------------
38 
39 /*
40  * note: there will be only a single instance of SalTimer
41  * SalTimer originally had only static methods, but
42  * this needed to be virtualized for the sal plugin migration
43  */
44 
45 class VCL_PLUGIN_PUBLIC SalTimer
46 {
47     SALTIMERPROC		m_pProc;
48 public:
49     SalTimer() : m_pProc( NULL ) {}
50     virtual ~SalTimer();
51 
52     // AutoRepeat and Restart
53 	virtual void 			Start( sal_uLong nMS ) = 0;
54 	virtual void 			Stop() = 0;
55 
56 	// Callbacks (indepen in \sv\source\app\timer.cxx)
57 	void 			SetCallback( SALTIMERPROC pProc )
58     {
59         m_pProc = pProc;
60     }
61 
62     void			CallCallback()
63     {
64         if( m_pProc )
65             m_pProc();
66     }
67 };
68 
69 #endif // _SV_SALTIMER_HXX
70