File indexing completed on 2024-05-19 04:56:04

0001 /**
0002  * \file iabortable.h
0003  * Interface for abortable operations.
0004  *
0005  * \b Project: Kid3
0006  * \author Urs Fleisch
0007  * \date 27 Jan 2013
0008  *
0009  * Copyright (C) 2013-2018  Urs Fleisch
0010  *
0011  * This file is part of Kid3.
0012  *
0013  * Kid3 is free software; you can redistribute it and/or modify
0014  * it under the terms of the GNU General Public License as published by
0015  * the Free Software Foundation; either version 2 of the License, or
0016  * (at your option) any later version.
0017  *
0018  * Kid3 is distributed in the hope that it will be useful,
0019  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0020  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0021  * GNU General Public License for more details.
0022  *
0023  * You should have received a copy of the GNU General Public License
0024  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
0025  */
0026 
0027 #pragma once
0028 
0029 #include "kid3api.h"
0030 
0031 /**
0032  * Interface for abortable operations.
0033  */
0034 class KID3_CORE_EXPORT IAbortable {
0035 public:
0036   /**
0037    * Destructor.
0038    */
0039   virtual ~IAbortable();
0040 
0041   /**
0042    * Abort operation.
0043    */
0044   virtual void abort() = 0;
0045 
0046   /**
0047    * Check if operation is aborted.
0048    *
0049    * @return true if aborted.
0050    */
0051   virtual bool isAborted() const = 0;
0052 
0053   /**
0054    * Clear state which is reported by isAborted().
0055    */
0056   virtual void clearAborted() = 0;
0057 };