luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-06-03 19:30:07 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Move the GAppInfoMonitor SECTION

Browse Source 
Move the contents to the struct docs.

Helps: #3037
This commit is contained in:
Matthias Clasen 2023-09-25 21:34:01 -04:00 committed by Philip Withnall
parent bf9bf0b0cc
commit 93788dfb07
1 changed files with 36 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
gio/gappinfo.c
View File

@ -1654,53 +1654,46 @@ g_app_launch_context_launch_failed (GAppLaunchContext *context,
/** /**
* SECTION:gappinfomonitor * GAppInfoMonitor:
* @short_description: Monitor application information for changes
* *
* #GAppInfoMonitor is a very simple object used for monitoring the app * `GAppInfoMonitor` monitors application information for changes.
*
* `GAppInfoMonitor` is a very simple object used for monitoring the app
* info database for changes (newly installed or removed applications). * info database for changes (newly installed or removed applications).
* *
* Call g_app_info_monitor_get() to get a #GAppInfoMonitor and connect * Call [func@Gio.AppInfoMonitor.get] to get a `GAppInfoMonitor` and connect
* to the #GAppInfoMonitor::changed signal. The signal will be emitted once when * to the [signal@Gio.AppInfoMonitor.changed] signal. The signal will be emitted once when
* the app info database changes, and will not be emitted again until after the * the app info database changes, and will not be emitted again until after the
* next call to g_app_info_get_all() or another `g_app_info_*()` function. This * next call to [func@Gio.AppInfo.get_all] or another `g_app_info_*()` function.
* is because monitoring the app info database for changes is expensive. * This is because monitoring the app info database for changes is expensive.
* *
* The following functions will re-arm the #GAppInfoMonitor::changed signal so * The following functions will re-arm the [signal@Gio.AppInfoMonitor.changed]
* it can be emitted again: * signal so it can be emitted again:
* - g_app_info_get_all() *
* - g_app_info_get_all_for_type() * - [method@Gio.AppInfo.get_all]
* - g_app_info_get_default_for_type() * - [method@Gio.AppInfo.get_all_for_type]
* - g_app_info_get_fallback_for_type() * - [method@Gio.AppInfo.get_default_for_type]
* - g_app_info_get_recommended_for_type() * - [method@Gio.AppInfo.get_fallback_for_type]
* - g_desktop_app_info_get_implementations() * - [method@Gio.AppInfo.get_recommended_for_type]
* - g_desktop_app_info_new() * - [method@Gio.DesktopAppInfo.get_implementations]
* - g_desktop_app_info_new_from_filename() * - [method@Gio.DesktopAppInfo.new]
* - g_desktop_app_info_new_from_keyfile() * - [method@Gio.DesktopAppInfo.new_from_filename]
* - g_desktop_app_info_search() * - [method@Gio.DesktopAppInfo.new_from_keyfile]
* - [method@Gio.DesktopAppInfo.search]
* *
* In the usual case, applications should try to make note of the change * In the usual case, applications should try to make note of the change
* (doing things like invalidating caches) but not act on it. In * (doing things like invalidating caches) but not act on it. In
* particular, applications should avoid making calls to #GAppInfo APIs * particular, applications should avoid making calls to `GAppInfo` APIs
* in response to the change signal, deferring these until the time that * in response to the change signal, deferring these until the time that
* the updated data is actually required. The exception to this case is when * the updated data is actually required. The exception to this case is when
* application information is actually being displayed on the screen * application information is actually being displayed on the screen
* (for example, during a search or when the list of all applications is shown). * (for example, during a search or when the list of all applications is shown).
* The reason for this is that changes to the list of installed * The reason for this is that changes to the list of installed applications
* applications often come in groups (like during system updates) and * often come in groups (like during system updates) and rescanning the list
* rescanning the list on every change is pointless and expensive. * on every change is pointless and expensive.
* *
* Since: 2.40 * Since: 2.40
**/ */
/**
* GAppInfoMonitor:
*
* The only thing you can do with this is to get it via
* g_app_info_monitor_get() and connect to the "changed" signal.
*
* Since: 2.40
**/
typedef struct _GAppInfoMonitorClass GAppInfoMonitorClass; typedef struct _GAppInfoMonitorClass GAppInfoMonitorClass;