diff options
Diffstat (limited to 'pluma/pluma-utils.h')
| -rwxr-xr-x | pluma/pluma-utils.h | 162 |
1 files changed, 162 insertions, 0 deletions
diff --git a/pluma/pluma-utils.h b/pluma/pluma-utils.h new file mode 100755 index 00000000..98d2aec1 --- /dev/null +++ b/pluma/pluma-utils.h @@ -0,0 +1,162 @@ +/* + * pluma-utils.h + * This file is part of pluma + * + * Copyright (C) 1998, 1999 Alex Roberts, Evan Lawrence + * Copyright (C) 2000, 2001 Chema Celorio, Paolo Maggi + * Copyright (C) 2002 - 2005 Paolo Maggi + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, + * Boston, MA 02111-1307, USA. + */ + +/* + * Modified by the pluma Team, 1998-2005. See the AUTHORS file for a + * list of people on the pluma Team. + * See the ChangeLog files for a list of changes. + * + * $Id$ + */ + +#ifndef __PLUMA_UTILS_H__ +#define __PLUMA_UTILS_H__ + +#include <glib.h> +#include <gtk/gtk.h> +#include <atk/atk.h> +#include <pluma/pluma-encodings.h> + +G_BEGIN_DECLS + +/* useful macro */ +#define GBOOLEAN_TO_POINTER(i) (GINT_TO_POINTER ((i) ? 2 : 1)) +#define GPOINTER_TO_BOOLEAN(i) ((gboolean) ((GPOINTER_TO_INT(i) == 2) ? TRUE : FALSE)) + +#define IS_VALID_BOOLEAN(v) (((v == TRUE) || (v == FALSE)) ? TRUE : FALSE) + +enum { PLUMA_ALL_WORKSPACES = 0xffffffff }; + +gboolean pluma_utils_uri_has_writable_scheme (const gchar *uri); +gboolean pluma_utils_uri_has_file_scheme (const gchar *uri); + +void pluma_utils_menu_position_under_widget (GtkMenu *menu, + gint *x, + gint *y, + gboolean *push_in, + gpointer user_data); + +void pluma_utils_menu_position_under_tree_view + (GtkMenu *menu, + gint *x, + gint *y, + gboolean *push_in, + gpointer user_data); + +gchar *pluma_gdk_color_to_string (GdkColor color); + +GtkWidget *pluma_gtk_button_new_with_stock_icon (const gchar *label, + const gchar *stock_id); + +GtkWidget *pluma_dialog_add_button (GtkDialog *dialog, + const gchar *text, + const gchar *stock_id, + gint response_id); + +gchar *pluma_utils_escape_underscores (const gchar *text, + gssize length); + +gchar *pluma_utils_str_middle_truncate (const gchar *string, + guint truncate_length); + +gchar *pluma_utils_str_end_truncate (const gchar *string, + guint truncate_length); + +gboolean g_utf8_caselessnmatch (const char *s1, + const char *s2, + gssize n1, + gssize n2); + +void pluma_utils_set_atk_name_description (GtkWidget *widget, + const gchar *name, + const gchar *description); + +void pluma_utils_set_atk_relation (GtkWidget *obj1, + GtkWidget *obj2, + AtkRelationType rel_type); + +gboolean pluma_utils_uri_exists (const gchar* text_uri); + +gchar *pluma_utils_escape_search_text (const gchar *text); + +gchar *pluma_utils_unescape_search_text (const gchar *text); + +void pluma_warning (GtkWindow *parent, + const gchar *format, + ...) G_GNUC_PRINTF(2, 3); + +gchar *pluma_utils_make_valid_utf8 (const char *name); + +/* Note that this function replace home dir with ~ */ +gchar *pluma_utils_uri_get_dirname (const char *uri); + +gchar *pluma_utils_location_get_dirname_for_display + (GFile *location); + +gchar *pluma_utils_replace_home_dir_with_tilde (const gchar *uri); + +guint pluma_utils_get_current_workspace (GdkScreen *screen); + +guint pluma_utils_get_window_workspace (GtkWindow *gtkwindow); + +void pluma_utils_get_current_viewport (GdkScreen *screen, + gint *x, + gint *y); + +void pluma_utils_activate_url (GtkAboutDialog *about, + const gchar *url, + gpointer data); + +gboolean pluma_utils_is_valid_uri (const gchar *uri); + +gboolean pluma_utils_get_ui_objects (const gchar *filename, + gchar **root_objects, + GtkWidget **error_widget, + const gchar *object_name, + ...) G_GNUC_NULL_TERMINATED; + +gboolean pluma_utils_file_has_parent (GFile *gfile); + +/* Return NULL if str is not a valid URI and/or filename */ +gchar *pluma_utils_make_canonical_uri_from_shell_arg + (const gchar *str); + +gchar *pluma_utils_uri_for_display (const gchar *uri); +gchar *pluma_utils_basename_for_display (const gchar *uri); +gboolean pluma_utils_decode_uri (const gchar *uri, + gchar **scheme, + gchar **user, + gchar **port, + gchar **host, + gchar **path); + + +/* Turns data from a drop into a list of well formatted uris */ +gchar **pluma_utils_drop_get_uris (GtkSelectionData *selection_data); + +G_END_DECLS + +#endif /* __PLUMA_UTILS_H__ */ + + |