Cydia/ProgressEvent.h

   1 /* Cydia - iPhone UIKit Front-End for Debian APT
   2  * Copyright (C) 2008-2011  Jay Freeman (saurik)
   3 */
   4
   5 /* Modified BSD License {{{ */
   6 /*
   7  *        Redistribution and use in source and binary
   8  * forms, with or without modification, are permitted
   9  * provided that the following conditions are met:
  10  *
  11  * 1. Redistributions of source code must retain the
  12  *    above copyright notice, this list of conditions
  13  *    and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the
  15  *    above copyright notice, this list of conditions
  16  *    and the following disclaimer in the documentation
  17  *    and/or other materials provided with the
  18  *    distribution.
  19  * 3. The name of the author may not be used to endorse
  20  *    or promote products derived from this software
  21  *    without specific prior written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS''
  24  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
  25  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  26  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
  28  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  29  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  30  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  31  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  33  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  34  * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  35  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  36  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  37 */
  38 /* }}} */
  39
  40 #ifndef Cydia_ProgressEvent_H
  41 #define Cydia_ProgressEvent_H
  42
  43 #include <Foundation/Foundation.h>
  44
  45 #include <CydiaSubstrate/CydiaSubstrate.h>
  46
  47 #include <apt-pkg/acquire.h>
  48
  49 @interface CydiaProgressEvent : NSObject {
  50     _H<NSString> message_;
  51     _H<NSString> type_;
  52
  53     _H<NSArray> item_;
  54     _H<NSString> package_;
  55     _H<NSString> url_;
  56     _H<NSString> version_;
  57 }
  58
  59 + (CydiaProgressEvent *) eventWithMessage:(NSString *)message ofType:(NSString *)type;
  60 + (CydiaProgressEvent *) eventWithMessage:(NSString *)message ofType:(NSString *)type forPackage:(NSString *)package;
  61 + (CydiaProgressEvent *) eventWithMessage:(NSString *)message ofType:(NSString *)type forItem:(pkgAcquire::ItemDesc &)item;
  62
  63 - (id) initWithMessage:(NSString *)message ofType:(NSString *)type;
  64
  65 - (NSString *) message;
  66 - (NSString *) type;
  67
  68 - (NSArray *) item;
  69 - (NSString *) package;
  70 - (NSString *) url;
  71 - (NSString *) version;
  72
  73 - (void) setItem:(NSArray *)item;
  74 - (void) setPackage:(NSString *)package;
  75 - (void) setURL:(NSString *)url;
  76 - (void) setVersion:(NSString *)version;
  77
  78 - (NSString *) compound:(NSString *)value;
  79 - (NSString *) compoundMessage;
  80 - (NSString *) compoundTitle;
  81
  82 @end
  83
  84 @protocol ProgressDelegate
  85 - (void) addProgressEvent:(CydiaProgressEvent *)event;
  86 - (void) setProgressPercent:(NSNumber *)percent;
  87 - (void) setProgressStatus:(NSDictionary *)status;
  88 - (void) setProgressCancellable:(NSNumber *)cancellable;
  89 - (bool) isProgressCancelled;
  90 - (void) setTitle:(NSString *)title;
  91 @end
  92
  93 #endif//Cydia_ProgressEvent_H