libpurple/countingnode.h

   1 /* purple
   2  *
   3  * Purple is the legal property of its developers, whose names are too numerous
   4  * to list here.  Please refer to the COPYRIGHT file distributed with this
   5  * source distribution.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  20  */
  21
  22 #ifndef PURPLE_COUNTING_NODE_H
  23 #define PURPLE_COUNTING_NODE_H
  24 /**
  25  * SECTION:countingnode
  26  * @section_id: libpurple-countingnode
  27  * @short_description: <filename>countingnode.h</filename>
  28  * @title: CountingNode Object
  29  */
  30
  31 #include <glib.h>
  32 #include <glib-object.h>
  33
  34 #include "blistnode.h"
  35
  36 #define PURPLE_TYPE_COUNTING_NODE             (purple_counting_node_get_type())
  37 #define PURPLE_COUNTING_NODE(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_COUNTING_NODE, PurpleCountingNode))
  38 #define PURPLE_COUNTING_NODE_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_COUNTING_NODE, PurpleCountingNodeClass))
  39 #define PURPLE_IS_COUNTING_NODE(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_COUNTING_NODE))
  40 #define PURPLE_IS_COUNTING_NODE_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_COUNTING_NODE))
  41 #define PURPLE_COUNTING_NODE_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_COUNTING_NODE, PurpleCountingNodeClass))
  42
  43 typedef struct _PurpleCountingNode PurpleCountingNode;
  44 typedef struct _PurpleCountingNodeClass PurpleCountingNodeClass;
  45
  46 /**
  47  * PurpleCountingNode:
  48  *
  49  * A node that keeps count of the number of children that it has. It tracks the
  50  * total number of children, the number of children corresponding to online
  51  * accounts, and the number of online children.
  52  *
  53  * The two types of counting nodes are:
  54  * <orderedlist>
  55  *  <listitem>Contact: Keeps track of the number of buddies under it.</listitem>
  56  *  <listitem>Group: Keeps track of the number of chats and contacts under it.
  57  *                                                                   </listitem>
  58  * </orderedlist>
  59  *
  60  * See #PurpleContact, #PurpleGroup
  61  */
  62 struct _PurpleCountingNode {
  63         PurpleBlistNode node;
  64 };
  65
  66 struct _PurpleCountingNodeClass {
  67         PurpleBlistNodeClass node_class;
  68
  69         /*< private >*/
  70         void (*_purple_reserved1)(void);
  71         void (*_purple_reserved2)(void);
  72         void (*_purple_reserved3)(void);
  73         void (*_purple_reserved4)(void);
  74 };
  75
  76 G_BEGIN_DECLS
  77
  78 /**
  79  * purple_counting_node_get_type:
  80  *
  81  * Returns: The #GType for the #PurpleCountingNode object.
  82  */
  83 GType purple_counting_node_get_type(void);
  84
  85 /**
  86  * purple_counting_node_get_total_size:
  87  * @counter:  The node
  88  *
  89  * Returns the total number of children of the counting node.
  90  *
  91  * Returns:  The total number of children of the node
  92  */
  93 int purple_counting_node_get_total_size(PurpleCountingNode *counter);
  94
  95 /**
  96  * purple_counting_node_get_current_size:
  97  * @counter:  The node
  98  *
  99  * Returns the number of children of the counting node corresponding to online
 100  * accounts.
 101  *
 102  * Returns:  The number of children with online accounts
 103  */
 104 int purple_counting_node_get_current_size(PurpleCountingNode *counter);
 105
 106 /**
 107  * purple_counting_node_get_online_count:
 108  * @counter:  The node
 109  *
 110  * Returns the number of children of the counting node that are online.
 111  *
 112  * Returns:  The total number of online children
 113  */
 114 int purple_counting_node_get_online_count(PurpleCountingNode *counter);
 115
 116 /**
 117  * purple_counting_node_change_total_size:
 118  * @counter:  The node
 119  * @delta:    The value to change the total size by
 120  *
 121  * 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
 123  * decreased.
 124  */
 125 void purple_counting_node_change_total_size(PurpleCountingNode *counter, int delta);
 126
 127 /**
 128  * purple_counting_node_change_current_size:
 129  * @counter:  The node
 130  * @delta:    The value to change the current size by
 131  *
 132  * 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
 134  * negative, the count is decreased.
 135  */
 136 void purple_counting_node_change_current_size(PurpleCountingNode *counter, int delta);
 137
 138 /**
 139  * purple_counting_node_change_online_count:
 140  * @counter:  The node
 141  * @delta:    The value to change the online count by
 142  *
 143  * 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
 145  * decreased.
 146  */
 147 void purple_counting_node_change_online_count(PurpleCountingNode *counter, int delta);
 148
 149 /**
 150  * purple_counting_node_set_total_size:
 151  * @counter:    The node
 152  * @totalsize:  The total number of children of the node
 153  *
 154  * Sets the total number of children of the counting node.
 155  */
 156 void purple_counting_node_set_total_size(PurpleCountingNode *counter, int totalsize);
 157
 158 /**
 159  * purple_counting_node_set_current_size:
 160  * @counter:      The node
 161  * @currentsize:  The number of children with online accounts
 162  *
 163  * Sets the number of children of the counting node corresponding to online
 164  * accounts.
 165  */
 166 void purple_counting_node_set_current_size(PurpleCountingNode *counter, int currentsize);
 167
 168 /**
 169  * purple_counting_node_set_online_count:
 170  * @counter:      The node
 171  * @onlinecount:  The total number of online children
 172  *
 173  * Sets the number of children of the counting node that are online.
 174  */
 175 void purple_counting_node_set_online_count(PurpleCountingNode *counter, int onlinecount);
 176
 177 G_END_DECLS
 178
 179 #endif /* PURPLE_COUNTING_NODE_H */