sd/source/ui/inc/tools/AsynchronousCall.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: AsynchronousCall.hxx,v $
  10  * $Revision: 1.4 $
  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
  31 #ifndef SD_ASYNCHRONOUS_CALL_HXX
  32 #define SD_ASYNCHRONOUS_CALL_HXX
  33
  34 #include <vcl/timer.hxx>
  35 #include <memory>
  36 #include <boost/function.hpp>
  37
  38 namespace sd { namespace tools {
  39
  40
  41 /** Store a function object and execute it asynchronous.
  42
  43     The features of this class are:
  44     a) It provides a wrapper around a VCL Timer so that generic function
  45     objects can be used.
  46     b) When more than one function objects are posted to be executed later
  47     then the pending ones are erased and only the last one will actually be
  48     executed.
  49
  50     Use this class like this:
  51     aInstanceOfAsynchronousCall.Post(
  52         ::boost::bind(
  53             ::std::mem_fun(&DrawViewShell::SwitchPage),
  54             pDrawViewShell,
  55             11));
  56 */
  57 class AsynchronousCall
  58 {
  59 public:
  60     /** Create a new asynchronous call.  Each object of this class processes
  61         one (semantical) type of call.
  62     */
  63     AsynchronousCall (void);
  64
  65     ~AsynchronousCall (void);
  66
  67     /** Post a function object that is to be executed asynchronously.  When
  68         this method is called while the current function object has not bee
  69         executed then the later is destroyed and only the given function
  70         object will be executed.
  71         @param rFunction
  72             The function object that may be called asynchronously in the
  73             near future.
  74         @param nTimeoutInMilliseconds
  75             The timeout in milliseconds until the function object is
  76             executed.
  77     */
  78     typedef ::boost::function0<void> AsynchronousFunction;
  79     void Post (
  80         const AsynchronousFunction& rFunction,
  81         sal_uInt32 nTimeoutInMilliseconds=10);
  82
  83 private:
  84     Timer maTimer;
  85     /** The function object that will be executed when the TimerCallback
  86         function is called the next time.  This pointer may be NULL.
  87     */
  88     ::std::auto_ptr<AsynchronousFunction> mpFunction;
  89     DECL_LINK(TimerCallback,Timer*);
  90 };
  91
  92
  93 } } // end of namespace ::sd::tools
  94
  95 #endif