* 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.
* 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;
*/
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 "";
}