d8f3d5dd7fdf1a0bd3ea4a83d65529ae577480c7
[vlc.git] / extras / MacOSX / VLC_app / Sources / VLCBrowsableVideoView.h
1 /*****************************************************************************
2  * VLCBrowsableVideoView.h: VideoView subclasses that allow fullscreen
3  * browsing
4  *****************************************************************************
5  * Copyright (C) 2007 Pierre d'Herbemont
6  * Copyright (C) 2007 the VideoLAN team
7  * $Id$
8  *
9  * Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24  *****************************************************************************/
25
26 #import <QuartzCore/QuartzCore.h>
27 #import <VLC/VLC.h>
28
29 @interface VLCBrowsableVideoView : VLCVideoView {
30     BOOL            menuDisplayed;
31     NSArray *       itemsTree;
32     NSRange         displayedItems;
33     NSInteger       selectedIndex;
34     CALayer *       selectionLayer;
35     CALayer *       backLayer;
36     CALayer *       menuLayer;
37     NSIndexPath *   selectedPath;
38     NSString *      nodeKeyPath;
39     NSString *      contentKeyPath;
40     id              selectedObject;
41
42     /* Actions on non-node items*/
43     id target;
44     SEL action;
45 }
46
47 /* Binds an nsarray to that property. But don't forget the set the access keys. */
48 @property (retain) NSArray * itemsTree;
49 @property (copy) NSString * nodeKeyPath;
50 @property (copy) NSString * contentKeyPath;
51
52 @property (readonly, retain) id selectedObject;
53
54 /* Set up a specific action to do, on items that don't have node.
55  * action first argument is the browsableVideoView. You can get the selected object,
56  * with -selectedObject */
57 @property (retain) id target;
58 @property  SEL action;
59
60 - (void)toggleMenu;
61 - (void)displayMenu;
62 - (void)hideMenu;
63 @end