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 <!-- ##### ARG GtkFileChooserButton:dialog ##### -->
  61 <para>
  62
  63 </para>
  64
  65 <!-- ##### ARG GtkFileChooserButton:focus-on-click ##### -->
  66 <para>
  67
  68 </para>
  69
  70 <!-- ##### ARG GtkFileChooserButton:title ##### -->
  71 <para>
  72
  73 </para>
  74
  75 <!-- ##### ARG GtkFileChooserButton:width-chars ##### -->
  76 <para>
  77
  78 </para>
  79
  80 <!-- ##### FUNCTION gtk_file_chooser_button_new ##### -->
  81 <para>
  82
  83 </para>
  84
  85 @title:
  86 @action:
  87 @Returns:
  88
  89
  90 <!-- ##### FUNCTION gtk_file_chooser_button_new_with_backend ##### -->
  91 <para>
  92
  93 </para>
  94
  95 @title:
  96 @action:
  97 @backend:
  98 @Returns:
  99
 100
 101 <!-- ##### FUNCTION gtk_file_chooser_button_new_with_dialog ##### -->
 102 <para>
 103
 104 </para>
 105
 106 @dialog:
 107 @Returns:
 108
 109
 110 <!-- ##### FUNCTION gtk_file_chooser_button_get_title ##### -->
 111 <para>
 112
 113 </para>
 114
 115 @button:
 116 @Returns:
 117
 118
 119 <!-- ##### FUNCTION gtk_file_chooser_button_set_title ##### -->
 120 <para>
 121
 122 </para>
 123
 124 @button:
 125 @title:
 126
 127
 128 <!-- ##### FUNCTION gtk_file_chooser_button_get_width_chars ##### -->
 129 <para>
 130
 131 </para>
 132
 133 @button:
 134 @Returns:
 135
 136
 137 <!-- ##### FUNCTION gtk_file_chooser_button_set_width_chars ##### -->
 138 <para>
 139
 140 </para>
 141
 142 @button:
 143 @n_chars:
 144
 145
 146 <!-- ##### FUNCTION gtk_file_chooser_button_get_focus_on_click ##### -->
 147 <para>
 148
 149 </para>
 150
 151 @button:
 152 @Returns:
 153
 154
 155 <!-- ##### FUNCTION gtk_file_chooser_button_set_focus_on_click ##### -->
 156 <para>
 157
 158 </para>
 159
 160 @button:
 161 @focus_on_click:
 162
 163