Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkfilechooserbutton.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkFileChooserButton
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 A button to launch a file selection dialog
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 The #GtkFileChooserButton is a widget that lets the user select a
  10 file.  It implements the #GtkFileChooser interface.  Visually, it is a
  11 file name with a button to bring up a #GtkFileChooserDialog.
  12 The user can then use that dialog to change the file associated with
  13 that button.  This widget does not support setting the "select-multiple"
  14 property to %TRUE.
  15 </para>
  16
  17 <example>
  18 <title>Create a button to let the user select a file in /etc</title>
  19 <programlisting>
  20 {
  21   GtkWidget *button;
  22
  23   button = gtk_file_chooser_button_new (_("Select a file"),
  24                                         GTK_FILE_CHOOSER_ACTION_OPEN);
  25   gtk_file_chooser_set_current_folder (GTK_FILE_CHOOSER (button),
  26                                        "/etc");
  27 }
  28 </programlisting>
  29 </example>
  30
  31 <para>
  32 The #GtkFileChooserButton supports the #GtkFileChooserAction<!--
  33 -->s %GTK_FILE_CHOOSER_ACTION_OPEN and %GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER.
  34 </para>
  35
  36 <important>
  37 <para>
  38 The #GtkFileChooserButton will ellipsize the label,
  39 and thus will thus request little horizontal space.  To give the button
  40 more space, you should call gtk_widget_size_request(),
  41 gtk_file_chooser_button_set_width_chars(), or pack the button in
  42 such a way that other interface elements give space to the widget.
  43 </para>
  44 </important>
  45
  46 <!-- ##### SECTION See_Also ##### -->
  47 <para>
  48 #GtkFileChooserDialog
  49 </para>
  50
  51 <!-- ##### SECTION Stability_Level ##### -->
  52
  53
  54 <!-- ##### STRUCT GtkFileChooserButton ##### -->
  55 <para>
  56 This should not be accessed directly.  Use the accessor functions below.
  57 </para>
  58
  59
  60 <!-- ##### SIGNAL GtkFileChooserButton::file-set ##### -->
  61 <para>
  62
  63 </para>
  64
  65 @filechooserbutton: the object which received the signal.
  66
  67 <!-- ##### ARG GtkFileChooserButton:dialog ##### -->
  68 <para>
  69
  70 </para>
  71
  72 <!-- ##### ARG GtkFileChooserButton:focus-on-click ##### -->
  73 <para>
  74
  75 </para>
  76
  77 <!-- ##### ARG GtkFileChooserButton:title ##### -->
  78 <para>
  79
  80 </para>
  81
  82 <!-- ##### ARG GtkFileChooserButton:width-chars ##### -->
  83 <para>
  84
  85 </para>
  86
  87 <!-- ##### FUNCTION gtk_file_chooser_button_new ##### -->
  88 <para>
  89
  90 </para>
  91
  92 @title:
  93 @action:
  94 @Returns:
  95
  96
  97 <!-- ##### FUNCTION gtk_file_chooser_button_new_with_backend ##### -->
  98 <para>
  99
 100 </para>
 101
 102 @title:
 103 @action:
 104 @backend:
 105 @Returns:
 106
 107
 108 <!-- ##### FUNCTION gtk_file_chooser_button_new_with_dialog ##### -->
 109 <para>
 110
 111 </para>
 112
 113 @dialog:
 114 @Returns:
 115
 116
 117 <!-- ##### FUNCTION gtk_file_chooser_button_get_title ##### -->
 118 <para>
 119
 120 </para>
 121
 122 @button:
 123 @Returns:
 124
 125
 126 <!-- ##### FUNCTION gtk_file_chooser_button_set_title ##### -->
 127 <para>
 128
 129 </para>
 130
 131 @button:
 132 @title:
 133
 134
 135 <!-- ##### FUNCTION gtk_file_chooser_button_get_width_chars ##### -->
 136 <para>
 137
 138 </para>
 139
 140 @button:
 141 @Returns:
 142
 143
 144 <!-- ##### FUNCTION gtk_file_chooser_button_set_width_chars ##### -->
 145 <para>
 146
 147 </para>
 148
 149 @button:
 150 @n_chars:
 151
 152
 153 <!-- ##### FUNCTION gtk_file_chooser_button_get_focus_on_click ##### -->
 154 <para>
 155
 156 </para>
 157
 158 @button:
 159 @Returns:
 160
 161
 162 <!-- ##### FUNCTION gtk_file_chooser_button_set_focus_on_click ##### -->
 163 <para>
 164
 165 </para>
 166
 167 @button:
 168 @focus_on_click:
 169
 170