Mark const return value; correct the comment about valid menu items for the hotkey
[kugel-rb.git] / manual / plugins / pngviewer.tex
blob33160129ab25aff64caf58fa18253389d45f6950
1 % $Id$ %
2 \subsection{PNG viewer}
3 This plugin opens \fname{.png} files from the \setting{File Browser} to
4 display them.
5 \opt{swcodec}{
6 \note{When an audio file is playing the size of the image is limited as
7 the decoding process needs to share memory with audio tracks. To be able to
8 view a bigger file you may need to stop playback.\\}
10 \nopt{large_plugin_buffer}{%
11 \note{This plugin will cause playback to stop.}%
14 \begin{table}
15 \begin{btnmap}{}{}
16 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD%
17 ,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD%
18 ,MROBE100_PAD}
19 {\ButtonUp\ / \ButtonDown}%
20 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonMenu\ / \ButtonPlay}%
21 \opt{IRIVER_H10_PAD}{\ButtonScrollUp\ / \ButtonScrollDown} %
22 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD%
23 ,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD%
24 ,MROBE100_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IRIVER_H10_PAD}
25 {/ \ButtonLeft\ / \ButtonRight}
26 \opt{HAVEREMOTEKEYMAP}{& }
27 & Move around in zoomed in image\\
28 \opt{RECORDER_PAD}{\ButtonPlay}
29 \opt{ONDIO_PAD}{\ButtonMenu}
30 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD%
31 ,SANSA_FUZE_PAD,SANSA_C200_PAD,MROBE100_PAD}{\ButtonSelect}
32 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonScrollFwd}
33 \opt{IRIVER_H10_PAD}{\ButtonPlay}
34 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolUp}
35 \opt{HAVEREMOTEKEYMAP}{& }
36 & Zoom in\\
37 \opt{RECORDER_PAD}{\ButtonOn}
38 \opt{ONDIO_PAD}{\ButtonMenu+\ButtonDown}
39 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
40 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonScrollBack}
41 \opt{IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD}{Long \ButtonSelect}
42 \opt{IRIVER_H10_PAD}{Long \ButtonPlay}
43 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolDown}
44 \opt{MROBE100_PAD}{\ButtonPlay}
45 \opt{HAVEREMOTEKEYMAP}{& }
46 & Zoom out\\
47 \opt{RECORDER_PAD}{\ButtonFThree}
48 \opt{ONDIO_PAD}{\ButtonMenu+\ButtonRight}
49 \opt{IRIVER_H100_PAD}{\ButtonOn}
50 \opt{IRIVER_H300_PAD}{\ButtonRec}
51 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonRight}
52 \opt{IAUDIO_X5_PAD}{\ButtonPlay}
53 \opt{IRIVER_H10_PAD}{\ButtonFF}
54 \opt{SANSA_E200_PAD,SANSA_FUZE_PAD}{\ButtonScrollFwd}
55 \opt{SANSA_C200_PAD}{\ButtonVolUp}
56 \opt{GIGABEAT_PAD}{\ButtonA+\ButtonRight}
57 \opt{GIGABEAT_S_PAD}{\ButtonNext}
58 \opt{MROBE100_PAD}{\ButtonDisplay+\ButtonRight}
59 \opt{HAVEREMOTEKEYMAP}{& }
60 & Next png in directory\\
61 \opt{RECORDER_PAD}{\ButtonFTwo}
62 \opt{ONDIO_PAD}{\ButtonMenu+\ButtonLeft}
63 \opt{IRIVER_H100_PAD,IAUDIO_X5_PAD}{\ButtonRec}
64 \opt{IRIVER_H300_PAD}{\ButtonOn}
65 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonLeft}
66 \opt{IRIVER_H10_PAD}{\ButtonRew}
67 \opt{SANSA_E200_PAD,SANSA_FUZE_PAD}{\ButtonScrollBack}
68 \opt{SANSA_C200_PAD}{\ButtonVolDown}
69 \opt{GIGABEAT_PAD}{\ButtonA+\ButtonLeft}
70 \opt{GIGABEAT_S_PAD}{\ButtonPrev}
71 \opt{MROBE100_PAD}{\ButtonDisplay+\ButtonLeft}
72 \opt{HAVEREMOTEKEYMAP}{& }
73 & Previous png in directory\\
74 \opt{SANSA_E200_PAD,SANSA_C200_PAD}{%currently only defined for the sansa pads
75 \ButtonRec
76 \opt{HAVEREMOTEKEYMAP}{& }
77 & Toggle slide show mode\\
79 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
80 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonMenu}
81 \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{\ButtonPower}
82 \opt{SANSA_FUZE_PAD}{Long \ButtonHome}
83 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD}{\ButtonMenu}
84 \opt{HAVEREMOTEKEYMAP}{&
85 \opt{IRIVER_RC_H100_PAD}{\ButtonRCStop}
87 & Show menu / Abort while decoding \\
88 \opt{IPOD_4G_PAD,IPOD_3G_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD}{
89 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonPlay}
90 \opt{GIGABEAT_PAD,MROBE100_PAD}{\ButtonPower}
91 \opt{GIGABEAT_S_PAD}{\ButtonBack}
92 \opt{HAVEREMOTEKEYMAP}{& }
93 & Quit the viewer \\
95 \end{btnmap}
96 \end{table}
98 The menu has the following entries.
99 \begin{description}
100 \item[Return.] Returns you to the image
101 \item[Toggle Slideshow Mode.] Enables or disables the slideshow mode.
102 \item[Change Slideshow Timeout.] You can set the timeout for the slideshow
103 between 1 second and 20 seconds.
104 \opt{large_plugin_buffer}{
105 \item[Show Playback Menu.] From the playback menu you can control the
106 playback of the currently loaded playlist and change the volume of your \dap.
108 \item[Quit.] Quits the viewer and returns to the \setting{File Browser}.
109 \end{description}