GtkFileChooserButton

GtkFileChooserButton — A button to launch a file selection dialog

Synopsis


#include <gtk/gtk.h>


struct      GtkFileChooserButton;
GtkWidget*  gtk_file_chooser_button_new     (const gchar *title);
GtkWidget*  gtk_file_chooser_button_new_with_backend
                                            (const gchar *title,
                                             const gchar *backend);
GtkWidget*  gtk_file_chooser_button_new_with_dialog
                                            (GtkWidget *dialog);
G_CONST_RETURN gchar* gtk_file_chooser_button_get_title
                                            (GtkFileChooserButton *button);
void        gtk_file_chooser_button_set_title
                                            (GtkFileChooserButton *button,
                                             const gchar *title);
gboolean    gtk_file_chooser_button_get_active
                                            (GtkFileChooserButton *button);
void        gtk_file_chooser_button_set_active
                                            (GtkFileChooserButton *button,
                                             gboolean is_active);
gint        gtk_file_chooser_button_get_width_chars
                                            (GtkFileChooserButton *button);
void        gtk_file_chooser_button_set_width_chars
                                            (GtkFileChooserButton *button,
                                             gint n_chars);


Object Hierarchy


  GObject
   +----GtkObject
         +----GtkWidget
               +----GtkContainer
                     +----GtkBox
                           +----GtkHBox
                                 +----GtkFileChooserButton

Implemented Interfaces

GtkFileChooserButton implements AtkImplementorIface and GtkFileChooser.

Properties


  "active"               gboolean             : Read / Write
  "dialog"               GtkFileChooserDialog : Write / Construct Only
  "title"                gchararray           : Read / Write
  "width-chars"          gint                 : Read / Write

Description

The GtkFileChooserButton is a widget that lets the user select a file. It implements the GtkFileChooser interface. Visually, it is a file name with a button to bring up a GtkFileChooserDialog. The user can then use that dialog to change the file associated with that button. This widget does not support setting the "select-multiple" property to TRUE.

Example 5. Create a button to let the user select a file in /etc

{
  GtkWidget *button;

  button = gtk_file_chooser_button_new (_("Select a file"));
  gtk_file_chooser_set_current_folder (GTK_FILE_CHOOSER (button),
                                       "/etc");
}

The GtkFileChooserButton supports all four GtkFileChooserActions that the GtkFileChooser supports. Two of the actions, GTK_FILE_CHOOSER_ACTION_SAVE and GTK_FILE_CHOOSER_ACTION_CREATE_FOLDER, give the button the appearance of an entry next to a button. The user can type the name of a file in this entry, and it will complete as it types. The other two actions, GTK_FILE_CHOOSER_ACTION_OPEN and GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER, make the GtkFileChooserAction look like a GtkButton.

Example 6. Using GtkFileChooserButton in save mode

{
  GtkWidget *button;

  button = gtk_file_chooser_button_new (_("Save as..."));
  gtk_file_chooser_set_action (GTK_FILE_CHOOSER (button),
                               GTK_FILE_CHOOSER_ACTION_SAVE);
  gtk_file_chooser_set_current_folder (GTK_FILE_CHOOSER_BUTTON (button),
                                       DEFAULT_SAVE_DIRECTORY);
}

Important

The GtkFileChooserButton will ellipsize the label while in Open mode, and thus will thus request little horizontal space. To give the button more space, you should call gtk_widget_size_request(), gtk_file_chooser_button_set_width_chars(), or pack the button in such a way that other interface elements give space to the widget.

Details

struct GtkFileChooserButton

struct GtkFileChooserButton;

This should not be accessed directly. Use the accessor functions below.


gtk_file_chooser_button_new ()

GtkWidget*  gtk_file_chooser_button_new     (const gchar *title);

Creates a new file-selecting button widget.

title : the title of the browse dialog.
Returns : a new button widget.

Since 2.6


gtk_file_chooser_button_new_with_backend ()

GtkWidget*  gtk_file_chooser_button_new_with_backend
                                            (const gchar *title,
                                             const gchar *backend);

Creates a new file-selecting button widget using backend.

title : the title of the browse dialog.
backend : the name of the GtkFileSystem backend to use.
Returns : a new button widget.

Since 2.6


gtk_file_chooser_button_new_with_dialog ()

GtkWidget*  gtk_file_chooser_button_new_with_dialog
                                            (GtkWidget *dialog);

Creates a GtkFileChooserButton widget which uses dialog as it's file-picking window. Note that dialog must be a GtkFileChooserDialog (or subclass).

dialog : the GtkDialog widget to use.
Returns : a new button widget.

Since 2.6


gtk_file_chooser_button_get_title ()

G_CONST_RETURN gchar* gtk_file_chooser_button_get_title
                                            (GtkFileChooserButton *button);

Retrieves the title of the browse dialog used by button. The returned value should not be modified or freed.

button : the button widget to examine.
Returns : a pointer to the browse dialog's title.

Since 2.6


gtk_file_chooser_button_set_title ()

void        gtk_file_chooser_button_set_title
                                            (GtkFileChooserButton *button,
                                             const gchar *title);

Modifies the title of the browse dialog used by button.

button : the button widget to modify.
title : the new browse dialog title.

Since 2.6


gtk_file_chooser_button_get_active ()

gboolean    gtk_file_chooser_button_get_active
                                            (GtkFileChooserButton *button);

Retrieves whether or not the dialog attached to button is visible.

button : the button widget to examine.
Returns : a boolean whether the dialog is visible or not.

Since 2.6


gtk_file_chooser_button_set_active ()

void        gtk_file_chooser_button_set_active
                                            (GtkFileChooserButton *button,
                                             gboolean is_active);

Modifies whether or not the dialog attached to button is visible or not.

button : the button widget to modify.
is_active : whether or not the dialog is visible.

Since 2.6


gtk_file_chooser_button_get_width_chars ()

gint        gtk_file_chooser_button_get_width_chars
                                            (GtkFileChooserButton *button);

Retrieves the width in characters of the button widget's entry and/or label.

button : the button widget to examine.
Returns : an integer width (in characters) that the button will use to size itself.

Since 2.6


gtk_file_chooser_button_set_width_chars ()

void        gtk_file_chooser_button_set_width_chars
                                            (GtkFileChooserButton *button,
                                             gint n_chars);

Sets the width (in characters) that button will use to n_chars.

button : the button widget to examine.
n_chars : the new width, in chracters.

Since 2.6

Properties

"active" (gboolean : Read / Write)

TRUE, if the GtkFileChooserDialog associated with the button has been made visible. This can also be set by the application, though it is rarely useful to do so.

"dialog" (GtkFileChooserDialog : Write / Construct Only)

Instance of the GtkFileChooserDialog associated with the button.

"title" (gchararray : Read / Write)

Title to put on the GtkFileChooserDialog associated with the button.

"width-chars" (gint : Read / Write)

The width of the entry and label inside the button, in characters.

See Also

GtkFileChooserDialog