## cong-error-dialog

cong-error-dialog —

## Synopsis

    GtkDialog*  cong_error_dialog_new           (GtkWindow *parent_window,
                                                 const gchar *what_failed,
                                                 const gchar *why_failed,
                                                 const gchar *suggestions);
    GtkDialog*  cong_error_dialog_new_with_convenience
                                                (GtkWindow *parent_window,
                                                 const gchar *what_failed,
                                                 const gchar *why_failed,
                                                 const gchar *suggestions,
                                                 const gchar *convenience_label,
                                                 const gchar *cancel_label,
                                                 gboolean is_convenience_default,
                                                 void (*convenience_action) (gpointer data),
                                                 gpointer convenience_data);
    void        cong_error_dialog_run           (GtkDialog *dialog);
    void        cong_error_dialog_do            (GtkDialog *dialog);
    gchar*      cong_error_get_appname          (void);
    GtkDialog*  cong_error_dialog_new_from_unimplemented_feature
                                                (GtkWindow *parent_window,
                                                 const gchar *what_failed,
                                                 const char *filename,
                                                 int linenum);
    GtkDialog*  cong_error_dialog_new_from_unimplemented_feature_with_bugzilla_id
                                                (GtkWindow *parent_window,
                                                 const gchar *what_failed,
                                                 const char *filename,
                                                 int linenum,
                                                 const gchar *bugzilla_url,
                                                 int bugzilla_id);
    #define     CONG_BUGZILLA_URL
    #define     CONG_DO_UNIMPLEMENTED_DIALOG    (parent_window, what_failed)
    #define     CONG_DO_UNIMPLEMENTED_DIALOG_WITH_BUGZILLA_ID(parent_window, what_failed, bugzilla_id)
    GtkDialog*  cong_error_dialog_new_from_gerror
                                                (GtkWindow *toplevel_window,
                                                 const gchar *what_failed,
                                                 const char *details,
                                                 GError *error);
    GtkDialog*  cong_error_dialog_new_from_shell_command_failure_with_command_line
                                                (GtkWindow *parent_window,
                                                 const gchar *what_failed,
                                                 gint exit_status,
                                                 const gchar *standard_error,
                                                 const gchar *command_line);
    GtkDialog*  cong_error_dialog_new_from_shell_command_failure_with_argv
                                                (GtkWindow *parent_window,
                                                 const gchar *what_failed,
                                                 gint exit_status,
                                                 const gchar *standard_error,
                                                 const gchar **argv);
    gchar*      cong_error_what_failed_on_file_open_failure
                                                (const gchar *string_uri,
                                                 gboolean transient);
    GtkDialog*  cong_error_dialog_new_from_file_open_failure
                                                (GtkWindow *parent_window,
                                                 const gchar *string_uri,
                                                 gboolean transient,
                                                 const gchar *why_failed,
                                                 const gchar *suggestions);
    GtkDialog*  cong_error_dialog_new_from_file_open_failure_with_convenience
                                                (GtkWindow *parent_window,
                                                 const gchar *string_uri,
                                                 gboolean transient,
                                                 const gchar *why_failed,
                                                 const gchar *suggestions,
                                                 const gchar *convenience_label,
                                                 void (*convenience_action) (gpointer data),
                                                 gpointer convenience_data);
    GtkDialog*  cong_error_dialog_new_from_file_open_failure_with_vfs_result
                                                (GtkWindow *parent_window,
                                                 const gchar *string_uri,
                                                 GnomeVFSResult vfs_result);
    GtkDialog*  cong_error_dialog_new_from_file_save_failure
                                                (GtkWindow *parent_window,
                                                 const gchar *string_uri,
                                                 GnomeVFSResult vfs_result,
                                                 const GnomeVFSFileSize *file_size);
    GtkDialog*  cong_error_dialog_new_from_file_operation_failure
                                                (GtkWindow *parent_window,
                                                 const gchar *what_failed,
                                                 const gchar *string_uri,
                                                 GnomeVFSResult vfs_result,
                                                 const gchar *technical_details);
    void        cong_error_tests                (GtkWindow *parent_window);

## Description

## Details

### cong_error_dialog_new ()

    GtkDialog*  cong_error_dialog_new           (GtkWindow *parent_window,
                                                 const gchar *what_failed,
                                                 const gchar *why_failed,
                                                 const gchar *suggestions);

TODO: Write me

`parent_window` : |
`what_failed` : |
`why_failed` : |
`suggestions` : |
Returns : |

### cong_error_dialog_new_with_convenience ()

    GtkDialog*  cong_error_dialog_new_with_convenience
                                                (GtkWindow *parent_window,
                                                 const gchar *what_failed,
                                                 const gchar *why_failed,
                                                 const gchar *suggestions,
                                                 const gchar *convenience_label,
                                                 const gchar *cancel_label,
                                                 gboolean is_convenience_default,
                                                 void (*convenience_action) (gpointer data),
                                                 gpointer convenience_data);

Use this function to create a dialog, that will report user about error and suggest a way, how user can avoid those error. It is more preferable to report about errors with this function, rather than with cong_error_dialog_new.

`parent_window` : | Parent window for dialog.
`what_failed` : | The description of what failed
`why_failed` : | The reasons of failture
`suggestions` : | The suggestions for user.
`convenience_label` : | Label or gtk stock for convenience button.
`cancel_label` : | Label or gtk stock for cancel button.
`is_convenience_default` : | Should the convenience action be the default response.
`convenience_action` : | Callback to call on convenience response.
`convenience_data` : | Data to pass to the callback.
Returns : | Dialog widget that should be passed to cong_error_dialog_run.

### cong_error_dialog_run ()

    void        cong_error_dialog_run           (GtkDialog *dialog);

TODO: Write me

`dialog` : |

### cong_error_dialog_do ()

    void        cong_error_dialog_do            (GtkDialog *dialog);

TODO: Write me

`dialog` : |

### cong_error_get_appname ()

    gchar*      cong_error_get_appname          (void);

Returns : | a string containing "Conglomerate"

### cong_error_dialog_new_from_unimplemented_feature ()

    GtkDialog*  cong_error_dialog_new_from_unimplemented_feature
                                                (GtkWindow *parent_window,
                                                 const gchar *what_failed,
                                                 const char *filename,
                                                 int linenum);

TODO: Write me

`parent_window` : |
`what_failed` : |
`filename` : |
`linenum` : |
Returns : |

### cong_error_dialog_new_from_unimplemented_feature_with_bugzilla_id ()

    GtkDialog*  cong_error_dialog_new_from_unimplemented_feature_with_bugzilla_id
                                                (GtkWindow *parent_window,
                                                 const gchar *what_failed,
                                                 const char *filename,
                                                 int linenum,
                                                 const gchar *bugzilla_url,
                                                 int bugzilla_id);

TODO: Write me

`parent_window` : |
`what_failed` : |
`filename` : |
`linenum` : |
`bugzilla_url` : |
`bugzilla_id` : |
Returns : |

### CONG_BUGZILLA_URL

    #define CONG_BUGZILLA_URL ("http://bugzilla.gnome.org")

### CONG_DO_UNIMPLEMENTED_DIALOG()

    #define CONG_DO_UNIMPLEMENTED_DIALOG(parent_window, what_failed) (cong_error_dialog_do(cong_error_dialog_new_from_unimplemented_feature((parent_window), (what_failed), __FILE__, __LINE__)))

`parent_window` : |
`what_failed` : |

### CONG_DO_UNIMPLEMENTED_DIALOG_WITH_BUGZILLA_ID()

    #define CONG_DO_UNIMPLEMENTED_DIALOG_WITH_BUGZILLA_ID(parent_window, what_failed, bugzilla_id) (cong_error_dialog_do(cong_error_dialog_new_from_unimplemented_feature_with_bugzilla_id((parent_window), (what_failed), __FILE__, __LINE__, CONG_BUGZILLA_URL, (bugzilla_id))))

`parent_window` : |
`what_failed` : |
`bugzilla_id` : |

### cong_error_dialog_new_from_gerror ()

    GtkDialog*  cong_error_dialog_new_from_gerror
                                                (GtkWindow *toplevel_window,
                                                 const gchar *what_failed,
                                                 const char *details,
                                                 GError *error);

TODO: Write me

`toplevel_window` : |
`what_failed` : |
`details` : |
`error` : |
Returns : |

### cong_error_dialog_new_from_shell_command_failure_with_command_line ()

    GtkDialog*  cong_error_dialog_new_from_shell_command_failure_with_command_line
                                                (GtkWindow *parent_window,
                                                 const gchar *what_failed,
                                                 gint exit_status,
                                                 const gchar *standard_error,
                                                 const gchar *command_line);

TODO: Write me

`parent_window` : |
`what_failed` : |
`exit_status` : |
`standard_error` : |
`command_line` : |
Returns : |

### cong_error_dialog_new_from_shell_command_failure_with_argv ()

    GtkDialog*  cong_error_dialog_new_from_shell_command_failure_with_argv
                                                (GtkWindow *parent_window,
                                                 const gchar *what_failed,
                                                 gint exit_status,
                                                 const gchar *standard_error,
                                                 const gchar **argv);

Routine to manufacture an error dialog for when some shell operation fails, when you have access to the stderr output in the form of a string. argv is a NULL terminated array of strings.

`parent_window` : |
`what_failed` : |
`exit_status` : |
`standard_error` : |
`argv` : |
Returns : |

### cong_error_what_failed_on_file_open_failure ()

    gchar*      cong_error_what_failed_on_file_open_failure
                                                (const gchar *string_uri,
                                                 gboolean transient);

TODO: Write me

`string_uri` : |
`transient` : |
Returns : |

### cong_error_dialog_new_from_file_open_failure ()

    GtkDialog*  cong_error_dialog_new_from_file_open_failure
                                                (GtkWindow *parent_window,
                                                 const gchar *string_uri,
                                                 gboolean transient,
                                                 const gchar *why_failed,
                                                 const gchar *suggestions);

TODO: Write me

`parent_window` : |
`string_uri` : |
`transient` : |
`why_failed` : |
`suggestions` : |
Returns : |

### cong_error_dialog_new_from_file_open_failure_with_convenience ()

    GtkDialog*  cong_error_dialog_new_from_file_open_failure_with_convenience
                                                (GtkWindow *parent_window,
                                                 const gchar *string_uri,
                                                 gboolean transient,
                                                 const gchar *why_failed,
                                                 const gchar *suggestions,
                                                 const gchar *convenience_label,
                                                 void (*convenience_action) (gpointer data),
                                                 gpointer convenience_data);

TODO: Write me

`parent_window` : |
`string_uri` : |
`transient` : |
`why_failed` : |
`suggestions` : |
`convenience_label` : |
`convenience_action` : |
`convenience_data` : |
Returns : |

### cong_error_dialog_new_from_file_open_failure_with_vfs_result ()

    GtkDialog*  cong_error_dialog_new_from_file_open_failure_with_vfs_result
                                                (GtkWindow *parent_window,
                                                 const gchar *string_uri,
                                                 GnomeVFSResult vfs_result);

TODO: Write me

`parent_window` : |
`string_uri` : |
`vfs_result` : |
Returns : |

### cong_error_dialog_new_from_file_save_failure ()

    GtkDialog*  cong_error_dialog_new_from_file_save_failure
                                                (GtkWindow *parent_window,
                                                 const gchar *string_uri,
                                                 GnomeVFSResult vfs_result,
                                                 const GnomeVFSFileSize *file_size);

TODO: Write me

`parent_window` : |
`string_uri` : |
`vfs_result` : |
`file_size` : |
Returns : |

### cong_error_dialog_new_from_file_operation_failure ()

    GtkDialog*  cong_error_dialog_new_from_file_operation_failure
                                                (GtkWindow *parent_window,
                                                 const gchar *what_failed,
                                                 const gchar *string_uri,
                                                 GnomeVFSResult vfs_result,
                                                 const gchar *technical_details);

Routine to manufacture an error dialog for when some file operation fails that doesn't fall into one of the categories above. Displays what operation has failed, with a convenience button to get more techical information.

`parent_window` : |
`what_failed` : |
`string_uri` : | the URI from which you tried to access file.
`vfs_result` : |
`technical_details` : |
Returns : |

### cong_error_tests ()

    void        cong_error_tests                (GtkWindow *parent_window);

TODO: Write me

`parent_window` : |