Merge branch 'subtree'
[fanfix.git] / src / be / nikiroo / fanfix / bundles / UiConfig.java
CommitLineData
b4dc6ab5
NR
1package be.nikiroo.fanfix.bundles;
2
3import be.nikiroo.utils.resources.Meta;
ce788468 4import be.nikiroo.utils.resources.Meta.Format;
b4dc6ab5
NR
5
6/**
7 * The configuration options.
8 *
9 * @author niki
10 */
ce788468 11@SuppressWarnings("javadoc")
b4dc6ab5 12public enum UiConfig {
7cd006eb
NR
13 @Meta(description = "The directory where to store temporary files for the GUI reader; any relative path uses the applciation config directory as base, $HOME notation is supported, / is always accepted as directory separator",//
14 format = Format.DIRECTORY, def = "tmp-reader/")
b4dc6ab5 15 CACHE_DIR_LOCAL_READER, //
7cd006eb
NR
16 @Meta(description = "How to save the cached stories for the GUI Reader (non-images documents) -- those files will be sent to the reader",//
17 format = Format.COMBO_LIST, list = { "INFO_TEXT", "EPUB", "HTML", "TEXT" }, def = "EPUB")
e604986c 18 GUI_NON_IMAGES_DOCUMENT_TYPE, //
7cd006eb
NR
19 @Meta(description = "How to save the cached stories for the GUI Reader (images documents) -- those files will be sent to the reader",//
20 format = Format.COMBO_LIST, list = { "CBZ", "HTML" }, def = "CBZ")
e604986c 21 GUI_IMAGES_DOCUMENT_TYPE, //
7cd006eb
NR
22 @Meta(description = "Use the internal reader for images documents",//
23 format = Format.BOOLEAN, def = "true")
dd81a122 24 IMAGES_DOCUMENT_USE_INTERNAL_READER, //
7cd006eb
NR
25 @Meta(description = "The external viewer for images documents (or empty to use the system default program for the given file type)",//
26 format = Format.STRING)
edd46289 27 IMAGES_DOCUMENT_READER, //
7cd006eb
NR
28 @Meta(description = "Use the internal reader for non-images documents",//
29 format = Format.BOOLEAN, def = "true")
dd81a122 30 NON_IMAGES_DOCUMENT_USE_INTERNAL_READER, //
7cd006eb
NR
31 @Meta(description = "The external viewer for non-images documents (or empty to use the system default program for the given file type)",//
32 format = Format.STRING)
edd46289 33 NON_IMAGES_DOCUMENT_READER, //
9b558b88
NR
34 @Meta(description = "The icon to use for the program",//
35 format = Format.FIXED_LIST, def = "default", list = { "default", "alternative", "magic-book", "pony-book", "pony-library" })
36 PROGRAM_ICON, //
221d255c
NR
37 //
38 // GUI settings (hidden in config)
39 //
40 @Meta(description = "Show the side panel by default",//
3fe74d13 41 hidden = true, format = Format.BOOLEAN, def = "true")
221d255c
NR
42 SHOW_SIDE_PANEL, //
43 @Meta(description = "Show the details panel by default",//
3fe74d13 44 hidden = true, format = Format.BOOLEAN, def = "true")
221d255c
NR
45 SHOW_DETAILS_PANEL, //
46 @Meta(description = "Show thumbnails by default in the books view",//
3fe74d13 47 hidden = true, format = Format.BOOLEAN, def = "false")
221d255c 48 SHOW_THUMBNAILS, //
3b434684 49 @Meta(description = "Show a words/images count instead of the author by default in the books view",//
3fe74d13 50 hidden = true, format = Format.BOOLEAN, def = "false")
3b434684 51 SHOW_WORDCOUNT, //
221d255c
NR
52 //
53 // Deprecated
54 //
7cd006eb 55 @Meta(description = "The background colour of the library if you don't like the default system one",//
5788cc5b 56 hidden = true, format = Format.COLOR)
221d255c 57 @Deprecated
b4dc6ab5
NR
58 BACKGROUND_COLOR, //
59}