[GI] Annotate strings holding file paths as (type filename)

This commit is contained in:
Pavel Holejsovsky
2011-01-18 06:42:31 +01:00
parent 204d1fd0a6
commit 6d5cdad56e
13 changed files with 63 additions and 58 deletions

View File

@ -1033,7 +1033,7 @@ gtk_file_chooser_get_create_folders (GtkFileChooser *chooser)
* If the file chooser is in folder mode, this function returns the selected
* folder.
*
* Return value: The currently selected filename, or %NULL
* Return value: (type filename): The currently selected filename, or %NULL
* if no file is selected, or the selected file can't
* be represented with a local filename. Free with g_free().
*
@ -1061,7 +1061,7 @@ gtk_file_chooser_get_filename (GtkFileChooser *chooser)
/**
* gtk_file_chooser_set_filename:
* @chooser: a #GtkFileChooser
* @filename: the filename to set as current
* @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
@ -1115,7 +1115,7 @@ gtk_file_chooser_set_filename (GtkFileChooser *chooser,
/**
* gtk_file_chooser_select_filename:
* @chooser: a #GtkFileChooser
* @filename: the filename to select
* @filename: (type filename): the filename to select
*
* Selects a filename. If the file name isn't in the current
* folder of @chooser, then the current folder of @chooser will
@ -1146,7 +1146,7 @@ gtk_file_chooser_select_filename (GtkFileChooser *chooser,
/**
* gtk_file_chooser_unselect_filename:
* @chooser: a #GtkFileChooser
* @filename: the filename to unselect
* @filename: (type filename): the filename to unselect
*
* Unselects a currently selected filename. If the filename
* is not in the current directory, does not exist, or
@ -1201,9 +1201,10 @@ files_to_strings (GSList *files,
* folder cannot be represented as local filenames they will be ignored. (See
* gtk_file_chooser_get_uris())
*
* Return value: (element-type utf8) (transfer full): a #GSList containing the filenames of all selected
* files and subfolders in the current folder. Free the returned list
* with g_slist_free(), and the filenames with g_free().
* Return value: (element-type filename) (transfer full): a #GSList
* containing the filenames of all selected files and subfolders in
* the current folder. Free the returned list with g_slist_free(),
* and the filenames with g_free().
*
* Since: 2.4
**/
@ -1226,7 +1227,7 @@ gtk_file_chooser_get_filenames (GtkFileChooser *chooser)
/**
* gtk_file_chooser_set_current_folder:
* @chooser: a #GtkFileChooser
* @filename: the full path of the new current folder
* @filename: (type filename): the full path of the new current folder
*
* Sets the current folder for @chooser from a local filename.
* The user will be shown the full contents of the current folder,
@ -1269,10 +1270,11 @@ gtk_file_chooser_set_current_folder (GtkFileChooser *chooser,
* currently-selected folder in that mode, use gtk_file_chooser_get_uri() as the
* usual way to get the selection.
*
* Return value: the full path of the current folder, or %NULL if the current
* path cannot be represented as a local filename. Free with g_free(). This
* function will also return %NULL if the file chooser was unable to load the
* last folder that was requested from it; for example, as would be for calling
* Return value: (type filename): the full path of the current folder,
* or %NULL if the current path cannot be represented as a local
* filename. Free with g_free(). This function will also return
* %NULL if the file chooser was unable to load the last folder that
* was requested from it; for example, as would be for calling
* gtk_file_chooser_set_current_folder() on a nonexistent folder.
*
* Since: 2.4
@ -1298,7 +1300,7 @@ gtk_file_chooser_get_current_folder (GtkFileChooser *chooser)
/**
* gtk_file_chooser_set_current_name:
* @chooser: a #GtkFileChooser
* @name: the filename to use, as a UTF-8 string
* @name: (type filename): the filename to use, as a UTF-8 string
*
* 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
@ -2056,8 +2058,8 @@ _gtk_file_chooser_remove_shortcut_folder (GtkFileChooser *chooser,
* Gets the filename that should be previewed in a custom preview
* widget. See gtk_file_chooser_set_preview_widget().
*
* Return value: the filename to preview, or %NULL if no file
* is selected, or if the selected file cannot be represented
* Return value: (type filename): the filename to preview, or %NULL if
* no file is selected, or if the selected file cannot be represented
* as a local filename. Free with g_free()
*
* Since: 2.4
@ -2276,7 +2278,7 @@ gtk_file_chooser_get_filter (GtkFileChooser *chooser)
/**
* gtk_file_chooser_add_shortcut_folder:
* @chooser: a #GtkFileChooser
* @folder: filename of the folder to add
* @folder: (type filename): filename of the folder to add
* @error: (allow-none): location to store error, or %NULL
*
* Adds a folder to be displayed with the shortcut folders in a file chooser.
@ -2310,7 +2312,7 @@ gtk_file_chooser_add_shortcut_folder (GtkFileChooser *chooser,
/**
* gtk_file_chooser_remove_shortcut_folder:
* @chooser: a #GtkFileChooser
* @folder: filename of the folder to remove
* @folder: (type filename): filename of the folder to remove
* @error: (allow-none): location to store error, or %NULL
*
* Removes a folder from a file chooser's list of shortcut folders.
@ -2347,8 +2349,9 @@ gtk_file_chooser_remove_shortcut_folder (GtkFileChooser *chooser,
* Queries the list of shortcut folders in the file chooser, as set by
* gtk_file_chooser_add_shortcut_folder().
*
* Return value: (element-type utf8) (transfer full): A list of folder filenames, or %NULL if there are no shortcut
* folders. Free the returned list with g_slist_free(), and the filenames with
* Return value: (element-type filename) (transfer full): A list of
* folder filenames, or %NULL if there are no shortcut folders. Free
* the returned list with g_slist_free(), and the filenames with
* g_free().
*
* Since: 2.4