File indexing completed on 2024-12-08 09:41:33

 /*
     This file is part of the KDE project
     SPDX-FileCopyrightText: 1999 David Faure <faure@kde.org>
     SPDX-FileCopyrightText: 2001, 2002, 2004-2006 Michael Brade <brade@kde.org>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef kdirlister_h
 #define kdirlister_h
 
 #include "kiowidgets_export.h"
 #include <kcoredirlister.h>
 
 class QWidget;
 class KDirListerPrivate;
 
 /**
  * @class KDirLister kdirlister.h <KDirLister>
  *
  * Subclass of KCoreDirLister which uses QWidgets to show error messages
  * and to associate jobs with windows.
  */
 class KIOWIDGETS_EXPORT KDirLister : public KCoreDirLister
 {
     Q_OBJECT
 #if KIOCORE_ENABLE_DEPRECATED_SINCE(5, 82)
     Q_PROPERTY(bool autoErrorHandlingEnabled READ autoErrorHandlingEnabled)
 #endif
 
 public:
     /**
      * Create a directory lister.
      */
     KDirLister(QObject *parent = nullptr);
 
     /**
      * Destroy the directory lister.
      */
     ~KDirLister() override;
 
     /**
      * Check whether auto error handling is enabled.
      * If enabled, it will show an error dialog to the user when an
      * error occurs. It is turned on by default.
      * @return true if auto error handling is enabled, false otherwise
      * @see setAutoErrorHandlingEnabled()
      */
     bool autoErrorHandlingEnabled() const; // KF6 remove, already provided by KCoreDirLister
 
 #if KIOCORE_ENABLE_DEPRECATED_SINCE(5, 82)
     /**
      * Enable or disable auto error handling.
      * If enabled, it will show an error dialog to the user when an
      * error occurs. It is turned on by default.
      * @param enable true to enable auto error handling, false to disable
      * @param parent the parent widget for the error dialogs, can be @c nullptr for
      *               top-level
      * @see autoErrorHandlingEnabled()
      * @deprecated since 5.82, connect to the jobError() signal instead
      */
     KIOCORE_DEPRECATED_VERSION(5, 82, "Connect to the jobError() signal instead")
     void setAutoErrorHandlingEnabled(bool enable, QWidget *parent);
     using KCoreDirLister::setAutoErrorHandlingEnabled;
 #endif
 
     /**
      * Pass the main window this object is associated with
      * this is used for caching authentication data
      * @param window the window to associate with, @c nullptr to disassociate
      */
     void setMainWindow(QWidget *window);
 
     /**
      * Returns the main window associated with this object.
      * @return the associated main window, or @c nullptr if there is none
      */
     QWidget *mainWindow();
 
 protected:
 #if KIOCORE_BUILD_DEPRECATED_SINCE(5, 82)
     /**
      * Reimplemented to customize error handling
      * @reimp
      */
     void handleError(KIO::Job *) override;
 #endif
 
 #if KIOCORE_BUILD_DEPRECATED_SINCE(5, 81)
     /**
      * Reimplemented to customize error handling
      * @reimp
      */
     void handleErrorMessage(const QString &message) override;
 #endif
 
     /**
      * Reimplemented to associate a window with new jobs
      * @reimp
      */
     void jobStarted(KIO::ListJob *) override;
 
 private:
     friend class KDirListerPrivate;
     std::unique_ptr<KDirListerPrivate> d;
 };
 
 #endif