|  |  |  | libseahorse Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | ||||
const AvahiPoll * seahorse_util_dns_sd_get_poll (); enum SeahorseSuffix; #define SEAHORSE_EXT_ASC #define SEAHORSE_EXT_SIG #define SEAHORSE_EXT_PGP #define SEAHORSE_EXT_GPG gchar * seahorse_util_get_date_string (const time_t time); gchar * seahorse_util_get_display_date_string (const time_t time); #define SEAHORSE_ERROR GQuark seahorse_util_error_domain (); void seahorse_util_show_error (GtkWidget *parent,const gchar *heading,const gchar *message); void seahorse_util_handle_error (GError *err,const char *desc,...); gboolean seahorse_util_prompt_delete (const gchar *text,GtkWidget *parent); guchar * seahorse_util_read_to_memory (GInputStream *input,guint *len); guint seahorse_util_read_data_block (GString *buf,GInputStream *input,const gchar *start,const gchar *end); GMemoryInputStream * seahorse_util_memory_input_string (const gchar *string,gsize length); gsize seahorse_util_memory_output_length (GMemoryOutputStream *output); gboolean seahorse_util_print_fd (int fd,const char *data); gboolean seahorse_util_printf_fd (int fd,const char *data,...); gchar * seahorse_util_filename_for_objects (GList *objects); gboolean seahorse_util_uri_exists (const gchar *uri); gchar * seahorse_util_uri_unique (const gchar *uri); gchar * seahorse_util_uri_replace_ext (const gchar *uri,const gchar *ext); const gchar * seahorse_util_uri_get_last (const gchar *uri); const gchar * seahorse_util_uri_split_last (gchar *uri); gboolean seahorse_util_uris_package (const gchar *package,const gchar **uris); GQuark seahorse_util_detect_mime_type (const gchar *mime); GQuark seahorse_util_detect_data_type (const gchar *data,guint length); GQuark seahorse_util_detect_file_type (const gchar *uri); gboolean seahorse_util_write_file_private (const gchar *filename,const gchar *contents,GError **err); GtkDialog * seahorse_util_chooser_open_new (const gchar *title,GtkWindow *parent); GtkDialog * seahorse_util_chooser_save_new (const gchar *title,GtkWindow *parent); void seahorse_util_chooser_show_key_files (GtkDialog *dialog); void seahorse_util_chooser_show_archive_files (GtkDialog *dialog); void seahorse_util_chooser_set_filename_full (GtkDialog *dialog,GList *objects); void seahorse_util_chooser_set_filename (GtkDialog *dialog,struct _SeahorseObject *object); gchar * seahorse_util_chooser_open_prompt (GtkDialog *dialog); gchar * seahorse_util_chooser_save_prompt (GtkDialog *dialog); gboolean seahorse_util_check_suffix (const gchar *path,SeahorseSuffix suffix); gchar * seahorse_util_add_suffix (const gchar *path,SeahorseSuffix suffix,const gchar *prompt); gchar * seahorse_util_remove_suffix (const gchar *path,const gchar *prompt); gchar ** seahorse_util_strvec_dup (const gchar **vec); guint seahorse_util_strvec_length (const gchar **vec); GList * seahorse_util_objects_sort (GList *objects); GList * seahorse_util_objects_splice (GList *objects); gboolean seahorse_util_string_equals (const gchar *s1,const gchar *s2); gchar * seahorse_util_string_up_first (const gchar *orig); void seahorse_util_string_lower (gchar *s); GSList * seahorse_util_string_slist_free (GSList *slist); GSList * seahorse_util_string_slist_copy (GSList *slist); gboolean seahorse_util_string_slist_equal (GSList *sl1,GSList *sl2); gboolean seahorse_util_string_is_whitespace (const gchar *text); void seahorse_util_string_trim_whitespace (gchar *text); gchar * seahorse_util_hex_encode (gconstpointer value,gsize length); void seahorse_util_determine_popup_menu_position (GtkMenu *menu,int *x,int *y,gboolean *push_in,gpointer gdata); #define seahorse_util_wait_until (expr) #define DBG_PRINT (x)
gchar *		           seahorse_util_get_date_string       (const time_t time);
Creates a string representation of time for use with gpg.
| 
 | Time value to parse | 
| Returns : | A string representing time. The returned string should be freed
with g_free when no longer needed. | 
gchar *		           seahorse_util_get_display_date_string
                                                        (const time_t time);
Creates a string representation of time for display in the UI.
| 
 | Time value to parse | 
| Returns : | A string representing time. The returned string should be freed
with g_free when no longer needed. | 
GQuark seahorse_util_error_domain ();
| Returns : | The GError domain for generic seahorse errors | 
void seahorse_util_show_error (GtkWidget *parent,const gchar *heading,const gchar *message);
This displays an error dialog. The parent widget can be any widget. The dialog will be a child of the window the widget is in.
| 
 | The parent widget. Can be NULL | 
| 
 | The heading of the dialog | 
| 
 | The message to display | 
void seahorse_util_handle_error (GError *err,const char *desc,...);
Displays an error box. The message is the error message.
| 
 | The GError to print. | 
| 
 | The heading of the box | 
| 
 | Parameters to insert into the format string desc. | 
gboolean seahorse_util_prompt_delete (const gchar *text,GtkWidget *parent);
Displays a modal dialog with "cancel" and "delete"
| 
 | The text to display in the delete-dialog | 
| 
 | The widget to display the dialog for. Can be NULL | 
| Returns : | TRUE if the user pressed "delete", FALSE else | 
guchar * seahorse_util_read_to_memory (GInputStream *input,guint *len);
Reads data from the input stream and returns them as guchar
| 
 | Data to read. The GInputStream is read till the end. | 
| 
 | Length of the data read (out) | 
| Returns : | The string read from data. The returned string should be freed with g_free when no longer needed. | 
guint seahorse_util_read_data_block (GString *buf,GInputStream *input,const gchar *start,const gchar *end);
Breaks out one block of data (usually a key)
| 
 | A string buffer to write the data to. | 
| 
 | The input stream to read from. | 
| 
 | The start signature to look for. | 
| 
 | The end signature to look for. | 
| Returns : | The number of bytes copied. | 
GMemoryInputStream * seahorse_util_memory_input_string (const gchar *string,gsize length);
| 
 | The string to create the stream from | 
| 
 | The length of this string | 
| Returns : | The new input stream of type GMemoryInputStream | 
gsize               seahorse_util_memory_output_length  (GMemoryOutputStream *output);
A replacement for g_memory_output_stream_get_data_size (since 2.18)
| 
 | a stream | 
| Returns : | The length of the stream | 
gboolean seahorse_util_print_fd (int fd,const char *data);
| 
 | The file descriptor to write to | 
| Returns : | FALSE on error, TRUE on success | 
gboolean seahorse_util_printf_fd (int fd,const char *data,...);
| 
 | The file descriptor to write to | 
| 
 | The parameters to insert | 
| Returns : | TRUE on success, FALSE on error | 
gchar *             seahorse_util_filename_for_objects  (GList *objects);
If the single object has a nickname, this will be returned (with .asc attached) If there are multiple objects, "Multiple Keys.asc" will be returned. Single objects default to "Key Data.asc". Results are internationalized
| 
 | A list of objects | 
| Returns : | NULL on error, the filename else. The returned string should be freed with g_free when no longer needed. | 
gboolean            seahorse_util_uri_exists            (const gchar *uri);
Verify whether a given uri exists or not.
| 
 | The uri to check | 
| Returns : | FALSE if it does not exist, TRUE else | 
gchar *             seahorse_util_uri_unique            (const gchar *uri);
Creates a URI based on uri that does not exist.
A simple numbering scheme is used to create new
URIs. Not meant for temp file creation.
| 
 | The uri to guarantee is unique | 
| Returns : | Newly allocated unique URI. | 
gchar * seahorse_util_uri_replace_ext (const gchar *uri,const gchar *ext);
Replaces the extension on uri
| 
 | The uri with old extension | 
| 
 | The new extension | 
| Returns : | Newly allocated URI string with new extension. The returned string should be freed with g_free when no longer needed. | 
const gchar *       seahorse_util_uri_get_last          (const gchar *uri);
Finds the last portion of uri. Note that this does
not modify uri. If the uri is invalid or has no 
directories then the entire thing is returned.
| 
 | The uri to parse | 
| Returns : | Last portion of uri | 
const gchar *       seahorse_util_uri_split_last        (gchar *uri);
Splits the uri in two at it's last component. The result
is still part of the same string, so don't free it. This 
modifies the uri argument.
| 
 | The uri to split | 
| Returns : | The last component | 
gboolean seahorse_util_uris_package (const gchar *package,const gchar **uris);
Package uris into an archive. The uris must be local.
| 
 | Package uri | 
| 
 | null-terminated array of uris to package | 
| Returns : | TRUE on success or FALSE on failure | 
GQuark              seahorse_util_detect_mime_type      (const gchar *mime);
Return the mime type depending on the mime string
| 
 | The mime string | 
| Returns : | SEAHORSE_PGP, SEAHORSE_SSH or 0 | 
GQuark seahorse_util_detect_data_type (const gchar *data,guint length);
| 
 | The buffer to test for content type | 
| 
 | The length of this buffer | 
| Returns : | SEAHORSE_PGP, SEAHORSE_SSH or 0 | 
GQuark              seahorse_util_detect_file_type      (const gchar *uri);
| 
 | The file uri to test for content type | 
| Returns : | SEAHORSE_PGP, SEAHORSE_SSH or 0 | 
gboolean seahorse_util_write_file_private (const gchar *filename,const gchar *contents,GError **err);
GtkDialog * seahorse_util_chooser_open_new (const gchar *title,GtkWindow *parent);
Creates a file chooser dialog to open files.
| 
 | The title of the dialog | 
| 
 | The parent of the dialog | 
| Returns : | The new open dialog | 
GtkDialog * seahorse_util_chooser_save_new (const gchar *title,GtkWindow *parent);
Creates a file chooser dialog to save files.
| 
 | The title of the dialog | 
| 
 | The parent of the dialog | 
| Returns : | The new save dialog | 
void                seahorse_util_chooser_show_key_files
                                                        (GtkDialog *dialog);
Adds a key file filter and a "All files" filter. The key filter is used.
| 
 | the dialog to add the filter for | 
void                seahorse_util_chooser_show_archive_files
                                                        (GtkDialog *dialog);
Adds a archive file filter and a "All files" filter. The archive filter is used.
| 
 | the dialog to add the filter for | 
void seahorse_util_chooser_set_filename_full (GtkDialog *dialog,GList *objects);
| 
 | The dialog to pre set the name | 
| 
 | generate the file name from this object | 
void seahorse_util_chooser_set_filename (GtkDialog *dialog,struct _SeahorseObject *object);
| 
 | set the dialog for this | 
| 
 | The object to use for the filename. SeahorseObject | 
gchar *             seahorse_util_chooser_open_prompt   (GtkDialog *dialog);
Display an open dialog
| 
 | open dialog to display | 
| Returns : | The uri of the file to open or NULL | 
gchar *             seahorse_util_chooser_save_prompt   (GtkDialog *dialog);
If the selected file already exists, a confirmation dialog will be displayed
| 
 | save dialog to show | 
| Returns : | the uri of the chosen file or NULL | 
gboolean seahorse_util_check_suffix (const gchar *path,SeahorseSuffix suffix);
Checks that path has a suffix specified by suffix.
| 
 | Path of file to check | 
| 
 | Suffix type to check for. | 
| Returns : | TRUE if the file has a correct suffix, FALSE otherwise | 
gchar * seahorse_util_add_suffix (const gchar *path,SeahorseSuffix suffix,const gchar *prompt);
Constructs a new path for a file based on path plus a suffix determined by
suffix. If ASCII Armor is enabled, the suffix will be '.asc'. Otherwise the 
suffix will be '.pgp' if suffix is SEAHORSE_CRYPT_SUFFIX or '.sig' if 
suffix is SEAHORSE_SIG_SUFFIX.
| 
 | Path of an existing file | 
| 
 | Suffix type | 
| 
 | Overwrite prompt text | 
| Returns : | A new path with the suffix appended to path. NULL if prompt cancelled | 
gchar * seahorse_util_remove_suffix (const gchar *path,const gchar *prompt);
Removes a suffix from path. Does not check if path actually has a suffix.
| 
 | Path with a suffix | 
| 
 | Overwrite prompt text | 
| Returns : | pathwithout a suffix. NULL if prompt cancelled | 
gchar **            seahorse_util_strvec_dup            (const gchar **vec);
Copy a string table
| 
 | the string table to copy | 
| Returns : | the new char ** | 
guint               seahorse_util_strvec_length         (const gchar **vec);
Calculates the length of the string table
| 
 | The string table | 
| Returns : | The length of the string table | 
GList *             seahorse_util_objects_sort          (GList *objects);
The objects are sorted by their source
| 
 | SeahorseObject GList to sort | 
| Returns : | The sorted list | 
GList *             seahorse_util_objects_splice        (GList *objects);
Splices the list at the source disconuity
| 
 | A GList of SeahorseObject. Must be sorted | 
| Returns : | The second part of the list. | 
gboolean seahorse_util_string_equals (const gchar *s1,const gchar *s2);
Compares two string. If they are equal, it returns TRUE
| 
 | String, can be NULL | 
| 
 | String, can be NULL | 
| Returns : | TRUE if strings are equal, FALSE else | 
gchar *             seahorse_util_string_up_first       (const gchar *orig);
Upper case the first char in the UTF8 string
| 
 | The utf8 string to work with | 
| Returns : | a new string, with the first char upper cased. The returned string should be freed with g_free when no longer needed. | 
void                seahorse_util_string_lower          (gchar *s);
The whole ASCII string will be lower cased.
| 
 | ASCII string to change | 
GSList *            seahorse_util_string_slist_free     (GSList *slist);
Free a GSList along with string values
| 
 | the GSList to free | 
| Returns : | NULL | 
GSList *            seahorse_util_string_slist_copy     (GSList *slist);
Copy a GSList along with string values
| 
 | The list to copy | 
| Returns : | the new list | 
gboolean seahorse_util_string_slist_equal (GSList *sl1,GSList *sl2);
Compare two string GSLists.
| 
 | the first string list | 
| 
 | the second string list | 
| Returns : | TRUE if all the string are equal | 
gboolean            seahorse_util_string_is_whitespace  (const gchar *text);
| 
 | The UTF8 string to test | 
| Returns : | TRUE if textconsists of whitespaces | 
void                seahorse_util_string_trim_whitespace
                                                        (gchar *text);
Whitespaces will be removed from the start and the end of the text.
| 
 | The text to trim (UTF8) | 
gchar * seahorse_util_hex_encode (gconstpointer value,gsize length);
Creates a string contining the value in hex for printing.
| 
 | a buffer containing data | 
| 
 | The length of this buffer | 
| Returns : | The hex encoded value. The returned string should be freed
with g_free when no longer needed. | 
void seahorse_util_determine_popup_menu_position (GtkMenu *menu,int *x,int *y,gboolean *push_in,gpointer gdata);
Callback to determine where a popup menu should be placed
| 
 | The menu to place | 
| 
 | (out) x pos of the menu | 
| 
 | (out) y pos of the menu | 
| 
 | (out) will be set to TRUE | 
| 
 | GTK_WIDGET for which the menu is |