xref: /aoo41x/main/svx/source/inc/delayedevent.hxx (revision cdf0e10c)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3*cdf0e10cSrcweir  *
4*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
5*cdf0e10cSrcweir  *
6*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
7*cdf0e10cSrcweir  *
8*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
9*cdf0e10cSrcweir  *
10*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
11*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
12*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
13*cdf0e10cSrcweir  *
14*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
15*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
18*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
19*cdf0e10cSrcweir  *
20*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
21*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
22*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
23*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
24*cdf0e10cSrcweir  *
25*cdf0e10cSrcweir ************************************************************************/
26*cdf0e10cSrcweir 
27*cdf0e10cSrcweir #ifndef SVX_DELAYEDLINK_HXX
28*cdf0e10cSrcweir #define SVX_DELAYEDLINK_HXX
29*cdf0e10cSrcweir 
30*cdf0e10cSrcweir #include <tools/link.hxx>
31*cdf0e10cSrcweir 
32*cdf0e10cSrcweir //........................................................................
33*cdf0e10cSrcweir namespace svxform
34*cdf0e10cSrcweir {
35*cdf0e10cSrcweir //........................................................................
36*cdf0e10cSrcweir 
37*cdf0e10cSrcweir 	//====================================================================
38*cdf0e10cSrcweir 	//= DelayedEvent
39*cdf0e10cSrcweir 	//====================================================================
40*cdf0e10cSrcweir     /** small class which encapsulates posting a Link instance as ApplicationUserEvent
41*cdf0e10cSrcweir 
42*cdf0e10cSrcweir         No thread safety at all here, just a little saving of code to type multiple times
43*cdf0e10cSrcweir     */
44*cdf0e10cSrcweir 	class DelayedEvent
45*cdf0e10cSrcweir 	{
46*cdf0e10cSrcweir     public:
47*cdf0e10cSrcweir         DelayedEvent( const Link& _rHandler )
48*cdf0e10cSrcweir             :m_aHandler( _rHandler )
49*cdf0e10cSrcweir             ,m_nEventId( 0 )
50*cdf0e10cSrcweir         {
51*cdf0e10cSrcweir         }
52*cdf0e10cSrcweir 
53*cdf0e10cSrcweir         ~DelayedEvent()
54*cdf0e10cSrcweir         {
55*cdf0e10cSrcweir             CancelPendingCall();
56*cdf0e10cSrcweir         }
57*cdf0e10cSrcweir 
58*cdf0e10cSrcweir         /** calls the handler asynchronously
59*cdf0e10cSrcweir 
60*cdf0e10cSrcweir             If there's already a call pending, this previous call is cancelled.
61*cdf0e10cSrcweir         */
62*cdf0e10cSrcweir         void    Call( void* _pArg = NULL );
63*cdf0e10cSrcweir 
64*cdf0e10cSrcweir         /** cancels a call which is currently pending
65*cdf0e10cSrcweir 
66*cdf0e10cSrcweir             If no call is currently pending, then this is ignored.
67*cdf0e10cSrcweir         */
68*cdf0e10cSrcweir         void    CancelPendingCall();
69*cdf0e10cSrcweir 
70*cdf0e10cSrcweir     private:
71*cdf0e10cSrcweir         Link    m_aHandler;
72*cdf0e10cSrcweir         sal_uLong   m_nEventId;
73*cdf0e10cSrcweir 
74*cdf0e10cSrcweir     private:
75*cdf0e10cSrcweir         DECL_LINK( OnCall, void* );
76*cdf0e10cSrcweir 
77*cdf0e10cSrcweir     private:
78*cdf0e10cSrcweir         DelayedEvent();                                  // never implemented
79*cdf0e10cSrcweir         DelayedEvent( const DelayedEvent& );              // never implemented
80*cdf0e10cSrcweir         DelayedEvent& operator=( const DelayedEvent& );   // never implemented
81*cdf0e10cSrcweir 	};
82*cdf0e10cSrcweir 
83*cdf0e10cSrcweir //........................................................................
84*cdf0e10cSrcweir } // namespace svxform
85*cdf0e10cSrcweir //........................................................................
86*cdf0e10cSrcweir 
87*cdf0e10cSrcweir #endif // SVX_DELAYEDLINK_HXX
88