/usr/include/podofo/doc/PdfInfo.h is in libpodofo-dev 0.9.0-1.2+b2.
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 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 | /***************************************************************************
* 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. *
***************************************************************************/
#ifndef _PDF_INFO_H_
#define _PDF_INFO_H_
#include "podofo/base/PdfDefines.h"
#include "podofo/base/PdfName.h"
#include "PdfElement.h"
namespace PoDoFo {
class PdfString;
/** This class provides access to the documents
* info dictionary, which provides information
* about the PDF document.
*/
class PODOFO_DOC_API PdfInfo : public PdfElement {
public:
/**
* Enum to specifiy the initial information of the
* info dictionary.
*/
enum EPdfInfoInitial {
ePdfInfoInitial_WriteCreationTime = 0x01, ///< Write the creation time (current time). Default for new documents.
ePdfInfoInitial_WriteModificationTime = 0x02, ///< Write the modification time (current time). Default for loaded documents.
ePdfInfoInitial_WriteProducer = 0x04 ///< Write producer key. Default for new documents.
};
/** Create a new PdfInfo object
* \param pParent the parent of this object
* \param eInitial which information should be
* writting initially to the information dictionary
*/
PdfInfo( PdfVecObjects* pParent,
int eInitial = ePdfInfoInitial_WriteCreationTime | ePdfInfoInitial_WriteProducer );
/** Create a PdfInfo object from an existing
* object in the PDF file.
* \param pObject must be an info dictionary.
* \param eInitial which information should be
* writting initially to the information
*/
PdfInfo( PdfObject* pObject, int eInitial = ePdfInfoInitial_WriteModificationTime );
/** Destructor
*/
~PdfInfo();
/** Set the author of the document.
* \param sAuthor author
*/
void SetAuthor( const PdfString & sAuthor );
/** Get the author of the document
* \returns the author
*/
inline const PdfString & GetAuthor() const;
/** Set the creator of the document.
* Typically the name of the application using the library.
* \param sCreator creator
*/
void SetCreator( const PdfString & sCreator );
/** Get the creator of the document
* \returns the creator
*/
inline const PdfString & GetCreator() const;
/** Set keywords for this document
* \param sKeywords a list of keywords
*/
void SetKeywords( const PdfString & sKeywords );
/** Get the keywords of the document
* \returns the keywords
*/
inline const PdfString & GetKeywords() const;
/** Set the subject of the document.
* \param sSubject subject
*/
void SetSubject( const PdfString & sSubject );
/** Get the subject of the document
* \returns the subject
*/
inline const PdfString & GetSubject() const;
/** Set the title of the document.
* \param sTitle title
*/
void SetTitle( const PdfString & sTitle );
/** Get the title of the document
* \returns the title
*/
inline const PdfString & GetTitle() const;
// Peter Petrov 27 April 2008
/** Set the producer of the document.
* \param sProducer producer
*/
void SetProducer( const PdfString & sProducer );
// Peter Petrov 27 April 2008
/** Get the producer of the document
* \returns the producer
*/
inline const PdfString & GetProducer() const;
/** Set the trapping state of the document.
* \param sTrapped trapped
*/
void SetTrapped( const PdfName & sTrapped );
/** Get the trapping state of the document
* \returns the title
*/
inline const PdfName & GetTrapped() const;
private:
/** Add the initial document information to the dictionary.
* \param eInitial which information should be
* writting initially to the information
*/
void Init( int eInitial );
/** Get a value from the info dictionary as name
* \para rName the key to fetch from the info dictionary
* \return a value from the info dictionary
*/
const PdfString & GetStringFromInfoDict( const PdfName & rName ) const;
/** Get a value from the info dictionary as name
* \para rName the key to fetch from the info dictionary
* \return a value from the info dictionary
*/
const PdfName & GetNameFromInfoDict( const PdfName & rName ) const;
};
// -----------------------------------------------------
//
// -----------------------------------------------------
const PdfString & PdfInfo::GetAuthor() const
{
return this->GetStringFromInfoDict( PdfName("Author") );
}
// -----------------------------------------------------
//
// -----------------------------------------------------
const PdfString & PdfInfo::GetCreator() const
{
return this->GetStringFromInfoDict( PdfName("Creator") );
}
// -----------------------------------------------------
//
// -----------------------------------------------------
const PdfString & PdfInfo::GetKeywords() const
{
return this->GetStringFromInfoDict( PdfName("Keywords") );
}
// -----------------------------------------------------
//
// -----------------------------------------------------
const PdfString & PdfInfo::GetSubject() const
{
return this->GetStringFromInfoDict( PdfName("Subject") );
}
// -----------------------------------------------------
//
// -----------------------------------------------------
const PdfString & PdfInfo::GetTitle() const
{
return this->GetStringFromInfoDict( PdfName("Title") );
}
// -----------------------------------------------------
//
// -----------------------------------------------------
const PdfString & PdfInfo::GetProducer() const
{
return this->GetStringFromInfoDict( PdfName("Producer") );
}
// -----------------------------------------------------
//
// -----------------------------------------------------
const PdfName & PdfInfo::GetTrapped() const
{
return this->GetNameFromInfoDict( PdfName("Trapped") );
}
};
#endif // _PDF_INFO_H_
|