include/drawinglayer/primitive2d/structuretagprimitive2d.hxx

   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
  20 #ifndef INCLUDED_DRAWINGLAYER_PRIMITIVE2D_STRUCTURETAGPRIMITIVE2D_HXX
  21 #define INCLUDED_DRAWINGLAYER_PRIMITIVE2D_STRUCTURETAGPRIMITIVE2D_HXX
  22
  23 #include <drawinglayer/drawinglayerdllapi.h>
  24
  25 #include <drawinglayer/primitive2d/groupprimitive2d.hxx>
  26 #include <vcl/pdfwriter.hxx>
  27
  28 //////////////////////////////////////////////////////////////////////////////
  29
  30 namespace drawinglayer
  31 {
  32     namespace primitive2d
  33     {
  34         /** StructureTagPrimitive2D class
  35
  36             This class is used to provode simple support for adding grouped
  37             pdf writer structured element information like used in sd from
  38             unomodel.cxx where a ViewObjectContactRedirector is used to add
  39             such information for diverse objects.
  40             This primitive encapsulates these and the VCLPdfRenderer uses it
  41             to apply the needed infos directly to the pdf export in a compatible
  42             way.
  43             If a renderer ignores this, it just decomposes to it's child
  44             content.
  45          */
  46         class DRAWINGLAYER_DLLPUBLIC StructureTagPrimitive2D : public GroupPrimitive2D
  47         {
  48         private:
  49             /// the PDF structure element this grouping represents
  50             vcl::PDFWriter::StructElement           maStructureElement;
  51
  52         public:
  53             /// constructor
  54             StructureTagPrimitive2D(
  55                 const vcl::PDFWriter::StructElement& rStructureElement,
  56                 const Primitive2DSequence& rChildren);
  57
  58             /// data read access
  59             const vcl::PDFWriter::StructElement& getStructureElement() const { return maStructureElement; }
  60
  61             /// provide unique ID
  62             DeclPrimitive2DIDBlock()
  63         };
  64     } // end of namespace primitive2d
  65 } // end of namespace drawinglayer
  66
  67 //////////////////////////////////////////////////////////////////////////////
  68
  69 #endif //INCLUDED_DRAWINGLAYER_PRIMITIVE2D_STRUCTURETAGPRIMITIVE2D_HXX
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */