ab78abcc89fdd28848c037c9e21fece0bd09add6
[vlc.git] / extras / MacOSX / Framework / Headers / Public / VLCMediaList.h
1 /*****************************************************************************
2  * VLCMediaList.h: VLC.framework VLCMediaList header
3  *****************************************************************************
4  * Copyright (C) 2007 Pierre d'Herbemont
5  * Copyright (C) 2007 the VideoLAN team
6  * $Id: VLCMediaList.h 21564 2007-08-29 21:09:27Z pdherbemont $
7  *
8  * Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 #import "VLCMedia.h"
26
27 /* Notification Messages */
28 extern NSString * VLCMediaListItemAdded;
29 extern NSString * VLCMediaListItemDeleted;
30
31 @class VLCMedia;
32 @class VLCMediaList;
33 @class VLCMediaListAspect;
34
35 // TODO: Documentation
36 @protocol VLCMediaListDelegate
37 - (void)mediaList:(VLCMediaList *)aMediaList mediaAdded:(VLCMedia *)media atIndex:(int)index;
38 - (void)mediaList:(VLCMediaList *)aMediaList mediaRemovedAtIndex:(int)index;
39 @end
40
41 // TODO: Documentation
42 @interface VLCMediaList : NSObject
43 {
44     void * p_mlist;                //< Internal instance of media list
45     id <VLCMediaListDelegate,NSObject> delegate;                //< Delegate object
46     NSMutableArray *cachedMedia; /* We need that private copy because of Cocoa Bindings, that need to be working on first thread */
47     VLCMediaListAspect * flatAspect;
48     VLCMediaListAspect * hierarchicalAspect;
49 }
50
51 /* Properties */
52 - (void)setDelegate:(id)value;
53 - (id)delegate;
54
55 /* Operations */
56 - (void)lock;
57 - (void)unlock;
58
59 - (int)addMedia:(VLCMedia *)media;
60 - (void)insertMedia:(VLCMedia *)media atIndex:(int)index;
61 - (void)removeMediaAtIndex:(int)index;
62 - (VLCMedia *)mediaAtIndex:(int)index;
63 - (int)indexOfMedia:(VLCMedia *)media;
64 - (int)count;
65
66 - (BOOL)isReadOnly;
67
68 /* Media list aspect */
69 - (VLCMediaListAspect *)hierarchicalAspect;
70 - (VLCMediaListAspect *)hierarchicalNodeAspect;
71 - (VLCMediaListAspect *)flatAspect;
72 @end