pidgin/gtkprefs.h

   1 /**
   2  * @file gtkprefs.h GTK+ Preferences
   3  * @ingroup pidgin
   4  */
   5
   6 /* pidgin
   7  *
   8  * Pidgin is the legal property of its developers, whose names are too numerous
   9  * to list here.  Please refer to the COPYRIGHT file distributed with this
  10  * source distribution.
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  25  *
  26  */
  27 #ifndef _PIDGINPREFS_H_
  28 #define _PIDGINPREFS_H_
  29
  30 #include "prefs.h"
  31
  32 /**
  33  * Initializes all UI-specific preferences.
  34  */
  35 void pidgin_prefs_init(void);
  36
  37 /**
  38  * Shows the preferences dialog.
  39  */
  40 void pidgin_prefs_show(void);
  41
  42 /**
  43  * Add a new checkbox for a boolean preference
  44  *
  45  * @param title The text to be displayed as the checkbox label
  46  * @param key   The key of the purple bool pref that will be represented by the checkbox
  47  * @param page  The page to which the new checkbox will be added
  48  */
  49 GtkWidget *pidgin_prefs_checkbox(const char *title, const char *key,
  50                 GtkWidget *page);
  51
  52 /**
  53  * Add a new spin button representing an int preference
  54  *
  55  * @param page  The page to which the spin button will be added
  56  * @param title The text to be displayed as the spin button label
  57  * @param key   The key of the int pref that will be represented by the spin button
  58  * @param min   The minimum value of the spin button
  59  * @param max   The maximum value of the spin button
  60  * @param sg    If not NULL, the size group to which the spin button will be added
  61  * @return      An hbox containing both the label and the spinner.  Can be
  62  *              used to set the widgets to sensitive or insensitive based on the
  63  *              value of a checkbox.
  64  */
  65 GtkWidget *pidgin_prefs_labeled_spin_button(GtkWidget *page,
  66                 const gchar *title, const char *key, int min, int max, GtkSizeGroup *sg);
  67
  68 /**
  69  * Add a new entry representing a string preference
  70  *
  71  * @param page  The page to which the entry will be added
  72  * @param title The text to be displayed as the entry label
  73  * @param key   The key of the string pref that will be represented by the entry
  74  * @param sg    If not NULL, the size group to which the entry will be added
  75  *
  76  * @return      An hbox containing both the label and the entry.  Can be used to set
  77  *               the widgets to sensitive or insensitive based on the value of a
  78  *               checkbox.
  79  */
  80 GtkWidget *pidgin_prefs_labeled_entry(GtkWidget *page, const gchar *title,
  81                                                                                 const char *key, GtkSizeGroup *sg);
  82
  83 /**
  84  * Add a new entry representing a password (string) preference
  85  * The entry will use a password-style text entry (the text is substituded)
  86  *
  87  * @param page  The page to which the entry will be added
  88  * @param title The text to be displayed as the entry label
  89  * @param key   The key of the string pref that will be represented by the entry
  90  * @param sg    If not NULL, the size group to which the entry will be added
  91  *
  92  * @return      An hbox containing both the label and the entry.  Can be used to set
  93  *               the widgets to sensitive or insensitive based on the value of a
  94  *               checkbox.
  95  *
  96  * @since 2.6.0
  97  */
  98 GtkWidget *pidgin_prefs_labeled_password(GtkWidget *page, const gchar *title,
  99                                                                                 const char *key, GtkSizeGroup *sg);
 100
 101 /**
 102  * Add a new dropdown representing a preference of the specified type
 103  *
 104  * @param page  The page to which the dropdown will be added
 105  * @param title The text to be displayed as the dropdown label
 106  * @param type  The type of preference to be stored in the generated dropdown
 107  * @param key   The key of the pref that will be represented by the dropdown
 108  * @param ...   The choices to be added to the dropdown, choices should be
 109  *              paired as label/value
 110  */
 111 GtkWidget *pidgin_prefs_dropdown(GtkWidget *page, const gchar *title,
 112                 PurplePrefType type, const char *key, ...);
 113
 114 /**
 115  * Add a new dropdown representing a preference of the specified type
 116  *
 117  * @param page      The page to which the dropdown will be added
 118  * @param title     The text to be displayed as the dropdown label
 119  * @param type      The type of preference to be stored in the dropdown
 120  * @param key       The key of the pref that will be represented by the dropdown
 121  * @param menuitems The choices to be added to the dropdown, choices should
 122  *                  be paired as label/value
 123  */
 124 GtkWidget *pidgin_prefs_dropdown_from_list(GtkWidget *page,
 125                 const gchar * title, PurplePrefType type, const char *key,
 126                 GList *menuitems);
 127
 128 /**
 129  * Rename legacy prefs and delete some that no longer exist.
 130  */
 131 void pidgin_prefs_update_old(void);
 132
 133 #endif /* _PIDGINPREFS_H_ */