Blame gtk/gtkfilechooser.h

Packit Service fb6fa5
/* GTK - The GIMP Toolkit
Packit Service fb6fa5
 * gtkfilechooser.h: Abstract interface for file selector GUIs
Packit Service fb6fa5
 * Copyright (C) 2003, Red Hat, Inc.
Packit Service fb6fa5
 *
Packit Service fb6fa5
 * This library is free software; you can redistribute it and/or
Packit Service fb6fa5
 * modify it under the terms of the GNU Lesser General Public
Packit Service fb6fa5
 * License as published by the Free Software Foundation; either
Packit Service fb6fa5
 * version 2 of the License, or (at your option) any later version.
Packit Service fb6fa5
 *
Packit Service fb6fa5
 * This library is distributed in the hope that it will be useful,
Packit Service fb6fa5
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit Service fb6fa5
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit Service fb6fa5
 * Lesser General Public License for more details.
Packit Service fb6fa5
 *
Packit Service fb6fa5
 * You should have received a copy of the GNU Lesser General Public
Packit Service fb6fa5
 * License along with this library; if not, write to the
Packit Service fb6fa5
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Packit Service fb6fa5
 * Boston, MA 02111-1307, USA.
Packit Service fb6fa5
 */
Packit Service fb6fa5
Packit Service fb6fa5
#ifndef __GTK_FILE_CHOOSER_H__
Packit Service fb6fa5
#define __GTK_FILE_CHOOSER_H__
Packit Service fb6fa5
Packit Service fb6fa5
#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
Packit Service fb6fa5
#error "Only <gtk/gtk.h> can be included directly."
Packit Service fb6fa5
#endif
Packit Service fb6fa5
Packit Service fb6fa5
#include <gtk/gtkfilefilter.h>
Packit Service fb6fa5
#include <gtk/gtkwidget.h>
Packit Service fb6fa5
Packit Service fb6fa5
G_BEGIN_DECLS
Packit Service fb6fa5
Packit Service fb6fa5
#define GTK_TYPE_FILE_CHOOSER             (gtk_file_chooser_get_type ())
Packit Service fb6fa5
#define GTK_FILE_CHOOSER(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_FILE_CHOOSER, GtkFileChooser))
Packit Service fb6fa5
#define GTK_IS_FILE_CHOOSER(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_FILE_CHOOSER))
Packit Service fb6fa5
Packit Service fb6fa5
typedef struct _GtkFileChooser      GtkFileChooser;
Packit Service fb6fa5
Packit Service fb6fa5
/**
Packit Service fb6fa5
 * GtkFileChooserAction:
Packit Service fb6fa5
 * @GTK_FILE_CHOOSER_ACTION_OPEN: Indicates open mode.  The file chooser
Packit Service fb6fa5
 *  will only let the user pick an existing file.
Packit Service fb6fa5
 * @GTK_FILE_CHOOSER_ACTION_SAVE: Indicates save mode.  The file chooser
Packit Service fb6fa5
 *  will let the user pick an existing file, or type in a new
Packit Service fb6fa5
 *  filename.
Packit Service fb6fa5
 * @GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER: Indicates an Open mode for
Packit Service fb6fa5
 *  selecting folders.  The file chooser will let the user pick an
Packit Service fb6fa5
 *  existing folder.
Packit Service fb6fa5
 * @GTK_FILE_CHOOSER_ACTION_CREATE_FOLDER: Indicates a mode for creating a
Packit Service fb6fa5
 *  new folder.  The file chooser will let the user name an existing or
Packit Service fb6fa5
 *  new folder.
Packit Service fb6fa5
 *
Packit Service fb6fa5
 * Describes whether a #GtkFileChooser is being used to open existing files
Packit Service fb6fa5
 * or to save to a possibly new file.
Packit Service fb6fa5
 */
Packit Service fb6fa5
typedef enum
Packit Service fb6fa5
{
Packit Service fb6fa5
  GTK_FILE_CHOOSER_ACTION_OPEN,
Packit Service fb6fa5
  GTK_FILE_CHOOSER_ACTION_SAVE,
Packit Service fb6fa5
  GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER,
Packit Service fb6fa5
  GTK_FILE_CHOOSER_ACTION_CREATE_FOLDER
Packit Service fb6fa5
} GtkFileChooserAction;
Packit Service fb6fa5
Packit Service fb6fa5
/**
Packit Service fb6fa5
 * GtkFileChooserConfirmation:
Packit Service fb6fa5
 * @GTK_FILE_CHOOSER_CONFIRMATION_CONFIRM: The file chooser will present
Packit Service fb6fa5
 *  its stock dialog to confirm about overwriting an existing file.
Packit Service fb6fa5
 * @GTK_FILE_CHOOSER_CONFIRMATION_ACCEPT_FILENAME: The file chooser will
Packit Service fb6fa5
 *  terminate and accept the user's choice of a file name.
Packit Service fb6fa5
 * @GTK_FILE_CHOOSER_CONFIRMATION_SELECT_AGAIN: The file chooser will
Packit Service fb6fa5
 *  continue running, so as to let the user select another file name.
Packit Service fb6fa5
 *
Packit Service fb6fa5
 * Used as a return value of handlers for the
Packit Service fb6fa5
 * #GtkFileChooser::confirm-overwrite signal of a #GtkFileChooser. This
Packit Service fb6fa5
 * value determines whether the file chooser will present the stock
Packit Service fb6fa5
 * confirmation dialog, accept the user's choice of a filename, or
Packit Service fb6fa5
 * let the user choose another filename.
Packit Service fb6fa5
 *
Packit Service fb6fa5
 * Since: 2.8
Packit Service fb6fa5
 */
Packit Service fb6fa5
typedef enum
Packit Service fb6fa5
{
Packit Service fb6fa5
  GTK_FILE_CHOOSER_CONFIRMATION_CONFIRM,
Packit Service fb6fa5
  GTK_FILE_CHOOSER_CONFIRMATION_ACCEPT_FILENAME,
Packit Service fb6fa5
  GTK_FILE_CHOOSER_CONFIRMATION_SELECT_AGAIN
Packit Service fb6fa5
} GtkFileChooserConfirmation;
Packit Service fb6fa5
Packit Service fb6fa5
GType gtk_file_chooser_get_type (void) G_GNUC_CONST;
Packit Service fb6fa5
Packit Service fb6fa5
/* GError enumeration for GtkFileChooser */
Packit Service fb6fa5
/**
Packit Service fb6fa5
 * GTK_FILE_CHOOSER_ERROR:
Packit Service fb6fa5
 *
Packit Service fb6fa5
 * Used to get the #GError quark for #GtkFileChooser errors.
Packit Service fb6fa5
 */
Packit Service fb6fa5
#define GTK_FILE_CHOOSER_ERROR (gtk_file_chooser_error_quark ())
Packit Service fb6fa5
Packit Service fb6fa5
/**
Packit Service fb6fa5
 * GtkFileChooserError:
Packit Service fb6fa5
 * @GTK_FILE_CHOOSER_ERROR_NONEXISTENT: Indicates that a file does not exist.
Packit Service fb6fa5
 * @GTK_FILE_CHOOSER_ERROR_BAD_FILENAME: Indicates a malformed filename.
Packit Service fb6fa5
 * @GTK_FILE_CHOOSER_ERROR_ALREADY_EXISTS: Indicates a duplicate path (e.g. when
Packit Service fb6fa5
 *  adding a bookmark).
Packit Service fb6fa5
 * @GTK_FILE_CHOOSER_ERROR_INCOMPLETE_HOSTNAME: Indicates an incomplete hostname (e.g. "http://foo" without a slash after that).
Packit Service fb6fa5
 *
Packit Service fb6fa5
 * These identify the various errors that can occur while calling
Packit Service fb6fa5
 * #GtkFileChooser functions.
Packit Service fb6fa5
 */
Packit Service fb6fa5
typedef enum {
Packit Service fb6fa5
  GTK_FILE_CHOOSER_ERROR_NONEXISTENT,
Packit Service fb6fa5
  GTK_FILE_CHOOSER_ERROR_BAD_FILENAME,
Packit Service fb6fa5
  GTK_FILE_CHOOSER_ERROR_ALREADY_EXISTS,
Packit Service fb6fa5
  GTK_FILE_CHOOSER_ERROR_INCOMPLETE_HOSTNAME
Packit Service fb6fa5
} GtkFileChooserError;
Packit Service fb6fa5
Packit Service fb6fa5
GQuark gtk_file_chooser_error_quark (void);
Packit Service fb6fa5
Packit Service fb6fa5
/* Configuration
Packit Service fb6fa5
 */
Packit Service fb6fa5
void                 gtk_file_chooser_set_action          (GtkFileChooser       *chooser,
Packit Service fb6fa5
							   GtkFileChooserAction  action);
Packit Service fb6fa5
GtkFileChooserAction gtk_file_chooser_get_action          (GtkFileChooser       *chooser);
Packit Service fb6fa5
void                 gtk_file_chooser_set_local_only      (GtkFileChooser       *chooser,
Packit Service fb6fa5
							   gboolean              local_only);
Packit Service fb6fa5
gboolean             gtk_file_chooser_get_local_only      (GtkFileChooser       *chooser);
Packit Service fb6fa5
void                 gtk_file_chooser_set_select_multiple (GtkFileChooser       *chooser,
Packit Service fb6fa5
							   gboolean              select_multiple);
Packit Service fb6fa5
gboolean             gtk_file_chooser_get_select_multiple (GtkFileChooser       *chooser);
Packit Service fb6fa5
void                 gtk_file_chooser_set_show_hidden     (GtkFileChooser       *chooser,
Packit Service fb6fa5
							   gboolean              show_hidden);
Packit Service fb6fa5
gboolean             gtk_file_chooser_get_show_hidden     (GtkFileChooser       *chooser);
Packit Service fb6fa5
Packit Service fb6fa5
void                 gtk_file_chooser_set_do_overwrite_confirmation (GtkFileChooser *chooser,
Packit Service fb6fa5
								     gboolean        do_overwrite_confirmation);
Packit Service fb6fa5
gboolean             gtk_file_chooser_get_do_overwrite_confirmation (GtkFileChooser *chooser);
Packit Service fb6fa5
Packit Service fb6fa5
void                 gtk_file_chooser_set_create_folders  (GtkFileChooser       *chooser,
Packit Service fb6fa5
							  gboolean               create_folders);
Packit Service fb6fa5
gboolean             gtk_file_chooser_get_create_folders (GtkFileChooser *chooser);
Packit Service fb6fa5
Packit Service fb6fa5
/* Suggested name for the Save-type actions
Packit Service fb6fa5
 */
Packit Service fb6fa5
void     gtk_file_chooser_set_current_name   (GtkFileChooser *chooser,
Packit Service fb6fa5
					      const gchar    *name);
Packit Service fb6fa5
Packit Service fb6fa5
/* Filename manipulation
Packit Service fb6fa5
 */
Packit Service fb6fa5
#ifdef G_OS_WIN32
Packit Service fb6fa5
/* Reserve old names for DLL ABI backward compatibility */
Packit Service fb6fa5
#define gtk_file_chooser_get_filename gtk_file_chooser_get_filename_utf8
Packit Service fb6fa5
#define gtk_file_chooser_set_filename gtk_file_chooser_set_filename_utf8
Packit Service fb6fa5
#define gtk_file_chooser_select_filename gtk_file_chooser_select_filename_utf8
Packit Service fb6fa5
#define gtk_file_chooser_unselect_filename gtk_file_chooser_unselect_filename_utf8
Packit Service fb6fa5
#define gtk_file_chooser_get_filenames gtk_file_chooser_get_filenames_utf8
Packit Service fb6fa5
#define gtk_file_chooser_set_current_folder gtk_file_chooser_set_current_folder_utf8
Packit Service fb6fa5
#define gtk_file_chooser_get_current_folder gtk_file_chooser_get_current_folder_utf8
Packit Service fb6fa5
#define gtk_file_chooser_get_preview_filename gtk_file_chooser_get_preview_filename_utf8
Packit Service fb6fa5
#define gtk_file_chooser_add_shortcut_folder gtk_file_chooser_add_shortcut_folder_utf8
Packit Service fb6fa5
#define gtk_file_chooser_remove_shortcut_folder gtk_file_chooser_remove_shortcut_folder_utf8
Packit Service fb6fa5
#define gtk_file_chooser_list_shortcut_folders gtk_file_chooser_list_shortcut_folders_utf8
Packit Service fb6fa5
#endif
Packit Service fb6fa5
Packit Service fb6fa5
gchar *  gtk_file_chooser_get_filename       (GtkFileChooser *chooser);
Packit Service fb6fa5
gboolean gtk_file_chooser_set_filename       (GtkFileChooser *chooser,
Packit Service fb6fa5
					      const char     *filename);
Packit Service fb6fa5
gboolean gtk_file_chooser_select_filename    (GtkFileChooser *chooser,
Packit Service fb6fa5
					      const char     *filename);
Packit Service fb6fa5
void     gtk_file_chooser_unselect_filename  (GtkFileChooser *chooser,
Packit Service fb6fa5
					      const char     *filename);
Packit Service fb6fa5
void     gtk_file_chooser_select_all         (GtkFileChooser *chooser);
Packit Service fb6fa5
void     gtk_file_chooser_unselect_all       (GtkFileChooser *chooser);
Packit Service fb6fa5
GSList * gtk_file_chooser_get_filenames      (GtkFileChooser *chooser);
Packit Service fb6fa5
gboolean gtk_file_chooser_set_current_folder (GtkFileChooser *chooser,
Packit Service fb6fa5
					      const gchar    *filename);
Packit Service fb6fa5
gchar *  gtk_file_chooser_get_current_folder (GtkFileChooser *chooser);
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
/* URI manipulation
Packit Service fb6fa5
 */
Packit Service fb6fa5
gchar *  gtk_file_chooser_get_uri                (GtkFileChooser *chooser);
Packit Service fb6fa5
gboolean gtk_file_chooser_set_uri                (GtkFileChooser *chooser,
Packit Service fb6fa5
						  const char     *uri);
Packit Service fb6fa5
gboolean gtk_file_chooser_select_uri             (GtkFileChooser *chooser,
Packit Service fb6fa5
						  const char     *uri);
Packit Service fb6fa5
void     gtk_file_chooser_unselect_uri           (GtkFileChooser *chooser,
Packit Service fb6fa5
						  const char     *uri);
Packit Service fb6fa5
GSList * gtk_file_chooser_get_uris               (GtkFileChooser *chooser);
Packit Service fb6fa5
gboolean gtk_file_chooser_set_current_folder_uri (GtkFileChooser *chooser,
Packit Service fb6fa5
						  const gchar    *uri);
Packit Service fb6fa5
gchar *  gtk_file_chooser_get_current_folder_uri (GtkFileChooser *chooser);
Packit Service fb6fa5
Packit Service fb6fa5
/* GFile manipulation */
Packit Service fb6fa5
GFile *  gtk_file_chooser_get_file                (GtkFileChooser  *chooser);
Packit Service fb6fa5
gboolean gtk_file_chooser_set_file                (GtkFileChooser  *chooser,
Packit Service fb6fa5
                                                   GFile           *file,
Packit Service fb6fa5
                                                   GError         **error);
Packit Service fb6fa5
gboolean gtk_file_chooser_select_file             (GtkFileChooser  *chooser,
Packit Service fb6fa5
                                                   GFile           *file,
Packit Service fb6fa5
                                                   GError         **error);
Packit Service fb6fa5
void     gtk_file_chooser_unselect_file           (GtkFileChooser  *chooser,
Packit Service fb6fa5
                                                   GFile           *file);
Packit Service fb6fa5
GSList * gtk_file_chooser_get_files               (GtkFileChooser  *chooser);
Packit Service fb6fa5
gboolean gtk_file_chooser_set_current_folder_file (GtkFileChooser  *chooser,
Packit Service fb6fa5
                                                   GFile           *file,
Packit Service fb6fa5
                                                   GError         **error);
Packit Service fb6fa5
GFile *  gtk_file_chooser_get_current_folder_file (GtkFileChooser  *chooser);
Packit Service fb6fa5
Packit Service fb6fa5
/* Preview widget
Packit Service fb6fa5
 */
Packit Service fb6fa5
void       gtk_file_chooser_set_preview_widget        (GtkFileChooser *chooser,
Packit Service fb6fa5
						       GtkWidget      *preview_widget);
Packit Service fb6fa5
GtkWidget *gtk_file_chooser_get_preview_widget        (GtkFileChooser *chooser);
Packit Service fb6fa5
void       gtk_file_chooser_set_preview_widget_active (GtkFileChooser *chooser,
Packit Service fb6fa5
						       gboolean        active);
Packit Service fb6fa5
gboolean   gtk_file_chooser_get_preview_widget_active (GtkFileChooser *chooser);
Packit Service fb6fa5
void       gtk_file_chooser_set_use_preview_label     (GtkFileChooser *chooser,
Packit Service fb6fa5
						       gboolean        use_label);
Packit Service fb6fa5
gboolean   gtk_file_chooser_get_use_preview_label     (GtkFileChooser *chooser);
Packit Service fb6fa5
Packit Service fb6fa5
char  *gtk_file_chooser_get_preview_filename (GtkFileChooser *chooser);
Packit Service fb6fa5
char  *gtk_file_chooser_get_preview_uri      (GtkFileChooser *chooser);
Packit Service fb6fa5
GFile *gtk_file_chooser_get_preview_file     (GtkFileChooser *chooser);
Packit Service fb6fa5
Packit Service fb6fa5
/* Extra widget
Packit Service fb6fa5
 */
Packit Service fb6fa5
void       gtk_file_chooser_set_extra_widget (GtkFileChooser *chooser,
Packit Service fb6fa5
					      GtkWidget      *extra_widget);
Packit Service fb6fa5
GtkWidget *gtk_file_chooser_get_extra_widget (GtkFileChooser *chooser);
Packit Service fb6fa5
Packit Service fb6fa5
/* List of user selectable filters
Packit Service fb6fa5
 */
Packit Service fb6fa5
void    gtk_file_chooser_add_filter    (GtkFileChooser *chooser,
Packit Service fb6fa5
					GtkFileFilter  *filter);
Packit Service fb6fa5
void    gtk_file_chooser_remove_filter (GtkFileChooser *chooser,
Packit Service fb6fa5
					GtkFileFilter  *filter);
Packit Service fb6fa5
GSList *gtk_file_chooser_list_filters  (GtkFileChooser *chooser);
Packit Service fb6fa5
Packit Service fb6fa5
/* Current filter
Packit Service fb6fa5
 */
Packit Service fb6fa5
void           gtk_file_chooser_set_filter (GtkFileChooser *chooser,
Packit Service fb6fa5
					   GtkFileFilter  *filter);
Packit Service fb6fa5
GtkFileFilter *gtk_file_chooser_get_filter (GtkFileChooser *chooser);
Packit Service fb6fa5
Packit Service fb6fa5
/* Per-application shortcut folders */
Packit Service fb6fa5
Packit Service fb6fa5
gboolean gtk_file_chooser_add_shortcut_folder    (GtkFileChooser *chooser,
Packit Service fb6fa5
						  const char     *folder,
Packit Service fb6fa5
						  GError        **error);
Packit Service fb6fa5
gboolean gtk_file_chooser_remove_shortcut_folder (GtkFileChooser *chooser,
Packit Service fb6fa5
						  const char     *folder,
Packit Service fb6fa5
						  GError        **error);
Packit Service fb6fa5
GSList *gtk_file_chooser_list_shortcut_folders   (GtkFileChooser *chooser);
Packit Service fb6fa5
Packit Service fb6fa5
gboolean gtk_file_chooser_add_shortcut_folder_uri    (GtkFileChooser *chooser,
Packit Service fb6fa5
						      const char     *uri,
Packit Service fb6fa5
						      GError        **error);
Packit Service fb6fa5
gboolean gtk_file_chooser_remove_shortcut_folder_uri (GtkFileChooser *chooser,
Packit Service fb6fa5
						      const char     *uri,
Packit Service fb6fa5
						      GError        **error);
Packit Service fb6fa5
GSList *gtk_file_chooser_list_shortcut_folder_uris   (GtkFileChooser *chooser);
Packit Service fb6fa5
Packit Service fb6fa5
G_END_DECLS
Packit Service fb6fa5
Packit Service fb6fa5
#endif /* __GTK_FILE_CHOOSER_H__ */