AuroraMiddleware/gtk
1
0
Fork 1
mirror of https://gitlab.gnome.org/GNOME/gtk.git synced 2025-01-11 05:00:07 +00:00
Code Issues Projects Releases Wiki Activity

Merge branch 'more-docs-improvements' into 'main'

Browse Source 
launchers: Modernize the docs

See merge request GNOME/gtk!7943
This commit is contained in:
Matthias Clasen 2024-11-20 12:38:20 +00:00
commit dec4faa3d7
2 changed files with 42 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
gtk/gtkfilelauncher.c
View File

@ -34,8 +34,7 @@
/**
* GtkFileLauncher:
*
* A `GtkFileLauncher` object collects the arguments that are needed to open a
* file with an application.
* Collects the arguments that are needed to open a file with an application.
*
* Depending on system configuration, user preferences and available APIs, this
* may or may not show an app chooser dialog or launch the default application
@ -217,7 +216,7 @@ gtk_file_launcher_new (GFile *file)
/**
* gtk_file_launcher_get_file:
* @self: a `GtkFileLauncher`
* @self: a file launcher
*
* Gets the file that will be opened.
*
@ -235,8 +234,8 @@ gtk_file_launcher_get_file (GtkFileLauncher *self)
/**
* gtk_file_launcher_set_file:
* @self: a `GtkFileLauncher`
* @file: (nullable): a `GFile`
* @self: a file launcher
* @file: (nullable): the file
*
* Sets the file that will be opened.
*
@ -257,11 +256,11 @@ gtk_file_launcher_set_file (GtkFileLauncher *self,
/**
* gtk_file_launcher_get_always_ask:
* @self: a `GtkFileLauncher`
* @self: a file launcher
*
* Returns whether to ask the user to choose an app for opening the file.
* Returns whether to ask the user which app to use.
*
* Returns: `TRUE` if always asking for app
* Returns: true if always asking the user
*
* Since: 4.12
*/
@ -275,11 +274,13 @@ gtk_file_launcher_get_always_ask (GtkFileLauncher *self)
/**
* gtk_file_launcher_set_always_ask:
* @self: a `GtkFileLauncher`
* @always_ask: a `gboolean`
* @self: a file launcher
* @always_ask: whether to always ask
*
* Sets whether to awlays ask the user to choose an app for opening the file.
* If `FALSE`, the file might be opened with a default app or the previous choice.
* Sets whether to awlays ask the user which app to use.
*
* If false, the file might be opened with a default app
* or the previous choice.
*
* Since: 4.12
*/
@ -299,11 +300,11 @@ gtk_file_launcher_set_always_ask (GtkFileLauncher *self,
/**
* gtk_file_launcher_get_writable:
* @self: a `GtkFileLauncher`
* @self: a file launcher
*
* Returns whether to make the file writable for the handler.
*
* Returns: `TRUE` if the file will be made writable
* Returns: true if the file will be made writable
*
* Since: 4.14
*/
@ -317,8 +318,8 @@ gtk_file_launcher_get_writable (GtkFileLauncher *self)
/**
* gtk_file_launcher_set_writable:
* @self: a `GtkFileLauncher`
* @writable: a `gboolean`
* @self: a file launcher
* @writable: whether to make the file writable
*
* Sets whether to make the file writable for the handler.
*
@ -461,14 +462,14 @@ G_GNUC_END_IGNORE_DEPRECATIONS
/**
* gtk_file_launcher_launch:
* @self: a `GtkFileLauncher`
* @parent: (nullable): the parent `GtkWindow`
* @cancellable: (nullable): a `GCancellable` to cancel the operation
* @self: a file launcher
* @parent: (nullable): the parent window
* @cancellable: (nullable): a cancellable to cancel the operation
* @callback: (scope async) (closure user_data): a callback to call when the
* operation is complete
* @user_data: data to pass to @callback
*
* Launch an application to open the file.
* Launches an application to open the file.
*
* This may present an app chooser dialog to the user.
*
@ -538,15 +539,14 @@ G_GNUC_END_IGNORE_DEPRECATIONS
/**
* gtk_file_launcher_launch_finish:
* @self: a `GtkFileLauncher`
* @result: a `GAsyncResult`
* @self: a file launcher
* @result: the result
* @error: return location for a [enum@Gtk.DialogError] or [enum@Gio.Error] error
*
* Finishes the [method@Gtk.FileLauncher.launch] call and
* returns the result.
*
* Returns: `TRUE` if an application was launched,
* or `FALSE` and @error is set
* Returns: true if an application was launched
*
* Since: 4.10
*/
@ -564,16 +564,16 @@ gtk_file_launcher_launch_finish (GtkFileLauncher *self,
/**
* gtk_file_launcher_open_containing_folder:
* @self: a `GtkFileLauncher`
* @parent: (nullable): the parent `GtkWindow`
* @cancellable: (nullable): a `GCancellable` to cancel the operation
* @self: a file launcher
* @parent: (nullable): the parent window
* @cancellable: (nullable): a cancellable to cancel the operation
* @callback: (scope async) (closure user_data): a callback to call when the
* operation is complete
* @user_data: data to pass to @callback
*
* Launch a file manager to show the file in its parent directory.
* Launches a file manager to show the file in its parent directory.
*
* This is only supported native files. It will fail if @file
* This is only supported for native files. It will fail if @file
* is e.g. a http:// uri.
*
* Since: 4.10
@ -631,15 +631,14 @@ gtk_file_launcher_open_containing_folder (GtkFileLauncher *self,
/**
* gtk_file_launcher_open_containing_folder_finish:
* @self: a `GtkFileLauncher`
* @result: a `GAsyncResult`
* @self: a file launcher
* @result: the result
* @error: return location for a [enum@Gtk.DialogError] or [enum@Gio.Error] error
*
* Finishes the [method@Gtk.FileLauncher.open_containing_folder]
* call and returns the result.
*
* Returns: `TRUE` if an application was launched,
* or `FALSE` and @error is set
* Returns: true if an application was launched
*
* Since: 4.10
*/

22
gtk/gtkurilauncher.c
View File

@ -30,8 +30,7 @@
/**
* GtkUriLauncher:
*
* A `GtkUriLauncher` object collects the arguments that are needed to open a uri
* with an application.
* Collects the arguments that are needed to open a uri with an application.
*
* Depending on system configuration, user preferences and available APIs, this
* may or may not show an app chooser dialog or launch the default application
@ -168,7 +167,7 @@ gtk_uri_launcher_new (const char *uri)
/**
* gtk_uri_launcher_get_uri:
* @self: a `GtkUriLauncher`
* @self: an uri launcher
*
* Gets the uri that will be opened.
*
@ -186,7 +185,7 @@ gtk_uri_launcher_get_uri (GtkUriLauncher *self)
/**
* gtk_uri_launcher_set_uri:
* @self: a `GtkUriLauncher`
* @self: an uri launcher
* @uri: (nullable): the uri
*
* Sets the uri that will be opened.
@ -259,14 +258,14 @@ G_GNUC_END_IGNORE_DEPRECATIONS
/**
* gtk_uri_launcher_launch:
* @self: a `GtkUriLauncher`
* @parent: (nullable): the parent `GtkWindow`
* @cancellable: (nullable): a `GCancellable` to cancel the operation
* @self: an uri launcher
* @parent: (nullable): the parent window
* @cancellable: (nullable): a cancellable to cancel the operation
* @callback: (scope async) (closure user_data): a callback to call when the
* operation is complete
* @user_data: data to pass to @callback
*
* Launch an application to open the uri.
* Launches an application to open the uri.
*
* This may present an app chooser dialog to the user.
*
@ -331,15 +330,14 @@ G_GNUC_END_IGNORE_DEPRECATIONS
/**
* gtk_uri_launcher_launch_finish:
* @self: a `GtkUriLauncher`
* @result: a `GAsyncResult`
* @self: an uri launcher
* @result: the result
* @error: return location for a [enum@Gtk.DialogError] or [enum@Gio.Error] error
*
* Finishes the [method@Gtk.UriLauncher.launch] call and
* returns the result.
*
* Returns: `TRUE` if an application was launched,
* or `FALSE` and @error is set
* Returns: true if an application was launched
*
* Since: 4.10
*/