src/playlist/PlaylistAlbumGroup.h

   1 /***************************************************************************
   2  *   Copyright (c) 2007  Nikolaj Hald Nielsen <nhnFreespirit@gmail.com>    *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA  02111-1307, USA.         *
  18  ***************************************************************************/
  19
  20 #ifndef PLAYLISTPLAYLISTALBUMGROUP_H
  21 #define PLAYLISTPLAYLISTALBUMGROUP_H
  22
  23 #include <QList>
  24
  25
  26 namespace Playlist {
  27
  28
  29 enum GroupMode
  30 {
  31     None = 1,
  32     Head,
  33     Head_Collapsed,
  34     Body,
  35     End,
  36     Collapsed
  37 };
  38
  39 struct Group {
  40
  41     QList < int > rows;
  42     bool collapsed;
  43
  44 };
  45
  46 enum OffsetMode
  47 {
  48     OffsetNone = 0,
  49     OffsetBetween,
  50     OffsetAfter
  51 };
  52
  53
  54
  55 /**
  56 A helper class representing the group(s) of tracks for a specific album. For each album, the rows
  57 of all tracks are added and this class keeps tracks of what kind of GroupMode each row should use
  58
  59         @author
  60 */
  61 class AlbumGroup{
  62 public:
  63     AlbumGroup( );
  64
  65     ~AlbumGroup();
  66
  67     void addRow( int row );
  68     int groupMode( int row );
  69
  70     void setCollapsed( int row, bool collapsed );
  71     int elementsInGroup( int row );
  72
  73     int firstInGroup( int row );
  74     int lastInGroup( int row );
  75     void removeGroup( int row );
  76
  77     void removeBetween( int first, int last );
  78     void offsetBetween( int first, int last, int offset );
  79
  80     int subgroupCount();
  81
  82     void printGroupRows();
  83
  84 private:
  85
  86     QList< Group > m_groups;
  87
  88 };
  89
  90 }
  91
  92 #endif