X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Futils%2Fresources%2FMeta.java;h=fb4d4915015e2c1efbf4021c8dd7ef4d2623c98e;hb=68232a49b2f63e195dfaf1d907bd20c48cf2b394;hp=d377dcc5c10c1c08ed0c7e98a4ae6a3f7be5bbd8;hpb=db31c35860081535d6e7ddc83ab4af573bb0522e;p=nikiroo-utils.git

diff --git a/src/be/nikiroo/utils/resources/Meta.java b/src/be/nikiroo/utils/resources/Meta.java
index d377dcc..fb4d491 100644
--- a/src/be/nikiroo/utils/resources/Meta.java
+++ b/src/be/nikiroo/utils/resources/Meta.java
@@ -46,15 +46,30 @@ public @interface Meta {
 		 * custom String value (basically, a {@link Format#FIXED_LIST} with an
 		 * option to enter a not accounted for value).
 		 */
-		COMBO_LIST
+		COMBO_LIST,
 	}
 
 	/**
-	 * A description of this item.
+	 * A description for this item: what it is or does, how to explain that item
+	 * to the user including what can be used here (i.e., %s = file name, %d =
+	 * file size...).
+	 * <p>
+	 * For group, the first line ('\\n'-separated) will be used as a title while
+	 * the rest will be the description.
 	 * 
 	 * @return what it is
 	 */
 	String description() default "";
+	
+	/**
+	 * This item should be hidden from the user (she will still be able to
+	 * modify it if she opens the file manually).
+	 * <p>
+	 * Defaults to FALSE (visible).
+	 * 
+	 * @return TRUE if it should stay hidden
+	 */
+	boolean hidden() default false;
 
 	/**
 	 * This item is only used as a group, not as an option.
@@ -63,7 +78,7 @@ public @interface Meta {
 	 * use the value in the program, and LANGUAGE_CODE_FR, LANGUAGE_CODE_EN
 	 * inside for which the value must be set.
 	 * 
-	 * @return the group
+	 * @return TRUE if it is a group
 	 */
 	boolean group() default false;
 
@@ -89,21 +104,29 @@ public @interface Meta {
 	 */
 	boolean nullable() default true;
 
+	/**
+	 * The default value of this item.
+	 * 
+	 * @return the value
+	 */
+	String def() default "";
+
 	/**
 	 * This item is a comma-separated list of values instead of a single value.
+	 * <p>
+	 * The list items are separated by a comma, each surrounded by
+	 * double-quotes, with backslashes and double-quotes escaped by a backslash.
+	 * <p>
+	 * Example: <tt>"un", "deux"</tt>
 	 * 
 	 * @return TRUE if it is
 	 */
 	boolean array() default false;
 
 	/**
-	 * An addition to the format.
-	 * <p>
-	 * Free info text to help translate, for instance the parameters order and
-	 * type for String translations (i.e., %s = input file name, %d = file size
-	 * in MB).
-	 * 
-	 * @return some info
+	 * @deprecated add the info into the description, as only the description
+	 *             will be translated.
 	 */
+	@Deprecated
 	String info() default "";
 }