summaryrefslogtreecommitdiff
path: root/public/fpdf_save.h
blob: 0909d5a44703a2524ebd4f3e00d740fbc2b9d6dd (plain)
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
// Copyright 2014 PDFium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
 
// Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com

#ifndef _FPDFSAVE_H_
#define _FPDFSAVE_H_

#include "fpdfview.h"

#ifdef __cplusplus
extern "C" {
#endif


// Structure for custom file write
struct FPDF_FILEWRITE{

	//
	//Version number of the interface. Currently must be 1.
	//
	int version;

	// 
	// Method: WriteBlock
	//			Output a block of data in your custom way.
	// Interface Version:
	//			1
	// Implementation Required:
	//			Yes
	// Comments:
	//			Called by function FPDF_SaveDocument
	// Parameters:
	//			pThis		-	Pointer to the structure itself
	//			pData		-	Pointer to a buffer to output
	//			size		-	The size of the buffer.
	// Return value:
	//			Should be non-zero if successful, zero for error.
	//
	int		(*WriteBlock)( FPDF_FILEWRITE* pThis, const void* pData, unsigned long size);

};


/** @brief Incremental. */
#define FPDF_INCREMENTAL		1
/** @brief No Incremental. */
#define FPDF_NO_INCREMENTAL		2
/** @brief Remove security. */
#define FPDF_REMOVE_SECURITY	3

// Function: FPDF_SaveAsCopy
//			Saves the copy of specified document in custom way.
// Parameters:	
//			document		-	Handle to document. Returned by FPDF_LoadDocument and FPDF_CreateNewDocument.
//			pFileWrite		-	A pointer to a custom file write structure.
//			flags			-	The creating flags.
// Return value:
//			TRUE for succeed, FALSE for failed.
//
DLLEXPORT FPDF_BOOL STDCALL FPDF_SaveAsCopy(	FPDF_DOCUMENT document,FPDF_FILEWRITE * pFileWrite,
												FPDF_DWORD flags );

// Function: FPDF_SaveWithVersion
//			Same as function ::FPDF_SaveAsCopy, except the file version of the saved document could be specified by user.
// Parameters:	
//			document		-	Handle to document.
//			pFileWrite		-	A pointer to a custom file write structure.
//			flags			-	The creating flags.
//			fileVersion		-	The PDF file version. File version: 14 for 1.4, 15 for 1.5, ...
// Return value:
//			TRUE if succeed, FALSE if failed.
//
DLLEXPORT FPDF_BOOL STDCALL FPDF_SaveWithVersion(FPDF_DOCUMENT document,FPDF_FILEWRITE * pFileWrite,
	FPDF_DWORD flags, int fileVersion);

#ifdef __cplusplus
};
#endif

#endif //_FPDFSAVE_H_