File indexing completed on 2024-05-12 05:12:55

 /*
     This file is part of Akregator.
 
     SPDX-FileCopyrightText: 2004 Sashmit Bhaduri <smt@vfemail.net>
     SPDX-FileCopyrightText: 2005 Frank Osterfeld <osterfeld@kde.org>
 
     SPDX-License-Identifier: GPL-2.0-or-later WITH Qt-Commercial-exception-1.0
 */
 
 #pragma once
 
 #include <QIcon>
 #include <QWidget>
 
 #include <KConfigGroup>
 
 #include "akregator_export.h"
 
 class QUrl;
 
 namespace KPIM
 {
 class ProgressItem;
 }
 
 namespace Akregator
 {
 class OpenUrlRequest;
 
 class AKREGATOR_EXPORT Frame : public QWidget
 {
     Q_OBJECT
 
 public:
     explicit Frame(QWidget *parent = nullptr);
     ~Frame() override;
 
     enum State { Idle, Started, Completed, Canceled };
 
     virtual qreal zoomFactor() const = 0;
     /**
      * Returns whether the frame can be removed from
      * Akregator (via detach or close tab etc.)  Usually
      * all tabs but the main tab can be removed.
      * Default is @c true
      */
     [[nodiscard]] bool isRemovable() const;
 
     /**
      * returns the URL of the embedded part
      */
     virtual QUrl url() const = 0;
 
     [[nodiscard]] QString title() const;
     [[nodiscard]] QString caption() const;
     [[nodiscard]] State state() const;
     [[nodiscard]] int progress() const;
     [[nodiscard]] QString statusText() const;
     [[nodiscard]] QIcon icon() const;
     void setIcon(const QIcon &icon);
 
     [[nodiscard]] int id() const;
     /**
      * returns whether the embedded part is loading a website. If so, it can be stopped using slotStop() */
     virtual bool isLoading() const;
 
     virtual bool openUrl(const OpenUrlRequest &request) = 0;
 
     /**
      * Load a frame from a config file for session management.
      */
     virtual void loadConfig(const KConfigGroup & /*config*/, const QString & /*prefix*/)
     {
     }
 
     /**
      * Save a frame to a config file for session management.
      */
     virtual bool saveConfig(KConfigGroup & /*config*/, const QString & /*prefix*/)
     {
         return false;
     }
 
 public Q_SLOTS:
 
     /** reloads the current content, if possible. See also isReloadable(). */
     virtual void slotReload()
     {
     }
 
     virtual void slotStop();
 
     void slotSetStarted();
     void slotSetCanceled(const QString &);
     void slotSetCompleted();
     void slotSetState(State);
     void slotSetProgress(int);
     void slotSetCaption(const QString &);
     void slotSetTitle(const QString &);
     void slotSetStatusText(const QString &);
 
 Q_SIGNALS:
     void signalCaptionChanged(Akregator::Frame *, const QString &);
     void signalTitleChanged(Akregator::Frame *, const QString &);
     void signalStarted(Akregator::Frame *);
     void signalCanceled(Akregator::Frame *, const QString &);
     void signalCompleted(Akregator::Frame *);
     void signalLoadingProgress(Akregator::Frame *, int);
     void signalStatusText(Akregator::Frame *, const QString &);
 
     void signalOpenUrlRequest(Akregator::OpenUrlRequest &request);
     void showStatusBarMessage(const QString &msg);
 
 protected:
     void setRemovable(bool removable);
 
 protected:
     QIcon m_icon;
     QString m_title;
     QString m_caption;
     State m_state = Idle;
     int m_progress = -1;
     QString m_statusText;
     QString m_progressId;
     KPIM::ProgressItem *m_progressItem = nullptr;
     bool m_isRemovable = true;
     bool m_loading = false;
     int m_id;
     static int m_idCounter;
 };
 } // namespace Akregator