* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include "config.h"
* However, filenames are <emphasis>always</emphasis> returned in
* the character set specified by the
* <envar>G_FILENAME_ENCODING</envar> environment variable.
- * Please see the Glib documentation for more details about this
+ * Please see the GLib documentation for more details about this
* variable.
* <note>
* This means that while you can pass the result of
* </example>
* <note>
* If you want to set more than one extra widget in the file
- * chooser, you can a container such as a #GtkVBox or a #GtkTable
+ * chooser, you can a container such as a #GtkBox or a #GtkGrid
* and include your widgets in it. Then, set the container as
* the whole extra widget.
* </note>
GType iface_type = G_TYPE_FROM_INTERFACE (iface);
/**
- * GtkFileChooser::current-folder-changed
+ * GtkFileChooser::current-folder-changed:
* @chooser: the object which received the signal.
*
* This signal is emitted when the current folder in a #GtkFileChooser
G_TYPE_NONE, 0);
/**
- * GtkFileChooser::selection-changed
+ * GtkFileChooser::selection-changed:
* @chooser: the object which received the signal.
*
* This signal is emitted when there is a change in the set of selected files
G_TYPE_NONE, 0);
/**
- * GtkFileChooser::update-preview
+ * GtkFileChooser::update-preview:
* @chooser: the object which received the signal.
*
* This signal is emitted when the preview in a file chooser should be
G_TYPE_NONE, 0);
/**
- * GtkFileChooser::file-activated
+ * GtkFileChooser::file-activated:
* @chooser: the object which received the signal.
*
* This signal is emitted when the user "activates" a file in the file
* @chooser: a #GtkFileChooser
*
* Gets the filename for the currently selected file in
- * the file selector. If multiple files are selected,
- * one of the filenames will be returned at random.
+ * the file selector. The filename is returned as an absolute path. If
+ * multiple files are selected, one of the filenames will be returned at
+ * random.
*
* If the file chooser is in folder mode, this function returns the selected
* folder.
* @chooser: a #GtkFileChooser
* @filename: (type filename): the filename to set as current
*
- * Sets @filename as the current filename for the file chooser, by changing
- * to the file's parent folder and actually selecting the file in list. If
- * the @chooser is in %GTK_FILE_CHOOSER_ACTION_SAVE mode, the file's base name
- * will also appear in the dialog's file name entry.
- *
- * If the file name isn't in the current folder of @chooser, then the current
- * folder of @chooser will be changed to the folder containing @filename. This
- * is equivalent to a sequence of gtk_file_chooser_unselect_all() followed by
- * gtk_file_chooser_select_filename().
+ * Sets @filename as the current filename for the file chooser, by changing to
+ * the file's parent folder and actually selecting the file in list; all other
+ * files will be unselected. If the @chooser is in
+ * %GTK_FILE_CHOOSER_ACTION_SAVE mode, the file's base name will also appear in
+ * the dialog's file name entry.
*
* Note that the file must exist, or nothing will be done except
* for the directory change.
*
- * If you are implementing a <guimenuitem>File/Save As...</guimenuitem> dialog,
- * you should use this function if you already have a file name to which the
- * user may save; for example, when the user opens an existing file and then
- * does <guimenuitem>File/Save As...</guimenuitem> on it. If you don't have
- * a file name already — for example, if the user just created a new
- * file and is saving it for the first time, do not call this function.
- * Instead, use something similar to this:
+ * You should use this function only when implementing a <guimenuitem>File/Save
+ * As...</guimenuitem> dialog for which you already have a file name to which
+ * the user may save. For example, when the user opens an existing file and
+ * then does <guimenuitem>File/Save As...</guimenuitem> on it to save a copy or
+ * a modified version. If you don't have a file name already — for
+ * example, if the user just created a new file and is saving it for the first
+ * time, do not call this function. Instead, use something similar to this:
* |[
* if (document_is_new)
* {
* /* the user just created a new document */
- * gtk_file_chooser_set_current_folder (chooser, default_folder_for_saving);
* gtk_file_chooser_set_current_name (chooser, "Untitled document");
* }
* else
* gtk_file_chooser_set_filename (chooser, existing_filename);
* }
* ]|
+ *
+ * In the first case, the file chooser will present the user with useful suggestions
+ * as to where to save his new file. In the second case, the file's existing location
+ * is already known, so the file chooser will use it.
*
- * Return value: %TRUE if both the folder could be changed and the file was
- * selected successfully, %FALSE otherwise.
+ * Return value: Not useful.
*
* Since: 2.4
**/
* folder of @chooser, then the current folder of @chooser will
* be changed to the folder containing @filename.
*
- * Return value: %TRUE if both the folder could be changed and the file was
- * selected successfully, %FALSE otherwise.
+ * Return value: Not useful.
+ *
+ * See also: gtk_file_chooser_set_filename()
*
* Since: 2.4
**/
* The user will be shown the full contents of the current folder,
* plus user interface elements for navigating to other folders.
*
- * Return value: %TRUE if the folder could be changed successfully, %FALSE
- * otherwise.
+ * In general, you should not use this function. See the <link
+ * linkend="gtkfilechooserdialog-setting-up">section on setting up a file
+ * chooser dialog</link> for the rationale behind this.
+ *
+ * Return value: Not useful.
*
* Since: 2.4
**/
* Sets the current name in the file selector, as if entered
* by the user. Note that the name passed in here is a UTF-8
* string rather than a filename. This function is meant for
- * such uses as a suggested name in a "Save As..." dialog.
+ * such uses as a suggested name in a "Save As..." dialog. You can
+ * pass "Untitled.doc" or a similarly suitable suggestion for the @name.
*
* If you want to preselect a particular existing file, you should use
* gtk_file_chooser_set_filename() or gtk_file_chooser_set_uri() instead.
* list. If the @chooser is %GTK_FILE_CHOOSER_ACTION_SAVE mode, the URI's base
* name will also appear in the dialog's file name entry.
*
- * If the URI isn't in the current folder of @chooser, then the current folder
- * of @chooser will be changed to the folder containing @uri. This is equivalent
- * to a sequence of gtk_file_chooser_unselect_all() followed by
- * gtk_file_chooser_select_uri().
- *
* Note that the URI must exist, or nothing will be done except for the
* directory change.
- * If you are implementing a <guimenuitem>File/Save As...</guimenuitem> dialog,
- * you should use this function if you already have a file name to which the
- * user may save; for example, when the user opens an existing file and then
- * does <guimenuitem>File/Save As...</guimenuitem> on it. If you don't have
- * a file name already — for example, if the user just created a new
- * file and is saving it for the first time, do not call this function.
- * Instead, use something similar to this:
+ *
+ * You should use this function only when implementing a <guimenuitem>File/Save
+ * As...</guimenuitem> dialog for which you already have a file name to which
+ * the user may save. For example, whenthe user opens an existing file and then
+ * does <guimenuitem>File/Save As...</guimenuitem> on it to save a copy or a
+ * modified version. If you don't have a file name already — for example,
+ * if the user just created a new file and is saving it for the first time, do
+ * not call this function. Instead, use something similar to this:
* |[
* if (document_is_new)
* {
* /* the user just created a new document */
- * gtk_file_chooser_set_current_folder_uri (chooser, default_folder_for_saving);
* gtk_file_chooser_set_current_name (chooser, "Untitled document");
* }
* else
* }
* ]|
*
- * Return value: %TRUE if both the folder could be changed and the URI was
- * selected successfully, %FALSE otherwise.
+ *
+ * In the first case, the file chooser will present the user with useful suggestions
+ * as to where to save his new file. In the second case, the file's existing location
+ * is already known, so the file chooser will use it.
+ *
+ * Return value: Not useful.
*
* Since: 2.4
**/
* file in the current folder of @chooser, then the current folder of
* @chooser will be changed to the folder containing @filename.
*
- * Return value: %TRUE if both the folder could be changed and the URI was
- * selected successfully, %FALSE otherwise.
+ * Return value: Not useful.
*
* Since: 2.4
**/
* The user will be shown the full contents of the current folder,
* plus user interface elements for navigating to other folders.
*
+ * In general, you should not use this function. See the <link
+ * linkend="gtkfilechooserdialog-setting-up">section on setting up a file
+ * chooser dialog</link> for the rationale behind this.
+ *
* Return value: %TRUE if the folder could be changed successfully, %FALSE
* otherwise.
*
* Selects the file referred to by @file. An internal function. See
* _gtk_file_chooser_select_uri().
*
- * Return value: %TRUE if both the folder could be changed and the path was
- * selected successfully, %FALSE otherwise.
+ * Return value: Not useful.
*
* Since: 2.14
**/
* }
* ]|
*
- * Return value: %TRUE if both the folder could be changed and the file was
- * selected successfully, %FALSE otherwise.
+ * Return value: Not useful.
*
* Since: 2.14
**/
projects / ~andy / gtk / blobdiff