itemstoragemodel.h

Go to the documentation of this file.

/*
  * Copyright 2020 Twilight
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *   http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
*/
#pragma once
#include <QObject>
#include <QString>
#include <QAbstractListModel>
#include <QVector>
 
class Item;
class ItemStorageBox;
class Router;

class ItemStorageModel : public QAbstractListModel
{
  Q_OBJECT
 
  // Checkmarks changed
  Q_PROPERTY(bool hasChecked READ hasCheckedCached NOTIFY hasCheckedChangedCached STORED false) 
 
signals:
  void hasCheckedChanged();
  void hasCheckedChangedCached();
 
public:
  // Name of attached properties
  static constexpr const char* isCheckedKey = "isChecked"; 

  enum BagItemRoles {
    IdRole = Qt::UserRole + 1,
    CountRole,
    CheckedRole,
    PlaceholderRole,
  };
 
  ItemStorageModel(ItemStorageBox* items, Router* router); 
 
  virtual int rowCount(const QModelIndex& parent) const override;          
  virtual QVariant data(const QModelIndex& index, int role) const override; 
  virtual QHash<int, QByteArray> roleNames() const override;                
  bool setData(const QModelIndex &index, const QVariant &value,
                   int role = Qt::EditRole) override;                       
 
  QVariant getPlaceHolderData(int role) const; 
 
  // Signals from the box
  void onMove(int from, int to); 
  void onRemove(int ind);        
  void onInsert();               
  void onReset();                
 
  // Attached property management
  bool hasChecked();              
  bool hasCheckedCached();        
  QVector<Item*> getChecked();    
  void onBeforeRelocate(Item* item); 
  void checkStateDirty();         
 
  void pageClosing(); 
 
  // ---- Drag & drop (Bag / Items screen) -----------------------------------
  // Backing for the list's drag-to-reorder and drag-between-panes gestures, the
  // direct analogue of PokemonStorageModel's. `toIndex` is the destination
  // insertion slot (0..count): the moved item(s) land *before* the item at that
  // slot (== append when toIndex is the count). When `group` is true the whole
  // currently-checked set moves together (preserving order); otherwise just the
  // single item at `fromIndex`. Same rules as the checked* bulk actions
  // (destination never overflows). An item box can be empty, so -- unlike the
  // Pokemon party -- there is no "never empties" guard.

  Q_INVOKABLE void dragReorder(int fromIndex, int toIndex, bool group);

  Q_INVOKABLE void dragTransfer(int fromIndex, int toIndex, bool group);

  Q_INVOKABLE void deleteItem(int index, bool group);
 
public slots:
  // Attached property management
  void clearCheckedState();     
  void clearCheckedStateGone(); 
 
  void checkedMoveToTop();    
  void checkedMoveUp();       
  void checkedMoveDown();     
  void checkedMoveToBottom(); 
  void checkedDelete();       
  void checkedTransfer();     
  void checkedToggleAll();    
 
public:
  ItemStorageBox* items = nullptr; 
  Router* router;                  
  ItemStorageModel* otherModel = nullptr; 
  bool checkedStateDirty = false;  
};