xed-utils

xed-utils

Functions

Description

Functions

GBOOLEAN_TO_POINTER()

#define GBOOLEAN_TO_POINTER(i) (GINT_TO_POINTER ((i) ? 2 : 1))

GPOINTER_TO_BOOLEAN()

#define GPOINTER_TO_BOOLEAN(i) ((gboolean) ((GPOINTER_TO_INT(i) == 2) ? TRUE : FALSE))

IS_VALID_BOOLEAN()

#define IS_VALID_BOOLEAN(v) (((v == TRUE) || (v == FALSE)) ? TRUE : FALSE)

xed_gdk_color_to_string ()

gchar *
xed_gdk_color_to_string (GdkColor color);

xed_string_to_clamped_gint ()

gint
xed_string_to_clamped_gint (const gchar *text);

xed_utils_escape_underscores ()

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

xed_utils_str_middle_truncate ()

gchar *
xed_utils_str_middle_truncate (const gchar *string,
                               guint truncate_length);

xed_utils_str_end_truncate ()

gchar *
xed_utils_str_end_truncate (const gchar *string,
                            guint truncate_length);

g_utf8_caselessnmatch ()

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

xed_utils_set_atk_name_description ()

void
xed_utils_set_atk_name_description (GtkWidget *widget,
                                    const gchar *name,
                                    const gchar *description);

This function sets up name and description for a specified gtk widget.

Parameters

widget

The Gtk widget for which name/description to be set

 

name

Atk name string

 

description

Atk description string

 

xed_utils_set_atk_relation ()

void
xed_utils_set_atk_relation (GtkWidget *obj1,
                            GtkWidget *obj2,
                            AtkRelationType rel_type);

xed_warning ()

void
xed_warning (GtkWindow *parent,
             const gchar *format,
             ...);

xed_utils_make_valid_utf8 ()

gchar *
xed_utils_make_valid_utf8 (const char *name);

xed_utils_uri_get_dirname ()

gchar *
xed_utils_uri_get_dirname (const char *uri);

Note: this function replace home dir with ~

Parameters

uri

the URI to extract the dirname from

 

xed_utils_location_get_dirname_for_display ()

gchar *
xed_utils_location_get_dirname_for_display
                               (GFile *location);

Returns a string suitable to be displayed in the UI indicating the name of the directory where the file is located. For remote files it may also contain the hostname etc. For local files it tries to replace the home dir with ~.

Parameters

location

the location

 

Returns

a string to display the dirname


xed_utils_replace_home_dir_with_tilde ()

gchar *
xed_utils_replace_home_dir_with_tilde (const gchar *uri);

xed_utils_get_current_workspace ()

guint
xed_utils_get_current_workspace (GdkScreen *screen);

Get the currently visible workspace for the GdkScreen.

If the X11 window property isn't found, 0 (the first workspace) is returned.

Parameters

screen

a GdkScreen

 

xed_utils_get_window_workspace ()

guint
xed_utils_get_window_workspace (GtkWindow *gtkwindow);

Get the workspace the window is on.

This function gets the workspace that the GtkWindow is visible on, it returns XED_ALL_WORKSPACES if the window is sticky, or if the window manager doesn't support this function.

Parameters

gtkwindow

a GtkWindow.

 

Returns

the workspace the window is on.


xed_utils_get_current_viewport ()

void
xed_utils_get_current_viewport (GdkScreen *screen,
                                gint *x,
                                gint *y);

Get the currently visible viewport origin for the GdkScreen.

If the X11 window property isn't found, (0, 0) is returned.

Parameters

screen

a GdkScreen

 

x

x-axis point.

[out]

y

y-axis point.

[out]

xed_utils_is_valid_location ()

gboolean
xed_utils_is_valid_location (GFile *location);

xed_utils_get_ui_objects ()

gboolean
xed_utils_get_ui_objects (const gchar *filename,
                          gchar **root_objects,
                          GtkWidget **error_widget,
                          const gchar *object_name,
                          ...);

This function gets the requested objects from a GtkBuilder ui file. In case of error it returns FALSE and sets error_widget to a GtkLabel containing the error message to display.

Parameters

filename

the path to the gtk builder file

 

root_objects

a NULL terminated list of root objects to load or NULL to load all objects

 

error_widget

a pointer were a GtkLabel

 

object_name

the name of the first object

 

...

a pointer were the first object is returned, followed by more name / object pairs and terminated by NULL.

 

Returns

FALSE if an error occurs, TRUE on success.


xed_utils_file_has_parent ()

gboolean
xed_utils_file_has_parent (GFile *gfile);

Return TRUE if the specified gfile has a parent (is not the root), FALSE otherwise

Parameters

gfile

the GFile to check the parent for

 

xed_utils_make_canonical_uri_from_shell_arg ()

gchar *
xed_utils_make_canonical_uri_from_shell_arg
                               (const gchar *str);

xed_utils_basename_for_display ()

gchar *
xed_utils_basename_for_display (GFile *location);

Return the basename of a file suitable for display to users.

Parameters

location

location for which the basename should be displayed

 

xed_utils_decode_uri ()

gboolean
xed_utils_decode_uri (const gchar *uri,
                      gchar **scheme,
                      gchar **user,
                      gchar **port,
                      gchar **host,
                      gchar **path);

Parse and break an uri apart in its individual components like the uri scheme, user info, port, host and path. The return value pointer can be NULL to ignore certain parts of the uri. If the function returns TRUE, then all return value pointers should be freed using g_free

Parameters

uri

the uri to decode

 

scheme

return value pointer for the uri's scheme (e.g. http, sftp, ...), or NULL.

[allow-none]

user

return value pointer for the uri user info, or NULL.

[allow-none]

port

return value pointer for the uri port, or NULL.

[allow-none]

host

return value pointer for the uri host, or NULL.

[allow-none]

path

return value pointer for the uri path, or NULL.

[allow-none]

Returns

TRUE if the uri could be properly decoded, FALSE otherwise.


xed_utils_drop_get_uris ()

gchar **
xed_utils_drop_get_uris (GtkSelectionData *selection_data);

Create a list of valid uri's from a uri-list drop.

Parameters

selection_data

the GtkSelectionData from drag_data_received

 

Returns

a string array which will hold the uris or NULL if there were no valid uris. g_strfreev should be used when the string array is no longer used.

[transfer full]