sdext/source/pdfimport/tree/treevisiting.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: treevisiting.hxx,v $
  10  *
  11  * $Revision: 1.2 $
  12  *
  13  * This file is part of OpenOffice.org.
  14  *
  15  * OpenOffice.org is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU Lesser General Public License version 3
  17  * only, as published by the Free Software Foundation.
  18  *
  19  * OpenOffice.org is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Lesser General Public License version 3 for more details
  23  * (a copy is included in the LICENSE file that accompanied this code).
  24  *
  25  * You should have received a copy of the GNU Lesser General Public License
  26  * version 3 along with OpenOffice.org.  If not, see
  27  * <http://www.openoffice.org/license.html>
  28  * for a copy of the LGPLv3 License.
  29  *
  30  ************************************************************************/
  31
  32 #ifndef INCLUDED_PDFI_TREEVISITING_HXX
  33 #define INCLUDED_PDFI_TREEVISITING_HXX
  34
  35 #include <sal/config.h>
  36 #include <list>
  37
  38
  39 namespace pdfi
  40 {
  41     class  PDFIProcessor;
  42     class  StyleContainer;
  43     struct HyperlinkElement;
  44     struct TextElement;
  45     struct ParagraphElement;
  46     struct FrameElement;
  47     struct PolyPolyElement;
  48     struct ImageElement;
  49     struct PageElement;
  50     struct DocumentElement;
  51     struct EmitContext;
  52     struct Element;
  53
  54     /** To be visited by all tree element types
  55
  56         Visitor interface from the "visitor pattern". Implementor gets
  57         called with actual tree node instances.
  58      */
  59     struct ElementTreeVisitor
  60     {
  61         virtual void visit( HyperlinkElement&, const std::list< Element* >::const_iterator& ) = 0;
  62         virtual void visit( TextElement&, const std::list< Element* >::const_iterator&  ) = 0;
  63         virtual void visit( ParagraphElement&, const std::list< Element* >::const_iterator&  ) = 0;
  64         virtual void visit( FrameElement&, const std::list< Element* >::const_iterator&  ) = 0;
  65         virtual void visit( PolyPolyElement&, const std::list< Element* >::const_iterator&  ) = 0;
  66         virtual void visit( ImageElement&, const std::list< Element* >::const_iterator&  ) = 0;
  67         virtual void visit( PageElement&, const std::list< Element* >::const_iterator&  ) = 0;
  68         virtual void visit( DocumentElement&, const std::list< Element* >::const_iterator&  ) = 0;
  69     };
  70     typedef boost::shared_ptr<ElementTreeVisitor> ElementTreeVisitorSharedPtr;
  71
  72     /** Visitee interface
  73
  74         To be implemented by every tree node that needs to be
  75         visitable.
  76      */
  77     struct ElementTreeVisitable
  78     {
  79         virtual void visitedBy( ElementTreeVisitor&, const std::list< Element* >::const_iterator& rParentIt ) = 0;
  80     };
  81     typedef boost::shared_ptr<ElementTreeVisitable> ElementTreeVisitableSharedPtr;
  82 }
  83
  84 #endif