File indexing completed on 2024-04-14 04:53:08

 /*  This file is part of the KDE project
     SPDX-FileCopyrightText: 1998, 1999 Michael Reiher <michael.reiher@gmx.de>
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 #ifndef __konq_frame_h__
 #define __konq_frame_h__
 
 #include "konqfactory.h"
 #include <KParts/ReadOnlyPart> // for the inline QPointer usage
 
 #include <QPointer>
 #include <QWidget>
 #include <QCheckBox>
 #include <QPixmap>
 #include <QEvent>
 #include <QList>
 
 #include <KConfig>
 
 class KonqFrameStatusBar;
 class KonqFrameVisitor;
 class QVBoxLayout;
 class QUrl;
 
 class KonqView;
 class KonqFrameBase;
 class KonqFrame;
 class KonqFrameContainerBase;
 class KonqFrameContainer;
 class KSeparator;
 
 namespace KParts
 {
 class ReadOnlyPart;
 }
 
 typedef QList<KonqView *> ChildViewList;
 
 class KONQ_TESTS_EXPORT KonqFrameBase
 {
 public:
     enum Option {
         None = 0x0,
         SaveUrls = 0x01,
         SaveHistoryItems = 0x02
     };
     Q_DECLARE_FLAGS(Options, Option)
 
     enum FrameType { View, Tabs, ContainerBase, Container, MainWindow };
 
     virtual ~KonqFrameBase() {}
 
     virtual bool isContainer() const = 0;
 
     virtual bool accept(KonqFrameVisitor *visitor) = 0;
 
     virtual void saveConfig(KConfigGroup &config, const QString &prefix, const KonqFrameBase::Options &options, KonqFrameBase *docContainer, int id = 0, int depth = 0) = 0;
 
     virtual void copyHistory(KonqFrameBase *other) = 0;
 
     KonqFrameContainerBase *parentContainer() const
     {
         return m_pParentContainer;
     }
     void setParentContainer(KonqFrameContainerBase *parent)
     {
         m_pParentContainer = parent;
     }
 
     virtual void setTitle(const QString &title, QWidget *sender) = 0;
     virtual void setTabIcon(const QUrl &url, QWidget *sender) = 0;
 
     virtual QWidget *asQWidget() = 0;
 
     virtual FrameType frameType() const = 0;
 
     virtual void activateChild() = 0;
 
     virtual KonqView *activeChildView() const = 0;
 
     static QString frameTypeToString(const FrameType frameType);
     static FrameType frameTypeFromString(const QString &str);
 
 protected:
     KonqFrameBase();
 
     KonqFrameContainerBase *m_pParentContainer;
 };
 
 Q_DECLARE_OPERATORS_FOR_FLAGS(KonqFrameBase::Options)
 
 /**
  * The KonqFrame is the actual container for the views. It takes care of the
  * widget handling i.e. it attaches/detaches the view widget and activates
  * them on click at the statusbar.
  *
  * We create a vertical layout in the frame, with the view and the KonqFrameStatusBar.
  */
 
 class KONQ_TESTS_EXPORT KonqFrame : public QWidget, public KonqFrameBase
 {
     Q_OBJECT
 
 public:
     explicit KonqFrame(QWidget *parent, KonqFrameContainerBase *parentContainer = nullptr);
     ~KonqFrame() override;
 
     bool isContainer() const override
     {
         return false;
     }
 
     bool accept(KonqFrameVisitor *visitor) override;
 
     /**
      * Attach a view to the KonqFrame.
      * @param viewFactory the view to attach (instead of the current one, if any)
      */
     KParts::ReadOnlyPart *attach(const KonqViewFactory &viewFactory, bool allowPlaceholder = false);
 
     /**
      * Inserts the widget and the statusbar into the layout
      */
     void attachWidget(QWidget *widget);
 
     /**
      * Inserts a widget at the top of the part's widget, in the layout
      * (used for the find functionality)
      */
     void insertTopWidget(QWidget *widget);
 
     /**
      * Returns the part that is currently connected to the Frame.
      */
     KParts::ReadOnlyPart *part()
     {
         return m_pPart;
     }
     /**
      * Returns the view that is currently connected to the Frame.
      */
     KonqView *childView() const;
 
     bool isActivePart();
 
     void setView(KonqView *child);
 
     void saveConfig(KConfigGroup &config, const QString &prefix, const KonqFrameBase::Options &options, KonqFrameBase *docContainer, int id = 0, int depth = 0) override;
     void copyHistory(KonqFrameBase *other) override;
 
     void setTitle(const QString &title, QWidget *sender) override;
     void setTabIcon(const QUrl &url, QWidget *sender) override;
 
     QWidget *asQWidget() override
     {
         return this;
     }
     KonqFrameBase::FrameType frameType() const override
     {
         return KonqFrameBase::View;
     }
 
     QVBoxLayout *layout()const
     {
         return m_pLayout;
     }
 
     KonqFrameStatusBar *statusbar() const
     {
         return m_pStatusBar;
     }
 
     void activateChild() override;
 
     KonqView *activeChildView() const override;
 
     QString title() const
     {
         return m_title;
     }
 
 public Q_SLOTS:
 
     /**
      * Is called when the frame statusbar has been clicked
      */
     void slotStatusBarClicked();
 
     void slotLinkedViewClicked(bool mode);
 
     /**
      * Is called when 'Remove View' is called from the popup menu
      */
     void slotRemoveView();
 
 private:
     QVBoxLayout *m_pLayout;
     QPointer<KonqView> m_pView;
 
     QPointer<KParts::ReadOnlyPart> m_pPart;
 
     KSeparator *m_separator;
     KonqFrameStatusBar *m_pStatusBar;
 
     QString m_title;
 };
 
 #endif