Mercurial > pidgin3 / file comparison

comparison: libpurple/request/purplerequestfieldstring.h

libpurple/request/purplerequestfieldstring.h

changeset 43285
acde304cf24c
parent 43176
04f562dc0ff2
equal deleted inserted replaced
43284:50c1bcc45576 43285:acde304cf24c
56 * @multiline: Whether or not this should be a multiline string. 56 * @multiline: Whether or not this should be a multiline string.
57 * 57 *
58 * Creates a string request field. 58 * Creates a string request field.
59 * 59 *
60 * Returns: (transfer full) (type PurpleRequestFieldString): The new field. 60 * Returns: (transfer full) (type PurpleRequestFieldString): The new field.
61 *
62 * Since: 2.0
61 */ 63 */
62 PURPLE_AVAILABLE_IN_ALL 64 PURPLE_AVAILABLE_IN_ALL
63 PurpleRequestField *purple_request_field_string_new(const char *id, const char *text, const char *default_value, gboolean multiline); 65 PurpleRequestField *purple_request_field_string_new(const char *id, const char *text, const char *default_value, gboolean multiline);
64 66
65 /** 67 /**
66 * purple_request_field_string_set_default_value: 68 * purple_request_field_string_set_default_value:
67 * @field: The field. 69 * @field: The field.
68 * @default_value: The default value. 70 * @default_value: The default value.
69 * 71 *
70 * Sets the default value in a string field. 72 * Sets the default value in a string field.
73 *
74 * Since: 2.0
71 */ 75 */
72 PURPLE_AVAILABLE_IN_ALL 76 PURPLE_AVAILABLE_IN_ALL
73 void purple_request_field_string_set_default_value(PurpleRequestFieldString *field, const char *default_value); 77 void purple_request_field_string_set_default_value(PurpleRequestFieldString *field, const char *default_value);
74 78
75 /** 79 /**
76 * purple_request_field_string_set_value: 80 * purple_request_field_string_set_value:
77 * @field: The field. 81 * @field: The field.
78 * @value: The value. 82 * @value: The value.
79 * 83 *
80 * Sets the value in a string field. 84 * Sets the value in a string field.
85 *
86 * Since: 2.0
81 */ 87 */
82 PURPLE_AVAILABLE_IN_ALL 88 PURPLE_AVAILABLE_IN_ALL
83 void purple_request_field_string_set_value(PurpleRequestFieldString *field, const char *value); 89 void purple_request_field_string_set_value(PurpleRequestFieldString *field, const char *value);
84 90
85 /** 91 /**
87 * @field: The field. 93 * @field: The field.
88 * @masked: The masked value. 94 * @masked: The masked value.
89 * 95 *
90 * Sets whether or not a string field is masked 96 * Sets whether or not a string field is masked
91 * (commonly used for password fields). 97 * (commonly used for password fields).
98 *
99 * Since: 2.0
92 */ 100 */
93 PURPLE_AVAILABLE_IN_ALL 101 PURPLE_AVAILABLE_IN_ALL
94 void purple_request_field_string_set_masked(PurpleRequestFieldString *field, gboolean masked); 102 void purple_request_field_string_set_masked(PurpleRequestFieldString *field, gboolean masked);
95 103
96 /** 104 /**
98 * @field: The field. 106 * @field: The field.
99 * 107 *
100 * Returns the default value in a string field. 108 * Returns the default value in a string field.
101 * 109 *
102 * Returns: The default value. 110 * Returns: The default value.
111 *
112 * Since: 2.0
103 */ 113 */
104 PURPLE_AVAILABLE_IN_ALL 114 PURPLE_AVAILABLE_IN_ALL
105 const char *purple_request_field_string_get_default_value(PurpleRequestFieldString *field); 115 const char *purple_request_field_string_get_default_value(PurpleRequestFieldString *field);
106 116
107 /** 117 /**
109 * @field: The field. 119 * @field: The field.
110 * 120 *
111 * Returns the user-entered value in a string field. 121 * Returns the user-entered value in a string field.
112 * 122 *
113 * Returns: The value. 123 * Returns: The value.
124 *
125 * Since: 2.0
114 */ 126 */
115 PURPLE_AVAILABLE_IN_ALL 127 PURPLE_AVAILABLE_IN_ALL
116 const char *purple_request_field_string_get_value(PurpleRequestFieldString *field); 128 const char *purple_request_field_string_get_value(PurpleRequestFieldString *field);
117 129
118 /** 130 /**
120 * @field: The field. 132 * @field: The field.
121 * 133 *
122 * Returns whether or not a string field is multi-line. 134 * Returns whether or not a string field is multi-line.
123 * 135 *
124 * Returns: %TRUE if the field is mulit-line, or %FALSE otherwise. 136 * Returns: %TRUE if the field is mulit-line, or %FALSE otherwise.
137 *
138 * Since: 2.0
125 */ 139 */
126 PURPLE_AVAILABLE_IN_ALL 140 PURPLE_AVAILABLE_IN_ALL
127 gboolean purple_request_field_string_is_multiline(PurpleRequestFieldString *field); 141 gboolean purple_request_field_string_is_multiline(PurpleRequestFieldString *field);
128 142
129 /** 143 /**
131 * @field: The field. 145 * @field: The field.
132 * 146 *
133 * Returns whether or not a string field is masked. 147 * Returns whether or not a string field is masked.
134 * 148 *
135 * Returns: %TRUE if the field is masked, or %FALSE otherwise. 149 * Returns: %TRUE if the field is masked, or %FALSE otherwise.
150 *
151 * Since: 2.0
136 */ 152 */
137 PURPLE_AVAILABLE_IN_ALL 153 PURPLE_AVAILABLE_IN_ALL
138 gboolean purple_request_field_string_is_masked(PurpleRequestFieldString *field); 154 gboolean purple_request_field_string_is_masked(PurpleRequestFieldString *field);
139 155
140 /** 156 /**

Mercurial Repository: pidgin3

mercurial