sd/source/ui/inc/tools/AsynchronousTask.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: AsynchronousTask.hxx,v $
  10  * $Revision: 1.3 $
  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_TASK_HXX
  32 #define SD_ASYNCHRONOUS_TASK_HXX
  33
  34 namespace sd { namespace tools {
  35
  36 /** Interface for the asynchronous execution of a task.  This interface
  37     allows an controller to run the task either timer based with a fixed
  38     amount of time between the steps or thread based one step right after
  39     the other.
  40 */
  41 class AsynchronousTask
  42 {
  43 public:
  44     /** Run the next step of the task.  After HasNextStep() returns false
  45         this method should ignore further calls.
  46     */
  47     virtual void RunNextStep (void) = 0;
  48
  49     /** Return <TRUE/> when there is at least one more step to execute.
  50         When the task has been executed completely then <FALSE/> is
  51         returned.
  52     */
  53     virtual bool HasNextStep (void) = 0;
  54 };
  55
  56 } } // end of namespace ::sd::tools
  57
  58 #endif