sw/source/core/inc/node2lay.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: node2lay.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  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.
  17  *
  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).
  23  *
  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.
  28  *
  29  ************************************************************************/
  30 #ifndef _NODE2LAY_HXX
  31 #define _NODE2LAY_HXX
  32
  33 #include <tools/solar.h>
  34
  35 /* -----------------23.02.99 11:33-------------------
  36  * Die Klasse SwNode2Layout stellt die Verbindung von Nodes zum Layout her.
  37  * Sie liefert einen intelligenten Iterator ueber die zum Node oder Nodebereich
  38  * gehoerenden Frames. Je nach Zweck der Iteration, z.B. um vor oder hinter
  39  * den Frames andere Frames einzufuegen, werden Master/Follows erkannt und nur
  40  * die relevanten zurueckgegeben. Auch wiederholte Tabellenueberschriften werden
  41  * beachtet.
  42  * Es ist auch moeglich, ueber SectionNodes zu iterieren, die durch Schachtelung
  43  * manchmal gar keinem SectionFrm direkt zugeordnet sind, manchmal aber sogar
  44  * mehreren.
  45  * SwNode2Layout ist ein Schnittstelle zwischen der aufrufenden Methode und
  46  * einem SwClientIter, sie waehlt je nach Aufgabenstellung das richtige
  47  * SwModify aus, erzeugt einen SwClientIter und filtert dessen Iterationen
  48  * je nach Aufgabenstellung.
  49  * Die Aufgabenstellung wird durch die Wahl des Ctors bestimmt.
  50  * 1. Das Einsammeln der UpperFrms, damit spaeter RestoreUpperFrms wird,
  51  *        wird von MakeFrms gerufen, wenn es keinen PrevNext gibt, vor/hinter den
  52  *        die Frames gehaengt werden koennen.
  53  * 2. Die Lieferung der Frames hinter/vor die die neuen Frames eines Nodes
  54  *        gehaengt werden muessen, ebenfalls von MakeFrms gerufen.
  55  * --------------------------------------------------*/
  56
  57 class SwNode2LayImpl;
  58 class SwFrm;
  59 class SwLayoutFrm;
  60 class SwNode;
  61 class SwNodes;
  62 class Point;
  63 struct SwPosition;
  64
  65 class SwNode2Layout
  66 {
  67     SwNode2LayImpl *pImpl;
  68 public:
  69     // Dieser Ctor ist zum Einsammeln der UpperFrms gedacht.
  70     SwNode2Layout( const SwNode& rNd );
  71     // Dieser Ctor ist fuer das Einfuegen vor oder hinter rNd gedacht,
  72     // nIdx ist der Index des einzufuegenden Nodes
  73     SwNode2Layout( const SwNode& rNd, ULONG nIdx );
  74     ~SwNode2Layout();
  75     SwFrm* NextFrm();
  76     SwLayoutFrm* UpperFrm( SwFrm* &rpFrm, const SwNode& rNode );
  77     void RestoreUpperFrms( SwNodes& rNds, ULONG nStt, ULONG nEnd );
  78
  79     SwFrm *GetFrm( const Point* pDocPos = 0,
  80                     const SwPosition *pPos = 0,
  81                     const BOOL bCalcFrm = TRUE ) const;
  82 };
  83
  84 #endif