libpurple/purpleaccountusersplit.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_ACCOUNT_USER_SPLIT_H
  23 #define PURPLE_ACCOUNT_USER_SPLIT_H
  24
  25 /**
  26  * SECTION:accountusersplit
  27  * @section_id: libpurple-account-user-split
  28  * @short_description: Username splitting
  29  * @title: Account Username Splitting API
  30  */
  31
  32 #include <glib.h>
  33 #include <glib-object.h>
  34
  35 #define PURPLE_TYPE_ACCOUNT_USER_SPLIT (purple_account_user_split_get_type())
  36
  37 /**
  38  * PurpleAccountUserSplit:
  39  *
  40  * A username split.
  41  *
  42  * This is used by some protocols to separate the fields of the username
  43  * into more human-readable components.
  44  */
  45 typedef struct _PurpleAccountUserSplit  PurpleAccountUserSplit;
  46
  47 G_BEGIN_DECLS
  48
  49 GType purple_account_user_split_get_type(void);
  50
  51 /**
  52  * purple_account_user_split_new:
  53  * @text:          The text of the option.
  54  * @default_value: The default value.
  55  * @sep:           The field separator.
  56  *
  57  * Creates a new account username split.
  58  *
  59  * Returns: The new user split.
  60  */
  61 PurpleAccountUserSplit *purple_account_user_split_new(const gchar *text, const gchar *default_value, gchar sep);
  62
  63 /**
  64  * purple_account_user_split_copy:
  65  * @split: The split to copy.
  66  *
  67  * Creates a copy of @split.
  68  *
  69  * Returns: (transfer full): A copy of @split.
  70  *
  71  * Since: 3.0.0
  72  */
  73 PurpleAccountUserSplit *purple_account_user_split_copy(PurpleAccountUserSplit *split);
  74
  75 /**
  76  * purple_account_user_split_destroy:
  77  * @split: The split to destroy.
  78  *
  79  * Destroys an account username split.
  80  */
  81 void purple_account_user_split_destroy(PurpleAccountUserSplit *split);
  82
  83 /**
  84  * purple_account_user_split_get_text:
  85  * @split: The account username split.
  86  *
  87  * Returns the text for an account username split.
  88  *
  89  * Returns: The account username split's text.
  90  */
  91 const gchar *purple_account_user_split_get_text(const PurpleAccountUserSplit *split);
  92
  93 /**
  94  * purple_account_user_split_get_default_value:
  95  * @split: The account username split.
  96  *
  97  * Returns the default string value for an account split.
  98  *
  99  * Returns: The default string.
 100  */
 101 const gchar *purple_account_user_split_get_default_value(const PurpleAccountUserSplit *split);
 102
 103 /**
 104  * purple_account_user_split_get_separator:
 105  * @split: The account username split.
 106  *
 107  * Returns the field separator for an account split.
 108  *
 109  * Returns: The field separator.
 110  */
 111 gchar purple_account_user_split_get_separator(const PurpleAccountUserSplit *split);
 112
 113 /**
 114  * purple_account_user_split_get_reverse:
 115  * @split: The account username split.
 116  *
 117  * Returns the 'reverse' value for an account split.
 118  *
 119  * Returns: The 'reverse' value.
 120  */
 121 gboolean purple_account_user_split_get_reverse(const PurpleAccountUserSplit *split);
 122
 123 /**
 124  * purple_account_user_split_set_reverse:
 125  * @split:   The account username split.
 126  * @reverse: The 'reverse' value
 127  *
 128  * Sets the 'reverse' value for an account split.
 129  */
 130 void purple_account_user_split_set_reverse(PurpleAccountUserSplit *split, gboolean reverse);
 131
 132 /**
 133  * purple_account_user_split_is_constant:
 134  * @split: The account username split.
 135  *
 136  * Returns the constant parameter for an account split.
 137  *
 138  * When split is constant, it does not need to be displayed
 139  * in configuration dialog.
 140  *
 141  * Returns: %TRUE, if the split is constant.
 142  */
 143 gboolean purple_account_user_split_is_constant(const PurpleAccountUserSplit *split);
 144
 145 /**
 146  * purple_account_user_split_set_constant:
 147  * @split:    The account username split.
 148  * @constant: %TRUE, if the split is a constant part.
 149  *
 150  * Sets the constant parameter of account split.
 151  */
 152 void purple_account_user_split_set_constant(PurpleAccountUserSplit *split, gboolean constant);
 153
 154 G_END_DECLS
 155
 156 #endif /* PURPLE_ACCOUNT_USER_SPLIT_H */