xref: /aoo4110/main/sw/inc/swtypes.hxx (revision b1cdbd2c)
1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 #ifndef _SWTYPES_HXX
24 #define _SWTYPES_HXX
25 #include <tools/solar.h>
26 #include <SwGetPoolIdFromName.hxx>
27 
28 #ifndef INCLUDED_LIMITS_H
29 #include <limits.h> 	//fuer LONG_MAX
30 #define INCLUDED_LIMITS_H
31 #endif
32 
33 #ifdef PM20
34 #include <stdlib.h>
35 #endif
36 #include <com/sun/star/uno/Reference.h>
37 #include "swdllapi.h"
38 #include <i18npool/lang.h>
39 // wenn das hier geaendert wird, dann auch im globals.hrc aendern!!!
40 //#define SW_FILEFORMAT_40 SOFFICE_FILEFORMAT_40
41 
42 namespace com { namespace sun { namespace star {
43 	namespace linguistic2{
44 		class XDictionaryList;
45 		class XSpellChecker1;
46 		class XHyphenator;
47 		class XThesaurus;
48 	}
49 	namespace beans{
50 		class XPropertySet;
51 	}
52 }}}
53 namespace utl{
54 	class TransliterationWrapper;
55 }
56 
57 class Size;
58 class ResMgr;
59 class UniString;
60 class ByteString;
61 class SwPathFinder;
62 class Graphic;
63 class OutputDevice;
64 class CharClass;
65 class LocaleDataWrapper;
66 class CollatorWrapper;
67 
68 typedef long SwTwips;
69 #define INVALID_TWIPS	LONG_MAX
70 #define TWIPS_MAX		(LONG_MAX - 1)
71 
72 #define MM50   283	// 1/2 cm in TWIPS
73 // --> OD 2004-06-18 #i19922# - constant for minimal page header/footer height of 1mm
74 const SwTwips cMinHdFtHeight = 56;
75 
76 #define MINFLY 23	//Minimalgroesse fuer FlyFrms
77 #define MINLAY 23	//Minimalgroesse anderer Frms
78 
79 // Default-Spaltenabstand zweier Textspalten entspricht 0.3 cm
80 #define DEF_GUTTER_WIDTH (MM50 / 5 * 3)
81 
82 //Minimale Distance (Abstand zum Text) fuer das BorderAttribut, damit
83 //die aligned'en Linien nicht geplaettet werden.
84 //28 Twips == 0,4mm
85 #define MIN_BORDER_DIST 28
86 
87 	/* minimaler Dokmentrand */
88 const SwTwips lMinBorder = 1134;
89 
90 //Die Wiesenbreite links neben und ueber dem Dokument.
91 //Die halbe Wiesenbreite ist der Abstand zwischen den Seiten.
92 #define DOCUMENTBORDER  568L
93 #define GAPBETWEENPAGES 284L
94 
95 //initiale UndoActionCount
96 #define UNDO_ACTION_COUNT 20
97 
98 // Konstante Strings
99 SW_DLLPUBLIC extern UniString aEmptyStr;			// ""
100 extern ByteString aEmptyByteStr;	// ""
101 SW_DLLPUBLIC extern UniString aDotStr;			// '.'
102 
103 //Zum Einfuegen von Beschriftungen (wie bzw. wo soll eingefuegt werden).
104 //Hier weil ein eigenes hxx nicht lohnt und es sonst nirgendwo so recht
105 //hinpasst.
106 enum SwLabelType
107 {
108 	LTYPE_TABLE,	//Beschriftung einer Tabelle
109 	LTYPE_OBJECT,	//Beschriftung von Grafik oder OLE
110 	LTYPE_FLY,		//Beschriftung eines (Text-)Rahmens
111 	LTYPE_DRAW		//Beschriftung eines Zeichen-Objektes
112 };
113 
114 
115 const sal_uInt8 OLD_MAXLEVEL = 5;
116 const sal_uInt8 MAXLEVEL = 10;		//Ehemals numrule.hxx
117 const sal_uInt8 NO_NUM 		= 200;  //Ehemals numrule.hxx
118 //const sal_uInt8 NO_NUMBERING = 201;  //Ehemals numrule.hxx	//#outline level,removed by zhaojianwei
119 //const sal_uInt8 NO_INIT 		= 202;  //Ehemals numrule.hxx
120 
121 // fuer Absaetze mit NO_NUM aber auf unterschiedlichen Leveln
122 // DAMIT entfaellt das NO_NUM !!!!
123 const sal_uInt8 NO_NUMLEVEL  = 0x20;	// wird mit den Levels verodert
124 
125 
126 /*
127  * Nette Funktionen als MACRO oder inline
128  */
129 
130 /* ein KiloByte sind 1024 Byte */
131 #define KB 1024
132 
133 #define SET_CURR_SHELL( shell ) CurrShell aCurr( shell )
134 
135 // pPathFinder wird von der UI initialisiert. Die Klasse liefert alle
136 // benoetigten Pfade.
137 extern SwPathFinder *pPathFinder;
138 
139 // Werte fuer die Einzuege an der Nummerierung und BulletListe
140 // (fuer die weiteren Ebenen sind die Werte mit den Ebenen+1 zu
141 //	multiplizieren; Ebenen 0..4 !!!)
142 
143 // -> #i30312#
144 const sal_uInt16 lBullIndent = 1440/4;
145 const short lBullFirstLineOffset = -lBullIndent;
146 const sal_uInt16 lNumIndent = 1440/4;
147 const short lNumFirstLineOffset = -lNumIndent;
148 const short lOutlineMinTextDistance = 216; // 0.15 inch = 0.38 cm
149 // <- #i30312#
150 
151 // Anzahl der SystemField-Types vom SwDoc
152 #define INIT_FLDTYPES	32
153 // Anzahl der vordefinierten Seq-Feldtypen. Es handelt sich dabei
154 // immer um die letzen Felder vor INIT_FLDTYPES
155 #define INIT_SEQ_FLDTYPES	4
156 
157 //Die ehemaligen Rendevouz-Ids leben weiter:
158 //Es gibt Ids fuer die Anker (SwFmtAnchor) und ein paar weitere die nur fuer
159 //Schnittstellen Bedeutung haben (SwDoc).
160 enum RndStdIds
161 {
162     FLY_AT_PARA,        // anchored at paragraph
163     FLY_AS_CHAR,        // anchored as character
164     FLY_AT_PAGE,        // anchored at page
165     FLY_AT_FLY,         // anchored at frame
166     FLY_AT_CHAR,        // anchored at character
167 						//Der Rest wird nur fuer SS benutzt.
168 	RND_STD_HEADER,
169 	RND_STD_FOOTER,
170 	RND_STD_HEADERL,
171 	RND_STD_HEADERR,
172 	RND_STD_FOOTERL,
173 	RND_STD_FOOTERR,
174 
175 	RND_DRAW_OBJECT		// ein Draw-Object !! nur fuer die SwDoc-Schnittstelle!
176 };
177 
178 
179 extern ResMgr* pSwResMgr;			// steht in swapp0.cxx
180 #define SW_RES(i)		ResId(i,*pSwResMgr)
181 #define SW_RESSTR(i)	UniString(ResId(i,*pSwResMgr))
182 
183 ::com::sun::star::uno::Reference<
184 	::com::sun::star::linguistic2::XSpellChecker1 >	GetSpellChecker();
185 ::com::sun::star::uno::Reference<
186 	::com::sun::star::linguistic2::XHyphenator >	GetHyphenator();
187 ::com::sun::star::uno::Reference<
188 	::com::sun::star::linguistic2::XThesaurus >		GetThesaurus();
189 ::com::sun::star::uno::Reference<
190 	::com::sun::star::beans::XPropertySet >			GetLinguPropertySet();
191 
192 // reutns the twip size of this graphic
193 SW_DLLPUBLIC Size GetGraphicSizeTwip( const Graphic&, OutputDevice* pOutDev );
194 
195 
196 // Seperator fuer Sprunge im Dokument auf verschiedene Inhalttype
197 const sal_Unicode cMarkSeperator = '|';
198 extern const sal_Char* __FAR_DATA pMarkToTable;				// Strings stehen
199 extern const sal_Char* __FAR_DATA pMarkToFrame;             // im Init.cxx
200 extern const sal_Char* __FAR_DATA pMarkToRegion;
201 SW_DLLPUBLIC extern const sal_Char* __FAR_DATA pMarkToOutline;
202 extern const sal_Char* __FAR_DATA pMarkToText;
203 extern const sal_Char* __FAR_DATA pMarkToGraphic;
204 extern const sal_Char* __FAR_DATA pMarkToOLE;
205 
206 #ifndef DB_DELIM							// Ist in OFA definiert!!!
207 #define DB_DELIM ((sal_Unicode)0xff)		// Datenbank <-> Tabellen-Trenner
208 #endif
209 
210 
211 typedef sal_uInt16 SetAttrMode;
212 
213 namespace nsSetAttrMode
214 {
215 	const SetAttrMode SETATTR_DEFAULT        = 0x0000;	// default
216 	const SetAttrMode SETATTR_DONTEXPAND 	 = 0x0001;	// TextAttribute nicht weiter expand.
217 	const SetAttrMode SETATTR_DONTREPLACE	 = 0x0002;	// kein anderes TextAttrib verdraengen
218 
219 	const SetAttrMode SETATTR_NOTXTATRCHR	 = 0x0004;	// bei Attr ohne Ende kein 0xFF einfuegen
220 	const SetAttrMode SETATTR_NOHINTADJUST	 = 0x0008; 	// keine Zusammenfassung von Bereichen.
221 	const SetAttrMode SETATTR_NOFORMATATTR	 = 0x0010;	// nicht zum FormatAttribut umwandeln
222 	const SetAttrMode SETATTR_DONTCHGNUMRULE = 0x0020; 	// nicht die NumRule veraendern
223 	const SetAttrMode SETATTR_APICALL		 = 0x0040;	// called from API (all UI related
224 										                // functionality will be disabled)
225     /// force hint expand (only matters for hints with CH_TXTATR)
226     const SetAttrMode SETATTR_FORCEHINTEXPAND= 0x0080;
227     /// the inserted item is a copy -- intended for use in ndtxt.cxx
228     const SetAttrMode SETATTR_IS_COPY        = 0x0100;
229 }
230 
231 //Umrechnung Twip<-> 1/100 mm fuer UNO
232 
233 #define TWIP_TO_MM100(TWIP) 	((TWIP) >= 0 ? (((TWIP)*127L+36L)/72L) : (((TWIP)*127L-36L)/72L))
234 #define MM100_TO_TWIP(MM100)	((MM100) >= 0 ? (((MM100)*72L+63L)/127L) : (((MM100)*72L-63L)/127L))
235 #define TWIP_TO_MM100_UNSIGNED(TWIP)     ((((TWIP)*127L+36L)/72L))
236 #define MM100_TO_TWIP_UNSIGNED(MM100)    ((((MM100)*72L+63L)/127L))
237 
238 #define SW_ISPRINTABLE( c ) ( c >= ' ' && 127 != c )
239 
240 #ifndef SW_CONSTASCII_DECL
241 #define SW_CONSTASCII_DECL( n, s ) n[sizeof(s)]
242 #endif
243 #ifndef SW_CONSTASCII_DEF
244 #define SW_CONSTASCII_DEF( n, s ) n[sizeof(s)] = s
245 #endif
246 
247 
248 #define CHAR_HARDBLANK		((sal_Unicode)0x00A0)
249 #define CHAR_HARDHYPHEN		((sal_Unicode)0x2011)
250 #define CHAR_SOFTHYPHEN		((sal_Unicode)0x00AD)
251 #define CHAR_RLM            ((sal_Unicode)0x200F)
252 #define CHAR_LRM            ((sal_Unicode)0x200E)
253 #define CHAR_ZWSP           ((sal_Unicode)0x200B)
254 #define CHAR_ZWNBSP         ((sal_Unicode)0x2060)
255 
256 
257 // returns the APP - CharClass instance - used for all ToUpper/ToLower/...
258 SW_DLLPUBLIC CharClass& GetAppCharClass();
259 SW_DLLPUBLIC LanguageType GetAppLanguage();
260 
261 
262 #if 0
263 // I18N doesn't get this right, can't specify more than one to ignore
264 #define SW_COLLATOR_IGNORES ( \
265 	::com::sun::star::i18n::CollatorOptions::CollatorOptions_IGNORE_CASE | \
266 	::com::sun::star::i18n::CollatorOptions::CollatorOptions_IGNORE_KANA | \
267 	::com::sun::star::i18n::CollatorOptions::CollatorOptions_IGNORE_WIDTH )
268 #else
269 #define SW_COLLATOR_IGNORES ( \
270 	::com::sun::star::i18n::CollatorOptions::CollatorOptions_IGNORE_CASE )
271 #endif
272 
273 SW_DLLPUBLIC CollatorWrapper& GetAppCollator();
274 SW_DLLPUBLIC CollatorWrapper& GetAppCaseCollator();
275 
276 SW_DLLPUBLIC const ::utl::TransliterationWrapper& GetAppCmpStrIgnore();
277 
278 // --> OD 2004-06-30 #i28701# - moved from <frame.hxx>
279 //fuer Prepare() zur Benachrichtigung des Inhaltes durch das Layout auf
280 //dem kurzen Dienstweg.
281 //Der Inhalt sorgt dafuer, dass beim naechsten Aufruf von ::Format() das
282 //minimal notwendige berechnet wird.
283 enum PrepareHint
284 {
285     PREP_BEGIN,             //BEGIN
286     PREP_CLEAR = PREP_BEGIN,//Komplett neuformatieren.
287     PREP_WIDOWS_ORPHANS,    //Nur Witwen- und Waisen-Regelung pruefen und ggf.
288                             //Aufspalten.
289     PREP_FIXSIZE_CHG,       //Die FixSize hat sich veraendert.
290     PREP_FOLLOW_FOLLOWS,    //Follow ist jetzt moeglicherweise direkter
291                             //Nachbar.
292     PREP_ADJUST_FRM,        //Groesse per Grow/Shrink Ausrichten ohne zu
293                             //Formatieren.
294     PREP_FLY_CHGD,          //Ein FlyFrm hat sich (Groesse) veraendert.
295     PREP_FLY_ATTR_CHG,      //Ein FlyFrm hat seine Attribute veraendert
296                             //(z.B. Umlauf)
297     PREP_FLY_ARRIVE,        //Ein FlyFrm ueberlappt den Bereich jetzt neu.
298     PREP_FLY_LEAVE,         //Ein FlyFrm hat den Bereich verlassen.
299     PREP_FTN,               //Fussnoten-Invalidierung
300     PREP_POS_CHGD,          //Position des Frm hat sich verandert
301                             //(Zum Fly-Umbruch pruefen). Im void* des Prepare()
302                             //wird ein sal_Bool& uebergeben, dieser zeigt mit sal_True,
303                             //dass ein Format ausgefuehrt wurde.
304     PREP_UL_SPACE,          //UL-Space hat sich veraendert, TxtFrms muessen
305                             //den Zeilenabstand neu kalkulieren.
306     PREP_MUST_FIT,          //Frm passen machen (aufspalten) auch wenn die
307                             //Attribute es nicht erlauben (z.B. zusammenhalten).
308     PREP_WIDOWS,            // Ein Follow stellt fest, dass in ihm die Orphans-
309                             // regel zuschlaegt und verschickt an seinen
310                             // Vorgaenger (Master/Follow) ein PREP_WIDOWS
311     PREP_QUOVADIS,          // Wenn eine Fussnote _zwischen_ zwei Absaetzen
312                             // aufgespalten werden muss, dann muss der
313                             // letzte auf der Seite noch ein QUOVADIS bekommen
314                             // damit er den Text hineinformatiert.
315     PREP_BOSS_CHGD,         // Wenn ein Frm die Spalte/Seite wechselt, wird dieses
316                             // Zusatzprepare zum POS_CHGD im MoveFwd/Bwd
317                             // verschickt (Ftn-Nummern joinen etc.)
318                             // Die Richtung wird ueber pVoid mitgeteilt:
319                             //     MoveFwd: pVoid == 0
320                             //     MoveBwd: pVoid == pOldPage
321     PREP_SWAP,              //Grafiken Swappen, fuer Grafiken im sichtbaren
322                             //Bereich.
323     PREP_REGISTER,          //Registerhaltige Frames invalidieren
324     PREP_FTN_GONE,          //Ein Follow verliert eine Fussnote, ggf. kann seine erste
325                             //Zeile hochrutschen
326     PREP_MOVEFTN,           //eine Fussnote wechselt die Seite, der Inhalt bekommt
327                             //zunaechst eine Hoehe von Null, damit nicht zuviel
328                             //Unruhe entsteht. Beim Formatieren prueft er, ob er
329                             //ueberhaupt passt und wechselt ggf. unbemerkt wieder
330                             //die Seite.
331     PREP_ERGOSUM,           //wg. Bewegung in FtnFrms QuoVadis/ErgoSum pruefen
332     PREP_END                //END
333 };
334 // <--
335 
336 #endif
337