[mutter_plugin_get_windows] Document it

This commit is contained in:
Colin Walters 2009-09-28 16:42:12 -04:00
parent 2af788956e
commit d8ffc3c187

View File

@ -459,6 +459,18 @@ mutter_plugin_set_stage_input_region (MutterPlugin *plugin,
mutter_set_stage_input_region (screen, region); mutter_set_stage_input_region (screen, region);
} }
/**
* mutter_plugin_get_windows:
* @plugin: A #MutterPlugin
*
* This function returns all of the #MetaWindow objects referenced by Mutter, including
* override-redirect windows. The returned list is a snapshot of Mutter's current
* stacking order, with the topmost window last.
*
* The 'restacked' signal of #MetaScreen signals when this value has changed.
*
* Returns: (transfer none) (element-type MetaWindow): Windows in stacking order, topmost last
*/
GList * GList *
mutter_plugin_get_windows (MutterPlugin *plugin) mutter_plugin_get_windows (MutterPlugin *plugin)
{ {