modules/gui/macosx/VLCPlaylist.h

   1 /*****************************************************************************
   2  * VLCPlaylist.h: MacOS X interface module
   3  *****************************************************************************
   4  * Copyright (C) 2002-2015 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Benjamin Pracht <bigben at videolab dot org>
   8  *          Felix Paul Kühne <fkuehne at videolan dot org>
   9  *          David Fuhrmann <david dot fuhrmann at googlemail dot com>
  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 "PXSourceList.h"
  27 #import "VLCPLModel.h"
  28 #import "VLCPlaylistView.h"
  29
  30 @interface VLCPlaylist : NSResponder<NSOutlineViewDelegate>
  31
  32 @property (readwrite, weak) IBOutlet NSMenu *playlistMenu;
  33 @property (readwrite, weak) IBOutlet NSMenuItem *playPlaylistMenuItem;
  34 @property (readwrite, weak) IBOutlet NSMenuItem *deletePlaylistMenuItem;
  35 @property (readwrite, weak) IBOutlet NSMenuItem *infoPlaylistMenuItem;
  36 @property (readwrite, weak) IBOutlet NSMenuItem *revealInFinderPlaylistMenuItem;
  37 @property (readwrite, weak) IBOutlet NSMenuItem *selectAllPlaylistMenuItem;
  38 @property (readwrite, weak) IBOutlet NSMenuItem *recursiveExpandPlaylistMenuItem;
  39 @property (readwrite, weak) IBOutlet NSMenuItem *recursiveCollapsePlaylistMenuItem;
  40 @property (readwrite, weak) IBOutlet NSMenuItem *addFilesToPlaylistMenuItem;
  41
  42 @property (nonatomic, readwrite, weak) VLCPlaylistView *outlineView;
  43 @property (nonatomic, readwrite, weak) NSTableHeaderView *playlistHeaderView;
  44
  45 - (VLCPLModel *)model;
  46
  47 - (void)reloadStyles;
  48
  49 - (NSMenu *)menuForEvent:(NSEvent *)o_event;
  50
  51 - (void)playlistUpdated;
  52 - (void)playbackModeUpdated;
  53
  54 - (void)currentlyPlayingItemChanged;
  55
  56 - (BOOL)isSelectionEmpty;
  57
  58 - (IBAction)playItem:(id)sender;
  59 - (IBAction)revealItemInFinder:(id)sender;
  60 - (IBAction)deleteItem:(id)sender;
  61 - (IBAction)selectAll:(id)sender;
  62 - (IBAction)recursiveExpandOrCollapseNode:(id)sender;
  63 - (IBAction)showInfoPanel:(id)sender;
  64 - (IBAction)addFilesToPlaylist:(id)sender;
  65
  66 - (NSArray *)draggedItems;
  67
  68 /**
  69  * Prepares an array of playlist items for all suitable pasteboard types.
  70  *
  71  * This function checks external pasteboard objects (like files). If suitable,
  72  * an array of all objects is prepared.
  73  */
  74 - (NSArray *)createItemsFromExternalPasteboard:(NSPasteboard *)pasteboard;
  75
  76 /**
  77  * Simplified version to add new items at the end of the current playlist
  78  * @param array array of items. Each item is a Dictionary with meta info.
  79  */
  80 - (void)addPlaylistItems:(NSArray*)array;
  81
  82 /**
  83  * Add new items to playlist, with the possibility to check if an item can be added
  84  * to the currently playing media as subtitle.
  85  *
  86  * @param array array of items. Each item is a Dictionary with meta info.
  87  * @param isSubtitle if YES, method tries to add the item as a subtitle
  88  */
  89 - (void)addPlaylistItems:(NSArray*)array tryAsSubtitle:(BOOL)isSubtitle;
  90
  91 /**
  92  * Adds new items to the playlist, at specified parent node and index.
  93  * @param o_array array of items. Each item is a Dictionary with meta info.
  94  * @param i_plItemId parent playlist node id, -1 for default playlist
  95  * @param i_position index for new items, -1 for appending at end
  96  * @param b_start starts playback of first item if true
  97  */
  98 - (void)addPlaylistItems:(NSArray*)o_array withParentItemId:(int)i_plItemId atPos:(int)i_position startPlayback:(BOOL)b_start;
  99
 100
 101 - (void)continuePlaybackWhereYouLeftOff:(input_thread_t *)p_input_thread;
 102 - (void)storePlaybackPositionForItem:(input_thread_t *)p_input_thread;
 103
 104 @end