apps/konqueror/src/konqframecontainer.h

   1 /*  This file is part of the KDE project
   2     Copyright (C) 1998, 1999 Michael Reiher <michael.reiher@gmx.de>
   3     Copyright 2007 David Faure <faure@kde.org>
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18 */
  19
  20 #ifndef KONQ_FRAMECONTAINER_H
  21 #define KONQ_FRAMECONTAINER_H
  22
  23 #include "konqframe.h"
  24 #include <QtGui/QSplitter>
  25
  26 /**
  27  * Base class for containers
  28  * This implements the Composite pattern: a composite is a type of base element.
  29  */
  30 class KONQ_TESTS_EXPORT KonqFrameContainerBase : public KonqFrameBase
  31 {
  32 public:
  33     virtual ~KonqFrameContainerBase() {}
  34
  35     /**
  36      * Insert a new frame into the container.
  37      */
  38     virtual void insertChildFrame(KonqFrameBase * frame, int index = -1) = 0;
  39     /**
  40      * Replace a child frame with another
  41      */
  42     virtual void replaceChildFrame(KonqFrameBase* oldFrame, KonqFrameBase* newFrame);
  43     /**
  44      * Split one of our child frames
  45      */
  46     KonqFrameContainer* splitChildFrame(KonqFrameBase* frame, Qt::Orientation orientation);
  47
  48     /**
  49      * Call this before deleting one of our children.
  50      */
  51     virtual void childFrameRemoved( KonqFrameBase * frame ) = 0;
  52
  53     virtual bool isContainer() const { return true; }
  54
  55     virtual KonqFrameBase::FrameType frameType() const { return KonqFrameBase::ContainerBase; }
  56
  57   KonqFrameBase* activeChild() const { return m_pActiveChild; }
  58
  59   virtual void setActiveChild( KonqFrameBase* activeChild ) { m_pActiveChild = activeChild;
  60                                                               m_pParentContainer->setActiveChild( this ); }
  61
  62   virtual void activateChild() { if (m_pActiveChild) m_pActiveChild->activateChild(); }
  63
  64   virtual KonqView* activeChildView() const { if (m_pActiveChild) return m_pActiveChild->activeChildView();
  65                                         else return 0; }
  66
  67 protected:
  68   KonqFrameContainerBase() {}
  69
  70   KonqFrameBase* m_pActiveChild;
  71 };
  72
  73 /**
  74  * With KonqFrameContainers and @refKonqFrames we can create a flexible
  75  * storage structure for the views. The top most element is a
  76  * KonqFrameContainer. It's a direct child of the MainView. We can then
  77  * build up a binary tree of containers. KonqFrameContainers are the nodes.
  78  * That means that they always have two children. Which are either again
  79  * KonqFrameContainers or, as leaves, KonqFrames.
  80  */
  81 class KonqFrameContainer : public QSplitter, public KonqFrameContainerBase   // TODO rename to KonqFrameContainerSplitter?
  82 {
  83   Q_OBJECT
  84   friend class KonqFrame; //for emitting ctrlTabPressed() only, aleXXX
  85 public:
  86   KonqFrameContainer( Qt::Orientation o,
  87                       QWidget* parent,
  88                       KonqFrameContainerBase* parentContainer );
  89   virtual ~KonqFrameContainer();
  90
  91     virtual bool accept( KonqFrameVisitor* visitor );
  92
  93   virtual void saveConfig( KConfigGroup& config, const QString &prefix, const KonqFrameBase::Options &options, KonqFrameBase* docContainer, int id = 0, int depth = 0 );
  94   virtual void copyHistory( KonqFrameBase *other );
  95
  96   KonqFrameBase* firstChild() { return m_pFirstChild; }
  97   KonqFrameBase* secondChild() { return m_pSecondChild; }
  98   KonqFrameBase* otherChild( KonqFrameBase* child );
  99
 100   void swapChildren();
 101
 102   virtual void setTitle( const QString &title, QWidget* sender );
 103   virtual void setTabIcon( const KUrl &url, QWidget* sender );
 104
 105   virtual QWidget* asQWidget() { return this; }
 106   virtual KonqFrameBase::FrameType frameType() const { return KonqFrameBase::Container; }
 107
 108     /**
 109      * Insert a new frame into the splitter.
 110      */
 111     void insertChildFrame(KonqFrameBase * frame, int index = -1);
 112     /**
 113      * Call this before deleting one of our children.
 114      */
 115     void childFrameRemoved(KonqFrameBase * frame);
 116
 117     virtual void replaceChildFrame(KonqFrameBase* oldFrame, KonqFrameBase* newFrame);
 118
 119     void setAboutToBeDeleted() { m_bAboutToBeDeleted = true; }
 120
 121 protected:
 122     virtual void childEvent( QChildEvent * );
 123
 124 Q_SIGNALS:
 125   void ctrlTabPressed();
 126   void setRubberbandCalled();
 127
 128 protected:
 129   KonqFrameBase* m_pFirstChild;
 130   KonqFrameBase* m_pSecondChild;
 131   bool m_bAboutToBeDeleted;
 132 };
 133
 134 #endif /* KONQ_FRAMECONTAINER_H */
 135