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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
/*! -*- c++ -*-
* \file vdr_actions.h
* \brief Implements all actions for broswing media libraries within VDR
*
* \version $Revision: 1.13 $
* \date $Date: 2004-12-25 16:52:35 +0100 (Sat, 25 Dec 2004) $
* \author Wolfgang Rohdewald
* \author Responsible author: $Author: wr61 $
*
* $Id: vdr_actions.h 276 2004-12-25 15:52:35Z wr61 $
*/
#ifndef _VDR_ACTIONS_H
#define _VDR_ACTIONS_H
#include <string>
#include <vdr/osd.h>
#include <vdr/plugin.h>
#include "mg_selection.h"
using namespace std;
class mgSelection;
class mgMenu;
class mgOsd;
class mgSelOsd;
/*! \brief defines all actions which can appear in command submenus.
* Since these values are saved in muggle.state, new actions should
* always be appended. The order does not matter. actNone should be 0.
*/
enum mgActions
{
actNone,
actChooseOrder, //!< show a menu with all possible orders
actToggleSelection, //!< toggle between search and collection view
actClearCollection, //!< clear a collection,
actCreateCollection,
actInstantPlay, //!< instant play
actAddAllToCollection, //!< add all items of OSD list to default collection
actRemoveAllFromCollection, //!< remove from default collection
actDeleteCollection, //!< delete collection
actExportItemlist, //!< export track list into a *.m3u file
actAddCollEntry,
actRemoveCollEntry,
actAddThisToCollection, //!< add selected item to default collection
actRemoveThisFromCollection, //!< remove selected item from default collection
actEntry, //!< used for normal data base items
actSetButton, //!< connect a button with an action
actShowList,
actShowCommands,
actCreateOrder,
actDeleteOrder,
actSync,
actAddAllToDefaultCollection,
actAddThisToDefaultCollection,
actSetDefaultCollection,
actOrder,
actToggleShuffle,
actUnused6,
actEditOrder,
actToggleLoop,
actPrevTrack,
actNextTrack,
actShowLyrics,
actLoadExternalLyrics,
actSaveExternalLyrics,
actBack,
actBack2,
actExternal0 = 1000, //!< used for external commands, the number is the entry number in the .conf file starting with line 0
actExternal1, //!< used for external commands, the number is the entry number in the .conf file
actExternal2, //!< used for external commands, the number is the entry number in the .conf file
actExternal3, //!< used for external commands, the number is the entry number in the .conf file
actExternal4, //!< used for external commands, the number is the entry number in the .conf file
actExternal5, //!< used for external commands, the number is the entry number in the .conf file
actExternal6, //!< used for external commands, the number is the entry number in the .conf file
actExternal7, //!< used for external commands, the number is the entry number in the .conf file
actExternal8, //!< used for external commands, the number is the entry number in the .conf file
actExternal9, //!< used for external commands, the number is the entry number in the .conf file
actExternal10, //!< used for external commands, the number is the entry number in the .conf file
actExternal11, //!< used for external commands, the number is the entry number in the .conf file
actExternal12, //!< used for external commands, the number is the entry number in the .conf file
actExternal13, //!< used for external commands, the number is the entry number in the .conf file
actExternal14, //!< used for external commands, the number is the entry number in the .conf file
actExternal15, //!< used for external commands, the number is the entry number in the .conf file
actExternal16, //!< used for external commands, the number is the entry number in the .conf file
actExternal17, //!< used for external commands, the number is the entry number in the .conf file
actExternal18, //!< used for external commands, the number is the entry number in the .conf file
actExternal19, //!< used for external commands, the number is the entry number in the .conf file
};
//! \brief the highest possible actExternal value
const mgActions actExternalHigh = actExternal19;
//! \brief a generic class for the definition of user actions
class mgAction
{
public:
//! \brief if true, can be displayed
virtual bool Enabled(mgActions on = mgActions(0));
//! \brief the action to be executed
virtual bool Execute () {return true;}
//! \brief handles the kBack key
virtual eOSState Back();
/*! \brief the name for a button.
* The returned C string should be static, it will never be freed.
*/
virtual const char *ButtonName () {
return "";
}
/*! \brief the name for a menu entry. If empty, no button will be able
* to execute this. The returned C string must be freeable at any time.
* \param value a string that can be used for building the menu name.
*/
virtual const char *MenuName (const unsigned int idx=0,const mgListItem* item=0) {
return strdup(ButtonName());
}
//! \brief default constructor
mgAction ();
//! \brief default destructor
virtual ~ mgAction ();
//! \brief assoiates the action with the menu which created it
void SetMenu (mgMenu * const menu);
//! \brief what to do when mgStatus::OsdCurrentItem is called
//for this one
mgActions Type();
void SetText(const char *text,bool copy=true);
const char *Text();
void TryNotify();
/*! \brief vdr calls OsdCurrentItem more often than we
* want. This tells mgStatus to ignore the next call
* for a specific item.
* \todo is this behaviour intended or a bug in vdr
* or in muggle ?
*/
bool IgnoreNextEvent;
/*! \brief defines a reference. Can be used depending on the
* concrete class type. Currently used only by mgEntry
*/
void setHandle(unsigned int handle);
protected:
//! \brief returns the OSD owning the menu owning this item
mgOsd* osd ();
//! \brief returns the OSD owning the menu owning this item
mgSelOsd* Selosd ();
//! \brief the menu that created this object
mgMenu * m;
//! \brief returns the active selection
mgSelection* selection ();
//! \brief returns the collection selection
mgSelection* collselection ();
//! \brief returns the playselection
mgSelection* playselection ();
virtual void Notify();
eOSState ProcessKey(eKeys key);
virtual eOSState Process(eKeys key) { return osUnknown; }
unsigned int m_handle;
private:
mgOsd *m_osd;
};
class mgActionWithIntValue: public mgAction
{
public:
mgActionWithIntValue() { intval=0; }
void setValue(int i) { intval = i; }
protected:
int intval;
};
//! \brief generate an mgAction for action
mgAction* actGenerate(const mgActions action);
mgAction* actGenerateBoolItem(const char *Name, int *Value);
mgAction* actGenerateKeyItem(const char *Name, int *Value, int NumStrings, const char * const * Strings);
class mgOsdItem : public mgAction, public cOsdItem
{
public:
eOSState ProcessKey(eKeys key) { return mgAction::ProcessKey(key); }
};
#endif
|
