annotate gui/app/gui.h @ 37053:84c93a60ead3

Add new item 'rpotmeter'. This is the missing counterpart to hpotmeter and vpotmeter allowing rotary control elements in a GUI skin now. Based on an idea and a realization by Hans-Dieter Kosch, hdkosch kabelbw de. Additionally, update (and revise) documentation.
author ib
date Sat, 12 Apr 2014 23:29:29 +0000
parents 40ad45360c8a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
35429
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
1 /*
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
2 * This file is part of MPlayer.
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
3 *
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
4 * MPlayer is free software; you can redistribute it and/or modify
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
5 * it under the terms of the GNU General Public License as published by
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
6 * the Free Software Foundation; either version 2 of the License, or
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
7 * (at your option) any later version.
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
8 *
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
9 * MPlayer is distributed in the hope that it will be useful,
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
12 * GNU General Public License for more details.
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
13 *
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
14 * You should have received a copy of the GNU General Public License along
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
15 * with MPlayer; if not, write to the Free Software Foundation, Inc.,
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
17 */
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
18
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
19 /**
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
20 * @file
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
21 * @brief Internal declarations and definitions
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
22 */
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
23
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
24 #ifndef MPLAYER_GUI_GUI_H
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
25 #define MPLAYER_GUI_GUI_H
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
26
36053
7affacef2f88 Define "MPlayer" string.
ib
parents: 35729
diff changeset
27 /// Name of the program the GUI utilizes
7affacef2f88 Define "MPlayer" string.
ib
parents: 35729
diff changeset
28 #define MPlayer "MPlayer"
7affacef2f88 Define "MPlayer" string.
ib
parents: 35729
diff changeset
29
35493
411875efca3f Introduce boolean symbolic constants.
ib
parents: 35429
diff changeset
30 //@{
35729
a5f7a861a293 Revise some doxygen comments.
ib
parents: 35675
diff changeset
31 /// Boolean symbolic constant
35493
411875efca3f Introduce boolean symbolic constants.
ib
parents: 35429
diff changeset
32 #if !defined(True) && !defined(False)
411875efca3f Introduce boolean symbolic constants.
ib
parents: 35429
diff changeset
33 #define True 1
411875efca3f Introduce boolean symbolic constants.
ib
parents: 35429
diff changeset
34 #define False 0
411875efca3f Introduce boolean symbolic constants.
ib
parents: 35429
diff changeset
35 #endif
411875efca3f Introduce boolean symbolic constants.
ib
parents: 35429
diff changeset
36 //@}
411875efca3f Introduce boolean symbolic constants.
ib
parents: 35429
diff changeset
37
35729
a5f7a861a293 Revise some doxygen comments.
ib
parents: 35675
diff changeset
38 /// A pseudo stream type indicating not to change the current one
35429
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
39 #define SAME_STREAMTYPE (STREAMTYPE_DUMMY - 1)
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
40
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
41 /// StreamTypes that are permitted in a playlist
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
42 #define isPlaylistStreamtype (guiInfo.StreamType == STREAMTYPE_FILE || guiInfo.StreamType == STREAMTYPE_STREAM)
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
43
36429
28ea255e40ce Add support for TV/DVB to the GUI.
ib
parents: 36053
diff changeset
44 /// StreamTypes that permit seeking
28ea255e40ce Add support for TV/DVB to the GUI.
ib
parents: 36053
diff changeset
45 #define isSeekableStreamtype (guiInfo.StreamType != STREAMTYPE_STREAM && guiInfo.StreamType != STREAMTYPE_TV && guiInfo.StreamType != STREAMTYPE_DVB)
28ea255e40ce Add support for TV/DVB to the GUI.
ib
parents: 36053
diff changeset
46
35729
a5f7a861a293 Revise some doxygen comments.
ib
parents: 35675
diff changeset
47 /// Check whether @a x/y is inside the rectangle given by @a top @a x/y and @a bottom @a x/y.
35675
9e2183017f1f Move wgIsRect from ws.h to gui.h.
ib
parents: 35525
diff changeset
48 #define isInside(x, y, tx, ty, bx, by) ((x) > (tx) && (y) > (ty) && (x) < (bx) && (y) < (by))
9e2183017f1f Move wgIsRect from ws.h to gui.h.
ib
parents: 35525
diff changeset
49
36858
bb067298265a Fix bug with btnSet().
ib
parents: 36857
diff changeset
50 /// Check whether #guiItem @a item has a button (and thus a pressed state).
37053
84c93a60ead3 Add new item 'rpotmeter'.
ib
parents: 36920
diff changeset
51 #define hasButton(item) (item.type == itButton || item.type == itHPotmeter || item.type == itVPotmeter || item.type == itRPotmeter)
36858
bb067298265a Fix bug with btnSet().
ib
parents: 36857
diff changeset
52
36861
bade5683ca70 Fix bug with btnModify().
ib
parents: 36858
diff changeset
53 /// Check whether #guiItem @a item utilizes member 'value'
37053
84c93a60ead3 Add new item 'rpotmeter'.
ib
parents: 36920
diff changeset
54 #define hasValue(item) (item.type == itHPotmeter || item.type == itVPotmeter || item.type == itRPotmeter || item.type == itPimage)
36861
bade5683ca70 Fix bug with btnModify().
ib
parents: 36858
diff changeset
55
35429
3a9048421524 Create new header file gui.h.
ib
parents:
diff changeset
56 #endif /* MPLAYER_GUI_GUI_H */