pidgin/gtkprefs.h

branch
soc.2013.gobjectification.plugins
changeset 37023
d9bcdc9a91e6
parent 37017
8e2b68c79fa1
child 37034
9d6765962b22
equal deleted inserted replaced
37022:d891503c8aa6 37023:d9bcdc9a91e6
42 void pidgin_prefs_show(void); 42 void pidgin_prefs_show(void);
43 43
44 /** 44 /**
45 * Add a new checkbox for a boolean preference 45 * Add a new checkbox for a boolean preference
46 * 46 *
47 * @title: The text to be displayed as the checkbox label 47 * @param title The text to be displayed as the checkbox label
48 * @key: The key of the purple bool pref that will be represented by the checkbox 48 * @param key The key of the purple bool pref that will be represented by the checkbox
49 * @page: The page to which the new checkbox will be added 49 * @param page The page to which the new checkbox will be added
50 */ 50 */
51 GtkWidget *pidgin_prefs_checkbox(const char *title, const char *key, 51 GtkWidget *pidgin_prefs_checkbox(const char *title, const char *key,
52 GtkWidget *page); 52 GtkWidget *page);
53 53
54 /** 54 /**
55 * Add a new spin button representing an int preference 55 * Add a new spin button representing an int preference
56 * 56 *
57 * @page: The page to which the spin button will be added 57 * @param page The page to which the spin button will be added
58 * @title: The text to be displayed as the spin button label 58 * @param title The text to be displayed as the spin button label
59 * @key: The key of the int pref that will be represented by the spin button 59 * @param key The key of the int pref that will be represented by the spin button
60 * @min: The minimum value of the spin button 60 * @param min The minimum value of the spin button
61 * @max: The maximum value of the spin button 61 * @param max The maximum value of the spin button
62 * @sg: If not NULL, the size group to which the spin button will be added 62 * @param sg If not NULL, the size group to which the spin button will be added
63 * Returns: An hbox containing both the label and the spinner. Can be 63 * @return An hbox containing both the label and the spinner. Can be
64 * used to set the widgets to sensitive or insensitive based on the 64 * used to set the widgets to sensitive or insensitive based on the
65 * value of a checkbox. 65 * value of a checkbox.
66 */ 66 */
67 GtkWidget *pidgin_prefs_labeled_spin_button(GtkWidget *page, 67 GtkWidget *pidgin_prefs_labeled_spin_button(GtkWidget *page,
68 const gchar *title, const char *key, int min, int max, GtkSizeGroup *sg); 68 const gchar *title, const char *key, int min, int max, GtkSizeGroup *sg);
69 69
70 /** 70 /**
71 * Add a new entry representing a string preference 71 * Add a new entry representing a string preference
72 * 72 *
73 * @page: The page to which the entry will be added 73 * @param page The page to which the entry will be added
74 * @title: The text to be displayed as the entry label 74 * @param title The text to be displayed as the entry label
75 * @key: The key of the string pref that will be represented by the entry 75 * @param key The key of the string pref that will be represented by the entry
76 * @sg: If not NULL, the size group to which the entry will be added 76 * @param sg If not NULL, the size group to which the entry will be added
77 * 77 *
78 * Returns: An hbox containing both the label and the entry. Can be used to set 78 * @return An hbox containing both the label and the entry. Can be used to set
79 * the widgets to sensitive or insensitive based on the value of a 79 * the widgets to sensitive or insensitive based on the value of a
80 * checkbox. 80 * checkbox.
81 */ 81 */
82 GtkWidget *pidgin_prefs_labeled_entry(GtkWidget *page, const gchar *title, 82 GtkWidget *pidgin_prefs_labeled_entry(GtkWidget *page, const gchar *title,
83 const char *key, GtkSizeGroup *sg); 83 const char *key, GtkSizeGroup *sg);
84 84
85 /** 85 /**
86 * Add a new entry representing a password (string) preference 86 * Add a new entry representing a password (string) preference
87 * The entry will use a password-style text entry (the text is substituded) 87 * The entry will use a password-style text entry (the text is substituded)
88 * 88 *
89 * @page: The page to which the entry will be added 89 * @param page The page to which the entry will be added
90 * @title: The text to be displayed as the entry label 90 * @param title The text to be displayed as the entry label
91 * @key: The key of the string pref that will be represented by the entry 91 * @param key The key of the string pref that will be represented by the entry
92 * @sg: If not NULL, the size group to which the entry will be added 92 * @param sg If not NULL, the size group to which the entry will be added
93 * 93 *
94 * Returns: An hbox containing both the label and the entry. Can be used to set 94 * @return An hbox containing both the label and the entry. Can be used to set
95 * the widgets to sensitive or insensitive based on the value of a 95 * the widgets to sensitive or insensitive based on the value of a
96 * checkbox. 96 * checkbox.
97 */ 97 */
98 GtkWidget *pidgin_prefs_labeled_password(GtkWidget *page, const gchar *title, 98 GtkWidget *pidgin_prefs_labeled_password(GtkWidget *page, const gchar *title,
99 const char *key, GtkSizeGroup *sg); 99 const char *key, GtkSizeGroup *sg);
100 100
101 /** 101 /**
102 * Add a new dropdown representing a preference of the specified type 102 * Add a new dropdown representing a preference of the specified type
103 * 103 *
104 * @page: The page to which the dropdown will be added 104 * @param page The page to which the dropdown will be added
105 * @title: The text to be displayed as the dropdown label 105 * @param title The text to be displayed as the dropdown label
106 * @type: The type of preference to be stored in the generated dropdown 106 * @param type The type of preference to be stored in the generated dropdown
107 * @key: The key of the pref that will be represented by the dropdown 107 * @param key The key of the pref that will be represented by the dropdown
108 * @...: The choices to be added to the dropdown, choices should be 108 * @param ... The choices to be added to the dropdown, choices should be
109 * paired as label/value 109 * paired as label/value
110 */ 110 */
111 GtkWidget *pidgin_prefs_dropdown(GtkWidget *page, const gchar *title, 111 GtkWidget *pidgin_prefs_dropdown(GtkWidget *page, const gchar *title,
112 PurplePrefType type, const char *key, ...); 112 PurplePrefType type, const char *key, ...);
113 113
114 /** 114 /**
115 * Add a new dropdown representing a preference of the specified type 115 * Add a new dropdown representing a preference of the specified type
116 * 116 *
117 * @page: The page to which the dropdown will be added 117 * @param page The page to which the dropdown will be added
118 * @title: The text to be displayed as the dropdown label 118 * @param title The text to be displayed as the dropdown label
119 * @type: The type of preference to be stored in the dropdown 119 * @param type The type of preference to be stored in the dropdown
120 * @key: The key of the pref that will be represented by the dropdown 120 * @param key The key of the pref that will be represented by the dropdown
121 * @menuitems: The choices to be added to the dropdown, choices should 121 * @param menuitems The choices to be added to the dropdown, choices should
122 * be paired as label/value 122 * be paired as label/value
123 */ 123 */
124 GtkWidget *pidgin_prefs_dropdown_from_list(GtkWidget *page, 124 GtkWidget *pidgin_prefs_dropdown_from_list(GtkWidget *page,
125 const gchar * title, PurplePrefType type, const char *key, 125 const gchar * title, PurplePrefType type, const char *key,
126 GList *menuitems); 126 GList *menuitems);

mercurial