Line data    Source code

       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_SVX_SOURCE_INC_DELAYEDEVENT_HXX
      21             : #define INCLUDED_SVX_SOURCE_INC_DELAYEDEVENT_HXX
      22             : 
      23             : #include <tools/link.hxx>
      24             : 
      25             : 
      26             : namespace svxform
      27             : {
      28             : 
      29             : 
      30             : 
      31             :     //= DelayedEvent
      32             : 
      33             :     /** small class which encapsulates posting a Link instance as ApplicationUserEvent
      34             : 
      35             :         No thread safety at all here, just a little saving of code to type multiple times
      36             :     */
      37             :     class DelayedEvent
      38             :     {
      39             :     public:
      40           0 :         DelayedEvent( const Link& _rHandler )
      41             :             :m_aHandler( _rHandler )
      42           0 :             ,m_nEventId( 0 )
      43             :         {
      44           0 :         }
      45             : 
      46           0 :         ~DelayedEvent()
      47             :         {
      48           0 :             CancelPendingCall();
      49           0 :         }
      50             : 
      51             :         /** calls the handler asynchronously
      52             : 
      53             :             If there's already a call pending, this previous call is cancelled.
      54             :         */
      55             :         void    Call( void* _pArg = NULL );
      56             : 
      57             :         /** cancels a call which is currently pending
      58             : 
      59             :             If no call is currently pending, then this is ignored.
      60             :         */
      61             :         void    CancelPendingCall();
      62             : 
      63             :     private:
      64             :         Link    m_aHandler;
      65             :         sal_uLong   m_nEventId;
      66             : 
      67             :     private:
      68             :         DECL_LINK( OnCall, void* );
      69             : 
      70             :     private:
      71             :         DelayedEvent();                                  // never implemented
      72             :         DelayedEvent( const DelayedEvent& );              // never implemented
      73             :         DelayedEvent& operator=( const DelayedEvent& );   // never implemented
      74             :     };
      75             : 
      76             : 
      77             : } // namespace svxform
      78             : 
      79             : 
      80             : #endif // INCLUDED_SVX_SOURCE_INC_DELAYEDEVENT_HXX
      81             : 
      82             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */