src/uisupport/abstractbuffercontainer.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2018 by the Quassel Project                        *
   3  *   devel@quassel-irc.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) version 3.                                           *
   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                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  19  ***************************************************************************/
  20
  21 #ifndef ABSTRACTBUFFERCONTAINER_H_
  22 #define ABSTRACTBUFFERCONTAINER_H_
  23
  24 #include "abstractitemview.h"
  25 #include "buffermodel.h"
  26
  27 class AbstractChatView;
  28 class AbstractUiMsg;
  29 class Buffer;
  30
  31 class AbstractBufferContainer : public AbstractItemView
  32 {
  33     Q_OBJECT
  34
  35 public:
  36     AbstractBufferContainer(QWidget *parent);
  37     virtual ~AbstractBufferContainer();
  38
  39     inline BufferId currentBuffer() const { return _currentBuffer; }
  40
  41 signals:
  42     void currentChanged(BufferId);
  43     void currentChanged(const QModelIndex &);
  44
  45 protected:
  46     //! Create an AbstractChatView for the given BufferId and add it to the UI if necessary
  47     virtual AbstractChatView *createChatView(BufferId) = 0;
  48
  49     //! Remove a chat view from the UI and delete it
  50     /** This method shall remove the view from the UI (for example, from a QStackedWidget) if appropriate.
  51      *  It also shall delete the object afterwards.
  52      * \param view The chat view to be removed and deleted
  53      */
  54     virtual void removeChatView(BufferId) = 0;
  55
  56     //! If true, the marker line will be set automatically on buffer switch
  57     /** \return Whether the marker line should be set on buffer switch
  58      */
  59     virtual inline bool autoMarkerLine() const { return true; }
  60
  61 protected slots:
  62     virtual void currentChanged(const QModelIndex &current, const QModelIndex &previous);
  63     virtual void rowsAboutToBeRemoved(const QModelIndex &parent, int start, int end);
  64
  65     //! Show the given chat view
  66     /** This method is called when the given chat view should be displayed. Use this e.g. for
  67      *  selecting the appropriate page in a QStackedWidget.
  68      * \param view The chat view to be displayed. May be 0 if no chat view is selected.
  69      */
  70     virtual void showChatView(BufferId) = 0;
  71
  72 private slots:
  73     void removeBuffer(BufferId bufferId);
  74     void setCurrentBuffer(BufferId bufferId);
  75
  76 private:
  77     BufferId _currentBuffer;
  78     QHash<BufferId, AbstractChatView *> _chatViews;
  79 };
  80
  81
  82 class AbstractChatView
  83 {
  84 public:
  85     virtual ~AbstractChatView() {};
  86     virtual MsgId lastMsgId() const = 0;
  87 };
  88
  89
  90 #endif