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 #pragma once
  21
  22 namespace sd::tools
  23 {
  24 /** Interface for the asynchronous execution of a task.  This interface
  25     allows a controller to run the task either timer based with a fixed
  26     amount of time between the steps or thread based one step right after
  27     the other.
  28 */
  29 class AsynchronousTask
  30 {
  31 public:
  32     /** Run the next step of the task.  After HasNextStep() returns false
  33         this method should ignore further calls.
  34     */
  35     virtual void RunNextStep() = 0;
  36
  37     /** Return <TRUE/> when there is at least one more step to execute.
  38         When the task has been executed completely then <FALSE/> is
  39         returned.
  40     */
  41     virtual bool HasNextStep() = 0;
  42
  43 protected:
  44     ~AsynchronousTask() {}
  45 };
  46
  47 } // end of namespace ::sd::tools
  48
  49 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */