AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity

windowgroup: Convert docs

Browse Source
This commit is contained in:
Matthias Clasen 2021-03-01 22:48:08 -05:00 committed by Emmanuele Bassi
parent 190292a7da
commit f937fe4a87
1 changed files with 24 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
gtk/gtkwindowgroup.c
View File

@ -31,20 +31,19 @@
/** /**
* SECTION:gtkwindowgroup * GtkWindowGroup:
* @Short_description: Limit the effect of grabs
* @Title: GtkWindowGroup
* *
* A #GtkWindowGroup restricts the effect of grabs to windows * `GtkWindowGroup` makes group of windows behave like separate applications.
* in the same group, thereby making window groups almost behave *
* like separate applications. * It achieves this by limiting the effect of GTK grabs and modality
* to windows in the same group.
* *
* A window can be a member in at most one window group at a time. * A window can be a member in at most one window group at a time.
* Windows that have not been explicitly assigned to a group are * Windows that have not been explicitly assigned to a group are
* implicitly treated like windows of the default window group. * implicitly treated like windows of the default window group.
* *
* GtkWindowGroup objects are referenced by each window in the group, * `GtkWindowGroup` objects are referenced by each window in the group,
* so once you have added all windows to a GtkWindowGroup, you can drop * so once you have added all windows to a `GtkWindowGroup`, you can drop
* the initial reference to the window group with g_object_unref(). If the * the initial reference to the window group with g_object_unref(). If the
* windows in the window group are subsequently destroyed, then they will * windows in the window group are subsequently destroyed, then they will
* be removed from the window group and drop their references on the window * be removed from the window group and drop their references on the window
@ -81,13 +80,13 @@ gtk_window_group_class_init (GtkWindowGroupClass *klass)
/** /**
* gtk_window_group_new: * gtk_window_group_new:
* *
* Creates a new #GtkWindowGroup object. * Creates a new `GtkWindowGroup` object.
* *
* Modality of windows only affects windows * Modality of windows only affects windows
* within the same #GtkWindowGroup. * within the same `GtkWindowGroup`.
* *
* Returns: a new #GtkWindowGroup. * Returns: a new `GtkWindowGroup`.
**/ **/
GtkWindowGroup * GtkWindowGroup *
gtk_window_group_new (void) gtk_window_group_new (void)
@ -123,11 +122,11 @@ window_group_cleanup_grabs (GtkWindowGroup *group,
/** /**
* gtk_window_group_add_window: * gtk_window_group_add_window:
* @window_group: a #GtkWindowGroup * @window_group: a `GtkWindowGroup`
* @window: the #GtkWindow to add * @window: the `GtkWindow` to add
* *
* Adds a window to a #GtkWindowGroup. * Adds a window to a `GtkWindowGroup`.
**/ */
void void
gtk_window_group_add_window (GtkWindowGroup *window_group, gtk_window_group_add_window (GtkWindowGroup *window_group,
GtkWindow *window) GtkWindow *window)
@ -157,11 +156,11 @@ gtk_window_group_add_window (GtkWindowGroup *window_group,
/** /**
* gtk_window_group_remove_window: * gtk_window_group_remove_window:
* @window_group: a #GtkWindowGroup * @window_group: a `GtkWindowGroup`
* @window: the #GtkWindow to remove * @window: the `GtkWindow` to remove
* *
* Removes a window from a #GtkWindowGroup. * Removes a window from a `GtkWindowGroup`.
**/ */
void void
gtk_window_group_remove_window (GtkWindowGroup *window_group, gtk_window_group_remove_window (GtkWindowGroup *window_group,
GtkWindow *window) GtkWindow *window)
@ -181,13 +180,13 @@ gtk_window_group_remove_window (GtkWindowGroup *window_group,
/** /**
* gtk_window_group_list_windows: * gtk_window_group_list_windows:
* @window_group: a #GtkWindowGroup * @window_group: a `GtkWindowGroup`
* *
* Returns a list of the #GtkWindows that belong to @window_group. * Returns a list of the `GtkWindows` that belong to @window_group.
* *
* Returns: (element-type GtkWindow) (transfer container): A * Returns: (element-type GtkWindow) (transfer container): A
* newly-allocated list of windows inside the group. * newly-allocated list of windows inside the group.
**/ */
GList * GList *
gtk_window_group_list_windows (GtkWindowGroup *window_group) gtk_window_group_list_windows (GtkWindowGroup *window_group)
{ {