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
|
/*
* Copyright (C) 2003 Stefan Kleine Stegemann
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU 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 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 _H_PDF_DOCUMENT
#define _H_PDF_DOCUMENT
#include <Foundation/NSObject.h>
#include <Foundation/NSString.h>
#include <Foundation/NSGeometry.h>
#include <PDFKit/PDFOutline.h>
@class PDFSearchContext;
/**
* Provides a wrapper for an XPDF PDFDoc object. Such
* an object provides access to the meta-data of a
* PDF document as well as to the document content.
*/
@interface PDFDocument : NSObject
{
id pdfDocRef;
PDFOutline* outline;
}
- (id) init;
- (void) dealloc;
+ (void) initialize;
/* Create a new PDF Document from an input file.
* If the document could not be created, an invalid
* Document is returned (isOk returns NO). Use errorCode
* to get the reason of the failure.
* All returned objects are autoreleased. */
+ (PDFDocument*)documentFromFile: (NSString*)fileName;
+ (PDFDocument*)documentFromFile: (NSString*)fileName
ownerPassword: (NSString*)ownerPassword
userPassword: (NSString*)userPassword;
- (BOOL) isOk;
- (int) errorCode;
- (double) pageWidth: (int)pageNum;
- (double) pageHeight: (int)pageNum;
- (NSSize) pageSize: (int)pageNum considerRotation: (BOOL)rotation;
- (int) pageRotate: (int)pageNum;
- (int) countPages;
/** Returns nil if no MetaData is available
* otherwise an autoreleases string object. */
- (NSString*) metaData;
- (BOOL) hasOutline;
- (PDFOutline*) outline;
/** It is recommened to use the search-context based
* methods. */
- (BOOL) findText: (NSString*)text
page: (int*)pageNum
toPage: (int)maxPage
position: (NSRect*)pos
context: (NSString**)context;
/** Create a search context for the receiver. Using a search
* context can speed up a search if the document is searched
* for text subsequently. */
- (PDFSearchContext*) createSearchContext;
/** Find the next occurence of a text fragment starting a the
* specified position. If a match was found, the method returns
* YES and aTextContext contains the text around the occurence of
* the text fragment. Otherwise NO is returned and aTextContext is
* undefined. */
- (BOOL) findText: (NSString*)aText
usingSearchContext: (PDFSearchContext*)aSearchContext
page: (int*)pageNum
toPage: (int)maxPage
position: (NSRect*)pos
textContext: (NSString**)aTextContext;
- (NSString*) getTextAtPage: (int)pageNum inRect: (NSRect)pos;
@end
/**
* A search context holds some data to improve the speed
* of subsequent searches in the same document. There is
* no need for the programmer to know what's going on
* inside.
*/
@interface PDFSearchContext : NSObject
{
void* theSearchContext;
PDFDocument* theDocument;
}
/** Initialize a search context for use with a specific
* PDFDocument. The receiver does not retain the document. */
- (id) initWithDocument: (PDFDocument*)aDocument;
/** Get the document the receiver is associated to. */
- (PDFDocument*) document;
@end
/**
* Only for internal usage.
*/
@interface PDFDocument(Wrapper)
/** Returns the internal wrapped object. */
- (void*) xpdfobject;
@end
#endif
|
