64 lines
2.1 KiB
C++
64 lines
2.1 KiB
C++
/*************************************************************************
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* $RCSfile: AsynchronousTask.hxx,v $
|
|
*
|
|
* $Revision: 1.2 $
|
|
*
|
|
* last change: $Author: kz $ $Date: 2006-04-26 20:46:22 $
|
|
*
|
|
* The Contents of this file are made available subject to
|
|
* the terms of GNU Lesser General Public License Version 2.1.
|
|
*
|
|
*
|
|
* GNU Lesser General Public License Version 2.1
|
|
* =============================================
|
|
* Copyright 2005 by Sun Microsystems, Inc.
|
|
* 901 San Antonio Road, Palo Alto, CA 94303, USA
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License version 2.1, as published by the Free Software Foundation.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
|
* MA 02111-1307 USA
|
|
*
|
|
************************************************************************/
|
|
|
|
#ifndef SD_ASYNCHRONOUS_TASK_HXX
|
|
#define SD_ASYNCHRONOUS_TASK_HXX
|
|
|
|
namespace sd { namespace tools {
|
|
|
|
/** Interface for the asynchronous execution of a task. This interface
|
|
allows an controller to run the task either timer based with a fixed
|
|
amount of time between the steps or thread based one step right after
|
|
the other.
|
|
*/
|
|
class AsynchronousTask
|
|
{
|
|
public:
|
|
/** Run the next step of the task. After HasNextStep() returns false
|
|
this method should ignore further calls.
|
|
*/
|
|
virtual void RunNextStep (void) = 0;
|
|
|
|
/** Return <TRUE/> when there is at least one more step to execute.
|
|
When the task has been executed completely then <FALSE/> is
|
|
returned.
|
|
*/
|
|
virtual bool HasNextStep (void) = 0;
|
|
};
|
|
|
|
} } // end of namespace ::sd::tools
|
|
|
|
#endif
|