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