File indexing completed on 2024-05-19 04:56:04

 /**
  * \file framelist.h
  * List of frames.
  *
  * \b Project: Kid3
  * \author Urs Fleisch
  * \date 9 Jan 2003
  *
  * Copyright (C) 2003-2024  Urs Fleisch
  *
  * This file is part of Kid3.
  *
  * Kid3 is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
  *
  * Kid3 is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 #pragma once
 
 #include <QObject>
 #include "frame.h"
 
 class QItemSelectionModel;
 class FrameTableModel;
 class TaggedFile;
 class IFrameEditor;
 
 /**
  * List of frames.
  */
 class KID3_CORE_EXPORT FrameList : public QObject {
   Q_OBJECT
 public:
   /**
    * Constructor.
    *
    * @param tagNr tag number
    * @param ftm frame table model
    * @param selModel item selection model
    */
   FrameList(Frame::TagNumber tagNr,
             FrameTableModel* ftm, QItemSelectionModel* selModel);
 
   /**
    * Destructor.
    */
   ~FrameList() override = default;
 
   /**
    * Get editor for frames.
    * @return frame editor.
    */
   IFrameEditor* frameEditor() const { return m_frameEditor; }
 
   /**
    * Set editor for frames.
    *
    * @param frameEditor frame editor
    */
   void setFrameEditor(IFrameEditor* frameEditor);
 
   /**
    * Set tagged file.
    *
    * @param taggedFile file
    */
   void setTaggedFile(TaggedFile* taggedFile) { m_taggedFile = taggedFile; }
 
   /**
    * Get tagged file.
    * @return tagged file.
    */
   TaggedFile* getTaggedFile() const { return m_taggedFile; }
 
   /**
    * Delete selected frame.
    *
    * @return false if frame not found.
    */
   bool deleteFrame();
 
   /**
    * Let the user select and edit a frame type and then edit the frame.
    * Add the frame if the edits are accepted.
    * frameEdited() is emitted with the added frame.
    */
   void selectAddAndEditFrame();
 
   /**
    * Add and edit a new frame.
    * frameEdited() is emitted with the added frame.
    */
   void addAndEditFrame();
 
   /**
    * Edit the current frame.
    * The frame and its file have to be set using setFrame() and setTaggedFile().
    */
   void editFrame();
 
   /**
    * Paste the selected frame from the copy buffer.
    *
    * @return true if frame pasted.
    */
   bool pasteFrame();
 
   /**
    * Get the frame in the copy buffer.
    * @return frame from copy buffer.
    */
   const Frame& getFrame() const { return m_frame; }
 
   /**
    * Set the frame in the copy buffer.
    * @param frame frame to set
    */
   void setFrame(const Frame& frame) { m_frame = frame; }
 
   /**
    * Add a suitable field list for the frame in the copy buffer if missing.
    */
   void addFrameFieldList();
 
   /**
    * Check if the frame in the copy buffer is a picture frame.
    * @return true if picture frame.
    */
   bool isPictureFrame() const { return m_frame.getType() == Frame::FT_Picture; }
 
   /**
    * Get the name of the selected frame.
    *
    * @return name, QString::null if nothing selected.
    */
   QString getSelectedName() const;
 
   /**
    * Select a frame with a given name.
    *
    * @param name name of frame
    *
    * @return true if a frame with that name could be selected.
    */
   bool selectByName(const QString& name);
 
   /**
    * Select a frame by row number in the frame table.
    *
    * @param row row of frame
    *
    * @return true if a frame could be selected.
    */
   Q_INVOKABLE bool selectByRow(int row);
 
   /**
    * Get ID of selected frame list item.
    *
    * @return ID of selected item,
    *         -1 if not item is selected.
    */
   int getSelectedId() const;
 
   /**
    * Select the frame by ID.
    *
    * @param id ID of frame to select
    */
   void setSelectedId(int id);
 
   /**
    * Get number of tag containing the frames of this frame list.
    * @return tag number.
    */
   Frame::TagNumber tagNumber() const { return m_tagNr; }
 
   /**
    * Save the current cursor position.
    */
   void saveCursor();
 
   /**
    * Restore the cursor position saved with saveCursor().
    */
   void restoreCursor();
 
 signals:
   /**
    * Emitted when the dialog to add and edit a frame is closed and an
    * existing frame was edited.
    * @param frame edited frame if dialog was accepted, else 0
    */
   void frameEdited(const Frame* frame);
 
   /**
    * Emitted when the dialog to add and edit a frame is closed and a new
    * frame was added.
    * @param frame edited frame if dialog was accepted, else 0
    */
   void frameAdded(const Frame* frame);
 
 private slots:
   void onFrameSelected(Frame::TagNumber tagNr, const Frame* frame);
   void onFrameEdited(Frame::TagNumber tagNr, const Frame* frame);
 
 private:
   FrameList(const FrameList&);
   FrameList& operator=(const FrameList&);
 
   /**
    * Get frame of selected frame list item.
    *
    * @param frame the selected frame is returned here
    *
    * @return false if not item is selected.
    */
   bool getSelectedFrame(Frame& frame) const;
 
   /**
    * Set the frame table model from the tagged file.
    */
   void setModelFromTaggedFile();
 
   /** Set of old changed frames stored while in the edit dialog */
   QList<Frame::ExtendedType> m_oldChangedFrames;
   /** File containing tags */
   TaggedFile* m_taggedFile;
   /** Editor for frames */
   IFrameEditor* m_frameEditor;
   /** Frame used to add, edit and paste */
   Frame m_frame;
 
   FrameTableModel* m_frameTableModel;
   QItemSelectionModel* m_selectionModel;
 
   int m_cursorRow;
   int m_cursorColumn;
   const Frame::TagNumber m_tagNr;
 
   /** true while a frame is added */
   bool m_addingFrame;
 };