Line data Source code
1 : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 : /*
3 : * This file is part of the LibreOffice project.
4 : *
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/.
8 : *
9 : * This file incorporates work covered by the following license notice:
10 : *
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 .
18 : */
19 : #ifndef INCLUDED_SW_INC_POOLFMT_HXX
20 : #define INCLUDED_SW_INC_POOLFMT_HXX
21 :
22 : #include <limits.h>
23 : #include <tools/solar.h>
24 : #include <editeng/frmdir.hxx>
25 :
26 : /** POOLCOLL-IDs:
27 : // +----+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
28 : // !User! Range ! 0 ! Offset !
29 : // +----+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
30 : //
31 : // Range: 1 - text
32 : // 2 - lists
33 : // 3 - special ranges
34 : // 4 - indices
35 : // 5 - chapter / document
36 : // 6 - HTML-styles.
37 :
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 (?)
47 :
48 : // For all IDs we have:
49 : // Origin: 0 -pool
50 : // 1 -user
51 : // Offset: within the group */
52 :
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. */
56 :
57 : /// Mask for recognition of COLLPOOL-IDs:
58 :
59 : const sal_uInt16 POOLGRP_NOCOLLID = (1 << 10);
60 :
61 : /// POLLCOLL-groups:
62 :
63 : const sal_uInt16 USER_FMT = (1 << 15);
64 : const sal_uInt16 POOL_FMT = (0 << 15);
65 :
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);
73 :
74 : /// Other groups:
75 :
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 :
81 : /// Recognize whether it's a user defined style or not:
82 : const sal_uInt16 POOL_IDUSER_FMT =
83 : USHRT_MAX & ~(COLL_GET_RANGE_BITS + POOLGRP_NOCOLLID);
84 :
85 0 : inline sal_Bool IsPoolUserFmt( sal_uInt16 nId )
86 : {
87 : return POOL_IDUSER_FMT ==
88 0 : (nId & ~(COLL_GET_RANGE_BITS + POOLGRP_NOCOLLID))
89 0 : ? sal_True : sal_False;
90 : }
91 :
92 : /// IDs for the ranges.
93 : enum RES_POOLFMT
94 : {
95 : RES_POOLFMT_BEGIN = 1,
96 : RES_POOL_CHRFMT = RES_POOLFMT_BEGIN,
97 : RES_POOL_FRMFMT,
98 : RES_POOL_TXTCOLL,
99 : RES_POOL_PAGEFMT,
100 :
101 : RES_POOL_PARFMT,
102 : RES_POOL_GRFFMT,
103 : RES_POOLFMT_END
104 : };
105 :
106 : /// Ranges for the IDs of the formats.
107 :
108 : /// IDs for character styles.
109 : enum RES_POOL_CHRFMT_TYPE
110 : {
111 : RES_POOLCHR_BEGIN = POOLGRP_CHARFMT,
112 : RES_POOLCHR_NORMAL_BEGIN = POOLGRP_CHARFMT,
113 :
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.
120 :
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.
132 :
133 : RES_POOLCHR_NORMAL_END,
134 :
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,
146 :
147 : RES_POOLCHR_END = RES_POOLCHR_HTML_END
148 : };
149 :
150 : /// IDs for frame styles.
151 : enum RES_POOL_FRMFMT_TYPE
152 : {
153 : RES_POOLFRM_BEGIN = POOLGRP_FRAMEFMT,
154 :
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.
162 :
163 : RES_POOLFRM_END
164 : };
165 :
166 : /// IDs for page styles.
167 : enum RES_POOL_PAGEFMT_TYPE
168 : {
169 : RES_POOLPAGE_BEGIN = POOLGRP_PAGEDESC,
170 :
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.
181 :
182 : RES_POOLPAGE_END
183 : };
184 :
185 : // IDs for list styles.
186 : enum RES_POOL_NUMRULE_TYPE
187 : {
188 : RES_POOLNUMRULE_BEGIN = POOLGRP_NUMRULE,
189 : RES_POOLNUMRULE_NUM1 = RES_POOLNUMRULE_BEGIN, ///< NumRule Numbering 1.
190 : RES_POOLNUMRULE_NUM2, ///< NumRule Numbering 2.
191 : RES_POOLNUMRULE_NUM3, ///< NumRule Numbering 3.
192 : RES_POOLNUMRULE_NUM4, ///< NumRule Numbering 4.
193 : RES_POOLNUMRULE_NUM5, ///< NumRule Numbering 5.
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
200 : };
201 :
202 : // IDs for paragraph styles.
203 : enum RES_POOL_COLLFMT_TYPE
204 : {
205 : // Group text.
206 : RES_POOLCOLL_TEXT_BEGIN = COLL_TEXT_BITS,
207 :
208 : RES_POOLCOLL_STANDARD = RES_POOLCOLL_TEXT_BEGIN, ///< Standard.
209 : RES_POOLCOLL_TEXT, ///< Text body.
210 : RES_POOLCOLL_TEXT_IDENT, ///< Text body first line indent.
211 : RES_POOLCOLL_TEXT_NEGIDENT, ///< Text body hanging indent.
212 : RES_POOLCOLL_TEXT_MOVE, ///< Text body indent.
213 : RES_POOLCOLL_GREETING, ///< Complimentary close.
214 : RES_POOLCOLL_SIGNATURE, ///< Signature.
215 : RES_POOLCOLL_CONFRONTATION, ///< List indent.
216 : RES_POOLCOLL_MARGINAL, ///< Marginalia.
217 :
218 : /// Subgroup headings.
219 : RES_POOLCOLL_HEADLINE_BASE, ///< Base heading.
220 : RES_POOLCOLL_HEADLINE1, ///< Heading 1.
221 : RES_POOLCOLL_HEADLINE2, ///< Heading 2.
222 : RES_POOLCOLL_HEADLINE3, ///< Heading 3.
223 : RES_POOLCOLL_HEADLINE4, ///< Heading 4.
224 : RES_POOLCOLL_HEADLINE5, ///< Heading 5.
225 : RES_POOLCOLL_HEADLINE6, ///< Heading 6.
226 : RES_POOLCOLL_HEADLINE7, ///< Heading 7.
227 : RES_POOLCOLL_HEADLINE8, ///< Heading 8.
228 : RES_POOLCOLL_HEADLINE9, ///< Heading 9.
229 : RES_POOLCOLL_HEADLINE10, ///< Heading 10.
230 :
231 : RES_POOLCOLL_TEXT_END,
232 :
233 : /// Group lists.
234 : RES_POOLCOLL_LISTS_BEGIN = COLL_LISTS_BITS,
235 :
236 : RES_POOLCOLL_NUMBUL_BASE = RES_POOLCOLL_LISTS_BEGIN, ///< Base list.
237 :
238 : /// Subgroup numberings.
239 : RES_POOLCOLL_NUM_LEVEL1S, ///< Start 1st level.
240 : RES_POOLCOLL_NUM_LEVEL1, ///< 1st level.
241 : RES_POOLCOLL_NUM_LEVEL1E, ///< End 1st level.
242 : RES_POOLCOLL_NUM_NONUM1, ///< No numbering.
243 : RES_POOLCOLL_NUM_LEVEL2S, ///< Start 2nd level.
244 : RES_POOLCOLL_NUM_LEVEL2, ///< 2nd level.
245 : RES_POOLCOLL_NUM_LEVEL2E, ///< End 2nd level.
246 : RES_POOLCOLL_NUM_NONUM2, ///< No numbering.
247 : RES_POOLCOLL_NUM_LEVEL3S, ///< Start 3rd level.
248 : RES_POOLCOLL_NUM_LEVEL3, ///< 3rd level.
249 : RES_POOLCOLL_NUM_LEVEL3E, ///< End 3rd level.
250 : RES_POOLCOLL_NUM_NONUM3, ///< No numbering.
251 : RES_POOLCOLL_NUM_LEVEL4S, ///< Start 4th level.
252 : RES_POOLCOLL_NUM_LEVEL4, ///< 4th level.
253 : RES_POOLCOLL_NUM_LEVEL4E, ///< End 4th level.
254 : RES_POOLCOLL_NUM_NONUM4, ///< No numbering.
255 : RES_POOLCOLL_NUM_LEVEL5S, ///< Start 5th level.
256 : RES_POOLCOLL_NUM_LEVEL5, ///< 5th level.
257 : RES_POOLCOLL_NUM_LEVEL5E, ///< End 5th level.
258 : RES_POOLCOLL_NUM_NONUM5, ///< No numbering.
259 :
260 : ///Subgroup bullets.
261 : RES_POOLCOLL_BUL_LEVEL1S, ///< Start 1st level.
262 : RES_POOLCOLL_BUL_LEVEL1, ///< 1st level.
263 : RES_POOLCOLL_BUL_LEVEL1E, ///< End 1st level
264 : RES_POOLCOLL_BUL_NONUM1, ///< No numbering.
265 : RES_POOLCOLL_BUL_LEVEL2S, ///< Start 2nd level.
266 : RES_POOLCOLL_BUL_LEVEL2, ///< 2nd level.
267 : RES_POOLCOLL_BUL_LEVEL2E, ///< End 2nd level.
268 : RES_POOLCOLL_BUL_NONUM2, ///< No numbering.
269 : RES_POOLCOLL_BUL_LEVEL3S, ///< Start 3rd level.
270 : RES_POOLCOLL_BUL_LEVEL3, ///< 3rd Level.
271 : RES_POOLCOLL_BUL_LEVEL3E, ///< End 3rd level.
272 : RES_POOLCOLL_BUL_NONUM3, ///< No numbering.
273 : RES_POOLCOLL_BUL_LEVEL4S, ///< Start 4th level.
274 : RES_POOLCOLL_BUL_LEVEL4, ///< 4th level.
275 : RES_POOLCOLL_BUL_LEVEL4E, ///< End 4th level.
276 : RES_POOLCOLL_BUL_NONUM4, ///< No numbering.
277 : RES_POOLCOLL_BUL_LEVEL5S, ///< Start 5th level.
278 : RES_POOLCOLL_BUL_LEVEL5, ///< 5th level.
279 : RES_POOLCOLL_BUL_LEVEL5E, ///< End 5th Level.
280 : RES_POOLCOLL_BUL_NONUM5, ///< No numbering.
281 :
282 : RES_POOLCOLL_LISTS_END,
283 :
284 : /// Special ranges.
285 : RES_POOLCOLL_EXTRA_BEGIN = COLL_EXTRA_BITS,
286 :
287 : /// Subgroup header.
288 : RES_POOLCOLL_HEADER = RES_POOLCOLL_EXTRA_BEGIN, ///< Header Left&Right.
289 : RES_POOLCOLL_HEADERL, ///< Header Left.
290 : RES_POOLCOLL_HEADERR, ///< Header Right.
291 :
292 : /// Subgroup footer.
293 : RES_POOLCOLL_FOOTER, ///< Footer Left&Right.
294 : RES_POOLCOLL_FOOTERL, ///< Footer Left.
295 : RES_POOLCOLL_FOOTERR, ///< Footer Right.
296 :
297 : /// Subgroup table.
298 : RES_POOLCOLL_TABLE, ///< Table of Contents.
299 : RES_POOLCOLL_TABLE_HDLN, ///< Table of Contents - heading.
300 :
301 : /// Subgroup labels.
302 : RES_POOLCOLL_LABEL, ///< Base labels.
303 : RES_POOLCOLL_LABEL_ABB, ///< Label illustration.
304 : RES_POOLCOLL_LABEL_TABLE, ///< Label table.
305 : RES_POOLCOLL_LABEL_FRAME, ///< Label frame.
306 :
307 : /// Other stuff.
308 : RES_POOLCOLL_FRAME, ///< Frames.
309 : RES_POOLCOLL_FOOTNOTE, ///< Footnotes.
310 : RES_POOLCOLL_JAKETADRESS, ///< Addressee.
311 : RES_POOLCOLL_SENDADRESS, ///< Sender.
312 : RES_POOLCOLL_ENDNOTE, ///< Endnotes.
313 :
314 : RES_POOLCOLL_LABEL_DRAWING, ///< Label drawing objects.
315 : RES_POOLCOLL_EXTRA_END,
316 :
317 : /// Group indices.
318 : RES_POOLCOLL_REGISTER_BEGIN = COLL_REGISTER_BITS,
319 :
320 : RES_POOLCOLL_REGISTER_BASE = RES_POOLCOLL_REGISTER_BEGIN, ///< Base index.
321 :
322 : /// Subgroup index tables.
323 : RES_POOLCOLL_TOX_IDXH, ///< Header.
324 : RES_POOLCOLL_TOX_IDX1, ///< 1st level.
325 : RES_POOLCOLL_TOX_IDX2, ///< 2nd level.
326 : RES_POOLCOLL_TOX_IDX3, ///< 3rd level.
327 : RES_POOLCOLL_TOX_IDXBREAK, ///< Separator.
328 :
329 : /// Subgroup table of contents.
330 : RES_POOLCOLL_TOX_CNTNTH, ///< Header.
331 : RES_POOLCOLL_TOX_CNTNT1, ///< Content 1st level.
332 : RES_POOLCOLL_TOX_CNTNT2, ///< Content 2nd level.
333 : RES_POOLCOLL_TOX_CNTNT3, ///< Content 3rd level.
334 : RES_POOLCOLL_TOX_CNTNT4, ///< Content 4th level.
335 : RES_POOLCOLL_TOX_CNTNT5, ///< Content 5th level.
336 :
337 : /// Subgroup user indices.
338 : RES_POOLCOLL_TOX_USERH, ///< Header.
339 : RES_POOLCOLL_TOX_USER1, ///< 1st level.
340 : RES_POOLCOLL_TOX_USER2, ///< 2nd level.
341 : RES_POOLCOLL_TOX_USER3, ///< 3rd level.
342 : RES_POOLCOLL_TOX_USER4, ///< 4th level.
343 : RES_POOLCOLL_TOX_USER5, ///< 5th level.
344 :
345 : RES_POOLCOLL_TOX_CNTNT6, ///< Content 6th level.
346 : RES_POOLCOLL_TOX_CNTNT7, ///< Content 7th level.
347 : RES_POOLCOLL_TOX_CNTNT8, ///< Content 8th level.
348 : RES_POOLCOLL_TOX_CNTNT9, ///< Content 9th level.
349 : RES_POOLCOLL_TOX_CNTNT10, ///< Content 10th level.
350 :
351 : /// illustrations index.
352 : RES_POOLCOLL_TOX_ILLUSH, ///< Illustrations header.
353 : RES_POOLCOLL_TOX_ILLUS1, ///< Illustrations all levels.
354 :
355 : /// object index.
356 : RES_POOLCOLL_TOX_OBJECTH, ///< Objects header.
357 : RES_POOLCOLL_TOX_OBJECT1, ///< Objects all levels.
358 :
359 : /// tables index.
360 : RES_POOLCOLL_TOX_TABLESH, ///< Tables header.
361 : RES_POOLCOLL_TOX_TABLES1, ///< Tables all levels.
362 :
363 : /// index of authorities.
364 : RES_POOLCOLL_TOX_AUTHORITIESH, ///< Authorities header.
365 : RES_POOLCOLL_TOX_AUTHORITIES1, ///< Authorities all levels.
366 :
367 : /// user index 6..10.
368 : RES_POOLCOLL_TOX_USER6, ///< 6th level.
369 : RES_POOLCOLL_TOX_USER7, ///< 7th level.
370 : RES_POOLCOLL_TOX_USER8, ///< 8th level.
371 : RES_POOLCOLL_TOX_USER9, ///< 9th level.
372 : RES_POOLCOLL_TOX_USER10, ///< 10th level.
373 :
374 : RES_POOLCOLL_REGISTER_END,
375 :
376 : /// Group chapter / document.
377 : RES_POOLCOLL_DOC_BEGIN = COLL_DOC_BITS,
378 :
379 : RES_POOLCOLL_DOC_TITEL = RES_POOLCOLL_DOC_BEGIN, ///< Doc. titel.
380 : RES_POOLCOLL_DOC_SUBTITEL, ///< Doc. subtitel.
381 :
382 : RES_POOLCOLL_DOC_END,
383 :
384 : /// Group HTML-styles.
385 : RES_POOLCOLL_HTML_BEGIN = COLL_HTML_BITS,
386 :
387 : RES_POOLCOLL_HTML_BLOCKQUOTE = RES_POOLCOLL_HTML_BEGIN,
388 : RES_POOLCOLL_HTML_PRE,
389 : RES_POOLCOLL_HTML_HR,
390 : RES_POOLCOLL_HTML_DD,
391 : RES_POOLCOLL_HTML_DT,
392 :
393 : RES_POOLCOLL_HTML_END
394 :
395 : /// End of text styles collection.
396 : };
397 :
398 : /** Query defined parent of a POOL-ID
399 : Returns 0 if standard
400 : USHRT_MAX if no parent
401 : the parent in all other cases. */
402 : sal_uInt16 GetPoolParent( sal_uInt16 nId );
403 :
404 : SvxFrameDirection GetDefaultFrameDirection(sal_uLong nLanguage);
405 :
406 0 : inline sal_Bool IsConditionalByPoolId(sal_uInt16 nId)
407 : {
408 0 : return RES_POOLCOLL_TEXT == nId;
409 : }
410 :
411 : #endif
412 :
413 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
