xref: /aoo42x/main/sw/source/core/inc/node2lay.hxx (revision 1d2dbeb0)
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 _NODE2LAY_HXX
24 #define _NODE2LAY_HXX
25 
26 #include <tools/solar.h>
27 
28 /* -----------------23.02.99 11:33-------------------
29  * Die Klasse SwNode2Layout stellt die Verbindung von Nodes zum Layout her.
30  * Sie liefert einen intelligenten Iterator ueber die zum Node oder Nodebereich
31  * gehoerenden Frames. Je nach Zweck der Iteration, z.B. um vor oder hinter
32  * den Frames andere Frames einzufuegen, werden Master/Follows erkannt und nur
33  * die relevanten zurueckgegeben. Auch wiederholte Tabellenueberschriften werden
34  * beachtet.
35  * Es ist auch moeglich, ueber SectionNodes zu iterieren, die durch Schachtelung
36  * manchmal gar keinem SectionFrm direkt zugeordnet sind, manchmal aber sogar
37  * mehreren.
38  * SwNode2Layout ist ein Schnittstelle zwischen der aufrufenden Methode und
39  * einem SwClientIter, sie waehlt je nach Aufgabenstellung das richtige
40  * SwModify aus, erzeugt einen SwClientIter und filtert dessen Iterationen
41  * je nach Aufgabenstellung.
42  * Die Aufgabenstellung wird durch die Wahl des Ctors bestimmt.
43  * 1. Das Einsammeln der UpperFrms, damit spaeter RestoreUpperFrms wird,
44  * 	  wird von MakeFrms gerufen, wenn es keinen PrevNext gibt, vor/hinter den
45  * 	  die Frames gehaengt werden koennen.
46  * 2. Die Lieferung der Frames hinter/vor die die neuen Frames eines Nodes
47  * 	  gehaengt werden muessen, ebenfalls von MakeFrms gerufen.
48  * --------------------------------------------------*/
49 
50 class SwNode2LayImpl;
51 class SwFrm;
52 class SwLayoutFrm;
53 class SwNode;
54 class SwNodes;
55 class Point;
56 struct SwPosition;
57 
58 class SwNode2Layout
59 {
60 	SwNode2LayImpl *pImpl;
61 public:
62 	// Dieser Ctor ist zum Einsammeln der UpperFrms gedacht.
63 	SwNode2Layout( const SwNode& rNd );
64 	// Dieser Ctor ist fuer das Einfuegen vor oder hinter rNd gedacht,
65 	// nIdx ist der Index des einzufuegenden Nodes
66 	SwNode2Layout( const SwNode& rNd, sal_uLong nIdx );
67 	~SwNode2Layout();
68 	SwFrm* NextFrm();
69 	SwLayoutFrm* UpperFrm( SwFrm* &rpFrm, const SwNode& rNode );
70 	void RestoreUpperFrms( SwNodes& rNds, sal_uLong nStt, sal_uLong nEnd );
71 
72 	SwFrm *GetFrm( const Point* pDocPos = 0,
73 					const SwPosition *pPos = 0,
74 					const sal_Bool bCalcFrm = sal_True ) const;
75 };
76 
77 #endif
78