[cosmetics] update date in GPL header
[vuplus_xbmc] / xbmc / utils / GroupUtils.h
1 #pragma once
2 /*
3  *      Copyright (C) 2012-2013 Team XBMC
4  *      http://www.xbmc.org
5  *
6  *  This Program is free software; you can redistribute it and/or modify
7  *  it under the terms of the GNU General Public License as published by
8  *  the Free Software Foundation; either version 2, or (at your option)
9  *  any later version.
10  *
11  *  This Program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with XBMC; see the file COPYING.  If not, see
18  *  <http://www.gnu.org/licenses/>.
19  *
20  */
21
22 #include "SortUtils.h"
23
24 class CFileItemList;
25
26 // can be used as a flag
27 typedef enum {
28   GroupByNone = 0x0,
29   GroupBySet  = 0x1
30 } GroupBy;
31
32 typedef enum {
33   GroupAttributeNone              = 0x0,
34   GroupAttributeIgnoreSingleItems = 0x1
35 } GroupAttribute;
36
37 class GroupUtils
38 {
39 public:
40   static bool Group(GroupBy groupBy, const std::string &baseDir, const CFileItemList &items, CFileItemList &groupedItems, GroupAttribute groupAttributes = GroupAttributeNone);
41   static bool GroupAndSort(GroupBy groupBy, const std::string &baseDir, const CFileItemList &items, const SortDescription &sortDescription, CFileItemList &groupedItems, GroupAttribute groupAttributes = GroupAttributeNone);
42 };