Update ooo320-m1
[ooovba.git] / binfilter / inc / bf_sw / poolfmt.hxx
blob9573ac49a37fb9065b7e825164335616b90d34ce
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: poolfmt.hxx,v $
10 * $Revision: 1.4 $
12 * This file is part of OpenOffice.org.
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
29 ************************************************************************/
30 #ifndef _POOLFMT_HXX
31 #define _POOLFMT_HXX
33 #include <limits.h>
35 #ifndef _SOLAR_H
36 #include <tools/solar.h>
37 #endif
39 #ifndef _SVX_FRMDIR_HXX
40 #include <bf_svx/frmdir.hxx>
41 #endif
42 namespace binfilter {
44 // POOLCOLL-IDs:
45 // +----+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
46 // !User! Bereich ! 0 ! Offset !
47 // +----+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
49 // Bereich: 1 - Text
50 // 2 - Listen
51 // 3 - Sonderbereiche
52 // 4 - Verzeichnisse
53 // 5 - Kapitel / Dokument
54 // 6 - HTML-Vorlagen
56 // Andere IDs:
57 // +----+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
58 // !User! Bereich ! 1 ! Offset !
59 // +----+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
60 // Bereich: 0 - Zeichenvorlagen
61 // 1 - Frame-Vorlagen
62 // 2 - Seitenvorlagen
63 // 3 - Absatzformate (?)
64 // 4 - Grafikformate (?)
66 // F�r alle IDs gilt:
67 // Herkunft: 0 -Pool
68 // 1 -Benutzer
69 // Offset: innerhalb der Gruppe
72 // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
74 // ACHTUNG: neue ID's koennen nur noch am Ende der jeweiligen Gruppe
75 // zugefuegt werden. Diese Id's werden vom Reader/Writer ge-
76 // lesen und geschrieben. Diese kennen nur den Offset zum Start
78 // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
80 // Maske fuer Erkennung von COLLPOOL-Ids:
82 const USHORT POOLGRP_NOCOLLID = (1 << 10);
84 // POLLCOLL-Gruppen:
86 const USHORT USER_FMT = (1 << 15);
87 const USHORT POOL_FMT = (0 << 15);
89 const USHORT COLL_TEXT_BITS = (1 << 11);
90 const USHORT COLL_LISTS_BITS = (2 << 11);
91 const USHORT COLL_EXTRA_BITS = (3 << 11);
92 const USHORT COLL_REGISTER_BITS = (4 << 11);
93 const USHORT COLL_DOC_BITS = (5 << 11);
94 const USHORT COLL_HTML_BITS = (6 << 11);
95 const USHORT COLL_GET_RANGE_BITS = (15 << 11);
97 // Sonstige Gruppen:
99 const USHORT POOLGRP_CHARFMT = (0 << 11) + POOLGRP_NOCOLLID;
100 const USHORT POOLGRP_FRAMEFMT = (1 << 11) + POOLGRP_NOCOLLID;
101 const USHORT POOLGRP_PAGEDESC = (2 << 11) + POOLGRP_NOCOLLID;
102 const USHORT POOLGRP_NUMRULE = (3 << 11) + POOLGRP_NOCOLLID;
103 //const USHORT POOLGRP_GRFFMT = (4 << 11) + POOLGRP_NOCOLLID; // ?
105 // fuer Erkennung ob Benutzer-Vorlage oder nicht:
106 const USHORT POOL_IDUSER_FMT =
107 USHRT_MAX & ~(COLL_GET_RANGE_BITS + POOLGRP_NOCOLLID);
109 inline BOOL IsPoolUserFmt( USHORT nId )
111 return POOL_IDUSER_FMT ==
112 (nId & ~(COLL_GET_RANGE_BITS + POOLGRP_NOCOLLID))
113 ? TRUE : FALSE;
117 // ID-s fuer die Bereiche
118 enum RES_POOLFMT
120 RES_POOLFMT_BEGIN = 1, // HIER GEHT'S LOS !!!
121 RES_POOL_CHRFMT = RES_POOLFMT_BEGIN,
122 RES_POOL_FRMFMT,
123 RES_POOL_TXTCOLL,
124 RES_POOL_PAGEFMT,
126 RES_POOL_PARFMT, // ???
127 RES_POOL_GRFFMT, // ???
128 RES_POOLFMT_END
131 // Bereiche fuer die Id's der einzelnen Formate
133 // die Id's fuer die Zeichen-Vorlagen
134 enum RES_POOL_CHRFMT_TYPE
136 RES_POOLCHR_BEGIN = POOLGRP_CHARFMT,
137 RES_POOLCHR_NORMAL_BEGIN = POOLGRP_CHARFMT,
139 RES_POOLCHR_FOOTNOTE = RES_POOLCHR_NORMAL_BEGIN, // Fussnote
140 RES_POOLCHR_PAGENO, // Seiten/Feld
141 RES_POOLCHR_LABEL, // Beschriftung
142 RES_POOLCHR_DROPCAPS, // Initialienzeichen
143 RES_POOLCHR_NUM_LEVEL, // Nummerierungszeichen
144 RES_POOLCHR_BUL_LEVEL, // Aufzaehlungszeichen
146 RES_POOLCHR_INET_NORMAL, // Internet normal
147 RES_POOLCHR_INET_VISIT, // Internet besucht
148 RES_POOLCHR_JUMPEDIT, // Platzhalter
149 RES_POOLCHR_TOXJUMP, // Sprung aus Verzeichnis
150 RES_POOLCHR_ENDNOTE, // Endnote
151 RES_POOLCHR_LINENUM, // Zeilennummerierung
152 RES_POOLCHR_IDX_MAIN_ENTRY, // main entry in indexes
153 RES_POOLCHR_FOOTNOTE_ANCHOR, // Fussnotenanker
154 RES_POOLCHR_ENDNOTE_ANCHOR, // Endnotenanker
155 RES_POOLCHR_RUBYTEXT, // Rubytext
156 RES_POOLCHR_VERT_NUM, // Vertical numbering symbols
158 RES_POOLCHR_NORMAL_END,
160 RES_POOLCHR_HTML_BEGIN = RES_POOLCHR_BEGIN + 50, // HTML-Vorlagen
161 RES_POOLCHR_HTML_EMPHASIS= RES_POOLCHR_HTML_BEGIN,
162 RES_POOLCHR_HTML_CITIATION,
163 RES_POOLCHR_HTML_STRONG,
164 RES_POOLCHR_HTML_CODE,
165 RES_POOLCHR_HTML_SAMPLE,
166 RES_POOLCHR_HTML_KEYBOARD,
167 RES_POOLCHR_HTML_VARIABLE,
168 RES_POOLCHR_HTML_DEFINSTANCE,
169 RES_POOLCHR_HTML_TELETYPE,
170 RES_POOLCHR_HTML_END,
172 RES_POOLCHR_END = RES_POOLCHR_HTML_END
176 // die Id's fuer die Rahmen-Vorlagen
177 enum RES_POOL_FRMFMT_TYPE
179 RES_POOLFRM_BEGIN = POOLGRP_FRAMEFMT,
181 RES_POOLFRM_FRAME = RES_POOLFRM_BEGIN, // Rahmen
182 RES_POOLFRM_GRAPHIC, // Graphic
183 RES_POOLFRM_OLE, // OLE
184 RES_POOLFRM_FORMEL, // Formeln
185 RES_POOLFRM_MARGINAL, // Marginalen
186 RES_POOLFRM_WATERSIGN, // Wasserzeichen
187 RES_POOLFRM_LABEL, // Etikette
189 RES_POOLFRM_END
192 // die Id's fuer die Seiten-Vorlagen
193 enum RES_POOL_PAGEFMT_TYPE
195 RES_POOLPAGE_BEGIN = POOLGRP_PAGEDESC,
197 RES_POOLPAGE_STANDARD = RES_POOLPAGE_BEGIN, // Standard-Seite
198 RES_POOLPAGE_FIRST, // Erste Seite
199 RES_POOLPAGE_LEFT, // Linke Seite
200 RES_POOLPAGE_RIGHT, // Rechte Seite
201 RES_POOLPAGE_JAKET, // Umschlag
202 RES_POOLPAGE_REGISTER, // Verzeichnis
203 RES_POOLPAGE_HTML, // HTML
204 RES_POOLPAGE_FOOTNOTE, // Fussnote bei Dokumentende
205 RES_POOLPAGE_ENDNOTE, // Endnotensseite
207 RES_POOLPAGE_END
210 // die Id's fuer die NumRule-Vorlagen
211 enum RES_POOL_NUMRULE_TYPE
213 RES_POOLNUMRULE_BEGIN = POOLGRP_NUMRULE,
214 RES_POOLNUMRULE_NUM1 = RES_POOLNUMRULE_BEGIN, // NumRule Numerierung 1
215 RES_POOLNUMRULE_NUM2, // NumRule Numerierung 2
216 RES_POOLNUMRULE_NUM3, // NumRule Numerierung 3
217 RES_POOLNUMRULE_NUM4, // NumRule Numerierung 4
218 RES_POOLNUMRULE_NUM5, // NumRule Numerierung 5
219 RES_POOLNUMRULE_BUL1, // NumRule Bullets 1
220 RES_POOLNUMRULE_BUL2, // NumRule Bullets 2
221 RES_POOLNUMRULE_BUL3, // NumRule Bullets 3
222 RES_POOLNUMRULE_BUL4, // NumRule Bullets 4
223 RES_POOLNUMRULE_BUL5, // NumRule Bullets 5
224 RES_POOLNUMRULE_END
227 // die Id's fuer die Absatz-Vorlagen
228 enum RES_POOL_COLLFMT_TYPE
230 // Gruppe Text
231 RES_POOLCOLL_TEXT_BEGIN = COLL_TEXT_BITS,
233 RES_POOLCOLL_STANDARD = RES_POOLCOLL_TEXT_BEGIN, // Standard
234 RES_POOLCOLL_TEXT, // Textkoerper
235 RES_POOLCOLL_TEXT_IDENT, // Textkoerper Einzug
236 RES_POOLCOLL_TEXT_NEGIDENT, // Textkoerper neg. Einzug
237 RES_POOLCOLL_TEXT_MOVE, // Textkoerper Einrueckung
238 RES_POOLCOLL_GREETING, // Grussformel
239 RES_POOLCOLL_SIGNATURE, // Unterschrift
240 RES_POOLCOLL_CONFRONTATION, // Gegenueberstellung
241 RES_POOLCOLL_MARGINAL, // Marginalie
243 // Untergruppierung Ueberschriften
244 RES_POOLCOLL_HEADLINE_BASE, // Basis-Ueberschrift
245 RES_POOLCOLL_HEADLINE1, // Ueberschrift 1
246 RES_POOLCOLL_HEADLINE2, // Ueberschrift 2
247 RES_POOLCOLL_HEADLINE3, // Ueberschrift 3
248 RES_POOLCOLL_HEADLINE4, // Ueberschrift 4
249 RES_POOLCOLL_HEADLINE5, // Ueberschrift 5
250 RES_POOLCOLL_HEADLINE6, // Ueberschrift 6
251 RES_POOLCOLL_HEADLINE7, // Ueberschrift 7
252 RES_POOLCOLL_HEADLINE8, // Ueberschrift 8
253 RES_POOLCOLL_HEADLINE9, // Ueberschrift 9
254 RES_POOLCOLL_HEADLINE10, // Ueberschrift 10
256 RES_POOLCOLL_TEXT_END,
259 // Gruppe Listen
260 RES_POOLCOLL_LISTS_BEGIN = COLL_LISTS_BITS,
262 RES_POOLCOLL_NUMBUL_BASE = RES_POOLCOLL_LISTS_BEGIN, // Basis-Liste
264 // Untergruppe Nummerierung
265 RES_POOLCOLL_NUM_LEVEL1S, // Start Level1
266 RES_POOLCOLL_NUM_LEVEL1, // 1. Level
267 RES_POOLCOLL_NUM_LEVEL1E, // Ende Level1
268 RES_POOLCOLL_NUM_NONUM1, // keine Nummerierung
269 RES_POOLCOLL_NUM_LEVEL2S, // Start 2. Level
270 RES_POOLCOLL_NUM_LEVEL2, // 2. Level
271 RES_POOLCOLL_NUM_LEVEL2E, // Ende 2. Level
272 RES_POOLCOLL_NUM_NONUM2, // keine Nummerierung
273 RES_POOLCOLL_NUM_LEVEL3S, // Start 3. Level
274 RES_POOLCOLL_NUM_LEVEL3, // 3. Level
275 RES_POOLCOLL_NUM_LEVEL3E, // Ende 3. Level
276 RES_POOLCOLL_NUM_NONUM3, // keine Nummerierung
277 RES_POOLCOLL_NUM_LEVEL4S, // Start 4. Level
278 RES_POOLCOLL_NUM_LEVEL4, // 4. Level
279 RES_POOLCOLL_NUM_LEVEL4E, // Ende 4. Level
280 RES_POOLCOLL_NUM_NONUM4, // keine Nummerierung
281 RES_POOLCOLL_NUM_LEVEL5S, // Start 5. Level
282 RES_POOLCOLL_NUM_LEVEL5, // 5. Level
283 RES_POOLCOLL_NUM_LEVEL5E, // Ende 5. Level
284 RES_POOLCOLL_NUM_NONUM5, // keine Nummerierung
286 // Untergruppe Aufzaehlung
287 RES_POOLCOLL_BUL_LEVEL1S, // Start Level1
288 RES_POOLCOLL_BUL_LEVEL1, // 1. Level
289 RES_POOLCOLL_BUL_LEVEL1E, // Ende Level1
290 RES_POOLCOLL_BUL_NONUM1, // keine Nummerierung
291 RES_POOLCOLL_BUL_LEVEL2S, // Start 2. Level
292 RES_POOLCOLL_BUL_LEVEL2, // 2. Level
293 RES_POOLCOLL_BUL_LEVEL2E, // Ende 2. Level
294 RES_POOLCOLL_BUL_NONUM2, // keine Nummerierung
295 RES_POOLCOLL_BUL_LEVEL3S, // Start 3. Level
296 RES_POOLCOLL_BUL_LEVEL3, // 3. Level
297 RES_POOLCOLL_BUL_LEVEL3E, // Ende 3. Level
298 RES_POOLCOLL_BUL_NONUM3, // keine Nummerierung
299 RES_POOLCOLL_BUL_LEVEL4S, // Start 4. Level
300 RES_POOLCOLL_BUL_LEVEL4, // 4. Level
301 RES_POOLCOLL_BUL_LEVEL4E, // Ende 4. Level
302 RES_POOLCOLL_BUL_NONUM4, // keine Nummerierung
303 RES_POOLCOLL_BUL_LEVEL5S, // Start 5. Level
304 RES_POOLCOLL_BUL_LEVEL5, // 5. Level
305 RES_POOLCOLL_BUL_LEVEL5E, // Ende 5. Level
306 RES_POOLCOLL_BUL_NONUM5, // keine Nummerierung
308 RES_POOLCOLL_LISTS_END,
311 // Sonderbereiche
312 RES_POOLCOLL_EXTRA_BEGIN = COLL_EXTRA_BITS,
314 // Untergruppe Header
315 RES_POOLCOLL_HEADER = RES_POOLCOLL_EXTRA_BEGIN, // Header Left&Right
316 RES_POOLCOLL_HEADERL, // Header Left
317 RES_POOLCOLL_HEADERR, // Header Right
319 // Untergruppe Footer
320 RES_POOLCOLL_FOOTER, // Footer Left&Right
321 RES_POOLCOLL_FOOTERL, // Footer Left
322 RES_POOLCOLL_FOOTERR, // Footer Right
324 // Untergruppe Tabelle
325 RES_POOLCOLL_TABLE, // Tabelle "Inhalt"
326 RES_POOLCOLL_TABLE_HDLN, // Tabellen-Headline
329 // Untergruppe Beschriftung
330 RES_POOLCOLL_LABEL, // Beschriftung-Basis
331 RES_POOLCOLL_LABEL_ABB, // Beschriftung-Abbildung
332 RES_POOLCOLL_LABEL_TABLE, // Beschriftung-Tabelle
333 RES_POOLCOLL_LABEL_FRAME, // Beschriftung-Rahmen
335 // sonstiges
336 RES_POOLCOLL_FRAME, // Rahmen
337 RES_POOLCOLL_FOOTNOTE, // Fussnoten
338 RES_POOLCOLL_JAKETADRESS, // UmschlagAdresse
339 RES_POOLCOLL_SENDADRESS, // AbsenderAdresse
340 RES_POOLCOLL_ENDNOTE, // Endnoten
342 RES_POOLCOLL_LABEL_DRAWING, // Beschriftung-Zeichen-Objekte
343 RES_POOLCOLL_EXTRA_END,
346 // Gruppe Verzeichnisse
347 RES_POOLCOLL_REGISTER_BEGIN = COLL_REGISTER_BITS,
349 RES_POOLCOLL_REGISTER_BASE = RES_POOLCOLL_REGISTER_BEGIN, // Basis-Verzeichnis
351 // Untergruppe Index-Verzeichnisse
352 RES_POOLCOLL_TOX_IDXH, // Header
353 RES_POOLCOLL_TOX_IDX1, // 1. Ebene
354 RES_POOLCOLL_TOX_IDX2, // 2. Ebene
355 RES_POOLCOLL_TOX_IDX3, // 3. Ebene
356 RES_POOLCOLL_TOX_IDXBREAK, // Trenner
358 // Untergruppe Inhalts-Verzeichnisse
359 RES_POOLCOLL_TOX_CNTNTH, // Header
360 RES_POOLCOLL_TOX_CNTNT1, // 1. Ebene
361 RES_POOLCOLL_TOX_CNTNT2, // 2. Ebene
362 RES_POOLCOLL_TOX_CNTNT3, // 3. Ebene
363 RES_POOLCOLL_TOX_CNTNT4, // 4. Ebene
364 RES_POOLCOLL_TOX_CNTNT5, // 5. Ebene
366 // Untergruppe Benutzer-Verzeichnisse:
367 RES_POOLCOLL_TOX_USERH, // Header
368 RES_POOLCOLL_TOX_USER1, // 1. Ebene
369 RES_POOLCOLL_TOX_USER2, // 2. Ebene
370 RES_POOLCOLL_TOX_USER3, // 3. Ebene
371 RES_POOLCOLL_TOX_USER4, // 4. Ebene
372 RES_POOLCOLL_TOX_USER5, // 5. Ebene
375 RES_POOLCOLL_TOX_CNTNT6, // Inhalt 6. Ebene
376 RES_POOLCOLL_TOX_CNTNT7, // Inhalt 7. Ebene
377 RES_POOLCOLL_TOX_CNTNT8, // Inhalt 8. Ebene
378 RES_POOLCOLL_TOX_CNTNT9, // Inhalt 9. Ebene
379 RES_POOLCOLL_TOX_CNTNT10, // Inhalt 10. Ebene
381 // illustrations index
382 RES_POOLCOLL_TOX_ILLUSH, // illustrations header
383 RES_POOLCOLL_TOX_ILLUS1, // illustrations all levels
385 // object index
386 RES_POOLCOLL_TOX_OBJECTH, // objects header
387 RES_POOLCOLL_TOX_OBJECT1, // objects all levels
389 // tables index
390 RES_POOLCOLL_TOX_TABLESH, // tables header
391 RES_POOLCOLL_TOX_TABLES1, // tables all levels
393 // index of authorities
394 RES_POOLCOLL_TOX_AUTHORITIESH, // authorities header
395 RES_POOLCOLL_TOX_AUTHORITIES1, // authorities all levels
397 // user index 6..10
398 RES_POOLCOLL_TOX_USER6, // level 6
399 RES_POOLCOLL_TOX_USER7, // level 7
400 RES_POOLCOLL_TOX_USER8, // level 8
401 RES_POOLCOLL_TOX_USER9, // level 9
402 RES_POOLCOLL_TOX_USER10, // level 10
404 RES_POOLCOLL_REGISTER_END,
407 // Gruppe Kapitel/Dokument
408 RES_POOLCOLL_DOC_BEGIN = COLL_DOC_BITS,
410 RES_POOLCOLL_DOC_TITEL = RES_POOLCOLL_DOC_BEGIN, // Doc. Titel
411 RES_POOLCOLL_DOC_SUBTITEL, // Doc. UnterTitel
413 RES_POOLCOLL_DOC_END,
415 // Gruppe HTML-Vorlagen
416 RES_POOLCOLL_HTML_BEGIN = COLL_HTML_BITS,
418 RES_POOLCOLL_HTML_BLOCKQUOTE = RES_POOLCOLL_HTML_BEGIN,
419 RES_POOLCOLL_HTML_PRE,
420 RES_POOLCOLL_HTML_HR,
421 RES_POOLCOLL_HTML_DD,
422 RES_POOLCOLL_HTML_DT,
424 RES_POOLCOLL_HTML_END
426 // Ende der Textformat-Vorlagen Sammlung
431 // erfrage den definierten Parent zu einer POOL-Id
432 // returnt: 0 -> Standard
433 // USHRT_MAX -> kein Parent
434 // sonst -> den Parent
435 USHORT GetPoolParent( USHORT nId );
437 SvxFrameDirection GetDefaultFrameDirection(ULONG nLanguage);
439 inline BOOL IsConditionalByPoolId(USHORT nId)
441 return RES_POOLCOLL_TEXT == nId;
443 // die Id's fuer die Grafik-Formate
444 /*enum RES_POOL_GRFFMT_TYPE
446 RES_POOLGRF_BEGIN = RES_POOLPAR_END,
447 RES_POOLGRF_1 = RES_POOLGRF_BEGIN,
448 RES_POOLGRF_END
452 } //namespace binfilter
453 #endif