/usr/include/podofo/doc/PdfElement.h is in libpodofo-dev 0.9.5-9.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 | /***************************************************************************
* Copyright (C) 2006 by Dominik Seichter *
* domseichter@web.de *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU Library General Public License as *
* published by the Free Software Foundation; either version 2 of the *
* License, or (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU Library General Public *
* License along with this program; if not, write to the *
* Free Software Foundation, Inc., *
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
* *
* In addition, as a special exception, the copyright holders give *
* permission to link the code of portions of this program with the *
* OpenSSL library under certain conditions as described in each *
* individual source file, and distribute linked combinations *
* including the two. *
* You must obey the GNU General Public License in all respects *
* for all of the code used other than OpenSSL. If you modify *
* file(s) with this exception, you may extend this exception to your *
* version of the file(s), but you are not obligated to do so. If you *
* do not wish to do so, delete this exception statement from your *
* version. If you delete this exception statement from all source *
* files in the program, then also delete it here. *
***************************************************************************/
#ifndef _PDF_ELEMENT_H_
#define _PDF_ELEMENT_H_
#include "podofo/base/PdfDefines.h"
#include "podofo/base/PdfObject.h"
namespace PoDoFo {
class PdfStreamedDocument;
class PdfVecObjects;
/** PdfElement is a common base class for all elements
* in a PDF file. For example pages, action and annotations.
*
* Every PDF element has one PdfObject and provides an easier
* interface to modify the contents of the dictionary.
*
* A PdfElement base class can be created from an existing PdfObject
* or created from scratch. In the later case, the PdfElement creates
* a PdfObject and adds it to a vector of objects.
*
* A PdfElement cannot be created directly. Use one
* of the subclasses which implement real functionallity.
*
* \see PdfPage \see PdfAction \see PdfAnnotation
*/
class PODOFO_DOC_API PdfElement {
public:
virtual ~PdfElement();
/** Get access to the internal object
* \returns the internal PdfObject
*/
inline PdfObject* GetObject();
/** Get access to the internal object
* This is an overloaded member function.
*
* \returns the internal PdfObject
*/
inline const PdfObject* GetObject() const;
protected:
/** Creates a new PdfElement
* \param pszType type entry of the elements object
* \param pParent parent vector of objects.
* Add a newly created object to this vector.
*/
PdfElement( const char* pszType, PdfVecObjects* pParent );
/** Creates a new PdfElement
* \param pszType type entry of the elements object
* \param pParent parent PdfDocument.
* Add a newly created object to this vector.
*/
PdfElement( const char* pszType, PdfDocument* pParent );
/** Create a PdfElement from an existing PdfObject
* The object must be a dictionary.
*
* \param pszType type entry of the elements object.
* Throws an exception if the type in the
* PdfObject differs from pszType.
* \param pObject pointer to the PdfObject that is modified
* by this PdfElement
*/
PdfElement( const char* pszType, PdfObject* pObject );
/** Create a PdfElement from an existing PdfObject
* The object might be of any data type,
* PdfElement will throw an exception if the PdfObject
* if not of the same datatype as the expected one.
* This is necessary in rare cases. E.g. in PdfContents.
*
* \param eExpectedDataType the expected datatype of this object
* \param pObject pointer to the PdfObject that is modified
* by this PdfElement
*/
PdfElement( EPdfDataType eExpectedDataType, PdfObject* pObject );
/** Convert an enum or index to its string representation
* which can be written to the PDF file.
*
* This is a helper function for various PdfElement
* subclasses that need strings and enums for their
* SubTypes keys.
*
* \param i the index or enum value
* \param ppTypes an array of strings containing
* the string mapping of the index
* \param lLen the length of the string array
*
* \returns the string representation or NULL for
* values out of range
*/
const char* TypeNameForIndex( int i, const char** ppTypes, long lLen ) const;
/** Convert a string type to an array index or enum.
*
* This is a helper function for various PdfElement
* subclasses that need strings and enums for their
* SubTypes keys.
*
* \param pszType the type as string
* \param ppTypes an array of strings containing
* the string mapping of the index
* \param lLen the length of the string array
* \param nUnknownValue the value that is returned when the type is unknown
*
* \returns the index of the string in the array
*/
int TypeNameToIndex( const char* pszType, const char** ppTypes, long lLen, int nUnknownValue ) const;
/** Create a PdfObject in the parent of this PdfElement which
* might either be a PdfStreamedDocument, a PdfDocument or
* a PdfVecObjects
*
* Use this function in an own subclass of PdfElement to create new
* PdfObjects.
*
* \param pszType an optional /Type key of the created object
*
* \returns a PdfObject which is owned by the parent
*/
PdfObject* CreateObject( const char* pszType = NULL );
/** Get access to the internal object.
* Use this method if you need access to the internal
* object in a const-method without having to do a const cast.
*
* \returns the internal PdfObject
*/
inline PdfObject* GetNonConstObject() const;
private:
PdfObject* m_pObject;
};
// -----------------------------------------------------
//
// -----------------------------------------------------
inline PdfObject* PdfElement::GetObject()
{
return m_pObject;
}
// -----------------------------------------------------
//
// -----------------------------------------------------
inline const PdfObject* PdfElement::GetObject() const
{
return m_pObject;
}
// -----------------------------------------------------
//
// -----------------------------------------------------
inline PdfObject* PdfElement::GetNonConstObject() const
{
return const_cast<PdfElement*>(this)->m_pObject;
}
};
#endif // PDF_ELEMENT_H_
|