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  02110-1301, USA.         *
  18  ***************************************************************************/
  19
  20 #ifndef PLAYLISTPLAYLISTALBUMGROUP_H
  21 #define PLAYLISTPLAYLISTALBUMGROUP_H
  22
  23 #include <QList>
  24
  25
  26 namespace Playlist
  27 {
  28     // The Order of this enum is important, do not change it.
  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     enum OffsetMode
  46     {
  47         OffsetNone = 0,
  48         OffsetBetween,
  49         OffsetAfter
  50     };
  51
  52     /**
  53         A helper class representing the group(s) of tracks for a specific album. For each album, the rows
  54         of all tracks are added and this class keeps tracks of what kind of GroupMode each row should use
  55         @author
  56     */
  57     class AlbumGroup
  58     {
  59     public:
  60         AlbumGroup( );
  61
  62         ~AlbumGroup();
  63
  64         void addRow( int row );
  65         int groupMode( int row );
  66
  67         bool alternate( int row );
  68
  69         void setCollapsed( int row, bool collapsed );
  70         int elementsInGroup( int row );
  71
  72         int firstInGroup( int row );
  73         int lastInGroup( int row );
  74         void removeGroup( int row );
  75
  76         void removeBetween( int first, int last );
  77         void offsetBetween( int first, int last, int offset );
  78
  79         int subgroupCount();
  80
  81         void printGroupRows();
  82
  83     private:
  84         QList<Group> m_groups;
  85
  86 };
  87
  88 }
  89
  90 #endif