Merge branch 'master' into subtree
[nikiroo-utils.git] / bundles / UiConfig.java
1 package be.nikiroo.fanfix.bundles;
2
3 import be.nikiroo.utils.resources.Meta;
4 import be.nikiroo.utils.resources.Meta.Format;
5
6 /**
7 * The configuration options.
8 *
9 * @author niki
10 */
11 @SuppressWarnings("javadoc")
12 public enum UiConfig {
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/")
15 CACHE_DIR_LOCAL_READER, //
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")
18 GUI_NON_IMAGES_DOCUMENT_TYPE, //
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")
21 GUI_IMAGES_DOCUMENT_TYPE, //
22 @Meta(description = "Use the internal reader for images documents",//
23 format = Format.BOOLEAN, def = "true")
24 IMAGES_DOCUMENT_USE_INTERNAL_READER, //
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)
27 IMAGES_DOCUMENT_READER, //
28 @Meta(description = "Use the internal reader for non-images documents",//
29 format = Format.BOOLEAN, def = "true")
30 NON_IMAGES_DOCUMENT_USE_INTERNAL_READER, //
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)
33 NON_IMAGES_DOCUMENT_READER, //
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, //
37 //
38 // GUI settings (hidden in config)
39 //
40 @Meta(description = "Show the side panel by default",//
41 hidden = true, format = Format.BOOLEAN, def = "true")
42 SHOW_SIDE_PANEL, //
43 @Meta(description = "Show the details panel by default",//
44 hidden = true, format = Format.BOOLEAN, def = "true")
45 SHOW_DETAILS_PANEL, //
46 @Meta(description = "Show thumbnails by default in the books view",//
47 hidden = true, format = Format.BOOLEAN, def = "false")
48 SHOW_THUMBNAILS, //
49 @Meta(description = "Show a words/images count instead of the author by default in the books view",//
50 hidden = true, format = Format.BOOLEAN, def = "false")
51 SHOW_WORDCOUNT, //
52 //
53 // Deprecated
54 //
55 @Meta(description = "The background colour of the library if you don't like the default system one",//
56 hidden = true, format = Format.COLOR)
57 @Deprecated
58 BACKGROUND_COLOR, //
59 }