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