blob: a7324ae50fc6f6beaedd8018d5dc09df64a33227 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
/***************************************************************************
begin : Sun Oct 31 2004
copyright : (C) 2004 by Michael Pyne
email : [email protected]
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef JUK_CATEGORYREADERINTERFACE_H
#define JUK_CATEGORYREADERINTERFACE_H
#include "tagrenameroptions.h"
enum TagType;
class TQString;
template<class T> class TQValueList;
/**
* This class is used to map categories into values. You should implement the
* functionality in a subclass.
*
* @author Michael Pyne <[email protected]>
*/
class CategoryReaderInterface
{
public:
virtual ~CategoryReaderInterface() { }
/**
* Returns the textual representation of \p type, without any processing done
* on it. For example, track values shouldn't be expanded out to the minimum
* width from this function. No CategoryID is needed since the value is constant
* for a category.
*
* @param type, The category to retrieve the value of.
* @return textual representation of that category's value.
*/
virtual TQString categoryValue(TagType type) const = 0;
/**
* Returns the user-specified prefix string for \p category.
*
* @param category the category to retrieve the value for.
* @return user-specified prefix string for \p category.
*/
virtual TQString prefix(const CategoryID &category) const = 0;
/**
* Returns the user-specified suffix string for \p category.
*
* @param category the category to retrieve the value for.
* @return user-specified suffix string for \p category.
*/
virtual TQString suffix(const CategoryID &category) const = 0;
/**
* Returns the user-specified empty action for \p category.
*
* @param category the category to retrieve the value for.
* @return user-specified empty action for \p category.
*/
virtual TagRenamerOptions::EmptyActions emptyAction(const CategoryID &category) const = 0;
/**
* Returns the user-specified empty text for \p category. This text might
* be used to replace an empty value.
*
* @param category the category to retrieve the value for.
* @return the user-specified empty text for \p category.
*/
virtual TQString emptyText(const CategoryID &category) const = 0;
/**
* @return the categories in the order the user has chosen. Categories may
* be repeated (which is why CategoryID has the categoryNumber value to
* disambiguate duplicates).
*/
virtual TQValueList<CategoryID> categoryOrder() const = 0;
/**
* @return track width for the Track item identified by categoryNum.
*/
virtual int trackWidth(unsigned categoryNum) const = 0;
// You probably shouldn't reimplement this
virtual TQString value(const CategoryID &category) const;
virtual TQString separator() const = 0;
virtual TQString musicFolder() const = 0;
/**
* @param index the zero-based index of the item just before the
* separator in question.
* @return true if a folder separator should be placed between the tags
* at index and index + 1.
*/
virtual bool hasFolderSeparator(unsigned index) const = 0;
virtual bool isDisabled(const CategoryID &category) const = 0;
// You probably shouldn't reimplement this
virtual bool isRequired(const CategoryID &category) const;
// You probably shouldn't reimplement this
virtual bool isEmpty(TagType category) const;
// You probably shouldn't reimplement this
virtual TQString fixupTrack(const TQString &track, unsigned categoryNum) const;
};
#endif /* JUK_CATEGORYREADERINTERFACE_H */
// vim: set et sw=4 ts=4:
|
