1 /************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27 28 #ifndef SD_ASYNCHRONOUS_TASK_HXX 29 #define SD_ASYNCHRONOUS_TASK_HXX 30 31 namespace sd { namespace tools { 32 33 /** Interface for the asynchronous execution of a task. This interface 34 allows an controller to run the task either timer based with a fixed 35 amount of time between the steps or thread based one step right after 36 the other. 37 */ 38 class AsynchronousTask 39 { 40 public: 41 /** Run the next step of the task. After HasNextStep() returns false 42 this method should ignore further calls. 43 */ 44 virtual void RunNextStep (void) = 0; 45 46 /** Return <TRUE/> when there is at least one more step to execute. 47 When the task has been executed completely then <FALSE/> is 48 returned. 49 */ 50 virtual bool HasNextStep (void) = 0; 51 }; 52 53 } } // end of namespace ::sd::tools 54 55 #endif 56