## gtr-utils

gtr-utils

## Synopsis

    xmlDocPtr           gtr_xml_new_doc                     (const gchar *name);
    xmlDocPtr           gtr_xml_open_file                   (const gchar *filename);
    GtkWidget *         gtr_gtk_button_new_with_stock_icon  (const gchar *label,
                                                             const gchar *stock_id);
    void                gtr_utils_menu_position_under_widget
                                                            (GtkMenu *menu,
                                                             gint *x,
                                                             gint *y,
                                                             gboolean *push_in,
                                                             gpointer user_data);
    void                gtr_utils_menu_position_under_tree_view
                                                            (GtkMenu *menu,
                                                             gint *x,
                                                             gint *y,
                                                             gboolean *push_in,
                                                             gpointer user_data);
    GSList *            gtr_utils_drop_get_locations        (GtkSelectionData *selection_data);
    gchar *             gtr_utils_escape_search_text        (const gchar *text);
    gchar *             gtr_utils_unescape_search_text      (const gchar *text);
    gboolean            g_utf8_caselessnmatch               (const gchar *s1,
                                                             const gchar *s2,
                                                             gssize n1,
                                                             gssize n2);
    void                gtr_utils_help_display              (GtkWindow *parent,
                                                             const gchar *doc_id,
                                                             const gchar *file_name);
    gchar *             gtr_utils_get_user_config_dir       (void);
    gchar *             gtr_utils_get_current_date          (void);
    gchar *             gtr_utils_get_current_time          (void);
    gchar *             gtr_utils_get_current_year          (void);
    gchar *             gtr_utils_reduce_path               (const gchar *path);
    gchar *             gtr_utils_escape_underscores        (const gchar *text,
                                                             gssize length);
    gchar *             gtr_utils_get_file_from_pixmapsdir  (const gchar *filename);
    gchar *             gtr_utils_get_file_from_pkgdatadir  (const gchar *filename);
    gchar *             gtr_utils_get_datadir               (void);
    gchar *             gtr_utils_get_win32_plugindir       (void);

## Description

## Details

### gtr_xml_new_doc ()

    xmlDocPtr           gtr_xml_new_doc                     (const gchar *name);

### gtr_xml_open_file ()

    xmlDocPtr           gtr_xml_open_file                   (const gchar *filename);

### gtr_gtk_button_new_with_stock_icon ()

    GtkWidget *         gtr_gtk_button_new_with_stock_icon  (const gchar *label,
                                                             const gchar *stock_id);

Convenience function to create a GtkButton with a stock image.

`label` : | the label of the button
`stock_id` : | the id of the stock image
Returns : | a new GtkButton

### gtr_utils_menu_position_under_widget ()

    void                gtr_utils_menu_position_under_widget
                                                            (GtkMenu *menu,
                                                             gint *x,
                                                             gint *y,
                                                             gboolean *push_in,
                                                             gpointer user_data);

It returns the position to popup a menu in a specific widget.

`menu` : | a GtkMenu
`x` : | the x position of the widget
`y` : | the y position of the widget
`user_data` : | the widget to get the position

### gtr_utils_menu_position_under_tree_view ()

    void                gtr_utils_menu_position_under_tree_view
                                                            (GtkMenu *menu,
                                                             gint *x,
                                                             gint *y,
                                                             gboolean *push_in,
                                                             gpointer user_data);

It returns the position to popup a menu in a TreeView.

`menu` : | a GtkMenu
`x` : | the x position of the widget
`y` : | the y position of the widget
`user_data` : | the widget to get the position

### gtr_utils_drop_get_locations ()

    GSList *            gtr_utils_drop_get_locations        (GtkSelectionData *selection_data);

### gtr_utils_escape_search_text ()

    gchar *             gtr_utils_escape_search_text        (const gchar *text);

### gtr_utils_unescape_search_text ()

    gchar *             gtr_utils_unescape_search_text      (const gchar *text);

### g_utf8_caselessnmatch ()

    gboolean            g_utf8_caselessnmatch               (const gchar *s1,
                                                             const gchar *s2,
                                                             gssize n1,
                                                             gssize n2);

### gtr_utils_help_display ()

    void                gtr_utils_help_display              (GtkWindow *parent,
                                                             const gchar *doc_id,
                                                             const gchar *file_name);

Shows the help for an specific document in the default help browser.

`parent` : | a GtkWindow
`doc_id` : | the name of the type of doc
`file_name` : | the name of the doc

### gtr_utils_get_user_config_dir ()

    gchar *             gtr_utils_get_user_config_dir       (void);

### gtr_utils_get_current_date ()

    gchar *             gtr_utils_get_current_date          (void);

### gtr_utils_get_current_time ()

    gchar *             gtr_utils_get_current_time          (void);

### gtr_utils_get_current_year ()

    gchar *             gtr_utils_get_current_year          (void);

### gtr_utils_reduce_path ()

    gchar *             gtr_utils_reduce_path               (const gchar *path);

### gtr_utils_escape_underscores ()

    gchar *             gtr_utils_escape_underscores        (const gchar *text,
                                                             gssize length);

### gtr_utils_get_file_from_pixmapsdir ()

    gchar *             gtr_utils_get_file_from_pixmapsdir  (const gchar *filename);

### gtr_utils_get_file_from_pkgdatadir ()

    gchar *             gtr_utils_get_file_from_pkgdatadir  (const gchar *filename);

### gtr_utils_get_datadir ()

    gchar *             gtr_utils_get_datadir               (void);

### gtr_utils_get_win32_plugindir ()

    gchar *             gtr_utils_get_win32_plugindir       (void);