Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 72 lines (67 sloc) 2.406 kb
299d3b1 @groue v1.12.0
authored
1 // The MIT License
2 //
3 // Copyright (c) 2012 Gwendal Roué
4 //
5 // Permission is hereby granted, free of charge, to any person obtaining a copy
6 // of this software and associated documentation files (the "Software"), to deal
7 // in the Software without restriction, including without limitation the rights
8 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 // copies of the Software, and to permit persons to whom the Software is
10 // furnished to do so, subject to the following conditions:
11 //
12 // The above copyright notice and this permission notice shall be included in
13 // all copies or substantial portions of the Software.
14 //
15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 // THE SOFTWARE.
22
23 #import <Foundation/Foundation.h>
24 #import "GRMustacheAvailabilityMacros.h"
25
0d322bc @groue v4.1.1
authored
26 /**
27 * The GRMustacheInvocation class gives you information about the values that
b63bbe1 @groue v5.1.0
authored
28 * are rendered.
0d322bc @groue v4.1.1
authored
29 *
30 * You'll be given GRMustacheInvocation instances when providing a
31 * GRMustacheTemplateDelegate to your templates.
32 *
33 * **Companion guide:** https://github.com/groue/GRMustache/blob/master/Guides/delegate.md
34 *
35 * @see GRMustacheTemplateDelegate
36 *
37 * @since v1.12
38 */
299d3b1 @groue v1.12.0
authored
39 @interface GRMustacheInvocation : NSObject {
40 @private
41 id _returnValue;
7924382 @groue v5.0.0
authored
42 id _token;
299d3b1 @groue v1.12.0
authored
43 }
0d322bc @groue v4.1.1
authored
44
45 /**
b4dfe0d @groue v5.0.1
authored
46 * Returns a string that describes the invocation.
47 *
48 * It contains the original Mustache tag, the line number, and the path, URL, or
49 * name of the template, if any.
50 *
51 * @return a string that describes the invocation.
52 *
53 * @since v1.12
54 */
55 - (NSString *)description;
56
57 /**
0d322bc @groue v4.1.1
authored
58 * The return value of the invocation.
59 *
60 * For instance, the invocation that you would get for a `{{name}}` tag would
61 * have the name in the `returnValue` property.
62 *
63 * In a template's delegate methods, you can set the returnValue of an
64 * invocation, and alter a template rendering.
65 *
66 * @see GRMustacheTemplateDelegate
67 *
68 * @since v1.12
69 */
7924382 @groue v5.0.0
authored
70 @property (nonatomic, retain) id returnValue AVAILABLE_GRMUSTACHE_VERSION_5_0_AND_LATER;
299d3b1 @groue v1.12.0
authored
71 @end
Something went wrong with that request. Please try again.