lok: Hide file linking in section
[LibreOffice.git] / sw / inc / poolfmt.hxx
blob22b075978affb3bc05d8db899f01c35f4688544d
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
9 * This file incorporates work covered by the following license notice:
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
19 #ifndef INCLUDED_SW_INC_POOLFMT_HXX
20 #define INCLUDED_SW_INC_POOLFMT_HXX
22 #include <limits.h>
23 #include <editeng/frmdir.hxx>
24 #include <i18nlangtag/lang.h>
26 /** POOLCOLL-IDs:
27 // +----+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
28 // !User! Range ! 0 ! Offset !
29 // +----+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
31 // Range: 1 - text
32 // 2 - lists
33 // 3 - special ranges
34 // 4 - indices
35 // 5 - chapter / document
36 // 6 - HTML-styles.
38 // Other IDs:
39 // +----+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
40 // !User! Range ! 1 ! Offset !
41 // +----+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
42 // Range: 0 - character styles
43 // 1 - frame styles
44 // 2 - page styles
45 // 3 - paragraph styles (?)
46 // 4 - graphics styles (?)
48 // For all IDs we have:
49 // Origin: 0 -pool
50 // 1 -user
51 // Offset: within the group */
53 /** Attention: New IDs can only be added to the ends of the groups.
54 These IDs are read and written by the Reader/Writer.
55 They are only aware of the Offset to Start. */
57 /// Mask for recognition of COLLPOOL-IDs:
59 const sal_uInt16 POOLGRP_NOCOLLID = (1 << 10);
61 /// POLLCOLL-groups:
63 const sal_uInt16 USER_FMT = (1 << 15);
64 const sal_uInt16 POOL_FMT = (0 << 15);
66 const sal_uInt16 COLL_TEXT_BITS = (1 << 11);
67 const sal_uInt16 COLL_LISTS_BITS = (2 << 11);
68 const sal_uInt16 COLL_EXTRA_BITS = (3 << 11);
69 const sal_uInt16 COLL_REGISTER_BITS = (4 << 11);
70 const sal_uInt16 COLL_DOC_BITS = (5 << 11);
71 const sal_uInt16 COLL_HTML_BITS = (6 << 11);
72 const sal_uInt16 COLL_GET_RANGE_BITS = (15 << 11);
74 /// Other groups:
76 const sal_uInt16 POOLGRP_CHARFMT = (0 << 11) + POOLGRP_NOCOLLID;
77 const sal_uInt16 POOLGRP_FRAMEFMT = (1 << 11) + POOLGRP_NOCOLLID;
78 const sal_uInt16 POOLGRP_PAGEDESC = (2 << 11) + POOLGRP_NOCOLLID;
79 const sal_uInt16 POOLGRP_NUMRULE = (3 << 11) + POOLGRP_NOCOLLID;
80 const sal_uInt16 POOLGRP_TABSTYLE = (4 << 11) + POOLGRP_NOCOLLID;
81 const sal_uInt16 POOLGRP_CELLSTYLE = (5 << 11) + POOLGRP_NOCOLLID;
83 /// Recognize whether it's a user defined style or not:
84 const sal_uInt16 POOL_IDUSER_FMT =
85 USHRT_MAX & ~(COLL_GET_RANGE_BITS + POOLGRP_NOCOLLID);
87 inline bool IsPoolUserFormat( sal_uInt16 nId )
89 return POOL_IDUSER_FMT == (nId & ~(COLL_GET_RANGE_BITS + POOLGRP_NOCOLLID));
92 /// IDs for the ranges.
93 enum RES_POOLFMT
95 RES_POOLFMT_BEGIN = 1,
96 RES_POOL_CHRFMT = RES_POOLFMT_BEGIN,
97 RES_POOL_FRMFMT,
98 RES_POOL_TXTCOLL,
99 RES_POOL_PAGEFMT,
101 RES_POOL_PARFMT,
102 RES_POOL_GRFFMT,
103 RES_POOLFMT_END
106 /// Ranges for the IDs of the formats.
108 /// IDs for character styles.
109 enum RES_POOL_CHRFMT_TYPE
111 RES_POOLCHR_BEGIN = POOLGRP_CHARFMT,
112 RES_POOLCHR_NORMAL_BEGIN = POOLGRP_CHARFMT,
114 RES_POOLCHR_FOOTNOTE = RES_POOLCHR_NORMAL_BEGIN, ///< Footnote.
115 RES_POOLCHR_PAGENO, ///< Pages/field.
116 RES_POOLCHR_LABEL, ///< Label.
117 RES_POOLCHR_DROPCAPS, ///< Dropcaps.
118 RES_POOLCHR_NUM_LEVEL, ///< Numbering symbols
119 RES_POOLCHR_BUL_LEVEL, ///< Bullets.
121 RES_POOLCHR_INET_NORMAL, ///< Internet normal.
122 RES_POOLCHR_INET_VISIT, ///< Internet visited.
123 RES_POOLCHR_JUMPEDIT, ///< Placeholder.
124 RES_POOLCHR_TOXJUMP, ///< Jump from index.
125 RES_POOLCHR_ENDNOTE, ///< Endnote.
126 RES_POOLCHR_LINENUM, ///< Line numbering.
127 RES_POOLCHR_IDX_MAIN_ENTRY, ///< Main entry in indices.
128 RES_POOLCHR_FOOTNOTE_ANCHOR, ///< Footnote anchor.
129 RES_POOLCHR_ENDNOTE_ANCHOR, ///< Endnote anchor.
130 RES_POOLCHR_RUBYTEXT, ///< Rubytext.
131 RES_POOLCHR_VERT_NUM, ///< Vertical numbering symbols.
133 RES_POOLCHR_NORMAL_END,
135 RES_POOLCHR_HTML_BEGIN = RES_POOLCHR_BEGIN + 50, ///< HTML-styles.
136 RES_POOLCHR_HTML_EMPHASIS = RES_POOLCHR_HTML_BEGIN,
137 RES_POOLCHR_HTML_CITIATION,
138 RES_POOLCHR_HTML_STRONG,
139 RES_POOLCHR_HTML_CODE,
140 RES_POOLCHR_HTML_SAMPLE,
141 RES_POOLCHR_HTML_KEYBOARD,
142 RES_POOLCHR_HTML_VARIABLE,
143 RES_POOLCHR_HTML_DEFINSTANCE,
144 RES_POOLCHR_HTML_TELETYPE,
145 RES_POOLCHR_HTML_END,
147 RES_POOLCHR_END = RES_POOLCHR_HTML_END
150 /// IDs for frame styles.
151 enum RES_POOL_FRMFMT_TYPE
153 RES_POOLFRM_BEGIN = POOLGRP_FRAMEFMT,
155 RES_POOLFRM_FRAME = RES_POOLFRM_BEGIN, ///< Frame.
156 RES_POOLFRM_GRAPHIC, ///< Graphics.
157 RES_POOLFRM_OLE, ///< OLE.
158 RES_POOLFRM_FORMEL, ///< Formula.
159 RES_POOLFRM_MARGINAL, ///< Marginalia.
160 RES_POOLFRM_WATERSIGN, ///< Watermark.
161 RES_POOLFRM_LABEL, ///< Labels.
163 RES_POOLFRM_END
166 /// IDs for page styles.
167 enum RES_POOL_PAGEFMT_TYPE
169 RES_POOLPAGE_BEGIN = POOLGRP_PAGEDESC,
171 RES_POOLPAGE_STANDARD = RES_POOLPAGE_BEGIN, ///< Standard page.
172 RES_POOLPAGE_FIRST, ///< First page.
173 RES_POOLPAGE_LEFT, ///< Left page.
174 RES_POOLPAGE_RIGHT, ///< Right page.
175 RES_POOLPAGE_JAKET, ///< Envelope.
176 RES_POOLPAGE_REGISTER, ///< Index.
177 RES_POOLPAGE_HTML, ///< HTML.
178 RES_POOLPAGE_FOOTNOTE, ///< Footnote at end of document.
179 RES_POOLPAGE_ENDNOTE, ///< Endnote page.
180 RES_POOLPAGE_LANDSCAPE, ///< Landscape page style.
182 RES_POOLPAGE_END
185 // IDs for list styles.
186 enum RES_POOL_NUMRULE_TYPE
188 RES_POOLNUMRULE_BEGIN = POOLGRP_NUMRULE,
189 RES_POOLNUMRULE_NUM1 = RES_POOLNUMRULE_BEGIN, ///< NumRule Numbering 123.
190 RES_POOLNUMRULE_NUM2, ///< NumRule Numbering ABC.
191 RES_POOLNUMRULE_NUM3, ///< NumRule Numbering abc.
192 RES_POOLNUMRULE_NUM4, ///< NumRule Numbering IVX.
193 RES_POOLNUMRULE_NUM5, ///< NumRule Numbering ivx.
194 RES_POOLNUMRULE_BUL1, ///< NumRule Bullets 1.
195 RES_POOLNUMRULE_BUL2, ///< NumRule Bullets 2.
196 RES_POOLNUMRULE_BUL3, ///< NumRule Bullets 3.
197 RES_POOLNUMRULE_BUL4, ///< NumRule Bullets 4.
198 RES_POOLNUMRULE_BUL5, ///< NumRule Bullets 5.
199 RES_POOLNUMRULE_END
202 // IDs for table styles.
203 enum RES_POOL_TABSTYLE_TYPE
205 RES_POOLTABSTYLE_BEGIN = POOLGRP_TABSTYLE,
206 RES_POOLTABSTYLE_DEFAULT = RES_POOLTABSTYLE_BEGIN,
207 // 16 old styles
208 RES_POOLTABLESTYLE_3D,
209 RES_POOLTABLESTYLE_BLACK1,
210 RES_POOLTABLESTYLE_BLACK2,
211 RES_POOLTABLESTYLE_BLUE,
212 RES_POOLTABLESTYLE_BROWN,
213 RES_POOLTABLESTYLE_CURRENCY,
214 RES_POOLTABLESTYLE_CURRENCY_3D,
215 RES_POOLTABLESTYLE_CURRENCY_GRAY,
216 RES_POOLTABLESTYLE_CURRENCY_LAVENDER,
217 RES_POOLTABLESTYLE_CURRENCY_TURQUOISE,
218 RES_POOLTABLESTYLE_GRAY,
219 RES_POOLTABLESTYLE_GREEN,
220 RES_POOLTABLESTYLE_LAVENDER,
221 RES_POOLTABLESTYLE_RED,
222 RES_POOLTABLESTYLE_TURQUOISE,
223 RES_POOLTABLESTYLE_YELLOW,
224 // 10 new styles since LibreOffice 6.0
225 RES_POOLTABLESTYLE_LO6_ACADEMIC,
226 RES_POOLTABLESTYLE_LO6_BOX_LIST_BLUE,
227 RES_POOLTABLESTYLE_LO6_BOX_LIST_GREEN,
228 RES_POOLTABLESTYLE_LO6_BOX_LIST_RED,
229 RES_POOLTABLESTYLE_LO6_BOX_LIST_YELLOW,
230 RES_POOLTABLESTYLE_LO6_ELEGANT,
231 RES_POOLTABLESTYLE_LO6_FINANCIAL,
232 RES_POOLTABLESTYLE_LO6_SIMPLE_GRID_COLUMNS,
233 RES_POOLTABLESTYLE_LO6_SIMPLE_GRID_ROWS,
234 RES_POOLTABLESTYLE_LO6_SIMPLE_LIST_SHADED,
235 RES_POOLTABSTYLE_END
238 enum RES_POOL_CELLSTYLE_TYPE
240 RES_POOLCELLSTYLE_BEGIN = POOLGRP_CELLSTYLE,
241 RES_POOLCELLSTYLE_END = RES_POOLCELLSTYLE_BEGIN
244 // IDs for paragraph styles.
245 enum RES_POOL_COLLFMT_TYPE
247 // Group text.
248 RES_POOLCOLL_TEXT_BEGIN = COLL_TEXT_BITS,
250 RES_POOLCOLL_STANDARD = RES_POOLCOLL_TEXT_BEGIN, ///< Standard.
251 RES_POOLCOLL_TEXT, ///< Text body.
252 RES_POOLCOLL_TEXT_IDENT, ///< Text body first line indent.
253 RES_POOLCOLL_TEXT_NEGIDENT, ///< Text body hanging indent.
254 RES_POOLCOLL_TEXT_MOVE, ///< Text body indent.
255 RES_POOLCOLL_GREETING, ///< Complimentary close.
256 RES_POOLCOLL_SIGNATURE, ///< Signature.
257 RES_POOLCOLL_CONFRONTATION, ///< List indent.
258 RES_POOLCOLL_MARGINAL, ///< Marginalia.
260 /// Subgroup headings.
261 RES_POOLCOLL_HEADLINE_BASE, ///< Base heading.
262 RES_POOLCOLL_HEADLINE1, ///< Heading 1.
263 RES_POOLCOLL_HEADLINE2, ///< Heading 2.
264 RES_POOLCOLL_HEADLINE3, ///< Heading 3.
265 RES_POOLCOLL_HEADLINE4, ///< Heading 4.
266 RES_POOLCOLL_HEADLINE5, ///< Heading 5.
267 RES_POOLCOLL_HEADLINE6, ///< Heading 6.
268 RES_POOLCOLL_HEADLINE7, ///< Heading 7.
269 RES_POOLCOLL_HEADLINE8, ///< Heading 8.
270 RES_POOLCOLL_HEADLINE9, ///< Heading 9.
271 RES_POOLCOLL_HEADLINE10, ///< Heading 10.
273 RES_POOLCOLL_TEXT_END,
275 /// Group lists.
276 RES_POOLCOLL_LISTS_BEGIN = COLL_LISTS_BITS,
278 RES_POOLCOLL_NUMBUL_BASE = RES_POOLCOLL_LISTS_BEGIN, ///< Base list.
280 /// Subgroup numberings.
281 RES_POOLCOLL_NUM_LEVEL1S, ///< Start 1st level.
282 RES_POOLCOLL_NUM_LEVEL1, ///< 1st level.
283 RES_POOLCOLL_NUM_LEVEL1E, ///< End 1st level.
284 RES_POOLCOLL_NUM_NONUM1, ///< No numbering.
285 RES_POOLCOLL_NUM_LEVEL2S, ///< Start 2nd level.
286 RES_POOLCOLL_NUM_LEVEL2, ///< 2nd level.
287 RES_POOLCOLL_NUM_LEVEL2E, ///< End 2nd level.
288 RES_POOLCOLL_NUM_NONUM2, ///< No numbering.
289 RES_POOLCOLL_NUM_LEVEL3S, ///< Start 3rd level.
290 RES_POOLCOLL_NUM_LEVEL3, ///< 3rd level.
291 RES_POOLCOLL_NUM_LEVEL3E, ///< End 3rd level.
292 RES_POOLCOLL_NUM_NONUM3, ///< No numbering.
293 RES_POOLCOLL_NUM_LEVEL4S, ///< Start 4th level.
294 RES_POOLCOLL_NUM_LEVEL4, ///< 4th level.
295 RES_POOLCOLL_NUM_LEVEL4E, ///< End 4th level.
296 RES_POOLCOLL_NUM_NONUM4, ///< No numbering.
297 RES_POOLCOLL_NUM_LEVEL5S, ///< Start 5th level.
298 RES_POOLCOLL_NUM_LEVEL5, ///< 5th level.
299 RES_POOLCOLL_NUM_LEVEL5E, ///< End 5th level.
300 RES_POOLCOLL_NUM_NONUM5, ///< No numbering.
302 ///Subgroup bullets.
303 RES_POOLCOLL_BUL_LEVEL1S, ///< Start 1st level.
304 RES_POOLCOLL_BUL_LEVEL1, ///< 1st level.
305 RES_POOLCOLL_BUL_LEVEL1E, ///< End 1st level
306 RES_POOLCOLL_BUL_NONUM1, ///< No numbering.
307 RES_POOLCOLL_BUL_LEVEL2S, ///< Start 2nd level.
308 RES_POOLCOLL_BUL_LEVEL2, ///< 2nd level.
309 RES_POOLCOLL_BUL_LEVEL2E, ///< End 2nd level.
310 RES_POOLCOLL_BUL_NONUM2, ///< No numbering.
311 RES_POOLCOLL_BUL_LEVEL3S, ///< Start 3rd level.
312 RES_POOLCOLL_BUL_LEVEL3, ///< 3rd Level.
313 RES_POOLCOLL_BUL_LEVEL3E, ///< End 3rd level.
314 RES_POOLCOLL_BUL_NONUM3, ///< No numbering.
315 RES_POOLCOLL_BUL_LEVEL4S, ///< Start 4th level.
316 RES_POOLCOLL_BUL_LEVEL4, ///< 4th level.
317 RES_POOLCOLL_BUL_LEVEL4E, ///< End 4th level.
318 RES_POOLCOLL_BUL_NONUM4, ///< No numbering.
319 RES_POOLCOLL_BUL_LEVEL5S, ///< Start 5th level.
320 RES_POOLCOLL_BUL_LEVEL5, ///< 5th level.
321 RES_POOLCOLL_BUL_LEVEL5E, ///< End 5th Level.
322 RES_POOLCOLL_BUL_NONUM5, ///< No numbering.
324 RES_POOLCOLL_LISTS_END,
326 /// Special ranges.
327 RES_POOLCOLL_EXTRA_BEGIN = COLL_EXTRA_BITS,
329 /// Subgroup header.
330 RES_POOLCOLL_HEADERFOOTER = RES_POOLCOLL_EXTRA_BEGIN, ///< Header and Footer.
331 RES_POOLCOLL_HEADER, ///< Header Left&Right.
332 RES_POOLCOLL_HEADERL, ///< Header Left.
333 RES_POOLCOLL_HEADERR, ///< Header Right.
335 /// Subgroup footer.
336 RES_POOLCOLL_FOOTER, ///< Footer Left&Right.
337 RES_POOLCOLL_FOOTERL, ///< Footer Left.
338 RES_POOLCOLL_FOOTERR, ///< Footer Right.
340 /// Subgroup table.
341 RES_POOLCOLL_TABLE, ///< Table of Contents.
342 RES_POOLCOLL_TABLE_HDLN, ///< Table of Contents - heading.
344 /// Subgroup labels.
345 RES_POOLCOLL_LABEL, ///< Base labels.
346 RES_POOLCOLL_LABEL_ABB, ///< Label illustration.
347 RES_POOLCOLL_LABEL_TABLE, ///< Label table.
348 RES_POOLCOLL_LABEL_FRAME, ///< Label frame.
349 RES_POOLCOLL_LABEL_FIGURE, ///< Label figure
351 /// Other stuff.
352 RES_POOLCOLL_FRAME, ///< Frames.
353 RES_POOLCOLL_FOOTNOTE, ///< Footnotes.
354 RES_POOLCOLL_JAKETADRESS, ///< Addressee.
355 RES_POOLCOLL_SENDADRESS, ///< Sender.
356 RES_POOLCOLL_ENDNOTE, ///< Endnotes.
358 RES_POOLCOLL_LABEL_DRAWING, ///< Label drawing objects.
359 RES_POOLCOLL_EXTRA_END,
361 /// Group indices.
362 RES_POOLCOLL_REGISTER_BEGIN = COLL_REGISTER_BITS,
364 RES_POOLCOLL_REGISTER_BASE = RES_POOLCOLL_REGISTER_BEGIN, ///< Base index.
366 /// Subgroup index tables.
367 RES_POOLCOLL_TOX_IDXH, ///< Header.
368 RES_POOLCOLL_TOX_IDX1, ///< 1st level.
369 RES_POOLCOLL_TOX_IDX2, ///< 2nd level.
370 RES_POOLCOLL_TOX_IDX3, ///< 3rd level.
371 RES_POOLCOLL_TOX_IDXBREAK, ///< Separator.
373 /// Subgroup table of contents.
374 RES_POOLCOLL_TOX_CNTNTH, ///< Header.
375 RES_POOLCOLL_TOX_CNTNT1, ///< Content 1st level.
376 RES_POOLCOLL_TOX_CNTNT2, ///< Content 2nd level.
377 RES_POOLCOLL_TOX_CNTNT3, ///< Content 3rd level.
378 RES_POOLCOLL_TOX_CNTNT4, ///< Content 4th level.
379 RES_POOLCOLL_TOX_CNTNT5, ///< Content 5th level.
381 /// Subgroup user indices.
382 RES_POOLCOLL_TOX_USERH, ///< Header.
383 RES_POOLCOLL_TOX_USER1, ///< 1st level.
384 RES_POOLCOLL_TOX_USER2, ///< 2nd level.
385 RES_POOLCOLL_TOX_USER3, ///< 3rd level.
386 RES_POOLCOLL_TOX_USER4, ///< 4th level.
387 RES_POOLCOLL_TOX_USER5, ///< 5th level.
389 RES_POOLCOLL_TOX_CNTNT6, ///< Content 6th level.
390 RES_POOLCOLL_TOX_CNTNT7, ///< Content 7th level.
391 RES_POOLCOLL_TOX_CNTNT8, ///< Content 8th level.
392 RES_POOLCOLL_TOX_CNTNT9, ///< Content 9th level.
393 RES_POOLCOLL_TOX_CNTNT10, ///< Content 10th level.
395 /// illustrations index.
396 RES_POOLCOLL_TOX_ILLUSH, ///< Illustrations header.
397 RES_POOLCOLL_TOX_ILLUS1, ///< Illustrations all levels.
399 /// object index.
400 RES_POOLCOLL_TOX_OBJECTH, ///< Objects header.
401 RES_POOLCOLL_TOX_OBJECT1, ///< Objects all levels.
403 /// tables index.
404 RES_POOLCOLL_TOX_TABLESH, ///< Tables header.
405 RES_POOLCOLL_TOX_TABLES1, ///< Tables all levels.
407 /// index of authorities.
408 RES_POOLCOLL_TOX_AUTHORITIESH, ///< Authorities header.
409 RES_POOLCOLL_TOX_AUTHORITIES1, ///< Authorities all levels.
411 /// user index 6..10.
412 RES_POOLCOLL_TOX_USER6, ///< 6th level.
413 RES_POOLCOLL_TOX_USER7, ///< 7th level.
414 RES_POOLCOLL_TOX_USER8, ///< 8th level.
415 RES_POOLCOLL_TOX_USER9, ///< 9th level.
416 RES_POOLCOLL_TOX_USER10, ///< 10th level.
418 RES_POOLCOLL_REGISTER_END,
420 /// Group chapter / document.
421 RES_POOLCOLL_DOC_BEGIN = COLL_DOC_BITS,
423 RES_POOLCOLL_DOC_TITEL = RES_POOLCOLL_DOC_BEGIN, ///< Doc. title.
424 RES_POOLCOLL_DOC_SUBTITEL, ///< Doc. subtitle.
426 RES_POOLCOLL_DOC_END,
428 /// Group HTML-styles.
429 RES_POOLCOLL_HTML_BEGIN = COLL_HTML_BITS,
431 RES_POOLCOLL_HTML_BLOCKQUOTE = RES_POOLCOLL_HTML_BEGIN,
432 RES_POOLCOLL_HTML_PRE,
433 RES_POOLCOLL_HTML_HR,
434 RES_POOLCOLL_HTML_DD,
435 RES_POOLCOLL_HTML_DT,
437 RES_POOLCOLL_HTML_END
439 /// End of text styles collection.
442 /** Query defined parent of a POOL-ID
443 Returns 0 if standard
444 USHRT_MAX if no parent
445 the parent in all other cases. */
446 sal_uInt16 GetPoolParent( sal_uInt16 nId );
448 SvxFrameDirection GetDefaultFrameDirection(LanguageType nLanguage);
450 bool IsConditionalByPoolId(sal_uInt16 nId);
452 #endif
454 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */