-
Notifications
You must be signed in to change notification settings - Fork 3
/
listing1.html
executable file
·381 lines (310 loc) · 16.7 KB
/
listing1.html
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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<!-- BEGIN META TAG INFO -->
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<link rel="home" href="http://developer.apple.com/">
<link rel="find" href="http://developer.apple.com/search/">
<link rel="stylesheet" type="text/css" href="../../documentation/css/adcstyle.css" title="fonts">
<script language="JavaScript" src="../../documentation/js/adc.js" type="text/javascript"></script>
<!-- END META TAG INFO -->
<!-- BEGIN TITLE -->
<title>Aperture Image Resizer - /ApertureHeaders/ApertureExportManager.h</title>
<!-- END TITLE -->
<script language="JavaScript">
function JumpToNewPage() {
window.location=document.scpopupmenu.gotop.value;
return true;
}
</script>
</head>
<!-- BEGIN BODY OPEN -->
<body>
<!--END BODY OPEN -->
<!-- START CENTER OPEN -->
<center>
<!-- END CENTER OPEN -->
<!-- BEGIN LOGO AND SEARCH -->
<!--#include virtual="/includes/adcnavbar"-->
<!-- END LOGO AND SEARCH -->
<!-- START BREADCRUMB -->
<div id="breadcrumb">
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr>
<td scope="row"><img width="340" height="10" src="images/1dot.gif" alt=""></td>
<td><img width="340" height="10" src="images/1dot.gif" alt=""></td>
</tr>
<tr valign="middle">
<td align="left" colspan="2">
<a href="http://developer.apple.com/">ADC Home</a> > <a href="../../referencelibrary/index.html">Reference Library</a> > <a href="../../samplecode/index.html">Sample Code</a> > <a href="../../samplecode/AppleApplications/index.html">Apple Applications</a> > <a href="../../samplecode/AppleApplications/idxAperture-date.html">Aperture</a> > <A HREF="javascript:location.replace('index.html');">Aperture Image Resizer</A> >
</td>
</tr>
<tr>
<td colspan="2" scope="row"><img width="680" height="35" src="images/1dot.gif" alt=""></td>
</tr>
</table>
</div>
<!-- END BREADCRUMB -->
<!-- START MAIN CONTENT -->
<!-- START TITLE GRAPHIC AND INTRO-->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td><h1><div id="pagehead">Aperture Image Resizer</div></h1></td>
</tr>
</table>
<!-- END TITLE GRAPHIC AND INTRO -->
<!-- START WIDE COLUMN -->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td id="scdetails">
<h2>/ApertureHeaders/ApertureExportManager.h</h2>
<form name="scpopupmenu" onSubmit="return false;" method=post>
<p><strong>View Source Code:</strong>
<select name="gotop" onChange="JumpToNewPage();" style="width:340px"><option selected value="ingnore">Select File</option>
<option value="listing1.html">/ApertureHeaders/ApertureExportManager.h</option>
<option value="listing2.html">/ApertureHeaders/ApertureExportPlugIn.h</option>
<option value="listing3.html">/Resizer.h</option>
<option value="listing4.html">/Resizer.m</option></select>
</p>
</form>
<p><strong><a href="ApertureResizer.zip">Download Sample</a></strong> (“ApertureResizer.zip”, 25.6K)<BR>
<strong><a href="ApertureResizer.dmg">Download Sample</a></strong> (“ApertureResizer.dmg”, 82.7K)</p>
<!--
<p><strong><a href="#">Download Sample</a></strong> (“filename.sit”, 500K)</p>
-->
</td>
</tr>
<tr>
<td scope="row"><img width="680" height="10" src="images/1dot.gif" alt=""><br>
<img height="1" width="680" src="images/1dot_919699.gif" alt=""><br>
<img width="680" height="20" src="images/1dot.gif" alt=""></td>
</tr>
<tr>
<td scope="row">
<!--googleon: index -->
<pre class="sourcecodebox">/*!
@header ApertureExportManager.h
@copyright 2006 Apple Computer, Inc. All rights reserved.
@abstract Version 2 of the protocol declaration for Aperture's export interface.
@discussion An Aperture export plug-in uses these methods to control the export process. Version 2 supported by Aperture 1.5.1 and later.
*/
/*!
@define kExportKeyThumbnailImage
@discussion An NSImage object containing a reduced-size JPEG of the specified image. Note that values may be nil for this key for master images, or for versions of unsupported master formats.
*/
#define kExportKeyThumbnailImage @"kExportKeyThumbnailImage"
/*!
@define kExportKeyVersionName
@discussion An NSString containing the version name of the selected image.
*/
#define kExportKeyVersionName @"kExportKeyVersionName"
/*!
@define kExportKeyProjectName
@discussion An NSString containing the name of the project containing the image.
*/
#define kExportKeyProjectName @"kExportKeyProjectName"
/*!
@define kExportKeyEXIFProperties
@discussion An NSDictionary containing the EXIF key-value pairs for the image.
*/
#define kExportKeyEXIFProperties @"kExportKeyEXIFProperties"
/*!
@define kExportKeyIPTCProperties
@discussion An NSDictionary containing all the IPTC key-value pairs for the image.
*/
#define kExportKeyIPTCProperties @"kExportKeyIPTCProperties"
/*!
@define kExportKeyCustomProperties
@discussion An NSDictionary containing all the Custom Metadata key-value pairs for the image.
*/
#define kExportKeyCustomProperties @"kExportKeyCustomProperties"
/*!
@define kExportKeyKeywords
@discussion An NSArray containing an NSString for each keyword for this image.
*/
#define kExportKeyKeywords @"kExportKeyKeywords"
/* New in version 2 of the ApertureExportManager protocol. */
/*!
@define kExportKeyHierarchicalKeywords
@discussion New in version 2 of the ApertureExportManager protocol. Supported by Aperture 1.5.1 and later. An NSArray containing hierarchical keywords. Each entry in the array represents a single keyword and is itself an NSArray of NSStrings. Each hierarchy array starts with the keyword itself at index 0, followed by its parent, and so on.
*/
#define kExportKeyHierarchicalKeywords @"kExportKeyHierarchicalKeywords"
/*!
@define kExportKeyMainRating
@discussion An NSNumber representing the rating for this image.
*/
#define kExportKeyMainRating @"kExportKeyMainRating"
/*!
@define kExportKeyXMPString
@discussion An NSString containing the XMP data for the original master of this image.
*/
#define kExportKeyXMPString @"kExportKeyXMPString"
/*!
@define kExportKeyReferencedMasterPath
@discussion An NSString containing the absolute path to the master image file. If the image is not referenced (i.e. the master is inside the Aperture Library bundle), then this value is nil.
*/
#define kExportKeyReferencedMasterPath @"kExportKeyReferencedMasterPath"
/*!
@define kExportKeyUniqueID
@discussion An NSString containing a unique identifier for specified image.
*/
#define kExportKeyUniqueID @"kExportKeyUniqueID"
/*!
@define kExportKeyImageSize
@discussion An NSValue object containing an NSSize with the pixel dimensions of the specified image. For Version images, the pixel dimensions take all cropping, adjustments, and rotations into account. For Master images, the size is the original pixel dimensions of the image.
*/
#define kExportKeyImageSize @"kExportKeyImageSize"
/* New in version 2 of the ApertureExportManager protocol. */
/*!
@typedef ApertureExportThumbnailSize
@discussion New in version 2 of the ApertureExportManager protocol. Supported by Aperture 1.5.1 and later. These constants are used in the -thumbnailForImageAtIndex:size: method to specify the size that Aperture should return. Tiny images are 32px, Mini are 250px, and Thumbnails are 1024px.
*/
typedef enum
{
kExportThumbnailSizeThumbnail = 0,
kExportThumbnailSizeMini,
kExportThumbnailSizeTiny
} ApertureExportThumbnailSize;
/*!
@protocol ApertureExportManager
@discussion Version 2 of the protocol definition for the Aperture export interface. You use this protocol to communicate with the Aperture application.
*/
@protocol ApertureExportManager
/*!
@method imageCount
@abstract Returns the number of images the user wants to export.
@result An unsigned integer indicating the number of images the user wants to export.
@discussion Note that the image count may change if the user is allowed to choose between Master and Version export (see -allowsMasterExport). If the user switches, the Aperture export manager sends the plug-in a message (see -exportManagerExportTypeDidChange). The plug-in should then call -imageCount to make sure the number of images to export is correct.
*/
- (unsigned)imageCount;
/*!
@method propertiesForImageAtIndex:
@abstract Returns a dictionary containing all the properties for an image.
@param index The index of the target image.
@result A dictionary containing the available properties for the specified image. The returned dictionary contains a thumbnail image whose size is kExportThumbnailSizeMini.
@discussion For Master images, the returned properties come from the original import properties. These include properties from the image file and camera as well as any IPTC values the user added on import. The keys contained in the properties dictionary are defined at the beginning of this header file.
*/
- (NSDictionary *)propertiesForImageAtIndex:(unsigned)index;
/* New in version 2 of the ApertureExportManager protocol. */
/*!
@method propertiesWithoutThumbnailForImageAtIndex:
@abstract Returns a dictionary containing all the properties for an image, but without a value for the kExportKeyThumbnailImage key. (Version 2)
@param index The index of the target image.
@result A dictionary containing all the available properties for the specified image, except a thumbnail. You may obtain a thumbnail separately using the -thumbnailImageForImageAtIndex:size: method.
@discussion New in version 2 of the ApertureExportManager protocol. Supported by Aperture 1.5.1 and later. For Master images, the returned properties come from the original import properties. These include properties from the image file and camera as well as any IPTC values the user added on import. The keys contained in the properties dictionary are defined at the beginning of this header file. You may check if the Aperture your plug-in is running in supports version 2 by using the PROAPIAccessing protocol.
*/
- (NSDictionary *)propertiesWithoutThumbnailForImageAtIndex:(unsigned)index;
/* New in version 2 of the ApertureExportManager protocol. */
/*!
@method thumbnailForImageAtIndex:size:
@abstract Returns a small version of the specified image. (Version 2)
@param index The index of the target image
@param size The constant indicating how large of a thumbnail image Aperture should return.
@result An image object containing the thumbnail data
@discussion New in version 2 of the ApertureExportManager protocol. Supported by Aperture 1.5.1 and later. For master images, this method may return nil. You may check if the Aperture your plug-in is running in supports version 2 by using the PROAPIAccessing protocol.
*/
- (NSImage *)thumbnailForImageAtIndex:(unsigned)index
size:(ApertureExportThumbnailSize)size;
/*!
@method selectedExportPresetDictionary
@abstract Returns the key-value pairs defining the currently-selected export presets for a Version export.
@result A pointer to an NSDictionary structure.
@discussion Returns the key-value pairs defining the currently-selected export presets for a Version export. Returns nil if the user is exporting a Master image.
*/
- (NSDictionary *)selectedExportPresetDictionary;
/*!
@method addKeywords:toImageAtIndex:
@abstract Adds keywords to a Version image.
@param keywords An NSArray of NSString objects representing the keywords to add.
@param index The index of the target image.
@discussion This method has no effect if called on a Master image.
*/
- (void)addKeywords:(NSArray *)keywords
toImageAtIndex:(unsigned)index;
/* New in version 2 of the ApertureExportManager protocol. */
/*!
@method addHierarchicalKeywords:toImageAtIndex:
@abstract Adds keyword hierarchies to a Version image. (Version 2)
@param hierarchicalKeywords An NSArray of NSArray objects, each containing NSString objects representing the hierarchy of a single keyword. For each NSArray, the NSString at index 0 is the keyword, with the item at index 1 being its parent, and so on.
@param index The index of the target image.
@discussion New in version 2 of the ApertureExportManager protocol. Supported by Aperture 1.5.1 and later. You may check if the Aperture your plug-in is running in supports version 2 by using the PROAPIAccessing protocol. This method has no effect if called on a Master image.
*/
- (void)addHierarchicalKeywords:(NSArray *)hierarchicalKeywords
toImageAtIndex:(unsigned)index;
/*!
@method addCustomMetadataKeyValues:toImageAtIndex
@abstract Adds custom metadata to a Version image.
@param customMetadata An NSDictionary containing NSString key-value pairs representing the custom metadata.
@param index The index of the target image.
@discussion This method has no effect if called on a Master image.
*/
- (void)addCustomMetadataKeyValues:(NSDictionary *)customMetadata
toImageAtIndex:(unsigned)index;
/*!
@method window
@abstract Provides reference to frontmost window.
@result A reference to the current frontmost window.
@discussion Until the plug-in calls -shouldBeginExport, the reference points to the export window. After the export process begins, the reference points to the progress sheet or to Aperture's main window.
*/
- (id)window;
/*!
@method isMasterExport
@abstract Indicates whether Aperture is exporting Master or Version images.
@result Returns YES if Aperture is exporting Master images. Returns NO if Aperture is exporting Version images.
*/
- (BOOL)isMasterExport;
/*!
@method shouldBeginExport
@abstract Tells Aperture to start the export process.
@discussion Calling this method causes Aperture to determine the destination path for export, confirm the images to export, put away the export window, and begin the export process. A plug-in should call this method only in response to -exportManagerShouldBeginExport and after performing any necessary validations, network checks, and so on.
*/
- (void)shouldBeginExport;
/*!
@method shouldCancelExport
@abstract Tells Aperture to cancel the export process.
@discussion The plug-in can call this method at any time to have Aperture put away all export windows, stop the export process, and return the user to the workspace. Additionally, if Aperture calls -exportManagerShouldCancelExport, Aperture then halts all activity and waits for the plug-in to call this method.
*/
- (void)shouldCancelExport;
/*!
@method shouldFinishExport
@abstract Signals that Aperture can deallocate the plug-in.
@discussion When Aperture finishes processing the export image data, it calls -exportManagerDidFinishExport. It continues to ask the plug-in for progress updates until the plug-in calls this method. Once this happens, Aperture closes the export modal window and deallocates the plug-in.
*/
- (void)shouldFinishExport;
@end</pre>
<!--googleoff: index -->
</td>
</tr>
</table>
<!-- END WIDE COLUMN -->
<!-- END MAIN CONTENT -->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr>
<td><div style="width: 100%; height: 1px; background-color: #919699; margin-top: 5px; margin-bottom: 15px"></div></td>
</tr>
<tr>
<td align="center"><br/>
<table border="0" cellpadding="0" cellspacing="0" class="graybox">
<tr>
<th>Did this document help you?</th>
</tr>
<tr>
<td>
<div style="margin-bottom: 8px"><a href="http://developer.apple.com/feedback/?v=1&url=/samplecode/ApertureResizer/listing1.html%3Fid%3DDTS10004358-1.0&media=dvd" target=_new>Yes</a>: Tell us what works for you.</div>
<div style="margin-bottom: 8px"><a href="http://developer.apple.com/feedback/?v=2&url=/samplecode/ApertureResizer/listing1.html%3Fid%3DDTS10004358-1.0&media=dvd" target=_new>It’s good, but:</a> Report typos, inaccuracies, and so forth.</div>
<div><a href="http://developer.apple.com/feedback/?v=3&url=/samplecode/ApertureResizer/listing1.html%3Fid%3DDTS10004358-1.0&media=dvd" target=_new>It wasn’t helpful</a>: Tell us what would have helped.</div>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- START BOTTOM APPLE NAVIGATION -->
<!--#include virtual="/includes/footer"-->
<!-- END BOTTOM APPLE NAVIGATION -->
<!-- START CENTER CLOSE -->
</center>
<!-- END CENTER CLOSE -->
</body>
</html>