forked from karelia/iMedia
/
IMBObject.h
166 lines (122 loc) · 6.67 KB
/
IMBObject.h
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
/*
iMedia Browser Framework <http://karelia.com/imedia/>
Copyright (c) 2005-2012 by Karelia Software et al.
iMedia Browser is based on code originally developed by Jason Terhorst,
further developed for Sandvox by Greg Hulands, Dan Wood, and Terrence Talbot.
The new architecture for version 2.0 was developed by Peter Baumgartner.
Contributions have also been made by Matt Gough, Martin Wennerberg and others
as indicated in source files.
The iMedia Browser Framework is licensed under the following terms:
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in all or substantial portions of the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to permit
persons to whom the Software is furnished to do so, subject to the following
conditions:
Redistributions of source code must retain the original terms stated here,
including this list of conditions, the disclaimer noted below, and the
following copyright notice: Copyright (c) 2005-2012 by Karelia Software et al.
Redistributions in binary form must include, in an end-user-visible manner,
e.g., About window, Acknowledgments window, or similar, either a) the original
terms stated here, including this list of conditions, the disclaimer noted
below, and the aforementioned copyright notice, or b) the aforementioned
copyright notice and a link to karelia.com/imedia.
Neither the name of Karelia Software, nor Sandvox, nor the names of
contributors to iMedia Browser may be used to endorse or promote products
derived from the Software without prior and express written permission from
Karelia Software or individual contributors, as appropriate.
Disclaimer: THE SOFTWARE IS PROVIDED BY THE COPYRIGHT OWNER AND CONTRIBUTORS
"AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH, THE
SOFTWARE OR THE USE OF, OR OTHER DEALINGS IN, THE SOFTWARE.
*/
// Author: Peter Baumgartner, Mike Abdullah
//----------------------------------------------------------------------------------------------------------------------
#pragma mark HEADERS
#import <Quartz/Quartz.h>
#import "IMBImageItem.h"
//----------------------------------------------------------------------------------------------------------------------
#pragma mark CONSTANTS
extern NSString* kIMBQuickLookImageProperty;
//----------------------------------------------------------------------------------------------------------------------
#pragma mark CLASSES
@class IMBParser;
//----------------------------------------------------------------------------------------------------------------------
// IMBObject encapsulates information about a single media item (e.g. image file or audio file). The location
// property uniquely identifies the item. In the case of files it could be a path or NSURL...
@interface IMBObject : NSObject
#if IMB_COMPILING_WITH_SNOW_LEOPARD_OR_NEWER_SDK
<NSCopying,NSCoding,IMBImageItem,QLPreviewItem,NSPasteboardWriting>
#else
<NSCopying,NSCoding,IMBImageItem>
#endif
{
@private
id _location;
NSString* _name;
NSDictionary* _preliminaryMetadata;
NSDictionary* _metadata;
NSString* _metadataDescription;
IMBParser* _parser;
NSString *_parserClassName;
NSString *_parserMediaType;
NSString *_parserMediaSource;
NSUInteger _index;
@protected
id _imageRepresentation;
NSString* _imageRepresentationType;
BOOL _needsImageRepresentation;
NSUInteger _imageVersion;
id _imageLocation;
BOOL _isLoadingThumbnail;
BOOL _shouldDrawAdornments;
BOOL _shouldDisableTitle;
// Generic image support through Quick Look
CGImageRef _quickLookImage;
BOOL _isLoadingQuickLookImage;
}
// Primary properties...
@property (retain) id location; // Path, URL, or other location info
@property (retain) NSString* name; // Display name for user interface
@property (readonly) NSImage* icon; // Small icon to be displayed in list view
@property (copy, readonly) NSString* parserClassName; // Name of the parser class which created this object
@property (copy, readonly) NSString* parserMediaType; // Media type for the parser class which created this object
@property (copy, readonly) NSString* parserMediaSource; // Media source for the parser class which created this object
@property (retain) NSDictionary* preliminaryMetadata; // Immediate (cheap) metadata
@property (retain) NSDictionary* metadata; // On demand (expensive) metadata (also contains preliminaryMetadata), initially nil
@property (retain) NSString* metadataDescription; // Metadata as display in UI (optional)
@property (retain) IMBParser* parser; // Parser that created this object
@property (assign) NSUInteger index; // Index of object in the array (optional)
@property (assign) BOOL shouldDrawAdornments; // YES if border/shadow should be drawn
@property (assign) BOOL shouldDisableTitle; // YES if title should be shown as disabled (e.g. not draggable)
// Helpers...
- (NSString*) path; // Convert location to path
- (NSURL*) URL; // Convert location to url
- (BOOL) isLocalFile; // Is this object a local file
- (NSString*) type; // Returns type of file if possible
- (NSString*) tooltipString;
- (NSString*) identifier;
// Derived Properties. See IKImageBrowserItem for documentation...
@property (retain) id imageLocation; // Optional url or path if different from location (e.g. lores thumbnail)
@property (nonatomic, readonly) NSString* imageUID;
@property (retain) id imageRepresentation;
@property (readonly) BOOL isSelectable;
@property (readonly) BOOL isDraggable;
@property (assign) BOOL needsImageRepresentation;
@property (retain) NSString* imageRepresentationType;
@property (readonly) NSString* imageTitle;
@property (assign) NSUInteger imageVersion;
// Asynchronous loading of thumbnails...
- (void) loadThumbnail;
- (BOOL) unloadThumbnail;
- (void) loadMetadata; // observe .metadata property to know when finished
@property (assign) BOOL isLoadingThumbnail;
- (CGImageRef) quickLookImage;
- (void) setQuickLookImage:(CGImageRef)inImage;
- (void) postProcessLocalURL:(NSURL*)localURL;
@end
//----------------------------------------------------------------------------------------------------------------------