brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

window: Add documentation to should_be_showing(_on_workspace)()

Browse Source 
It's a bit unclear whether "should be shown" takes ability to actually
immediately show into account. Make this clear in a function doc
comment.

Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/3475>
This commit is contained in:
Jonas Ådahl
2024-03-25 10:42:24 +01:00
committed by Marge Bot
parent e4763d00e8
commit fd6d86d33d
2 changed files with 18 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
src/core/window.c
View File

@ -1690,6 +1690,15 @@ window_has_buffer (MetaWindow *window)
return TRUE;
}
/**
* meta_window_should_be_showing_on_workspace:
*
* Tells whether a window should be showing on the passed workspace, while
* taking whether it can be immediately be shown. Whether it can be shown or
* not depends on what windowing system it was created from.
*
* Returns: %TRUE if the window should and can be shown.
*/
gboolean
meta_window_should_be_showing_on_workspace (MetaWindow *window,
MetaWorkspace *workspace)
@ -1710,6 +1719,15 @@ meta_window_should_be_showing_on_workspace (MetaWindow *window,
meta_window_showing_on_its_workspace (window));
}
/**
* meta_window_should_be_showing:
*
* Tells whether a window should be showing on the current workspace, while
* taking whether it can be immediately be shown. Whether it can be shown or
* not depends on what windowing system it was created from.
*
* Returns: %TRUE if the window should and can be shown.
*/
gboolean
meta_window_should_be_showing (MetaWindow *window)
{