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_HINTIDS_HXX
20 : #define INCLUDED_SW_INC_HINTIDS_HXX
21 :
22 : #include <tools/solar.h>
23 : #include <sal/types.h>
24 : #include "swdllapi.h"
25 :
26 : // For SwTxtHints without end index the following char is added:
27 :
28 : #define CH_TXTATR_BREAKWORD ((sal_Unicode)0x01)
29 : #define CH_TXTATR_INWORD ((sal_Unicode)0xFFF9)
30 : #define CH_TXTATR_TAB ((sal_Unicode)'\t')
31 : #define CH_TXTATR_NEWLINE ((sal_Unicode)'\n')
32 : #define CH_TXT_ATR_INPUTFIELDSTART ((sal_Unicode)0x04)
33 : #define CH_TXT_ATR_INPUTFIELDEND ((sal_Unicode)0x05)
34 :
35 : #define CH_TXT_ATR_FORMELEMENT ((sal_Unicode)0x06)
36 :
37 : #define CH_TXT_ATR_FIELDSTART ((sal_Unicode)0x07)
38 : #define CH_TXT_ATR_FIELDEND ((sal_Unicode)0x08)
39 : #define CH_TXT_ATR_SUBST_FIELDSTART ("[")
40 : #define CH_TXT_ATR_SUBST_FIELDEND ("]")
41 :
42 : /*
43 : * Enums for the hints
44 : */
45 :
46 : #define HINT_BEGIN 1
47 :
48 : #define POOLATTR_BEGIN HINT_BEGIN
49 : #define POOLATTR_END RES_UNKNOWNATR_END
50 :
51 : // Ranges for the IDs of the format-attributes.
52 : // Which-values for character-format attributes.
53 : enum RES_CHRATR
54 : {
55 : RES_CHRATR_BEGIN = HINT_BEGIN,
56 : RES_CHRATR_CASEMAP = RES_CHRATR_BEGIN, // 1
57 : RES_CHRATR_CHARSETCOLOR, // 2
58 : RES_CHRATR_COLOR, // 3
59 : RES_CHRATR_CONTOUR, // 4
60 : RES_CHRATR_CROSSEDOUT, // 5
61 : RES_CHRATR_ESCAPEMENT, // 6
62 : RES_CHRATR_FONT, // 7
63 : RES_CHRATR_FONTSIZE, // 8
64 : RES_CHRATR_KERNING, // 9
65 : RES_CHRATR_LANGUAGE, // 10
66 : RES_CHRATR_POSTURE, // 11
67 : RES_CHRATR_PROPORTIONALFONTSIZE, // 12
68 : RES_CHRATR_SHADOWED, // 13
69 : RES_CHRATR_UNDERLINE, // 14
70 : RES_CHRATR_WEIGHT, // 15
71 : RES_CHRATR_WORDLINEMODE, // 16
72 : RES_CHRATR_AUTOKERN, // 17
73 : RES_CHRATR_BLINK, // 18
74 : RES_CHRATR_NOHYPHEN, // 19
75 : RES_CHRATR_NOLINEBREAK, // 20
76 : RES_CHRATR_BACKGROUND, // 21
77 : RES_CHRATR_CJK_FONT, // 22
78 : RES_CHRATR_CJK_FONTSIZE, // 23
79 : RES_CHRATR_CJK_LANGUAGE, // 24
80 : RES_CHRATR_CJK_POSTURE, // 25
81 : RES_CHRATR_CJK_WEIGHT, // 26
82 : RES_CHRATR_CTL_FONT, // 27
83 : RES_CHRATR_CTL_FONTSIZE, // 28
84 : RES_CHRATR_CTL_LANGUAGE, // 29
85 : RES_CHRATR_CTL_POSTURE, // 30
86 : RES_CHRATR_CTL_WEIGHT, // 31
87 : RES_CHRATR_ROTATE, // 32
88 : RES_CHRATR_EMPHASIS_MARK, // 33
89 : RES_CHRATR_TWO_LINES, // 34
90 : RES_CHRATR_SCALEW, // 35
91 : RES_CHRATR_RELIEF, // 36
92 : RES_CHRATR_HIDDEN, // 37
93 : RES_CHRATR_OVERLINE, // 38
94 : RES_CHRATR_RSID, // 39
95 : RES_CHRATR_BOX, // 40
96 : RES_CHRATR_SHADOW, // 41
97 : RES_CHRATR_HIGHLIGHT, // 42
98 : RES_CHRATR_GRABBAG, // 43
99 : RES_CHRATR_BIDIRTL, // 44
100 : RES_CHRATR_IDCTHINT, // 45
101 : RES_CHRATR_END
102 : };
103 :
104 : // this Attribute used only in a TextNodes SwpAttr-Array
105 : enum RES_TXTATR
106 : {
107 : RES_TXTATR_BEGIN = RES_CHRATR_END,
108 :
109 : /** text attributes with start and end.
110 : #i105453#:
111 : Hints (SwTxtAttr) with the same start and end position are sorted by
112 : WhichId, i.e., the TXTATR constants defined here.
113 : The text formatting (SwAttrIter) poses some requirements on TXTATR order:
114 : - AUTOFMT must precede CHARFMT, so that auto style can overwrite char style.
115 : - INETFMT must precede CHARFMT, so that link style can overwrite char style.
116 : (this is actually surprising: CHARFMT hints are not split at INETFMT
117 : hints on insertion, but on exporting to ODF. if CHARFMT would precede
118 : INETFMT, then exporting and importing will effectively change precedence)
119 :
120 : Nesting hints (SwTxtAttrNesting) also have requirements on TXTATR order,
121 : to ensure proper nesting (because CJK_RUBY and INETFMT have no CH_TXTATR):
122 : - INETFMT should precede CJK_RUBY (for UNO API it does not matter...)
123 : - META and METAFIELD must precede CJK_RUBY and INETFMT
124 : */
125 : RES_TXTATR_WITHEND_BEGIN = RES_TXTATR_BEGIN ,
126 : RES_TXTATR_REFMARK = RES_TXTATR_WITHEND_BEGIN, // 46
127 : RES_TXTATR_TOXMARK, // 47
128 : RES_TXTATR_META, // 48
129 : RES_TXTATR_METAFIELD, // 49
130 : RES_TXTATR_AUTOFMT, // 50
131 : RES_TXTATR_INETFMT, // 51
132 : RES_TXTATR_CHARFMT, // 52
133 : RES_TXTATR_CJK_RUBY, // 53
134 : RES_TXTATR_UNKNOWN_CONTAINER, // 54
135 : RES_TXTATR_INPUTFIELD, // 55
136 : RES_TXTATR_WITHEND_END,
137 :
138 : // all TextAttributes without an end
139 : RES_TXTATR_NOEND_BEGIN = RES_TXTATR_WITHEND_END,
140 : RES_TXTATR_FIELD = RES_TXTATR_NOEND_BEGIN, // 56
141 : RES_TXTATR_FLYCNT, // 57
142 : RES_TXTATR_FTN, // 58
143 : RES_TXTATR_ANNOTATION, // 59
144 : RES_TXTATR_DUMMY3, // 60
145 : RES_TXTATR_DUMMY1, // 61
146 : RES_TXTATR_DUMMY2, // 62
147 : RES_TXTATR_NOEND_END,
148 : RES_TXTATR_END = RES_TXTATR_NOEND_END
149 : };
150 :
151 : enum RES_PARATR
152 : {
153 : RES_PARATR_BEGIN = RES_TXTATR_END,
154 : RES_PARATR_LINESPACING = RES_PARATR_BEGIN, // 63
155 : RES_PARATR_ADJUST, // 64
156 : RES_PARATR_SPLIT, // 65
157 : RES_PARATR_ORPHANS, // 66
158 : RES_PARATR_WIDOWS, // 67
159 : RES_PARATR_TABSTOP, // 68
160 : RES_PARATR_HYPHENZONE, // 69
161 : RES_PARATR_DROP, // 70
162 : RES_PARATR_REGISTER, // 71
163 : RES_PARATR_NUMRULE, // 72
164 : RES_PARATR_SCRIPTSPACE, // 73
165 : RES_PARATR_HANGINGPUNCTUATION, // 74
166 : RES_PARATR_FORBIDDEN_RULES, // 75
167 : RES_PARATR_VERTALIGN, // 76
168 : RES_PARATR_SNAPTOGRID, // 77
169 : RES_PARATR_CONNECT_BORDER, // 78
170 : RES_PARATR_OUTLINELEVEL, // 79
171 : RES_PARATR_RSID, // 80
172 : RES_PARATR_GRABBAG, // 81
173 : RES_PARATR_END
174 : };
175 :
176 : // list attributes for paragraphs.
177 : // intentionally these list attributes are not contained in paragraph styles
178 : enum RES_PARATR_LIST
179 : {
180 : RES_PARATR_LIST_BEGIN = RES_PARATR_END,
181 : RES_PARATR_LIST_ID = RES_PARATR_LIST_BEGIN, // 82
182 : RES_PARATR_LIST_LEVEL, // 83
183 : RES_PARATR_LIST_ISRESTART, // 84
184 : RES_PARATR_LIST_RESTARTVALUE, // 85
185 : RES_PARATR_LIST_ISCOUNTED, // 86
186 : RES_PARATR_LIST_END
187 : };
188 :
189 : enum RES_FRMATR
190 : {
191 : RES_FRMATR_BEGIN = RES_PARATR_LIST_END,
192 : RES_FILL_ORDER = RES_FRMATR_BEGIN, // 87
193 : RES_FRM_SIZE, // 88
194 : RES_PAPER_BIN, // 89
195 : RES_LR_SPACE, // 90
196 : RES_UL_SPACE, // 91
197 : RES_PAGEDESC, // 92
198 : RES_BREAK, // 93
199 : RES_CNTNT, // 94
200 : RES_HEADER, // 95
201 : RES_FOOTER, // 96
202 : RES_PRINT, // 97
203 : RES_OPAQUE, // 98
204 : RES_PROTECT, // 99
205 : RES_SURROUND, // 100
206 : RES_VERT_ORIENT, // 101
207 : RES_HORI_ORIENT, // 102
208 : RES_ANCHOR, // 103
209 : RES_BACKGROUND, // 104
210 : RES_BOX, // 105
211 : RES_SHADOW, // 106
212 : RES_FRMMACRO, // 107
213 : RES_COL, // 108
214 : RES_KEEP, // 109
215 : RES_URL, // 110
216 : RES_EDIT_IN_READONLY, // 111
217 : RES_LAYOUT_SPLIT, // 112
218 : RES_CHAIN, // 113
219 : RES_TEXTGRID, // 114
220 : RES_LINENUMBER , // 115
221 : RES_FTN_AT_TXTEND, // 116
222 : RES_END_AT_TXTEND, // 117
223 : RES_COLUMNBALANCE, // 118
224 : RES_FRAMEDIR, // 119
225 : RES_HEADER_FOOTER_EAT_SPACING, // 120
226 : RES_ROW_SPLIT, // 121
227 : RES_FOLLOW_TEXT_FLOW, // 122
228 : RES_COLLAPSING_BORDERS, // 123
229 : RES_WRAP_INFLUENCE_ON_OBJPOS, // 124
230 : RES_AUTO_STYLE, // 125
231 : RES_FRMATR_STYLE_NAME, // 126
232 : RES_FRMATR_CONDITIONAL_STYLE_NAME, // 127
233 : RES_FRMATR_GRABBAG, // 130
234 : RES_TEXT_VERT_ADJUST, // 131
235 : RES_FRMATR_END
236 : };
237 :
238 : enum RES_GRFATR
239 : {
240 : RES_GRFATR_BEGIN = RES_FRMATR_END,
241 : RES_GRFATR_MIRRORGRF = RES_GRFATR_BEGIN, // 132
242 : RES_GRFATR_CROPGRF, // 133
243 :
244 : RES_GRFATR_ROTATION, // 134
245 : RES_GRFATR_LUMINANCE, // 135
246 : RES_GRFATR_CONTRAST, // 136
247 : RES_GRFATR_CHANNELR, // 137
248 : RES_GRFATR_CHANNELG, // 138
249 : RES_GRFATR_CHANNELB, // 139
250 : RES_GRFATR_GAMMA, // 140
251 : RES_GRFATR_INVERT, // 141
252 : RES_GRFATR_TRANSPARENCY, // 142
253 : RES_GRFATR_DRAWMODE, // 143
254 :
255 : RES_GRFATR_DUMMY1, // 144
256 : RES_GRFATR_DUMMY2, // 145
257 : RES_GRFATR_DUMMY3, // 146
258 : RES_GRFATR_DUMMY4, // 147
259 : RES_GRFATR_DUMMY5, // 148
260 : RES_GRFATR_END
261 : };
262 :
263 : enum RES_BOXATR
264 : {
265 : RES_BOXATR_BEGIN = RES_GRFATR_END,
266 : RES_BOXATR_FORMAT = RES_BOXATR_BEGIN, // 149
267 : RES_BOXATR_FORMULA, // 150
268 : RES_BOXATR_VALUE, // 151
269 : RES_BOXATR_END
270 : };
271 :
272 : enum RES_UNKNOWNATR
273 : {
274 : RES_UNKNOWNATR_BEGIN = RES_BOXATR_END,
275 : RES_UNKNOWNATR_CONTAINER = RES_UNKNOWNATR_BEGIN,// 152
276 : RES_UNKNOWNATR_END
277 : };
278 :
279 : // Format IDs
280 : enum RES_FMT
281 : {
282 : RES_FMT_BEGIN = RES_UNKNOWNATR_END,
283 : RES_CHRFMT = RES_FMT_BEGIN, // 144
284 : RES_FRMFMT, // 145
285 : RES_FLYFRMFMT, // 146
286 : RES_TXTFMTCOLL, // 147
287 : RES_GRFFMTCOLL, // 148
288 : RES_DRAWFRMFMT, // 149
289 : RES_CONDTXTFMTCOLL, // 150
290 : RES_FMT_END
291 : };
292 :
293 : // ID's for Messages in the Formats
294 : enum RES_MSG
295 : {
296 : RES_MSG_BEGIN = RES_FMT_END,
297 : RES_OBJECTDYING = RES_MSG_BEGIN, // 151
298 : RES_FMT_CHG,
299 : RES_ATTRSET_CHG,
300 : RES_FRM_SIZECHG,
301 : RES_TXTATR_FLDCHG,
302 : RES_TXTATR_EMPTYCHG,
303 : RES_INS_CHR,
304 : RES_INS_TXT,
305 : RES_DEL_CHR,
306 : RES_DEL_TXT,
307 : RES_UPDATE_ATTR,
308 : RES_PAGEDESC_FTNINFO,
309 : RES_REFMARKFLD_UPDATE,
310 : RES_DOCPOS_UPDATE,
311 : RES_TABLEFML_UPDATE,
312 : RES_UPDATEDDETBL,
313 : RES_TBLHEADLINECHG,
314 : RES_AUTOFMT_DOCNODE,
315 : RES_REPAINT,
316 : RES_DOC_DTOR,
317 : RES_SECTION_HIDDEN,
318 : RES_SECTION_NOT_HIDDEN,
319 : RES_GRAPHIC_ARRIVED,
320 : RES_GRAPHIC_PIECE_ARRIVED,
321 : RES_HIDDENPARA_PRINT,
322 : RES_CONDCOLL_CONDCHG,
323 : RES_VIRTPAGENUM_INFO,
324 : RES_GETLOWERNUMLEVEL,
325 : RES_RESET_FMTWRITTEN,
326 : RES_REMOVE_UNO_OBJECT,
327 : RES_GRF_REREAD_AND_INCACHE,
328 : RES_SECTION_RESETHIDDENFLAG,
329 : RES_FINDNEARESTNODE,
330 : RES_CONTENT_VISIBLE,
331 : RES_FOOTNOTE_DELETED,
332 : RES_REFMARK_DELETED,
333 : RES_TOXMARK_DELETED,
334 : RES_GRAPHIC_SWAPIN,
335 : RES_FIELD_DELETED,
336 : RES_NAME_CHANGED,
337 : RES_TITLE_CHANGED,
338 : RES_DESCRIPTION_CHANGED,
339 : RES_UNOCURSOR_LEAVES_SECTION,
340 : RES_LINKED_GRAPHIC_STREAM_ARRIVED,
341 : RES_MSG_END
342 : };
343 :
344 : // An ID for the RTF-reader. The stylesheets are treated like attributes,
345 : // i.e. there is a StyleSheet-attribute. To avoid collision with other
346 : // Which()-values, the value is listed here. (The help system too defines
347 : // new attributes!)
348 : enum RES_FLTRATTR
349 : {
350 : RES_FLTRATTR_BEGIN = RES_MSG_END,
351 : RES_FLTR_STYLESHEET = RES_FLTRATTR_BEGIN,
352 : RES_FLTR_BOOKMARK,
353 : RES_FLTR_ANCHOR,
354 : RES_FLTR_BORDER,
355 : RES_FLTR_NUMRULE,
356 : RES_FLTR_NUMRULE_NUM,
357 : RES_FLTR_SDR_ANCHOR,
358 : RES_FLTR_TOX,
359 : RES_FLTR_SECTION,
360 : RES_FLTR_REDLINE,
361 : RES_FLTR_SCRIPTTYPE,
362 : RES_FLTRATTR_END
363 : };
364 :
365 : #define RES_TBX_DUMMY RES_FLTRATTR_END + 1
366 :
367 : #define HINT_END RES_TBX_DUMMY
368 :
369 : // Error recognition!!
370 : #define INVALID_HINT HINT_END
371 : #define RES_WHICHHINT_END HINT_END
372 :
373 0 : inline bool isATR(const sal_uInt16 nWhich)
374 : {
375 0 : return (RES_CHRATR_BEGIN <= nWhich) && (RES_UNKNOWNATR_END > nWhich);
376 : }
377 0 : inline bool isCHRATR(const sal_uInt16 nWhich)
378 : {
379 0 : return (RES_CHRATR_BEGIN <= nWhich) && (RES_CHRATR_END > nWhich);
380 : }
381 0 : inline bool isTXTATR_WITHEND(const sal_uInt16 nWhich)
382 : {
383 : return (RES_TXTATR_WITHEND_BEGIN <= nWhich)
384 0 : && (RES_TXTATR_WITHEND_END > nWhich);
385 : }
386 0 : inline bool isTXTATR_NOEND(const sal_uInt16 nWhich)
387 : {
388 : return (RES_TXTATR_NOEND_BEGIN <= nWhich)
389 0 : && (RES_TXTATR_NOEND_END > nWhich);
390 : }
391 0 : inline bool isTXTATR(const sal_uInt16 nWhich)
392 : {
393 0 : return (RES_TXTATR_BEGIN <= nWhich) && (RES_TXTATR_END > nWhich);
394 : }
395 0 : inline bool isPARATR(const sal_uInt16 nWhich)
396 : {
397 0 : return (RES_PARATR_BEGIN <= nWhich) && (RES_PARATR_END > nWhich);
398 : }
399 0 : inline bool isPARATR_LIST(const sal_uInt16 nWhich)
400 : {
401 0 : return (RES_PARATR_LIST_BEGIN <= nWhich) && (RES_PARATR_LIST_END > nWhich); }
402 0 : inline bool isFRMATR(const sal_uInt16 nWhich)
403 : {
404 0 : return (RES_FRMATR_BEGIN <= nWhich) && (RES_FRMATR_END > nWhich);
405 : }
406 0 : inline bool isGRFATR(const sal_uInt16 nWhich)
407 : {
408 0 : return (RES_GRFATR_BEGIN <= nWhich) && (RES_GRFATR_END > nWhich);
409 : }
410 0 : inline bool isBOXATR(const sal_uInt16 nWhich)
411 : {
412 0 : return (RES_BOXATR_BEGIN <= nWhich) && (RES_BOXATR_END > nWhich);
413 : }
414 0 : inline bool isUNKNOWNATR(const sal_uInt16 nWhich)
415 : {
416 0 : return (RES_UNKNOWNATR_BEGIN <= nWhich) && (RES_UNKNOWNATR_END > nWhich);
417 : }
418 :
419 : // Take the respective default attribute from the statistical default
420 : // attributes table over the Which-value.
421 : // If none exists, return a 0 pointer!!!
422 : // This function is implemented in Init.cxx. It is declared here as external
423 : // in order to allow the formats to access it.
424 : // Inline in PRODUCT.
425 : class SfxPoolItem;
426 : struct SfxItemInfo;
427 : typedef SfxPoolItem* SwDfltAttrTab[ POOLATTR_END - POOLATTR_BEGIN ];
428 :
429 : extern SwDfltAttrTab aAttrTab;
430 : extern SfxItemInfo aSlotTab[];
431 :
432 : SW_DLLPUBLIC const SfxPoolItem* GetDfltAttr( sal_uInt16 nWhich );
433 :
434 : SW_DLLPUBLIC sal_uInt16 GetWhichOfScript( sal_uInt16 nWhich, sal_uInt16 nScript );
435 :
436 : // return for the given TextAttribute without an end the correct character.
437 : // This function returns
438 : // CH_TXTATR_BREAKWORD for Textattribute which breaks a word (default)
439 : // CH_TXTATR_INWORD for Textattribute which dont breaks a word
440 : class SwTxtAttr;
441 : sal_Unicode GetCharOfTxtAttr( const SwTxtAttr& rAttr );
442 :
443 : // all Sets defined in init.cxx
444 :
445 : // AttrSet-Range for the 3 Break-Attribute
446 : extern sal_uInt16 aBreakSetRange[];
447 : // AttrSet-Range for TxtFmtColl
448 : extern sal_uInt16 aTxtFmtCollSetRange[];
449 : // AttrSet-Range for GrfFmtColl
450 : extern sal_uInt16 aGrfFmtCollSetRange[];
451 : // AttrSet-Range for TextNode
452 : SW_DLLPUBLIC extern sal_uInt16 aTxtNodeSetRange[];
453 : // AttrSet-Range for NoTxtNode
454 : extern sal_uInt16 aNoTxtNodeSetRange[];
455 : // AttrSet-Range for SwTable
456 : extern sal_uInt16 aTableSetRange[];
457 : // AttrSet-Range for SwTableLine
458 : extern sal_uInt16 aTableLineSetRange[];
459 : // AttrSet-Range for SwTableBox
460 : extern sal_uInt16 aTableBoxSetRange[];
461 : // AttrSet-Range for SwFrmFmt
462 : SW_DLLPUBLIC extern sal_uInt16 aFrmFmtSetRange[];
463 : // AttrSet-Range for SwCharFmt
464 : extern sal_uInt16 aCharFmtSetRange[];
465 : // AttrSet-Range for the autostyles
466 : extern sal_uInt16 aCharAutoFmtSetRange[];
467 : // AttrSet-Range for SwPageDescFmt
468 : extern sal_uInt16 aPgFrmFmtSetRange[];
469 :
470 : // check if ID is InRange of AttrSet-Ids
471 : bool IsInRange( const sal_uInt16* pRange, const sal_uInt16 nId );
472 :
473 : #endif
474 :
475 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
