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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef SD_ASYNCHRONOUS_TASK_HXX
  21 #define SD_ASYNCHRONOUS_TASK_HXX
  22
  23 namespace sd { namespace tools {
  24
  25 /** Interface for the asynchronous execution of a task.  This interface
  26     allows an controller to run the task either timer based with a fixed
  27     amount of time between the steps or thread based one step right after
  28     the other.
  29 */
  30 class AsynchronousTask
  31 {
  32 public:
  33     /** Run the next step of the task.  After HasNextStep() returns false
  34         this method should ignore further calls.
  35     */
  36     virtual void RunNextStep (void) = 0;
  37
  38     /** Return <TRUE/> when there is at least one more step to execute.
  39         When the task has been executed completely then <FALSE/> is
  40         returned.
  41     */
  42     virtual bool HasNextStep (void) = 0;
  43
  44 protected:
  45     ~AsynchronousTask() {}
  46 };
  47
  48 } } // end of namespace ::sd::tools
  49
  50 #endif
  51
  52 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */