libpurple/countingnode.h

changeset 40215
f7cf821e15de
parent 38016
3ac0882cd563
child 40474
1341be8e3402
equal deleted inserted replaced
40214:2bfdd6552f14 40215:f7cf821e15de
56 * <listitem>Group: Keeps track of the number of chats and contacts under it. 56 * <listitem>Group: Keeps track of the number of chats and contacts under it.
57 * </listitem> 57 * </listitem>
58 * </orderedlist> 58 * </orderedlist>
59 * 59 *
60 * See #PurpleContact, #PurpleGroup 60 * See #PurpleContact, #PurpleGroup
61 *
62 * Since: 3.0.0
61 */ 63 */
62 struct _PurpleCountingNode { 64 struct _PurpleCountingNode {
63 PurpleBlistNode node; 65 PurpleBlistNode node;
64 }; 66 };
65 67
77 79
78 /** 80 /**
79 * purple_counting_node_get_type: 81 * purple_counting_node_get_type:
80 * 82 *
81 * Returns: The #GType for the #PurpleCountingNode object. 83 * Returns: The #GType for the #PurpleCountingNode object.
84 *
85 * Since: 3.0.0
82 */ 86 */
83 GType purple_counting_node_get_type(void); 87 GType purple_counting_node_get_type(void);
84 88
85 /** 89 /**
86 * purple_counting_node_get_total_size: 90 * purple_counting_node_get_total_size:
87 * @counter: The node 91 * @counter: The node
88 * 92 *
89 * Returns the total number of children of the counting node. 93 * Returns the total number of children of the counting node.
90 * 94 *
91 * Returns: The total number of children of the node 95 * Returns: The total number of children of the node
96 *
97 * Since: 3.0.0
92 */ 98 */
93 int purple_counting_node_get_total_size(PurpleCountingNode *counter); 99 int purple_counting_node_get_total_size(PurpleCountingNode *counter);
94 100
95 /** 101 /**
96 * purple_counting_node_get_current_size: 102 * purple_counting_node_get_current_size:
98 * 104 *
99 * Returns the number of children of the counting node corresponding to online 105 * Returns the number of children of the counting node corresponding to online
100 * accounts. 106 * accounts.
101 * 107 *
102 * Returns: The number of children with online accounts 108 * Returns: The number of children with online accounts
109 *
110 * Since: 3.0.0
103 */ 111 */
104 int purple_counting_node_get_current_size(PurpleCountingNode *counter); 112 int purple_counting_node_get_current_size(PurpleCountingNode *counter);
105 113
106 /** 114 /**
107 * purple_counting_node_get_online_count: 115 * purple_counting_node_get_online_count:
108 * @counter: The node 116 * @counter: The node
109 * 117 *
110 * Returns the number of children of the counting node that are online. 118 * Returns the number of children of the counting node that are online.
111 * 119 *
112 * Returns: The total number of online children 120 * Returns: The total number of online children
121 *
122 * Since: 3.0.0
113 */ 123 */
114 int purple_counting_node_get_online_count(PurpleCountingNode *counter); 124 int purple_counting_node_get_online_count(PurpleCountingNode *counter);
115 125
116 /** 126 /**
117 * purple_counting_node_change_total_size: 127 * purple_counting_node_change_total_size:
119 * @delta: The value to change the total size by 129 * @delta: The value to change the total size by
120 * 130 *
121 * Changes the total number of children of the counting node. The provided 131 * Changes the total number of children of the counting node. The provided
122 * delta value is added to the count, or if it's negative, the count is 132 * delta value is added to the count, or if it's negative, the count is
123 * decreased. 133 * decreased.
134 *
135 * Since: 3.0.0
124 */ 136 */
125 void purple_counting_node_change_total_size(PurpleCountingNode *counter, int delta); 137 void purple_counting_node_change_total_size(PurpleCountingNode *counter, int delta);
126 138
127 /** 139 /**
128 * purple_counting_node_change_current_size: 140 * purple_counting_node_change_current_size:
130 * @delta: The value to change the current size by 142 * @delta: The value to change the current size by
131 * 143 *
132 * Changes the number of children of the counting node corresponding to online 144 * Changes the number of children of the counting node corresponding to online
133 * accounts. The provided delta value is added to the count, or if it's 145 * accounts. The provided delta value is added to the count, or if it's
134 * negative, the count is decreased. 146 * negative, the count is decreased.
147 *
148 * Since: 3.0.0
135 */ 149 */
136 void purple_counting_node_change_current_size(PurpleCountingNode *counter, int delta); 150 void purple_counting_node_change_current_size(PurpleCountingNode *counter, int delta);
137 151
138 /** 152 /**
139 * purple_counting_node_change_online_count: 153 * purple_counting_node_change_online_count:
141 * @delta: The value to change the online count by 155 * @delta: The value to change the online count by
142 * 156 *
143 * Changes the number of children of the counting node that are online. The 157 * Changes the number of children of the counting node that are online. The
144 * provided delta value is added to the count, or if it's negative, the count is 158 * provided delta value is added to the count, or if it's negative, the count is
145 * decreased. 159 * decreased.
160 *
161 * Since: 3.0.0
146 */ 162 */
147 void purple_counting_node_change_online_count(PurpleCountingNode *counter, int delta); 163 void purple_counting_node_change_online_count(PurpleCountingNode *counter, int delta);
148 164
149 /** 165 /**
150 * purple_counting_node_set_total_size: 166 * purple_counting_node_set_total_size:
151 * @counter: The node 167 * @counter: The node
152 * @totalsize: The total number of children of the node 168 * @totalsize: The total number of children of the node
153 * 169 *
154 * Sets the total number of children of the counting node. 170 * Sets the total number of children of the counting node.
171 *
172 * Since: 3.0.0
155 */ 173 */
156 void purple_counting_node_set_total_size(PurpleCountingNode *counter, int totalsize); 174 void purple_counting_node_set_total_size(PurpleCountingNode *counter, int totalsize);
157 175
158 /** 176 /**
159 * purple_counting_node_set_current_size: 177 * purple_counting_node_set_current_size:
160 * @counter: The node 178 * @counter: The node
161 * @currentsize: The number of children with online accounts 179 * @currentsize: The number of children with online accounts
162 * 180 *
163 * Sets the number of children of the counting node corresponding to online 181 * Sets the number of children of the counting node corresponding to online
164 * accounts. 182 * accounts.
183 *
184 * Since: 3.0.0
165 */ 185 */
166 void purple_counting_node_set_current_size(PurpleCountingNode *counter, int currentsize); 186 void purple_counting_node_set_current_size(PurpleCountingNode *counter, int currentsize);
167 187
168 /** 188 /**
169 * purple_counting_node_set_online_count: 189 * purple_counting_node_set_online_count:
170 * @counter: The node 190 * @counter: The node
171 * @onlinecount: The total number of online children 191 * @onlinecount: The total number of online children
172 * 192 *
173 * Sets the number of children of the counting node that are online. 193 * Sets the number of children of the counting node that are online.
194 *
195 * Since: 3.0.0
174 */ 196 */
175 void purple_counting_node_set_online_count(PurpleCountingNode *counter, int onlinecount); 197 void purple_counting_node_set_online_count(PurpleCountingNode *counter, int onlinecount);
176 198
177 G_END_DECLS 199 G_END_DECLS
178 200

mercurial