e-shell-utils: Evolution Shell Reference Manual

## e-shell-utils e-shell-utils — high-level utilities with shell integration |

## Functions

GFile * | e_shell_run_open_dialog ()
GFile * | e_shell_run_save_dialog ()
guint | e_shell_utils_import_uris ()
void | e_shell_utils_run_preferences ()
gboolean | e_shell_utils_is_quick_reference_available ()
void | e_shell_utils_run_quick_reference ()
void | e_shell_utils_run_help_about ()
void | e_shell_utils_run_help_contents ()
EAlertSink * | e_shell_utils_find_alternate_alert_sink ()

## Includes

    #include <shell/e-shell-utils.h>

## Description

## Functions

### e_shell_run_open_dialog ()

    GFile *
    e_shell_run_open_dialog (EShell *shell,
                             const gchar *title,
                             GtkCallback customize_func,
                             gpointer customize_data);

`e_shell_run_open_dialog` is deprecated and should not be used in newly-written code.

Runs a GtkFileChooserDialog in open mode with the given title and returns the selected GFile. If `customize_func` is provided, the function is called just prior to running the dialog (the file chooser is the first argument, `customize` data is the second). If the user cancels the dialog the function will return `NULL`.

#### Parameters

shell | an EShell |
title | file chooser dialog title |
customize_func | optional dialog customization function |
customize_data | optional data to pass to `customize_func` |

#### Returns

the GFile to open, or `NULL`

### e_shell_run_save_dialog ()

    GFile *
    e_shell_run_save_dialog (EShell *shell,
                             const gchar *title,
                             const gchar *suggestion,
                             const gchar *filters,
                             GtkCallback customize_func,
                             gpointer customize_data);

`e_shell_run_save_dialog` is deprecated and should not be used in newly-written code.

Runs a GtkFileChooserDialog in save mode with the given title and returns the selected GFile. If `customize_func` is provided, the function is called just prior to running the dialog (the file chooser is the first argument, `customize_data` is the second). If the user cancels the dialog the function will return `NULL`.

With non-`NULL` `filters` will be added also file filters to the dialog. The string format is "pat1:mt1;pat2:mt2:...", where 'pat' is a pattern and 'mt' is a MIME type for the pattern to be used. There can be more than one MIME type, those are separated by comma.

#### Parameters

shell | an EShell |
title | file chooser dialog title |
suggestion | file name suggestion, or `NULL` |
filters | Possible filters for dialog, or `NULL` |
customize_func | optional dialog customization function |
customize_data | optional data to pass to `customize_func` |

#### Returns

the GFile to save to, or `NULL`

### e_shell_utils_import_uris ()

    guint
    e_shell_utils_import_uris (EShell *shell,
                               const gchar * const *uris);

`e_shell_utils_import_uris` is deprecated and should not be used in newly-written code.

Imports given URIs to Evolution, giving user a choice what to import if more than one importer can be applied, and where to import it, if the importer itself is configurable.

URIs should be either a filename or URI of form file://. All others are skipped.

#### Parameters

shell | The EShell instance |
uris | `NULL`-terminated list of URIs to import |

#### Returns

the number of URIs successfully handled

### e_shell_utils_run_preferences ()

    void
    e_shell_utils_run_preferences (EShell *shell);

`e_shell_utils_run_preferences` is deprecated and should not be used in newly-written code.

### e_shell_utils_is_quick_reference_available ()

    gboolean
    e_shell_utils_is_quick_reference_available
                                   (EShell *shell);

`e_shell_utils_is_quick_reference_available` is deprecated and should not be used in newly-written code.

### e_shell_utils_run_quick_reference ()

    void
    e_shell_utils_run_quick_reference (EShell *shell);

`e_shell_utils_run_quick_reference` is deprecated and should not be used in newly-written code.

### e_shell_utils_run_help_about ()

    void
    e_shell_utils_run_help_about (EShell *shell);

`e_shell_utils_run_help_about` is deprecated and should not be used in newly-written code.

### e_shell_utils_run_help_contents ()

    void
    e_shell_utils_run_help_contents (EShell *shell);

`e_shell_utils_run_help_contents` is deprecated and should not be used in newly-written code.

### e_shell_utils_find_alternate_alert_sink ()

    EAlertSink *
    e_shell_utils_find_alternate_alert_sink
                                   (GtkWidget *widget);

`e_shell_utils_find_alternate_alert_sink` is deprecated and should not be used in newly-written code.

Search an alternate EAlertSink in the widget hierarchy up-wards from the `widget` (skipping the `widget` itself).

#### Parameters

widget | a GtkWidget for which to do the search |

#### Returns

an alert sink, different than `widget` , or `NULL`, when none found.

[nullable][transfer none]

Since: 3.24

## Types and Values