pidgin/pidginproxyoptions.h

changeset 41767
f9bb5493c0a0
parent 41766
78a984e17548
child 41768
108bed9875bd
equal deleted inserted replaced
41766:78a984e17548 41767:f9bb5493c0a0
1 /*
2 * Pidgin - Internet Messenger
3 * Copyright (C) Pidgin Developers <devel@pidgin.im>
4 *
5 * Pidgin is the legal property of its developers, whose names are too numerous
6 * to list here. Please refer to the COPYRIGHT file distributed with this
7 * source distribution.
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, see <https://www.gnu.org/licenses/>.
21 */
22
23 #if !defined(PIDGIN_GLOBAL_HEADER_INSIDE) && !defined(PIDGIN_COMPILATION)
24 # error "only <pidgin.h> may be included directly"
25 #endif
26
27 #ifndef PIDGIN_PROXY_OPTIONS_H
28 #define PIDGIN_PROXY_OPTIONS_H
29
30 #include <gtk/gtk.h>
31
32 #include <purple.h>
33
34 G_BEGIN_DECLS
35
36 /**
37 * PidginProxyOptions:
38 *
39 * A widget for the proxy options in the account editor.
40 *
41 * Since: 3.0.0
42 */
43
44 #define PIDGIN_TYPE_PROXY_OPTIONS (pidgin_proxy_options_get_type())
45 G_DECLARE_FINAL_TYPE(PidginProxyOptions, pidgin_proxy_options, PIDGIN,
46 PROXY_OPTIONS, GtkBox)
47
48 /**
49 * pidgin_proxy_options_new:
50 *
51 * Creates a new proxy options widget.
52 *
53 * Returns: (transfer full): The widget.
54 *
55 * Since: 3.0.0
56 */
57 GtkWidget *pidgin_proxy_options_new(void);
58
59 /**
60 * pidgin_proxy_options_set_show_global:
61 * @options: The instance.
62 * @show_global: Whether or not to show the use global settings proxy item.
63 *
64 * Sets whether or not to show the "Use Global Proxy Settings" item.
65 *
66 * Since: 3.0.0
67 */
68 void pidgin_proxy_options_set_show_global(PidginProxyOptions *options, gboolean show_global);
69
70 /**
71 * pidgin_proxy_options_get_show_global:
72 * @options: The instance.
73 *
74 * Gets whether or not @options is displaying the "Use Global Proxy Settings"
75 * item.
76 *
77 * Returns: %TRUE if displaying it, %FALSE otherwise.
78 *
79 * Since: 3.0.0
80 */
81 gboolean pidgin_proxy_options_get_show_global(PidginProxyOptions *options);
82
83 /**
84 * pidgin_proxy_options_get_info:
85 * @options: The instance.
86 *
87 * Gets the [class@Purple.ProxyInfo] that is being configured.
88 *
89 * Returns: (transfer none): The proxy info.
90 *
91 * Since: 3.0.0
92 */
93 PurpleProxyInfo *pidgin_proxy_options_get_info(PidginProxyOptions *options);
94
95 /**
96 * pidgin_proxy_options_set_info:
97 * @options: The instance.
98 * @info: (nullable): The [class@Purple.ProxyInfo] to set.
99 *
100 * The proxy info that will be configured.
101 *
102 * Since: 3.0.0
103 */
104 void pidgin_proxy_options_set_info(PidginProxyOptions *options, PurpleProxyInfo *info);
105
106 G_END_DECLS
107
108 #endif /* PIDGIN_PROXY_OPTIONS_H */

mercurial