svx/source/inc/delayedevent.hxx

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