Changes between Version 34 and Version 35 of TaggingPresets


Ignore:
Timestamp:
2011-01-21T08:28:20+01:00 (14 years ago)
Author:
framm
Comment:

multiselect doc

Legend:

Unmodified
Added
Removed
Modified
  • TaggingPresets

    v34 v35  
    7676   If readonly is not set, combo boxes can be edited as if they were text fields (additional to the drop down menu). Readonly
    7777   combo boxes can only contain one of the specified values.
     78 '''<multiselect>'''::
     79   Displays a list from which zero or more items can be chosen. ''key'' and ''values'' are mandatory, and ''text'', ''default'', ''delimiter'', and ''required'' are optional. The selected values will be concatenated with the specified delimiter (default: semicolon) and written to the tag value. If a tag value has already been set when the preset dialog is opened, the multiselect will attempt to mark the appropriate items in the list as select. If the tag value cannot be represented by a combination of choices in the list, then the list will be disabled so that the user cannot accidentally overwrite a custom value. In contrast to the "combo" element, the "multiselect" expects the list of values, descriptions etc. to use the specified delimiter, i.e. by default you will have to use a semicolon. You can specify delimiter="," but then a comma will also be used in the tag value.
    7880 '''<check>'''::
    7981   A checkbox which the user can only select or deselect. The ''key'' attribute is mandatory. ''text'', ''default'' and ''required'' is optional.
     
    103105   If the text (or combo) box is left empty, the key is removed instead inserting an key with empty value. Default is "false".
    104106 '''values="entry1,entry2,entry3"'''::
    105    A comma separated list of entries (for the combo box). It is not possible to specify an entry that contain a comma.
     107   A list of entries (for the combo box and multiselect). The list has to be separated by commas (for the combo box) or by the specified delimiter (for the multiselect). If a value contains the delimiter, the delimiter may be escaped with a backslash. If a value contains a backslash, it must also be escaped with a backslash.
    106108 '''values_context="context"'''::
    107109   Translation context for name attribute to separate equals words with different meaning (not required for in-file translations).
    108110 '''display_values="Entry1,Entry2,Entry3"'''::
    109    A comma separated list of entries that is displayed to the user. Must be the same number of entries as values and '''readonly''' must be true or not specified.
     111   A list of entries that is displayed to the user. Must be the same number of entries as values and '''readonly''' must be true or not specified. For the delimiter character and escaping, see the remarks at ''values''.
    110112 '''value="foobar"'''::
    111113   Specify a value to be entered in the <key> tag.
     
    115117   Specify the false value to be entered in the <key> tag (default is "no").
    116118 '''readonly="true"'''::
    117    The combo box is readonly, which means, the user can only select an item in the list.
     119   The combo box is readonly, which means that the user can only select an item in the list.
    118120 '''use_last_as_default="true"'''::
    119121   For combo boxes or text fields the last value is used as default.