RTKVerse.h

   1 //
   2 //   RTKVerse.h
   3 //   (CleverRabbit.app)
   4 //
   5 //   Copyright (c) 2005 A. Karl Keller (http://karlk.net)
   6 //
   7 //   This code is open-source, free software, made available without warranty under
   8 //   the terms of the GNU General Public License, either version 2 or later (see
   9 //   http://www.gnu.org/licenses/gpl.html or included copy); as such, it may be
  10 //   redistributed and/or modified in accordance with that document.
  11 //
  12
  13
  14
  15 #import <Cocoa/Cocoa.h>
  16
  17 #define RTK_CHANGED_REVISION        @"RTKChangedRevision"
  18
  19 @class RTKRevision;
  20
  21 @interface RTKVerse : NSObject
  22 {
  23     NSString * reference;
  24         NSString * preUSFMType; // maintained for previous versions
  25     NSString * type;
  26         BOOL locked;
  27
  28     NSMutableArray *revisions;
  29     int currentRevisionIndex;
  30
  31     // Lossless forwards/backwards compatibility
  32     NSDictionary * dictionary;
  33 }
  34
  35 - (id)initWithDictionary:(NSDictionary *)dict;
  36 - (id)initWithString:(NSString *)string;
  37 - (id)initWithSFMString:(NSString *)string
  38            andStateDict:(NSMutableDictionary *)dict;
  39 - (id)deepCopy;
  40 + (RTKVerse *)verseWithSFMString:string
  41                     andStateDict:dict;
  42 - (void)updateTypeFieldToUSFM;
  43 - (void)appendLine:(NSString *)line;
  44 - (NSString *)string;
  45 - (NSString *)sfmString;
  46 - (NSMutableAttributedString *)mutableAttributedString:(BOOL)romanString;
  47
  48 - (void)setLocked:(BOOL)state;
  49 - (BOOL)locked;
  50
  51 - (void)setReference:(NSString *)theReference;
  52 - (NSString *)reference;
  53
  54 - (void)setPreUSFMType:(NSString *)theType;
  55 - (NSString *)preUSFMType;
  56 - (void)setType:(NSString *)theType;
  57 - (NSString *)type;
  58
  59 - (BOOL)blank;
  60 - (BOOL)matchesString:(NSString *)string;
  61 - (void)setDictionary:(NSDictionary *)theDictionary;
  62 - (NSDictionary *)dictionary;
  63
  64 - (BOOL)updateWithAttributedString:(NSAttributedString *)string
  65                            atIndex:(NSUInteger)index;
  66
  67 #pragma mark - revision management
  68
  69 - (void)setRevisions:(NSMutableArray *)theRevisions;
  70 - (NSMutableArray *)revisions;
  71 - (int)revisionCount;
  72 - (void)setCurrentRevisionIndex:(int)index;
  73 - (int)currentRevisionIndex;
  74 - (RTKRevision *)currentRevision;
  75
  76
  77
  78 @end