← Back to branch summary

~ubuntu-branches/ubuntu/saucy/clementine/saucy

« back to all changes in this revision

Viewing changes to src/globalsearch/common.h

  • Committer: Package Import Robot
  • Author(s): Thomas PIERSON
  • Date: 2012-01-01 20:43:39 UTC
  • mfrom: (1.1.1)
  • Revision ID: package-import@ubuntu.com-20120101204339-lsb6nndwhfy05sde
Tags: 1.0.1+dfsg-1
http://bugs.debian.org/653926
http://bugs.debian.org/651611
http://bugs.debian.org/657391
New upstream release. (Closes: #653926, #651611, #657391)

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/globalsearch/common.h
 
1
/* This file is part of Clementine.
 
2
   Copyright 2011, David Sansome <me@davidsansome.com>
 
3
 
 
4
   Clementine 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 3 of the License, or
 
7
   (at your option) any later version.
 
8
 
 
9
   Clementine 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 Clementine.  If not, see <http://www.gnu.org/licenses/>.
 
16
*/
 
17
 
 
18
#ifndef GLOBALSEARCHSERVICERESULT_H
 
19
#define GLOBALSEARCHSERVICERESULT_H
 
20
 
 
21
// This file contains definitions that are shared between Clementine and any
 
22
// external applications that need to do global searches over DBus.
 
23
 
 
24
#include "config.h"
 
25
 
 
26
#ifdef HAVE_DBUS
 
27
#  include <QDBusArgument>
 
28
#endif
 
29
 
 
30
#include <QIcon>
 
31
 
 
32
namespace globalsearch {
 
33
 
 
34
// The order of types here is the order they'll appear in the UI.
 
35
enum Type {
 
36
  Type_Track = 0,
 
37
  Type_Stream,
 
38
  Type_Album
 
39
};
 
40
 
 
41
enum MatchQuality {
 
42
  // A token in the search string matched at the beginning of the song
 
43
  // metadata.
 
44
  Quality_AtStart = 0,
 
45
 
 
46
  // A token matched somewhere else.
 
47
  Quality_Middle,
 
48
 
 
49
  Quality_None
 
50
};
 
51
 
 
52
} // namespace globalsearch
 
53
 
 
54
 
 
55
#ifdef HAVE_DBUS
 
56
 
 
57
struct GlobalSearchServiceResult {
 
58
  // When adding new fields to this struct remember to update the dbus signature
 
59
  // which is duplicated in the xml specification and in clementinerunner.cpp
 
60
 
 
61
  int result_id_;
 
62
  bool art_on_the_way_;
 
63
 
 
64
  QString provider_name_;
 
65
  globalsearch::Type type_;
 
66
  globalsearch::MatchQuality match_quality_;
 
67
 
 
68
  int album_size_;
 
69
 
 
70
  QString title_;
 
71
  QString artist_;
 
72
  QString album_;
 
73
  QString album_artist_;
 
74
  bool is_compilation_;
 
75
  int track_;
 
76
 
 
77
  // Not included in the dbus emission.
 
78
  QIcon image_;
 
79
  int provider_order_;
 
80
};
 
81
typedef QList<GlobalSearchServiceResult> GlobalSearchServiceResultList;
 
82
 
 
83
Q_DECLARE_METATYPE(GlobalSearchServiceResult)
 
84
Q_DECLARE_METATYPE(GlobalSearchServiceResultList)
 
85
 
 
86
QDBusArgument& operator <<(QDBusArgument& arg, const GlobalSearchServiceResult& result);
 
87
const QDBusArgument& operator >>(const QDBusArgument& arg, GlobalSearchServiceResult& result);
 
88
 
 
89
#endif // HAVE_DBUS
 
90
 
 
91
 
 
92
#endif // GLOBALSEARCHSERVICERESULT_H