1 /* GTK - The GIMP Toolkit
2 * gtkfilechooserentry.c: Entry with filename completion
3 * Copyright (C) 2003, Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
24 #include "gtkcelllayout.h"
25 #include "gtkcellrenderertext.h"
27 #include "gtkfilechooserentry.h"
32 typedef struct _GtkFileChooserEntryClass GtkFileChooserEntryClass;
34 #define GTK_FILE_CHOOSER_ENTRY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_FILE_CHOOSER_ENTRY, GtkFileChooserEntryClass))
35 #define GTK_IS_FILE_CHOOSER_ENTRY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_FILE_CHOOSER_ENTRY))
36 #define GTK_FILE_CHOOSER_ENTRY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_FILE_CHOOSER_ENTRY, GtkFileChooserEntryClass))
38 struct _GtkFileChooserEntryClass
40 GtkEntryClass parent_class;
43 struct _GtkFileChooserEntry
45 GtkEntry parent_instance;
47 GtkFileChooserAction action;
49 GtkFileSystem *file_system;
50 GtkFilePath *base_folder;
51 GtkFilePath *current_folder_path;
54 GSource *check_completion_idle;
55 GSource *load_directory_idle;
57 GtkFileFolder *current_folder;
58 GtkFileSystemHandle *load_folder_handle;
60 GtkListStore *completion_store;
62 guint has_completion : 1;
74 static void gtk_file_chooser_entry_class_init (GtkFileChooserEntryClass *class);
75 static void gtk_file_chooser_entry_iface_init (GtkEditableClass *iface);
76 static void gtk_file_chooser_entry_init (GtkFileChooserEntry *chooser_entry);
78 static void gtk_file_chooser_entry_finalize (GObject *object);
79 static void gtk_file_chooser_entry_dispose (GObject *object);
80 static gboolean gtk_file_chooser_entry_focus (GtkWidget *widget,
81 GtkDirectionType direction);
82 static void gtk_file_chooser_entry_activate (GtkEntry *entry);
83 static void gtk_file_chooser_entry_changed (GtkEditable *editable);
84 static void gtk_file_chooser_entry_do_insert_text (GtkEditable *editable,
85 const gchar *new_text,
89 static void clear_completion_callback (GtkFileChooserEntry *chooser_entry,
91 static gboolean match_selected_callback (GtkEntryCompletion *completion,
94 GtkFileChooserEntry *chooser_entry);
95 static gboolean completion_match_func (GtkEntryCompletion *comp,
99 static void files_added_cb (GtkFileSystem *file_system,
101 GtkFileChooserEntry *chooser_entry);
102 static void files_deleted_cb (GtkFileSystem *file_system,
103 GSList *deleted_uris,
104 GtkFileChooserEntry *chooser_entry);
105 static char *maybe_append_separator_to_path (GtkFileChooserEntry *chooser_entry,
107 gchar *display_name);
109 static GObjectClass *parent_class;
110 static GtkEditableClass *parent_editable_iface;
113 _gtk_file_chooser_entry_get_type (void)
115 static GType file_chooser_entry_type = 0;
117 if (!file_chooser_entry_type)
119 static const GTypeInfo file_chooser_entry_info =
121 sizeof (GtkFileChooserEntryClass),
122 NULL, /* base_init */
123 NULL, /* base_finalize */
124 (GClassInitFunc) gtk_file_chooser_entry_class_init,
125 NULL, /* class_finalize */
126 NULL, /* class_data */
127 sizeof (GtkFileChooserEntry),
129 (GInstanceInitFunc) gtk_file_chooser_entry_init,
132 static const GInterfaceInfo editable_info =
134 (GInterfaceInitFunc) gtk_file_chooser_entry_iface_init, /* interface_init */
135 NULL, /* interface_finalize */
136 NULL /* interface_data */
140 file_chooser_entry_type = g_type_register_static (GTK_TYPE_ENTRY, I_("GtkFileChooserEntry"),
141 &file_chooser_entry_info, 0);
142 g_type_add_interface_static (file_chooser_entry_type,
148 return file_chooser_entry_type;
152 gtk_file_chooser_entry_class_init (GtkFileChooserEntryClass *class)
154 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
155 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
156 GtkEntryClass *entry_class = GTK_ENTRY_CLASS (class);
158 parent_class = g_type_class_peek_parent (class);
160 gobject_class->finalize = gtk_file_chooser_entry_finalize;
161 gobject_class->dispose = gtk_file_chooser_entry_dispose;
163 widget_class->focus = gtk_file_chooser_entry_focus;
165 entry_class->activate = gtk_file_chooser_entry_activate;
169 gtk_file_chooser_entry_iface_init (GtkEditableClass *iface)
171 parent_editable_iface = g_type_interface_peek_parent (iface);
173 iface->do_insert_text = gtk_file_chooser_entry_do_insert_text;
174 iface->changed = gtk_file_chooser_entry_changed;
178 gtk_file_chooser_entry_init (GtkFileChooserEntry *chooser_entry)
180 GtkEntryCompletion *comp;
181 GtkCellRenderer *cell;
183 g_object_set (chooser_entry, "truncate-multiline", TRUE, NULL);
185 comp = gtk_entry_completion_new ();
186 gtk_entry_completion_set_popup_single_match (comp, FALSE);
188 gtk_entry_completion_set_match_func (comp,
189 completion_match_func,
193 cell = gtk_cell_renderer_text_new ();
194 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (comp),
196 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (comp),
200 g_signal_connect (comp, "match-selected",
201 G_CALLBACK (match_selected_callback), chooser_entry);
203 gtk_entry_set_completion (GTK_ENTRY (chooser_entry), comp);
204 g_object_unref (comp);
206 g_signal_connect (chooser_entry, "notify::cursor-position",
207 G_CALLBACK (clear_completion_callback), NULL);
208 g_signal_connect (chooser_entry, "notify::selection-bound",
209 G_CALLBACK (clear_completion_callback), NULL);
213 gtk_file_chooser_entry_finalize (GObject *object)
215 GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (object);
217 gtk_file_path_free (chooser_entry->base_folder);
218 gtk_file_path_free (chooser_entry->current_folder_path);
219 g_free (chooser_entry->file_part);
221 parent_class->finalize (object);
225 gtk_file_chooser_entry_dispose (GObject *object)
227 GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (object);
229 if (chooser_entry->completion_store)
231 g_object_unref (chooser_entry->completion_store);
232 chooser_entry->completion_store = NULL;
235 if (chooser_entry->load_folder_handle)
237 gtk_file_system_cancel_operation (chooser_entry->load_folder_handle);
238 chooser_entry->load_folder_handle = NULL;
241 if (chooser_entry->current_folder)
243 g_signal_handlers_disconnect_by_func (chooser_entry->current_folder,
244 G_CALLBACK (files_added_cb), chooser_entry);
245 g_signal_handlers_disconnect_by_func (chooser_entry->current_folder,
246 G_CALLBACK (files_deleted_cb), chooser_entry);
247 g_object_unref (chooser_entry->current_folder);
248 chooser_entry->current_folder = NULL;
251 if (chooser_entry->file_system)
253 g_object_unref (chooser_entry->file_system);
254 chooser_entry->file_system = NULL;
257 parent_class->dispose (object);
260 /* Match functions for the GtkEntryCompletion */
262 match_selected_callback (GtkEntryCompletion *completion,
265 GtkFileChooserEntry *chooser_entry)
271 gtk_tree_model_get (model, iter,
272 DISPLAY_NAME_COLUMN, &display_name,
276 if (!display_name || !path)
278 /* these shouldn't complain if passed NULL */
279 gtk_file_path_free (path);
280 g_free (display_name);
284 display_name = maybe_append_separator_to_path (chooser_entry, path, display_name);
286 pos = chooser_entry->file_part_pos;
288 /* We don't set in_change here as we want to update the current_folder
290 gtk_editable_delete_text (GTK_EDITABLE (chooser_entry),
292 gtk_editable_insert_text (GTK_EDITABLE (chooser_entry),
295 gtk_editable_set_position (GTK_EDITABLE (chooser_entry), -1);
297 gtk_file_path_free (path);
298 g_free (display_name);
303 /* Match function for the GtkEntryCompletion */
305 completion_match_func (GtkEntryCompletion *comp,
306 const char *key_unused,
310 GtkFileChooserEntry *chooser_entry;
313 char *norm_file_part;
316 chooser_entry = GTK_FILE_CHOOSER_ENTRY (data);
318 /* We ignore the key because it is the contents of the entry. Instead, we
319 * just use our precomputed file_part.
321 if (!chooser_entry->file_part)
326 gtk_tree_model_get (GTK_TREE_MODEL (chooser_entry->completion_store), iter, DISPLAY_NAME_COLUMN, &name, -1);
329 return FALSE; /* Uninitialized row, ugh */
332 /* If we have an empty file_part, then we're at the root of a directory. In
333 * that case, we want to match all non-dot files. We might want to match
334 * dot_files too if show_hidden is TRUE on the fileselector in the future.
336 /* Additionally, support for gnome .hidden files would be sweet, too */
337 if (chooser_entry->file_part[0] == '\000')
349 norm_file_part = g_utf8_normalize (chooser_entry->file_part, -1, G_NORMALIZE_ALL);
350 norm_name = g_utf8_normalize (name, -1, G_NORMALIZE_ALL);
352 #ifdef G_PLATFORM_WIN32
356 temp = norm_file_part;
357 norm_file_part = g_utf8_casefold (norm_file_part, -1);
361 norm_name = g_utf8_casefold (norm_name, -1);
366 result = (strncmp (norm_file_part, norm_name, strlen (norm_file_part)) == 0);
368 g_free (norm_file_part);
375 /* This function will append a directory separator to paths to
376 * display_name iff the path associated with it is a directory.
377 * maybe_append_separator_to_path will g_free the display_name and
378 * return a new one if needed. Otherwise, it will return the old one.
379 * You should be safe calling
381 * display_name = maybe_append_separator_to_path (entry, path, display_name);
383 * g_free (display_name);
386 maybe_append_separator_to_path (GtkFileChooserEntry *chooser_entry,
394 info = gtk_file_folder_get_info (chooser_entry->current_folder,
395 path, NULL); /* NULL-GError */
399 if (gtk_file_info_get_is_folder (info))
401 gchar *tmp = display_name;
402 display_name = g_strconcat (tmp, G_DIR_SEPARATOR_S, NULL);
406 gtk_file_info_free (info);
414 /* Determines if the completion model has entries with a common prefix relative
415 * to the current contents of the entry. Also, if there's one and only one such
416 * path, stores it in unique_path_ret.
419 find_common_prefix (GtkFileChooserEntry *chooser_entry,
420 gchar **common_prefix_ret,
421 GtkFilePath **unique_path_ret)
426 *common_prefix_ret = NULL;
427 *unique_path_ret = NULL;
429 if (chooser_entry->completion_store == NULL)
432 valid = gtk_tree_model_get_iter_first (GTK_TREE_MODEL (chooser_entry->completion_store), &iter);
439 gtk_tree_model_get (GTK_TREE_MODEL (chooser_entry->completion_store),
441 DISPLAY_NAME_COLUMN, &display_name,
445 if (g_str_has_prefix (display_name, chooser_entry->file_part))
447 if (!*common_prefix_ret)
449 *common_prefix_ret = g_strdup (display_name);
450 *unique_path_ret = gtk_file_path_copy (path);
454 gchar *p = *common_prefix_ret;
455 const gchar *q = display_name;
457 while (*p && *p == *q)
465 gtk_file_path_free (*unique_path_ret);
466 *unique_path_ret = NULL;
470 g_free (display_name);
471 gtk_file_path_free (path);
472 valid = gtk_tree_model_iter_next (GTK_TREE_MODEL (chooser_entry->completion_store), &iter);
476 /* Finds a common prefix based on the contents of the entry and mandatorily appends it */
478 append_common_prefix (GtkFileChooserEntry *chooser_entry,
481 gchar *common_prefix;
482 GtkFilePath *unique_path;
484 find_common_prefix (chooser_entry, &common_prefix, &unique_path);
488 common_prefix = maybe_append_separator_to_path (chooser_entry,
491 gtk_file_path_free (unique_path);
497 gint common_prefix_len;
500 file_part_len = g_utf8_strlen (chooser_entry->file_part, -1);
501 common_prefix_len = g_utf8_strlen (common_prefix, -1);
503 if (common_prefix_len > file_part_len)
505 pos = chooser_entry->file_part_pos;
507 chooser_entry->in_change = TRUE;
508 gtk_editable_delete_text (GTK_EDITABLE (chooser_entry),
510 gtk_editable_insert_text (GTK_EDITABLE (chooser_entry),
513 chooser_entry->in_change = FALSE;
517 gtk_editable_select_region (GTK_EDITABLE (chooser_entry),
518 chooser_entry->file_part_pos + file_part_len,
519 chooser_entry->file_part_pos + common_prefix_len);
520 chooser_entry->has_completion = TRUE;
524 g_free (common_prefix);
529 check_completion_callback (GtkFileChooserEntry *chooser_entry)
531 GDK_THREADS_ENTER ();
533 g_assert (chooser_entry->file_part);
535 chooser_entry->check_completion_idle = NULL;
537 if (strcmp (chooser_entry->file_part, "") == 0)
540 /* We only insert the common prefix without requiring the user to hit Tab in
541 * the "open" modes. For "save" modes, the user must hit Tab to cause the prefix
542 * to be inserted. That happens in gtk_file_chooser_entry_focus().
544 if (chooser_entry->action == GTK_FILE_CHOOSER_ACTION_OPEN
545 || chooser_entry->action == GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER)
546 append_common_prefix (chooser_entry, TRUE);
550 GDK_THREADS_LEAVE ();
556 add_completion_idle (GtkFileChooserEntry *chooser_entry)
558 /* idle to update the selection based on the file list */
559 if (chooser_entry->check_completion_idle == NULL)
561 chooser_entry->check_completion_idle = g_idle_source_new ();
562 g_source_set_priority (chooser_entry->check_completion_idle, G_PRIORITY_HIGH);
563 g_source_set_closure (chooser_entry->check_completion_idle,
564 g_cclosure_new_object (G_CALLBACK (check_completion_callback),
565 G_OBJECT (chooser_entry)));
566 g_source_attach (chooser_entry->check_completion_idle, NULL);
572 update_current_folder_files (GtkFileChooserEntry *chooser_entry,
577 g_assert (chooser_entry->completion_store != NULL);
579 /* Bah. Need to turn off sorting */
580 for (tmp_list = added_uris; tmp_list; tmp_list = tmp_list->next)
585 path = tmp_list->data;
587 info = gtk_file_folder_get_info (chooser_entry->current_folder,
589 NULL); /* NULL-GError */
592 const gchar *display_name = gtk_file_info_get_display_name (info);
595 gtk_list_store_append (chooser_entry->completion_store, &iter);
596 gtk_list_store_set (chooser_entry->completion_store, &iter,
597 DISPLAY_NAME_COLUMN, display_name,
601 gtk_file_info_free (info);
605 /* FIXME: we want to turn off sorting temporarily. I suck... */
606 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (chooser_entry->completion_store),
607 DISPLAY_NAME_COLUMN, GTK_SORT_ASCENDING);
609 add_completion_idle (chooser_entry);
613 files_added_cb (GtkFileSystem *file_system,
615 GtkFileChooserEntry *chooser_entry)
617 update_current_folder_files (chooser_entry, added_uris);
621 files_deleted_cb (GtkFileSystem *file_system,
622 GSList *deleted_uris,
623 GtkFileChooserEntry *chooser_entry)
625 /* FIXME: gravy... */
629 load_directory_get_folder_callback (GtkFileSystemHandle *handle,
630 GtkFileFolder *folder,
634 gboolean cancelled = handle->cancelled;
635 GtkFileChooserEntry *chooser_entry = data;
637 if (handle != chooser_entry->load_folder_handle)
640 chooser_entry->load_folder_handle = NULL;
642 if (cancelled || error)
645 chooser_entry->current_folder = folder;
646 g_signal_connect (chooser_entry->current_folder, "files-added",
647 G_CALLBACK (files_added_cb), chooser_entry);
648 g_signal_connect (chooser_entry->current_folder, "files-removed",
649 G_CALLBACK (files_deleted_cb), chooser_entry);
651 chooser_entry->completion_store = gtk_list_store_new (N_COLUMNS,
655 gtk_entry_completion_set_model (gtk_entry_get_completion (GTK_ENTRY (chooser_entry)),
656 GTK_TREE_MODEL (chooser_entry->completion_store));
659 g_object_unref (chooser_entry);
660 g_object_unref (handle);
664 load_directory_callback (GtkFileChooserEntry *chooser_entry)
666 GSList *child_paths = NULL;
668 GDK_THREADS_ENTER ();
670 chooser_entry->load_directory_idle = NULL;
672 /* guard against bogus settings*/
673 if (chooser_entry->current_folder_path == NULL ||
674 chooser_entry->file_system == NULL)
677 if (chooser_entry->current_folder != NULL)
679 g_warning ("idle activate multiple times without clearing the folder object first.");
682 g_assert (chooser_entry->completion_store == NULL);
684 /* Load the folder */
685 if (chooser_entry->load_folder_handle)
686 gtk_file_system_cancel_operation (chooser_entry->load_folder_handle);
688 chooser_entry->load_folder_handle =
689 gtk_file_system_get_folder (chooser_entry->file_system,
690 chooser_entry->current_folder_path,
691 GTK_FILE_INFO_DISPLAY_NAME | GTK_FILE_INFO_IS_FOLDER,
692 load_directory_get_folder_callback,
693 g_object_ref (chooser_entry));
697 GDK_THREADS_LEAVE ();
703 gtk_file_chooser_entry_do_insert_text (GtkEditable *editable,
704 const gchar *new_text,
705 gint new_text_length,
708 GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (editable);
710 parent_editable_iface->do_insert_text (editable, new_text, new_text_length, position);
712 if (! chooser_entry->in_change)
713 add_completion_idle (GTK_FILE_CHOOSER_ENTRY (editable));
717 gtk_file_chooser_entry_focus (GtkWidget *widget,
718 GtkDirectionType direction)
720 GtkFileChooserEntry *chooser_entry;
721 GtkEditable *editable;
723 GdkModifierType state;
724 gboolean control_pressed;
726 chooser_entry = GTK_FILE_CHOOSER_ENTRY (widget);
727 editable = GTK_EDITABLE (widget);
728 entry = GTK_ENTRY (widget);
730 if (!chooser_entry->eat_tabs)
731 return GTK_WIDGET_CLASS (parent_class)->focus (widget, direction);
733 control_pressed = FALSE;
735 if (gtk_get_current_event_state (&state))
737 if ((state & GDK_CONTROL_MASK) == GDK_CONTROL_MASK)
738 control_pressed = TRUE;
741 /* This is a bit evil -- it makes Tab never leave the entry. It basically
742 * makes it 'safe' for people to hit. */
743 if ((direction == GTK_DIR_TAB_FORWARD) &&
744 (GTK_WIDGET_HAS_FOCUS (widget)) &&
749 if (!chooser_entry->has_completion
750 && gtk_editable_get_position (editable) == entry->text_length)
751 append_common_prefix (chooser_entry, FALSE);
753 gtk_editable_set_position (editable, entry->text_length);
755 /* Trigger the completion window to pop up again by a
756 * zero-length insertion, a bit of a hack.
758 gtk_editable_insert_text (editable, "", -1, &pos);
763 return GTK_WIDGET_CLASS (parent_class)->focus (widget, direction);
767 gtk_file_chooser_entry_activate (GtkEntry *entry)
769 GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (entry);
771 if (chooser_entry->has_completion)
773 gtk_editable_set_position (GTK_EDITABLE (entry),
777 GTK_ENTRY_CLASS (parent_class)->activate (entry);
780 /* This will see if a path typed by the user is new, and installs the loading
784 gtk_file_chooser_entry_maybe_update_directory (GtkFileChooserEntry *chooser_entry,
785 GtkFilePath *folder_path,
786 gboolean force_reload)
788 gboolean queue_idle = FALSE;
790 if (chooser_entry->current_folder_path)
792 if (gtk_file_path_compare (folder_path, chooser_entry->current_folder_path) != 0 || force_reload)
794 /* We changed our current directory. We need to clear out the old
795 * directory information.
797 if (chooser_entry->current_folder)
799 g_signal_handlers_disconnect_by_func (chooser_entry->current_folder,
800 G_CALLBACK (files_added_cb), chooser_entry);
801 g_signal_handlers_disconnect_by_func (chooser_entry->current_folder,
802 G_CALLBACK (files_deleted_cb), chooser_entry);
804 g_object_unref (chooser_entry->current_folder);
805 chooser_entry->current_folder = NULL;
807 if (chooser_entry->completion_store)
809 gtk_entry_completion_set_model (gtk_entry_get_completion (GTK_ENTRY (chooser_entry)), NULL);
810 g_object_unref (chooser_entry->completion_store);
811 chooser_entry->completion_store = NULL;
817 gtk_file_path_free (chooser_entry->current_folder_path);
824 chooser_entry->current_folder_path = folder_path;
826 if (queue_idle && chooser_entry->load_directory_idle == NULL)
828 chooser_entry->load_directory_idle = g_idle_source_new ();
829 g_source_set_priority (chooser_entry->load_directory_idle, G_PRIORITY_HIGH);
830 g_source_set_closure (chooser_entry->load_directory_idle,
831 g_cclosure_new_object (G_CALLBACK (load_directory_callback),
832 G_OBJECT (chooser_entry)));
833 g_source_attach (chooser_entry->load_directory_idle, NULL);
840 gtk_file_chooser_entry_changed (GtkEditable *editable)
842 GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (editable);
844 GtkFilePath *folder_path;
846 gsize total_len, file_part_len;
849 if (chooser_entry->in_change)
852 text = gtk_entry_get_text (GTK_ENTRY (editable));
854 if (!chooser_entry->file_system ||
855 !chooser_entry->base_folder ||
856 !gtk_file_system_parse (chooser_entry->file_system,
857 chooser_entry->base_folder, text,
858 &folder_path, &file_part, NULL)) /* NULL-GError */
860 folder_path = gtk_file_path_copy (chooser_entry->base_folder);
861 file_part = g_strdup ("");
866 file_part_len = strlen (file_part);
867 total_len = strlen (text);
868 if (total_len > file_part_len)
869 file_part_pos = g_utf8_strlen (text, total_len - file_part_len);
874 if (chooser_entry->file_part)
875 g_free (chooser_entry->file_part);
877 chooser_entry->file_part = file_part;
878 chooser_entry->file_part_pos = file_part_pos;
880 gtk_file_chooser_entry_maybe_update_directory (chooser_entry, folder_path, file_part_pos == -1);
884 clear_completion_callback (GtkFileChooserEntry *chooser_entry,
887 if (chooser_entry->has_completion)
889 chooser_entry->has_completion = FALSE;
890 gtk_file_chooser_entry_changed (GTK_EDITABLE (chooser_entry));
895 * _gtk_file_chooser_entry_new:
896 * @eat_tabs: If %FALSE, allow focus navigation with the tab key.
898 * Creates a new #GtkFileChooserEntry object. #GtkFileChooserEntry
899 * is an internal implementation widget for the GTK+ file chooser
900 * which is an entry with completion with respect to a
901 * #GtkFileSystem object.
903 * Return value: the newly created #GtkFileChooserEntry
906 _gtk_file_chooser_entry_new (gboolean eat_tabs)
908 GtkFileChooserEntry *chooser_entry;
910 chooser_entry = g_object_new (GTK_TYPE_FILE_CHOOSER_ENTRY, NULL);
911 chooser_entry->eat_tabs = (eat_tabs != FALSE);
913 return GTK_WIDGET (chooser_entry);
917 * _gtk_file_chooser_entry_set_file_system:
918 * @chooser_entry: a #GtkFileChooser
919 * @file_system: an object implementing #GtkFileSystem
921 * Sets the file system for @chooser_entry.
924 _gtk_file_chooser_entry_set_file_system (GtkFileChooserEntry *chooser_entry,
925 GtkFileSystem *file_system)
927 g_return_if_fail (GTK_IS_FILE_CHOOSER_ENTRY (chooser_entry));
928 g_return_if_fail (GTK_IS_FILE_SYSTEM (file_system));
930 if (file_system != chooser_entry->file_system)
932 if (chooser_entry->file_system)
933 g_object_unref (chooser_entry->file_system);
935 chooser_entry->file_system = g_object_ref (file_system);
940 * _gtk_file_chooser_entry_set_base_folder:
941 * @chooser_entry: a #GtkFileChooserEntry
942 * @path: path of a folder in the chooser entries current file system.
944 * Sets the folder with respect to which completions occur.
947 _gtk_file_chooser_entry_set_base_folder (GtkFileChooserEntry *chooser_entry,
948 const GtkFilePath *path)
950 if (chooser_entry->base_folder)
951 gtk_file_path_free (chooser_entry->base_folder);
953 chooser_entry->base_folder = gtk_file_path_copy (path);
955 gtk_file_chooser_entry_changed (GTK_EDITABLE (chooser_entry));
956 gtk_editable_select_region (GTK_EDITABLE (chooser_entry), 0, -1);
960 * _gtk_file_chooser_entry_get_current_folder:
961 * @chooser_entry: a #GtkFileChooserEntry
963 * Gets the current folder for the #GtkFileChooserEntry. If the
964 * user has only entered a filename, this will be the base folder
965 * (see _gtk_file_chooser_entry_set_base_folder()), but if the
966 * user has entered a relative or absolute path, then it will
967 * be different. If the user has entered a relative or absolute
968 * path that doesn't point to a folder in the file system, it will
971 * Return value: the path of current folder - this value is owned by the
972 * chooser entry and must not be modified or freed.
975 _gtk_file_chooser_entry_get_current_folder (GtkFileChooserEntry *chooser_entry)
977 if (chooser_entry->has_completion)
979 gtk_editable_set_position (GTK_EDITABLE (chooser_entry),
980 GTK_ENTRY (chooser_entry)->text_length);
982 return chooser_entry->current_folder_path;
986 * _gtk_file_chooser_entry_get_file_part:
987 * @chooser_entry: a #GtkFileChooserEntry
989 * Gets the non-folder portion of whatever the user has entered
990 * into the file selector. What is returned is a UTF-8 string,
991 * and if a filename path is needed, gtk_file_system_make_path()
994 * Return value: the entered filename - this value is owned by the
995 * chooser entry and must not be modified or freed.
998 _gtk_file_chooser_entry_get_file_part (GtkFileChooserEntry *chooser_entry)
1000 if (chooser_entry->has_completion)
1002 gtk_editable_set_position (GTK_EDITABLE (chooser_entry),
1003 GTK_ENTRY (chooser_entry)->text_length);
1005 return chooser_entry->file_part;
1009 * _gtk_file_chooser_entry_set_file_part:
1010 * @chooser_entry: a #GtkFileChooserEntry
1011 * @file_part: text to display in the entry, in UTF-8
1013 * Sets the current text shown in the file chooser entry.
1016 _gtk_file_chooser_entry_set_file_part (GtkFileChooserEntry *chooser_entry,
1017 const gchar *file_part)
1019 g_return_if_fail (GTK_IS_FILE_CHOOSER_ENTRY (chooser_entry));
1021 gtk_entry_set_text (GTK_ENTRY (chooser_entry), file_part);
1026 * _gtk_file_chooser_entry_set_action:
1027 * @chooser_entry: a #GtkFileChooserEntry
1028 * @action: the action which is performed by the file selector using this entry
1030 * Sets action which is performed by the file selector using this entry.
1031 * The #GtkFileChooserEntry will use different completion strategies for
1032 * different actions.
1035 _gtk_file_chooser_entry_set_action (GtkFileChooserEntry *chooser_entry,
1036 GtkFileChooserAction action)
1038 g_return_if_fail (GTK_IS_FILE_CHOOSER_ENTRY (chooser_entry));
1040 if (chooser_entry->action != action)
1042 GtkEntryCompletion *comp;
1044 chooser_entry->action = action;
1046 comp = gtk_entry_get_completion (GTK_ENTRY (chooser_entry));
1050 case GTK_FILE_CHOOSER_ACTION_OPEN:
1051 case GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER:
1052 gtk_entry_completion_set_popup_single_match (comp, FALSE);
1054 case GTK_FILE_CHOOSER_ACTION_SAVE:
1055 case GTK_FILE_CHOOSER_ACTION_CREATE_FOLDER:
1056 gtk_entry_completion_set_popup_single_match (comp, TRUE);
1064 * _gtk_file_chooser_entry_get_action:
1065 * @chooser_entry: a #GtkFileChooserEntry
1067 * Gets the action for this entry.
1069 * Returns: the action
1071 GtkFileChooserAction
1072 _gtk_file_chooser_entry_get_action (GtkFileChooserEntry *chooser_entry)
1074 g_return_val_if_fail (GTK_IS_FILE_CHOOSER_ENTRY (chooser_entry),
1075 GTK_FILE_CHOOSER_ACTION_OPEN);
1077 return chooser_entry->action;
1081 _gtk_file_chooser_entry_get_is_folder (GtkFileChooserEntry *chooser_entry,
1082 const GtkFilePath *path)
1084 gboolean retval = FALSE;
1086 if (chooser_entry->current_folder)
1088 GtkFileInfo *file_info;
1090 file_info = gtk_file_folder_get_info (chooser_entry->current_folder,
1094 retval = gtk_file_info_get_is_folder (file_info);
1095 gtk_file_info_free (file_info);
1102 #define __GTK_FILE_CHOOSER_ENTRY_C__
1103 #include "gtkaliasdef.c"