root/Trunk/Adium.framework/Versions/A/Headers/AIListObject.h @ 2

/* 
 * Adium is the legal property of its developers, whose names are listed in the copyright file included
 * with this source distribution.
 * 
 * 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.
 */

#import <Adium/ESObjectWithProperties.h>
#import <Adium/AIStatus.h>

@class AIListObject, AIService, AIMutableOwnerArray, AIListGroup;

#define KEY_ORDER_INDEX         @"Order Index"
#define KEY_IS_BLOCKED          @"isBlocked"

typedef enum {
        AIAvailableStatus = 'avaL',
        AIAwayStatus = 'awaY',
        AIIdleStatus = 'idlE',
        AIAwayAndIdleStatus = 'aYiE',
        AIOfflineStatus = 'offL',
        AIUnknownStatus = 'unkN'
} AIStatusSummary;

@protocol AIContainingObject <NSObject>
- (NSArray *)containedObjects;
- (unsigned)containedObjectsCount;
- (BOOL)containsObject:(AIListObject *)inObject;

- (NSString *)contentsBasedIdentifier;

- (id)objectAtIndex:(unsigned)index;
- (int)indexOfObject:(AIListObject *)inObject;
- (AIListObject *)objectWithService:(AIService *)inService UID:(NSString *)inUID;

- (float)smallestOrder;
- (float)largestOrder;

/*!
 * @brief Get the visbile object at a given index
 */
- (AIListObject *)visibleObjectAtIndex:(NSUInteger)index;

- (void)listObject:(AIListObject *)listObject didSetOrderIndex:(float)inOrderIndex;
- (float)orderIndexForObject:(AIListObject *)listObject;

//Should list each list contact only once (for groups, this is the same as the objectEnumerator)
- (NSArray *)listContacts;
- (NSArray *)visibleListContacts;

- (BOOL)addObject:(AIListObject *)inObject;

- (void)removeObject:(AIListObject *)inObject;
- (void)removeAllObjects;

- (void)setExpanded:(BOOL)inExpanded;
- (BOOL)isExpanded;
- (BOOL)isExpandable;
- (unsigned)visibleCount;

- (void)visibilityOfContainedObject:(AIListObject *)inObject changedTo:(BOOL)inVisible;

@end

@protocol AIListObject
- (void)object:(id)inObject didChangeValueForProperty:(NSString *)key notify:(NotifyTiming)notify;
- (void)notifyOfChangedPropertiesSilently:(BOOL)silent;
- (void)listObject:(AIListObject *)listObject mutableOwnerArray:(AIMutableOwnerArray *)inArray didSetObject:(AIListObject *)anObject withOwner:(AIListObject *)inOwner priorityLevel:(float)priority;
@end

@interface AIListObject : ESObjectWithProperties <AIListObject> {
        AIService                               *service;
        
    NSString                            *UID;
        NSString                                *internalObjectID;
        BOOL                                    visible;                                //Visibility of this object
        BOOL                                    alwaysVisible;

        //Grouping, Manual ordering
    id <AIContainingObject, AIListObject>       containingObject;               //The group/metacontact this object is in
        float                                                                   orderIndex;                             //Placement of this contact within a group
        
        //For AIContainingObject-compliant subclasses
        float                           largestOrder;
        float                           smallestOrder;
}

//
- (id)initWithUID:(NSString *)inUID service:(AIService *)inService;

//Identifying information
- (NSString *)UID;
- (AIService *)service;
- (NSString *)serviceID;
- (NSString *)serviceClass;
- (NSString *)internalObjectID;
+ (NSString *)internalObjectIDForServiceID:(NSString *)inServiceID UID:(NSString *)inUID;

//Visibility
- (void)setVisible:(BOOL)inVisible;
- (BOOL)visible;
- (void)setAlwaysVisible:(BOOL)isVisible;
- (BOOL)alwaysVisible;

//Grouping
- (AIListObject <AIContainingObject> *)containingObject;
- (float)orderIndex;
- (BOOL)containsMultipleContacts;

//Display
- (NSString *)formattedUID;
- (void)setFormattedUID:(NSString *)inFormattedUID notify:(NotifyTiming)notify;
- (NSString *)longDisplayName;

//Prefs
- (void)setPreference:(id)value forKey:(NSString *)inKey group:(NSString *)groupName;
- (void)setPreferences:(NSDictionary *)prefs inGroup:(NSString *)group;
- (id)preferenceForKey:(NSString *)inKey group:(NSString *)groupName ignoreInheritedValues:(BOOL)ignore;
- (id)preferenceForKey:(NSString *)inKey group:(NSString *)groupName;
- (NSString *)pathToPreferences;

//Alter the placement of this object in a group (PRIVATE: These are for AIListGroup ONLY)
- (void)setOrderIndex:(float)inIndex;

//Grouping (PRIVATE: These are for AIListGroup and AIMetaContact ONLY)
- (void)setContainingObject:(AIListObject <AIContainingObject> *)inGroup;

//Key-Value pairing
- (BOOL)online;

- (NSString *)statusName;
- (AIStatusType)statusType;
- (void)setStatusWithName:(NSString *)statusName statusType:(AIStatusType)statusType notify:(NotifyTiming)notify;
- (NSAttributedString *)statusMessage;
- (NSString *)statusMessageString;
- (void)setStatusMessage:(NSAttributedString *)statusMessage notify:(NotifyTiming)notify;
- (void)setBaseAvailableStatusAndNotify:(NotifyTiming)notify;
- (AIStatusSummary)statusSummary;

- (BOOL)soundsAreMuted;

- (BOOL)isStranger;
- (BOOL)isMobile;
- (BOOL)isBlocked;

- (NSString *)displayName;
- (void)setDisplayName:(NSString *)alias;

- (NSString *)phoneticName;

- (NSString *)notes;
- (void)setNotes:(NSString *)notes;

- (NSNumber *)idleTime;

- (NSImage *)userIcon;
- (NSImage *)menuIcon;
- (NSImage *)statusIcon;
- (NSData *)userIconData;
- (void)setUserIconData:(NSData *)inData;

//For use only by subclasses
- (NSImage *)internalUserIcon;

//mutableOwnerArray delegate and methods
- (void)listObject:(AIListObject *)listObject mutableOwnerArray:(AIMutableOwnerArray *)inArray didSetObject:(id)anObject withOwner:(AIListObject *)inOwner priorityLevel:(float)priority;

//Comparison
- (NSComparisonResult)compare:(AIListObject *)other;

@end

/*!
 * AIContainingObjectInheritableMethods methods are part of the AIContainingObject protocol
 * but are implemented by AIListObject (which does not conform to the protocol) for the convenience
 * of subclasses.
 */
@interface AIListObject (AIContainingObjectInheritableMethods)
- (float)smallestOrder;
- (float)largestOrder;
- (void)listObject:(AIListObject *)listObject didSetOrderIndex:(float)inOrderIndex;
- (float)orderIndexForObject:(AIListObject *)listObject;
@end