src/client/backlogsettings.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2022 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 "client-export.h"
  24
  25 #include "backlogrequester.h"
  26 #include "clientsettings.h"
  27
  28 class CLIENT_EXPORT BacklogSettings : public ClientSettings
  29 {
  30 public:
  31     BacklogSettings();
  32     int requesterType() const;
  33     // Default to PerBufferUnread to help work around performance problems on connect when there's
  34     // many buffers that don't have much activity.
  35     void setRequesterType(int requesterType);
  36
  37     int dynamicBacklogAmount() const;
  38     void setDynamicBacklogAmount(int amount);
  39
  40     /**
  41      * Gets if a buffer should fetch backlog upon show to provide a scrollable amount of backlog
  42      *
  43      * @return True if showing a buffer without scrollbar visible fetches backlog, otherwise false
  44      */
  45     bool ensureBacklogOnBufferShow() const;
  46     /**
  47      * Sets if a buffer should fetch backlog upon show to provide a scrollable amount of backlog
  48      *
  49      * @param enabled True if showing a buffer without scrollbar fetches backlog, otherwise false
  50      */
  51     void setEnsureBacklogOnBufferShow(bool enabled);
  52
  53     int fixedBacklogAmount() const;
  54     void setFixedBacklogAmount(int amount);
  55
  56     int globalUnreadBacklogLimit() const;
  57     void setGlobalUnreadBacklogLimit(int limit);
  58     int globalUnreadBacklogAdditional() const;
  59     void setGlobalUnreadBacklogAdditional(int additional);
  60
  61     int perBufferUnreadBacklogLimit() const;
  62     void setPerBufferUnreadBacklogLimit(int limit);
  63     int perBufferUnreadBacklogAdditional() const;
  64     void setPerBufferUnreadBacklogAdditional(int additional);
  65
  66     /**
  67      * Get the initial amount of backlog fetched across all buffers for legacy cores that do not
  68      * support Quassel::Feature::BufferActivitySync
  69      *
  70      * @seealso Quassel::Feature::BufferActivitySync
  71      * @return The amount of backlog to fetch per buffer
  72      */
  73     int asNeededLegacyBacklogAmount() const;
  74     /**
  75      * Set the initial amount of backlog fetched across all buffers for legacy cores that do not
  76      * support Quassel::Feature::BufferActivitySync
  77      *
  78      * @seealso BacklogSettings::asNeededLegacyBacklogAmount()
  79      * @param amount The amount of backlog to fetch per buffer
  80      */
  81     void setAsNeededLegacyBacklogAmount(int amount);
  82 };