summaryrefslogtreecommitdiff
path: root/SmartDeviceLink-iOS/SmartDeviceLink/SDLTextField.h
blob: 7af898fe55ffbbffca6bace3d203845d32d3c75d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
//  SDLTextField.h
//

#import "SDLRPCMessage.h"

@class SDLCharacterSet;
@class SDLTextFieldName;


/**
 * Struct defining the characteristics of a displayed field on the HMI.
 * 
 * Parameter List
 * <table border="1" rules="all">
 * 		<tr>
 * 			<th>Name</th>
 * 			<th>Type</th>
 * 			<th>Description</th>
 * 			<th>SmartDeviceLink Ver. Available</th>
 * 		</tr>
 * 		<tr>
 * 			<td>name</td>
 * 			<td>TextFieldName</td>
 * 			<td>Enumeration identifying the field.	</td>
 * 			<td>SDL 1.0</td>
 * 		</tr>
 * 		<tr>
 * 			<td>characterSet</td>
 * 			<td>CharacterSet</td>
 * 			<td>The character set that is supported in this field.	</td>
 * 			<td>SDL 1.0</td>
 * 		</tr>
 * 		<tr>
 * 			<td>width</td>
 * 			<td>Int16</td>
 * 			<td>The number of characters in one row of this field.
 * 					<ul>
 *					<li>Minvalue="1"</li>
 *					<li>maxvalue="500"</li>
 *					</ul>
 *			</td>
 * 			<td>SDL 1.0</td>
 * 		</tr>
 * 		<tr>
 * 			<td>rows</td>
 * 			<td>Int16</td>
 * 			<td>The number of rows for this text field.
 * 					<ul>
 *					<li>Minvalue="1"</li>
 *					<li>maxvalue="3"</li>
 *					</ul>
 *			</td>
 * 			<td>SDL 1.0</td>
 * 		</tr>
 * </table>
 *
 * @since SDL 1.0
 */
@interface SDLTextField : SDLRPCStruct {
}

/**
 * @abstract Constructs a newly allocated SDLTextField object
 */
- (instancetype)init;

/**
 * @abstract Constructs a newly allocated SDLTextField object indicated by the dictionary parameter
 *
 * @param dict The dictionary to use to construct the object
 */
- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;

/**
 * @abstract The enumeration identifying the field.
 *
 * @see SDLTextFieldName
 *
 * Required
 */
@property (strong) SDLTextFieldName *name;

/**
 * @abstract The character set that is supported in this field.
 *
 * @see SDLCharacterSet
 *
 * Required
 */
@property (strong) SDLCharacterSet *characterSet;

/**
 * @abstract The number of characters in one row of this field.
 * 
 * Required, Integer 1 - 500
 */
@property (strong) NSNumber *width;

/**
 * @abstract The number of rows for this text field.
 * 
 * Required, Integer 1 - 8
 */
@property (strong) NSNumber *rows;

@end