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

0001 /**
0002  * \file numbertracksconfig.h
0003  * Configuration for track numbering.
0004  *
0005  * \b Project: Kid3
0006  * \author Urs Fleisch
0007  * \date 29 Jun 2013
0008  *
0009  * Copyright (C) 2013-2018  Urs Fleisch
0010  *
0011  * This file is part of Kid3.
0012  *
0013  * Kid3 is free software; you can redistribute it and/or modify
0014  * it under the terms of the GNU General Public License as published by
0015  * the Free Software Foundation; either version 2 of the License, or
0016  * (at your option) any later version.
0017  *
0018  * Kid3 is distributed in the hope that it will be useful,
0019  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0020  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0021  * GNU General Public License for more details.
0022  *
0023  * You should have received a copy of the GNU General Public License
0024  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
0025  */
0026 
0027 #pragma once
0028 
0029 #include "generalconfig.h"
0030 #include "frame.h"
0031 #include "kid3api.h"
0032 
0033 /**
0034  * Configuration for track numbering.
0035  */
0036 class KID3_CORE_EXPORT NumberTracksConfig
0037     : public StoredConfig<NumberTracksConfig> {
0038   Q_OBJECT
0039   /** number tracks in tags 1, tags 2, or both */
0040   Q_PROPERTY(int numberTracksDestination READ numberTracksDestination
0041              WRITE setNumberTracksDstInt NOTIFY numberTracksDestinationChanged)
0042   /** number tracks start number */
0043   Q_PROPERTY(int numberTracksStart READ numberTracksStart
0044              WRITE setNumberTracksStart NOTIFY numberTracksStartChanged)
0045   /** enable track numbering */
0046   Q_PROPERTY(bool trackNumberingEnabled READ isTrackNumberingEnabled
0047              WRITE setTrackNumberingEnabled NOTIFY trackNumberingEnabledChanged)
0048   /** reset of counter for each directory */
0049   Q_PROPERTY(bool directoryCounterResetEnabled READ isDirectoryCounterResetEnabled
0050              WRITE setDirectoryCounterResetEnabled NOTIFY directoryCounterResetEnabledChanged)
0051   /** window geometry */
0052   Q_PROPERTY(QByteArray windowGeometry READ windowGeometry
0053              WRITE setWindowGeometry NOTIFY windowGeometryChanged)
0054 public:
0055   /**
0056    * Constructor.
0057    */
0058   NumberTracksConfig();
0059 
0060   /**
0061    * Destructor.
0062    */
0063   ~NumberTracksConfig() override = default;
0064 
0065   /**
0066    * Persist configuration.
0067    *
0068    * @param config configuration
0069    */
0070   void writeToConfig(ISettings* config) const override;
0071 
0072   /**
0073    * Read persisted configuration.
0074    *
0075    * @param config configuration
0076    */
0077   void readFromConfig(ISettings* config) override;
0078 
0079   /** Get destination tag. */
0080   Frame::TagVersion numberTracksDestination() const { return m_numberTracksDst; }
0081 
0082   /** Set destination tag. */
0083   void setNumberTracksDestination(Frame::TagVersion numberTracksDestination);
0084 
0085   /** Get start number when numbering tracks. */
0086   int numberTracksStart() const { return m_numberTracksStart; }
0087 
0088   /** Set start number when numbering tracks. */
0089   void setNumberTracksStart(int numberTracksStart);
0090 
0091   /**
0092    * Check if track numbering is enabled.
0093    * @return true if enabled.
0094    */
0095   bool isTrackNumberingEnabled() const { return m_trackNumberingEnabled; }
0096 
0097   /**
0098    * Enable or disable track numbering.
0099    * @param enable true to enable
0100    */
0101   void setTrackNumberingEnabled(bool enable);
0102 
0103   /**
0104    * Check if counter has to be reset for each directory.
0105    * @return true if enabled.
0106    */
0107   bool isDirectoryCounterResetEnabled() const {
0108     return m_directoryCounterResetEnabled;
0109   }
0110 
0111   /**
0112    * Enable reset of counter for each directory.
0113    * @param enable true to enable
0114    */
0115   void setDirectoryCounterResetEnabled(bool enable);
0116 
0117   /**
0118    * Get window geometry.
0119    * @return window geometry.
0120    */
0121   QByteArray windowGeometry() const { return m_windowGeometry; }
0122 
0123   /**
0124    * Set window geometry.
0125    * @param windowGeometry geometry
0126    */
0127   void setWindowGeometry(const QByteArray& windowGeometry);
0128 
0129 signals:
0130   /** Emitted when @a numberTracksDst changed. */
0131   void numberTracksDestinationChanged(Frame::TagVersion numberTracksDestination);
0132 
0133   /** Emitted when @a numberTracksStart changed. */
0134   void numberTracksStartChanged(int numberTracksStart);
0135 
0136   /** Emitted when @a trackNumberingEnabled changed. */
0137   void trackNumberingEnabledChanged(bool trackNumberingEnabled);
0138 
0139   /** Emitted when @a directoryCounterResetEnabled changed. */
0140   void directoryCounterResetEnabledChanged(bool directoryCounterResetEnabled);
0141 
0142   /** Emitted when @a windowGeometry changed. */
0143   void windowGeometryChanged(const QByteArray& windowGeometry);
0144 
0145 private:
0146   friend NumberTracksConfig& StoredConfig<NumberTracksConfig>::instance();
0147 
0148   void setNumberTracksDstInt(int numberTracksDst) {
0149     setNumberTracksDestination(Frame::tagVersionCast(numberTracksDst));
0150   }
0151 
0152   QByteArray m_windowGeometry;
0153   Frame::TagVersion m_numberTracksDst;
0154   int m_numberTracksStart;
0155   bool m_trackNumberingEnabled;
0156   bool m_directoryCounterResetEnabled;
0157 
0158   /** Index in configuration storage */
0159   static int s_index;
0160 };