VLCDialogProvider.h

/*****************************************************************************
 * VLCDialogProvider.h: an implementation of the libvlc dialog API
 *****************************************************************************
 * Copyright (C) 2016 VideoLabs SAS
 * $Id$
 *
 * Authors: Felix Paul Kühne <fkuehne # videolan.org>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/
 
@class VLCLibrary;
 
NS_ASSUME_NONNULL_BEGIN
 
typedef NS_ENUM(NSUInteger, VLCDialogQuestionType) {
    VLCDialogQuestionNormal,
    VLCDialogQuestionWarning,
    VLCDialogQuestionCritical,
};
 
@protocol VLCCustomDialogRendererProtocol <NSObject>
 
- (void)showErrorWithTitle:(NSString *)error
      message:(NSString *)message;
 
- (void)showLoginWithTitle:(NSString *)title
                   message:(NSString *)message
           defaultUsername:(nullable NSString *)username
          askingForStorage:(BOOL)askingForStorage
             withReference:(NSValue *)reference;
 
- (void)showQuestionWithTitle:(NSString *)title
                      message:(NSString *)message
                         type:(VLCDialogQuestionType)questionType
                 cancelString:(nullable NSString *)cancelString
                action1String:(nullable NSString *)action1String
                action2String:(nullable NSString *)action2String
                withReference:(NSValue *)reference;
 
- (void)showProgressWithTitle:(NSString *)title
                      message:(NSString *)message
              isIndeterminate:(BOOL)isIndeterminate
                     position:(float)position
                 cancelString:(nullable NSString *)cancelString
                withReference:(NSValue *)reference;
 
- (void)updateProgressWithReference:(NSValue *)reference
                            message:(nullable NSString *)message
                            position:(float)position;
 
- (void)cancelDialogWithReference:(NSValue *)reference;
 
@end
 
 
@interface VLCDialogProvider : NSObject
 
- (nullable instancetype)initWithLibrary:(nullable VLCLibrary *)library
                                 customUI:(BOOL)customUI;
 
@property (weak, readwrite, nonatomic, nullable) id<VLCCustomDialogRendererProtocol> customRenderer;
 
- (void)postUsername:(NSString *)username
         andPassword:(NSString *)password
  forDialogReference:(NSValue *)dialogReference
               store:(BOOL)store;
 
- (void)postAction:(int)buttonNumber
forDialogReference:(NSValue *)dialogReference;
 
- (void)dismissDialogWithReference:(NSValue *)dialogReference;
 
@end
 
NS_ASSUME_NONNULL_END