Subversion Repositories TruePreview

[/] [trunk/] [Source/] [TruePreviewLibraryMessage.h] - Blame information for rev 28

Go to most recent revision | Details | Compare with Previous | View Log

Line No. Rev Author Line
1 1 jhriggs
/*
2
 * Copyright (c) 2009, Jim Riggs, Christian Serving, L.L.C.
3
 * All rights reserved.
4
 *
5
 * Redistribution and use in source and binary forms, with or without
6
 * modification, are permitted provided that the following conditions are
7
 * met:
8
 *     * Redistributions of source code must retain the above copyright
9
 *       notice, this list of conditions and the following disclaimer.
10
 *     * Redistributions in binary form must reproduce the above
11
 *       copyright notice, this list of conditions and the following
12
 *       disclaimer in the documentation and/or other materials provided
13
 *       with the distribution.
14
 *     * Neither the name of Christian Serving, L.L.C. nor the names of
15
 *       its contributors may be used to endorse or promote products
16
 *       derived from this software without specific prior written
17
 *       permission.
18
 *
19
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30
 */
31
 
32
/*!
33
 * @header
34
 * Defines the <code>TruePreviewLibraryMessage</code> category for
35
 * <code>LibraryMessage</code>.
36
 * @copyright Copyright (c) 2009 Jim Riggs, Christian Serving, L.L.C. All rights reserved.
37
 * @version \@(#) $Id: TruePreviewLibraryMessage.h 17 2009-10-09 12:21:07Z jhriggs $
38
 * @updated $Date: 2009-10-09 07:21:07 -0500 (Fri, 09 Oct 2009) $
39
 */
40
 
41
#import "TruePreview.h"
42
 
43
/*!
44 17 jhriggs
 * @class
45 1 jhriggs
 * Adds a method for overriding the "mark as viewed" behavior of
46
 * <code>LibraryMessage</code>.
47
 * @version \@(#) $Id: TruePreviewLibraryMessage.h 17 2009-10-09 12:21:07Z jhriggs $
48
 * @updated $Date: 2009-10-09 07:21:07 -0500 (Fri, 09 Oct 2009) $
49
 */
50 17 jhriggs
@interface TruePreviewLibraryMessage : NSObject {
51
}
52 1 jhriggs
 
53 17 jhriggs
#pragma mark Swizzled instance methods
54
/*! @group Swizzled instance methods */
55 1 jhriggs
 
56
/*!
57
 * Does nothing.  The replacement behavior is handled in
58 17 jhriggs
 * <code>TruePreviewMessageViewer</code>.
59 1 jhriggs
 */
60
- (void)truePreviewMarkAsViewed;
61
 
62 17 jhriggs
#pragma mark Instance methods
63
/*! @group Instance methods */
64
 
65
/*!
66
 * Returns the TruePreview settings appropriate for this message.
67
 * @result
68
 *   An <code>NSMutableDictionary</code> containing the keys <code>delay</code>,
69
 *   <code>window</code>, and <code>scroll</code> and their respective values
70
 *   based on the default settings and/or the settings for this message's
71
 *   account.
72
 */
73
- (NSMutableDictionary*)truePreviewSettings;
74
 
75 1 jhriggs
@end