| blob | efb42651f2f069086e804316129a55ce98a93fd1 |
1 #
2 # This file is part of the LibreOffice project.
3 #
4 # This Source Code Form is subject to the terms of the Mozilla Public
5 # License, v. 2.0. If a copy of the MPL was not distributed with this
6 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
7 #
8 # This file incorporates work covered by the following license notice:
9 #
10 # Licensed to the Apache Software Foundation (ASF) under one or more
11 # contributor license agreements. See the NOTICE file distributed
12 # with this work for additional information regarding copyright
13 # ownership. The ASF licenses this file to you under the Apache
14 # License, Version 2.0 (the "License"); you may not use this file
15 # except in compliance with the License. You may obtain a copy of
16 # the License at http://www.apache.org/licenses/LICENSE-2.0 .
17 #
19 # dumper settings ============================================================
20 #
21 # Basic concepts
22 #
23 # - Character encoding of dumper ini files is UTF-8.
24 # - Whitespace characters are generally stripped, e.g. at start and end of
25 # lines, before/after equal signs, commas, etc.
26 # - Comments start with the hash (#) or semicolon (;) character. Leading
27 # whitespace characters are ignored.
28 #
29 # ----------------------------------------------------------------------------
31 # Enable entire dumper (default=off). This option does not affect the option
32 # 'enable-import'.
33 # 0=off, 1=on
36 # Enable import after dumping (default=on). Disabling this option allows
37 # to dump a file without loading it. This option is independent from the
38 # 'enable-dumper' option.
39 # 0=off, 1=on
42 # Maximum size of binary stream dumps (default=infinite).
45 # Maximum size of binary data blocks in content dumps (default=infinite).
48 # Shows unknown trailing data as binary dump (default=on).
49 # 0=off, 1=on
52 # Shows the absolute stream position of records in the record header field
53 # (default=on).
54 # 0=off, 1=on
57 # name lists =================================================================
58 #
59 # Syntax descriptions
60 #
61 # - Optional items are enclosed in brackets [].
62 # - Optional items that may be repeated are marked with an ellipsis (...).
63 # - Items in a set to choose from are separated by vertical lines (|).
64 # - <LISTNAME> denotes the name of a list. List names may consist of any non-
65 # whitespace characters.
66 # - <value>, <firstvalue>, <bitfield>, <bitmask> etc. denote integer values.
67 # Decimal and hexadecimal notation is supported, using C/C++ notation.
68 # - <bool> denotes a boolean value. Possible values are 0|1|false|true.
69 # - <constname> denotes a literal name for a constant or bit.
70 #
71 # ----------------------------------------------------------------------------
72 #
73 # constlist
74 #
75 # Defines names for a list of specific values.
76 #
77 # Syntax:
78 #
79 # constlist = <LISTNAME>
80 # default = <constname>
81 # include = <LISTNAME>[,<LISTNAME>...]
82 # exclude = <value>[,<value>...]
83 # quote-names = <bool>
84 # <value> = <constname>
85 # end
86 #
87 # - default (optional): Declares <constname> as a default name for values not
88 # specified in the name list. <constname> may be the empty string. If not
89 # set, the literal string '?err:no-name' (unquoted) is the default name.
90 # - include (optional): Includes the specified name list(s) into the own list.
91 # - exclude (optional): Removes values from the name lists, useful e.g. after
92 # a name list has been included.
93 # - quote-names (optional): Specifies whether to return the contained names
94 # enclosed in single quote (') characters. Default is false.
95 #
96 # The order of the declarations is important, later declarations may overwrite
97 # names generated from earlier declarations.
98 #
99 # Example:
100 #
101 # constlist = EXAMPLE-CONSTLIST
102 # 1 = my-value
103 # include = OTHER-LIST
104 # exclude = 2,3
105 # 0x0004 = other-value
106 # end
107 #
108 # - Defines the name 'my-value' for the constant 1.
109 # - Includes 'OTHER-LIST' which may overwrite the name of the constant 1.
110 # - Excludes the names of constants 2 and 3, which may have been included from
111 # the name list 'OTHER-LIST'.
112 # - Defines the name 'other-value' for the constant 4, which may overwrite the
113 # name of this constant included from the name list 'OTHER-LIST'.
114 #
115 # ----------------------------------------------------------------------------
116 #
117 # multilist
118 #
119 # Defines names for contiguous ranges of values.
120 #
121 # Syntax:
122 #
123 # multilist = <LISTNAME>
124 # default = <constname>
125 # include = <LISTNAME>[,<LISTNAME>...]
126 # exclude = <value>[,<value>...]
127 # ignore-empty = <bool>
128 # <firstvalue> = <constname>[,<constname>...]
129 # end
130 #
131 # - default (optional): See constlist above.
132 # - include (optional): See constlist above.
133 # - exclude (optional): See constlist above.
134 # - ignore-empty (optional): Specifies whether to skip empty names in a list.
135 # - True = skips an empty entry, the default name will be generated.
136 # - False = creates an empty string for the entry.
137 # Default is true (skip empty entries).
138 #
139 # Examples:
140 #
141 # multilist = EXAMPLE-MULTILIST
142 # 0 = value0,value1,,value3
143 # 8 = value8
144 # end
145 #
146 # - Defines the names 'value0' for the constant 0, 'value1' for the constant
147 # 1, 'value3' for the constant 3, and 'value8' for the constant 8.
148 #
149 # multilist = EXAMPLE-MULTILIST-2
150 # include = EXAMPLE-MULTILIST
151 # ignore-empty = false
152 # default = other
153 # end
154 #
155 # - Same as example above (includes EXAMPLE-MULTILIST), but defines the empty
156 # string for the constant 2. Other constants (less than 0 or greater than 3
157 # and not equal to 8) get the default name 'other'.
158 #
159 # ----------------------------------------------------------------------------
160 #
161 # shortlist
162 #
163 # Defines names for a contiguous range of values. The entire list definition
164 # is given in a single text line.
165 #
166 # Syntax:
167 #
168 # shortlist = <LISTNAME>,<firstvalue>,<constname>[,<constname>...]
169 #
170 # Uses default settings of the multi-list (i.e. skips empty entries).
171 #
172 # ----------------------------------------------------------------------------
173 #
174 # flagslist
175 #
176 # Defines names for single bits in a bit field.
177 #
178 # Syntax:
179 #
180 # flagslist = <LISTNAME>
181 # include = <LISTNAME>[,<LISTNAME>...]
182 # exclude = <bitfield>[,<bitfield>...]
183 # ignore = <bitfield>
184 # <bitmask> = <cname> | !<cname> | :<cname> | !<cname0>!<cname1>
185 # end
186 #
187 # - include (optional): See constlist above.
188 # - exclude (optional): See constlist above.
189 # - ignore (optional): Specifies bits to be ignored. Bits without an explicit
190 # name and not set in this declaration will be shown as unknown. Default is
191 # to not ignore a bit.
192 # - <bitmask>: The bit to be named. Must be a value with a single bit set.
193 # - <cname> - Sets a name for the bit that will be shown if the bit is set.
194 # Does not show anything if the bit is cleared.
195 # - !<cname> - Sets a name for the bit that will be shown if the bit is
196 # cleared. Does not show anything if the bit is set.
197 # - :<cname> - Sets a name for the bit that will always be shown together
198 # with the actual state of the bit, appended as ':on' or ':off'.
199 # - !<cname0>!<cname1> - Sets a name for both the cleared bit (cname0), and
200 # for the set bit (cname1).
201 #
202 # ----------------------------------------------------------------------------
203 #
204 # combilist
205 #
206 # Defines names for single bits and for embedded values in a bit field. This
207 # is an extension of the flagslist described above.
208 #
209 # Syntax:
210 #
211 # combilist = <LISTNAME>
212 # include = <LISTNAME>[,<LISTNAME>...]
213 # exclude = <bitmask>[,<bitmask>...]
214 # ignore = <bitfield>
215 # <bitmask> = <cname> | !<cname> | :<cname> | !<cname0>!<cname1>
216 # <bitfield> = <datatype>,<dataformat>,<bitfieldname>[,<LISTNAME>[,options...]]
217 # end
218 #
219 # - include (optional): See constlist above.
220 # - exclude (optional): See constlist above.
221 # - ignore (optional): See flagslist above.
222 # - <bitmask>: See flagslist above.
223 # - <bitfield>: The mask of the embedded bitfield. Must be a value with
224 # exactly one sequence of at least 2 consecutive bits.
225 # - <datatype>: [u]int8 | [u]int16 | [u]int32 | [u]int64 | float | double
226 # - <dataformat>: dec | hex | shorthex | bin | fix | bool
227 # - <bitfieldname>: The name of the embedded bitfield.
228 # - <LISTAME>: Optional name list with names for the values of the embedded
229 # bitfield.
230 # - options: Additional options for this bitfield:
231 # - filter = <filterbitfield>~<filtervalue>: If set, the entire bitfield
232 # will only be written, if the complete data item currently dumped
233 # contains exactly the value specified in <filtervalue> in the bitfield
234 # specified in <filterbitfield>. Otherwise, nothing is written. It is
235 # possible to specify multiple filter rules for this bitfield. In that
236 # case, the bitfield will be written, if at least one filter rule
237 # applies for the current data item.
238 # - noshift = <bool>: If set to 'true', the extracted value will be
239 # shifted to the right (normalized). If set to 'false', the value will
240 # be written unshifted. Default is 'true'.
241 #
242 # ----------------------------------------------------------------------------
243 #
244 # unitconverter
245 #
246 # Converts values and appends a unit name.
247 #
248 # Syntax:
249 #
250 # unitconverter = <LISTNAME>,[/]<factor>[,<unitname>]
251 #
252 # ----------------------------------------------------------------------------
269 end
275 end
297 end
302 end
307 end
385 end
403 end
407 0x08=window-text,active-title-text,active-border,inactive-border,app-workspace,highlight,highlight-text,button-face
408 0x10=button-shadow,disabled-text,button-text,inactive-title-text,button-highlight,button-dark-shadow,button-light-shadow,tooltip-text
410 end
412 # ============================================================================