xref: /aoo41x/main/svx/source/inc/delayedevent.hxx (revision 3334a7e6)
1*3334a7e6SAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*3334a7e6SAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*3334a7e6SAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*3334a7e6SAndrew Rist  * distributed with this work for additional information
6*3334a7e6SAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*3334a7e6SAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*3334a7e6SAndrew Rist  * "License"); you may not use this file except in compliance
9*3334a7e6SAndrew Rist  * with the License.  You may obtain a copy of the License at
10*3334a7e6SAndrew Rist  *
11*3334a7e6SAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12*3334a7e6SAndrew Rist  *
13*3334a7e6SAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*3334a7e6SAndrew Rist  * software distributed under the License is distributed on an
15*3334a7e6SAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*3334a7e6SAndrew Rist  * KIND, either express or implied.  See the License for the
17*3334a7e6SAndrew Rist  * specific language governing permissions and limitations
18*3334a7e6SAndrew Rist  * under the License.
19*3334a7e6SAndrew Rist  *
20*3334a7e6SAndrew Rist  *************************************************************/
21*3334a7e6SAndrew Rist 
22*3334a7e6SAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir #ifndef SVX_DELAYEDLINK_HXX
25cdf0e10cSrcweir #define SVX_DELAYEDLINK_HXX
26cdf0e10cSrcweir 
27cdf0e10cSrcweir #include <tools/link.hxx>
28cdf0e10cSrcweir 
29cdf0e10cSrcweir //........................................................................
30cdf0e10cSrcweir namespace svxform
31cdf0e10cSrcweir {
32cdf0e10cSrcweir //........................................................................
33cdf0e10cSrcweir 
34cdf0e10cSrcweir 	//====================================================================
35cdf0e10cSrcweir 	//= DelayedEvent
36cdf0e10cSrcweir 	//====================================================================
37cdf0e10cSrcweir     /** small class which encapsulates posting a Link instance as ApplicationUserEvent
38cdf0e10cSrcweir 
39cdf0e10cSrcweir         No thread safety at all here, just a little saving of code to type multiple times
40cdf0e10cSrcweir     */
41cdf0e10cSrcweir 	class DelayedEvent
42cdf0e10cSrcweir 	{
43cdf0e10cSrcweir     public:
DelayedEvent(const Link & _rHandler)44cdf0e10cSrcweir         DelayedEvent( const Link& _rHandler )
45cdf0e10cSrcweir             :m_aHandler( _rHandler )
46cdf0e10cSrcweir             ,m_nEventId( 0 )
47cdf0e10cSrcweir         {
48cdf0e10cSrcweir         }
49cdf0e10cSrcweir 
~DelayedEvent()50cdf0e10cSrcweir         ~DelayedEvent()
51cdf0e10cSrcweir         {
52cdf0e10cSrcweir             CancelPendingCall();
53cdf0e10cSrcweir         }
54cdf0e10cSrcweir 
55cdf0e10cSrcweir         /** calls the handler asynchronously
56cdf0e10cSrcweir 
57cdf0e10cSrcweir             If there's already a call pending, this previous call is cancelled.
58cdf0e10cSrcweir         */
59cdf0e10cSrcweir         void    Call( void* _pArg = NULL );
60cdf0e10cSrcweir 
61cdf0e10cSrcweir         /** cancels a call which is currently pending
62cdf0e10cSrcweir 
63cdf0e10cSrcweir             If no call is currently pending, then this is ignored.
64cdf0e10cSrcweir         */
65cdf0e10cSrcweir         void    CancelPendingCall();
66cdf0e10cSrcweir 
67cdf0e10cSrcweir     private:
68cdf0e10cSrcweir         Link    m_aHandler;
69cdf0e10cSrcweir         sal_uLong   m_nEventId;
70cdf0e10cSrcweir 
71cdf0e10cSrcweir     private:
72cdf0e10cSrcweir         DECL_LINK( OnCall, void* );
73cdf0e10cSrcweir 
74cdf0e10cSrcweir     private:
75cdf0e10cSrcweir         DelayedEvent();                                  // never implemented
76cdf0e10cSrcweir         DelayedEvent( const DelayedEvent& );              // never implemented
77cdf0e10cSrcweir         DelayedEvent& operator=( const DelayedEvent& );   // never implemented
78cdf0e10cSrcweir 	};
79cdf0e10cSrcweir 
80cdf0e10cSrcweir //........................................................................
81cdf0e10cSrcweir } // namespace svxform
82cdf0e10cSrcweir //........................................................................
83cdf0e10cSrcweir 
84cdf0e10cSrcweir #endif // SVX_DELAYEDLINK_HXX
85