Retired Document
Important: This sample code may not represent best practices for current development. The project may use deprecated symbols and illustrate technologies and techniques that are no longer recommended.
Bucket.h
/* |
File: Bucket.h |
Abstract: Declarations for the bucket container |
class in this example application. Buckets can |
contain trinkets and treasures. |
Version: 1.2 |
Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple |
Inc. ("Apple") in consideration of your agreement to the following |
terms, and your use, installation, modification or redistribution of |
this Apple software constitutes acceptance of these terms. If you do |
not agree with these terms, please do not use, install, modify or |
redistribute this Apple software. |
In consideration of your agreement to abide by the following terms, and |
subject to these terms, Apple grants you a personal, non-exclusive |
license, under Apple's copyrights in this original Apple software (the |
"Apple Software"), to use, reproduce, modify and redistribute the Apple |
Software, with or without modifications, in source and/or binary forms; |
provided that if you redistribute the Apple Software in its entirety and |
without modifications, you must retain this notice and the following |
text and disclaimers in all such redistributions of the Apple Software. |
Neither the name, trademarks, service marks or logos of Apple Inc. may |
be used to endorse or promote products derived from the Apple Software |
without specific prior written permission from Apple. Except as |
expressly stated in this notice, no other rights or licenses, express or |
implied, are granted by Apple herein, including but not limited to any |
patent rights that may be infringed by your derivative works or by other |
works in which the Apple Software may be incorporated. |
The Apple Software is provided by Apple on an "AS IS" basis. APPLE |
MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION |
THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS |
FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND |
OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS. |
IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL |
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, |
MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED |
AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), |
STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE |
POSSIBILITY OF SUCH DAMAGE. |
Copyright (C) 2011 Apple Inc. All Rights Reserved. |
*/ |
#import <Cocoa/Cocoa.h> |
#import "Element.h" |
/* The Bucket class is a container for trinkets and treasures. |
Two points of interest in this class are the weight and value |
accessor methods that we use to implement the weight and value |
AppleScript properties. These accessors implement read only |
properties and they return a calculated result reflecting the sum |
total of the weights of all of the trinkets and treasures |
contained in the bucket. |
We take care of most of the 'infrastructure' type operations |
needed for scripting in the Element class (the superclass of the |
Trinket class), so all we have to worry about here is storage management |
and providing accessors for the properties.*/ |
@interface Bucket : Element { |
NSMutableArray *theTrinkets; |
NSMutableArray *theTreasures; |
} |
/* storage management */ |
- (id)init; |
- (void)dealloc; |
/* kvc Cocoa property for the 'weight' AppleScript property. Note that rather |
than simply returning a value, this method calculates its result by |
summing the weights of all of the trinkets and treasures contained |
in the bucket. |
Also note, 'weight' is a declared as a read only property in our scripting |
definition file so we have only defined a read only Cocoa property. */ |
@property (nonatomic, readonly) NSNumber *weight; |
/* kvc Cocoa property for the 'value' AppleScript property. Here also rather |
than simply returning a value, this method calculates its result by |
summing the values of all of the treasures contained in the bucket. |
And, as with the 'weight' property, 'value' is a declared as a read |
only property in our scripting definition file so we have only defined |
a read only Cocoa property. */ |
@property (nonatomic, readonly) NSNumber *value; |
/* kvc methods for the 'trinkets' AppleScript element. Here we implement the methods |
necessary for maintaining the list of trinkets inside of a Bucket. Note the names. |
In our scripting definition file we specified that the 'bucket' class contains an |
element of type 'trinket', like so: |
<element type="trinket"/> |
Cocoa will use the plural form of the class name, 'trinkets', when naming the |
property used by AppleScript to access the list of buckets, and we should use |
the property name when naming our methods. So, using the property name, we |
name our methods as follows: |
- (NSArray*) trinkets; (implied by property declaration) |
-(void) insertInTrinkets:(id) trinket; |
-(void) insertInTrinkets:(id) trinket atIndex:(unsigned)index; |
-(void) removeFromTrinketsAtIndex:(unsigned)index; |
*/ |
/* return the entire list of trinkets */ |
@property (nonatomic, readonly) NSArray *trinkets; |
/* insert a trinket at the beginning of the list */ |
-(void) insertInTrinkets:(id) trinket; |
/* insert a trinket at some position in the list */ |
-(void) insertInTrinkets:(id) trinket atIndex:(unsigned)index; |
/* remove a trinket from the list */ |
-(void) removeFromTrinketsAtIndex:(unsigned)index; |
/* kvc methods for the 'treasure' AppleScript element. Here we implement the methods |
necessary for maintaining the list of trinkets inside of a Bucket. Note the names. |
In our scripting definition file we specified that the 'bucket' class contains an |
element of type 'treasure', like so: |
<element type="treasure"/> |
Cocoa will use the plural form of the class name, 'treasures', when naming the |
property used by AppleScript to access the list of buckets, and we should use |
the property name when naming our methods. So, using the property name, we |
name our methods as follows: |
- (NSArray*) treasures; (implied by property declaration) |
-(void) insertInTreasures:(id) treasure; |
-(void) insertInTreasures:(id) treasure atIndex:(unsigned)index; |
-(void) removeFromTreasuresAtIndex:(unsigned)index; |
*/ |
/* return the entire list of treasures */ |
@property (nonatomic, readonly) NSArray *treasures; |
/* insert a treasure at the beginning of the list */ |
-(void) insertInTreasures:(id) treasure; |
/* insert a treasure at some position in the list */ |
-(void) insertInTreasures:(id) treasure atIndex:(unsigned)index; |
/* remove a treasure from the list */ |
-(void) removeFromTreasuresAtIndex:(unsigned)index; |
@end |
Copyright © 2011 Apple Inc. All Rights Reserved. Terms of Use | Privacy Policy | Updated: 2011-09-07