EProxyPreferences

EProxyPreferences — Manage network proxy preferences

Synopsis

#include <e-util/e-util.h>

struct              EProxyPreferences;
GtkWidget *         e_proxy_preferences_new             (ESourceRegistry *registry);
void                e_proxy_preferences_submit          (EProxyPreferences *preferences);
ESourceRegistry *   e_proxy_preferences_get_registry    (EProxyPreferences *preferences);
gboolean            e_proxy_preferences_get_show_advanced
                                                        (EProxyPreferences *preferences);
void                e_proxy_preferences_set_show_advanced
                                                        (EProxyPreferences *preferences,
                                                         gboolean show_advanced);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkWidget
               +----GtkContainer
                     +----GtkBox
                           +----EProxyPreferences

Implemented Interfaces

EProxyPreferences implements AtkImplementorIface, GtkBuildable and GtkOrientable.

Properties

  "registry"                 ESourceRegistry*      : Read / Write / Construct Only
  "show-advanced"            gboolean              : Read / Write

Description

EProxyPreferences is the main widget for displaying network proxy preferences. A link button toggles between a basic mode (for most users) and advanced mode. Basic mode only shows proxy details for the built-in proxy profile, which all new accounts use by default. Advanced mode reveals a sidebar of proxy profiles, allowing users to create or delete custom profiles and apply them to particular accounts.

Details

struct EProxyPreferences

struct EProxyPreferences;

Contains only private data that should be read and manipulated using the functions below.


e_proxy_preferences_new ()

GtkWidget *         e_proxy_preferences_new             (ESourceRegistry *registry);

Creates a new EProxyPreferences widget using ESource instances in registry.

registry :

an ESourceRegistry

Returns :

a new EProxyPreferences

e_proxy_preferences_submit ()

void                e_proxy_preferences_submit          (EProxyPreferences *preferences);

Writes the displayed proxy profile details to the ESource being edited, and submits the changes to the registry service asynchronously.

Normally changes are submitted to the registry service automatically after a brief delay, but changes may sometimes need to be submitted explicitly such as when the top-level window is closing.

preferences :

an EProxyPreferences

e_proxy_preferences_get_registry ()

ESourceRegistry *   e_proxy_preferences_get_registry    (EProxyPreferences *preferences);

Returns the ESourceRegistry passed to e_proxy_preferences_new().

preferences :

an EProxyPreferences

Returns :

an ESourceRegistry

e_proxy_preferences_get_show_advanced ()

gboolean            e_proxy_preferences_get_show_advanced
                                                        (EProxyPreferences *preferences);

Returns whether preferences is currently in advanced mode.

preferences :

an EProxyPreferences

Returns :

whether advanced proxy preferences are visible

e_proxy_preferences_set_show_advanced ()

void                e_proxy_preferences_set_show_advanced
                                                        (EProxyPreferences *preferences,
                                                         gboolean show_advanced);

Switches preferences to advanced mode if show_advanced is TRUE, or to basic mode if show_advanced is FALSE.

preferences :

an EProxyPreferences

show_advanced :

whether to show advanced proxy preferences

Property Details

The "registry" property

  "registry"                 ESourceRegistry*      : Read / Write / Construct Only

Data source registry.


The "show-advanced" property

  "show-advanced"            gboolean              : Read / Write

Show advanced proxy preferences.

Default value: FALSE