1 /***************************************************************************
2  *   Copyright (C) 2008-2021 by Andrzej Rybczak                            *
3  *   andrzej@rybczak.net                                                   *
4  *                                                                         *
5  *   This program is free software; you can redistribute it and/or modify  *
6  *   it under the terms of the GNU General Public License as published by  *
7  *   the Free Software Foundation; either version 2 of the License, or     *
8  *   (at your option) any later version.                                   *
9  *                                                                         *
10  *   This program is distributed in the hope that it will be useful,       *
11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
13  *   GNU General Public License for more details.                          *
14  *                                                                         *
15  *   You should have received a copy of the GNU General Public License     *
16  *   along with this program; if not, write to the                         *
17  *   Free Software Foundation, Inc.,                                       *
18  *   51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.              *
19  ***************************************************************************/
20 
21 #ifndef NCMPCPP_INTERFACES_H
22 #define NCMPCPP_INTERFACES_H
23 
24 #include <boost/range/detail/any_iterator.hpp>
25 #include <boost/tuple/tuple.hpp>
26 #include <string>
27 #include "enums.h"
28 #include "gcc.h"
29 #include "screens/screen.h"
30 #include "song.h"
31 
32 struct Searchable
33 {
34 	virtual bool allowsSearching() = 0;
35 
36 	virtual const std::string &searchConstraint() = 0;
37 	virtual void setSearchConstraint(const std::string &constraint) = 0;
38 	virtual void clearSearchConstraint() = 0;
39 	virtual bool search(SearchDirection direction, bool wrap, bool skip_current) = 0;
40 };
41 
42 struct Filterable
43 {
44 	virtual bool allowsFiltering() = 0;
45 	virtual std::string currentFilter() = 0;
46 	virtual void applyFilter(const std::string &constraint) = 0;
47 };
48 
49 struct HasActions
50 {
51 	virtual bool actionRunnable() = 0;
52 	virtual void runAction() = 0;
53 };
54 
55 struct HasSongs
56 {
57 	virtual bool itemAvailable() = 0;
58 	virtual bool addItemToPlaylist(bool play) = 0;
59 	virtual std::vector<MPD::Song> getSelectedSongs() = 0;
60 };
61 
62 struct HasColumns
63 {
64 	virtual bool previousColumnAvailable() = 0;
65 	virtual void previousColumn() = 0;
66 
67 	virtual bool nextColumnAvailable() = 0;
68 	virtual void nextColumn() = 0;
69 };
70 
71 struct Tabbable
72 {
TabbableTabbable73 	Tabbable() : m_previous_screen(0) { }
74 
switchToPreviousScreenTabbable75 	void switchToPreviousScreen() const {
76 		if (m_previous_screen)
77 			m_previous_screen->switchTo();
78 	}
setPreviousScreenTabbable79 	void setPreviousScreen(BaseScreen *screen) {
80 		m_previous_screen = screen;
81 	}
previousScreenTabbable82 	BaseScreen *previousScreen() const {
83 		return m_previous_screen;
84 	}
85 
86 private:
87 	BaseScreen *m_previous_screen;
88 };
89 
90 #endif // NCMPCPP_INTERFACES_H
91