pidgin/gtkprefs.h

   1 /* pidgin
   2  *
   3  * Pidgin 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
  23 #ifndef _PIDGINPREFS_H_
  24 #define _PIDGINPREFS_H_
  25 /**
  26  * SECTION:gtkprefs
  27  * @section_id: pidgin-gtkprefs
  28  * @short_description: <filename>gtkprefs.h</filename>
  29  * @title: Preferences
  30  */
  31
  32 #include "prefs.h"
  33
  34 G_BEGIN_DECLS
  35
  36 #define PIDGIN_TYPE_PREFS_WINDOW (pidgin_prefs_window_get_type())
  37 G_DECLARE_FINAL_TYPE(PidginPrefsWindow, pidgin_prefs_window, PIDGIN, PREFS_WINDOW, GtkDialog)
  38
  39 /**
  40  * pidgin_prefs_init:
  41  *
  42  * Initializes all UI-specific preferences.
  43  */
  44 void pidgin_prefs_init(void);
  45
  46 /**
  47  * pidgin_prefs_show:
  48  *
  49  * Shows the preferences dialog.
  50  */
  51 void pidgin_prefs_show(void);
  52
  53 /**
  54  * pidgin_prefs_checkbox:
  55  * @title: The text to be displayed as the checkbox label
  56  * @key:   The key of the purple bool pref that will be represented by the checkbox
  57  * @page:  The page to which the new checkbox will be added
  58  *
  59  * Add a new checkbox for a boolean preference
  60  *
  61  * Returns: (transfer full): The new checkbox
  62  */
  63 GtkWidget *pidgin_prefs_checkbox(const char *title, const char *key,
  64                 GtkWidget *page);
  65
  66 /**
  67  * pidgin_prefs_labeled_spin_button:
  68  * @page:  The page to which the spin button will be added
  69  * @title: The text to be displayed as the spin button label
  70  * @key:   The key of the int pref that will be represented by the spin button
  71  * @min:   The minimum value of the spin button
  72  * @max:   The maximum value of the spin button
  73  * @sg:    If not NULL, the size group to which the spin button will be added
  74  *
  75  * Add a new spin button representing an int preference
  76  *
  77  * Returns: (transfer full): An hbox containing both the label and the spinner.  Can be
  78  *          used to set the widgets to sensitive or insensitive based on the
  79  *          value of a checkbox.
  80  */
  81 GtkWidget *pidgin_prefs_labeled_spin_button(GtkWidget *page,
  82                 const gchar *title, const char *key, int min, int max, GtkSizeGroup *sg);
  83
  84 /**
  85  * pidgin_prefs_labeled_entry:
  86  * @page:  The page to which the entry will be added
  87  * @title: The text to be displayed as the entry label
  88  * @key:   The key of the string pref that will be represented by the entry
  89  * @sg:    If not NULL, the size group to which the entry will be added
  90  *
  91  * Add a new entry representing a string preference
  92  *
  93  * Returns: (transfer full) :An hbox containing both the label and the entry.  Can be used to set
  94  *          the widgets to sensitive or insensitive based on the value of a
  95  *          checkbox.
  96  */
  97 GtkWidget *pidgin_prefs_labeled_entry(GtkWidget *page, const gchar *title,
  98                                                                                 const char *key, GtkSizeGroup *sg);
  99
 100 /**
 101  * pidgin_prefs_labeled_password:
 102  * @page:  The page to which the entry will be added
 103  * @title: The text to be displayed as the entry label
 104  * @key:   The key of the string pref that will be represented by the entry
 105  * @sg:    If not NULL, the size group to which the entry will be added
 106  *
 107  * Add a new entry representing a password (string) preference
 108  * The entry will use a password-style text entry (the text is substituded)
 109  *
 110  * Returns: (transfer full): An hbox containing both the label and the entry.  Can be used to set
 111  *          the widgets to sensitive or insensitive based on the value of a
 112  *          checkbox.
 113  */
 114 GtkWidget *pidgin_prefs_labeled_password(GtkWidget *page, const gchar *title,
 115                                                                                 const char *key, GtkSizeGroup *sg);
 116
 117 /**
 118  * pidgin_prefs_dropdown:
 119  * @page:  The page to which the dropdown will be added
 120  * @title: The text to be displayed as the dropdown label
 121  * @type:  The type of preference to be stored in the generated dropdown
 122  * @key:   The key of the pref that will be represented by the dropdown
 123  * @...:   The choices to be added to the dropdown, choices should be
 124  *              paired as label/value
 125  *
 126  * Add a new dropdown representing a preference of the specified type
 127  *
 128  * Returns: (transfer full): The new dropdown.
 129  */
 130 GtkWidget *pidgin_prefs_dropdown(GtkWidget *page, const gchar *title,
 131                 PurplePrefType type, const char *key, ...);
 132
 133 /**
 134  * pidgin_prefs_dropdown_from_list:
 135  * @page:      The page to which the dropdown will be added
 136  * @title:     The text to be displayed as the dropdown label
 137  * @type:      The type of preference to be stored in the dropdown
 138  * @key:       The key of the pref that will be represented by the dropdown
 139  * @menuitems: The choices to be added to the dropdown, choices should
 140  *             be paired as label/value
 141  *
 142  * Add a new dropdown representing a preference of the specified type
 143  *
 144  * Returns: (transfer full): The new dropdown.
 145  */
 146 GtkWidget *pidgin_prefs_dropdown_from_list(GtkWidget *page,
 147                 const gchar * title, PurplePrefType type, const char *key,
 148                 GList *menuitems);
 149
 150 /**
 151  * pidgin_prefs_update_old:
 152  *
 153  * Rename legacy prefs and delete some that no longer exist.
 154  */
 155 void pidgin_prefs_update_old(void);
 156
 157 G_END_DECLS
 158
 159 #endif /* _PIDGINPREFS_H_ */