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

stack: Style and introspection doc fixes

Browse Source 
https://gitlab.gnome.org/GNOME/mutter/merge_requests/669
This commit is contained in:
Marco Trevisan (Treviño) 2019-07-04 13:03:40 +02:00
parent 6d8293a422
commit 62f4e0501f
2 changed files with 62 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
src/core/stack.c
View File

@ -49,10 +49,9 @@
static void meta_window_set_stack_position_no_sync (MetaWindow *window, static void meta_window_set_stack_position_no_sync (MetaWindow *window,
int position); int position);
static void stack_do_relayer (MetaStack *stack); static void stack_do_relayer (MetaStack *stack);
static void stack_do_constrain (MetaStack *stack); static void stack_do_constrain (MetaStack *stack);
static void stack_do_resort (MetaStack *stack); static void stack_do_resort (MetaStack *stack);
static void stack_ensure_sorted (MetaStack *stack); static void stack_ensure_sorted (MetaStack *stack);
enum enum
@ -969,7 +968,7 @@ stack_ensure_sorted (MetaStack *stack)
stack_do_resort (stack); stack_do_resort (stack);
} }
MetaWindow* MetaWindow *
meta_stack_get_top (MetaStack *stack) meta_stack_get_top (MetaStack *stack)
{ {
stack_ensure_sorted (stack); stack_ensure_sorted (stack);
@ -980,7 +979,7 @@ meta_stack_get_top (MetaStack *stack)
return NULL; return NULL;
} }
MetaWindow* MetaWindow *
meta_stack_get_bottom (MetaStack *stack) meta_stack_get_bottom (MetaStack *stack)
{ {
GList *link; GList *link;
@ -994,10 +993,10 @@ meta_stack_get_bottom (MetaStack *stack)
return NULL; return NULL;
} }
MetaWindow* MetaWindow *
meta_stack_get_above (MetaStack *stack, meta_stack_get_above (MetaStack *stack,
MetaWindow *window, MetaWindow *window,
gboolean only_within_layer) gboolean only_within_layer)
{ {
GList *link; GList *link;
MetaWindow *above; MetaWindow *above;
@ -1019,10 +1018,10 @@ meta_stack_get_above (MetaStack *stack,
return above; return above;
} }
MetaWindow* MetaWindow *
meta_stack_get_below (MetaStack *stack, meta_stack_get_below (MetaStack *stack,
MetaWindow *window, MetaWindow *window,
gboolean only_within_layer) gboolean only_within_layer)
{ {
GList *link; GList *link;
MetaWindow *below; MetaWindow *below;
@ -1078,7 +1077,7 @@ window_can_get_default_focus (MetaWindow *window)
return TRUE; return TRUE;
} }
static MetaWindow* static MetaWindow *
get_default_focus_window (MetaStack *stack, get_default_focus_window (MetaStack *stack,
MetaWorkspace *workspace, MetaWorkspace *workspace,
MetaWindow *not_this_one, MetaWindow *not_this_one,
@ -1117,7 +1116,7 @@ get_default_focus_window (MetaStack *stack,
return NULL; return NULL;
} }
MetaWindow* MetaWindow *
meta_stack_get_default_focus_window_at_point (MetaStack *stack, meta_stack_get_default_focus_window_at_point (MetaStack *stack,
MetaWorkspace *workspace, MetaWorkspace *workspace,
MetaWindow *not_this_one, MetaWindow *not_this_one,
@ -1128,7 +1127,7 @@ meta_stack_get_default_focus_window_at_point (MetaStack *stack,
TRUE, root_x, root_y); TRUE, root_x, root_y);
} }
MetaWindow* MetaWindow *
meta_stack_get_default_focus_window (MetaStack *stack, meta_stack_get_default_focus_window (MetaStack *stack,
MetaWorkspace *workspace, MetaWorkspace *workspace,
MetaWindow *not_this_one) MetaWindow *not_this_one)
@ -1137,7 +1136,7 @@ meta_stack_get_default_focus_window (MetaStack *stack,
FALSE, 0, 0); FALSE, 0, 0);
} }
GList* GList *
meta_stack_list_windows (MetaStack *stack, meta_stack_list_windows (MetaStack *stack,
MetaWorkspace *workspace) MetaWorkspace *workspace)
{ {
@ -1186,9 +1185,9 @@ meta_stack_get_default_focus_candidates (MetaStack *stack,
} }
int int
meta_stack_windows_cmp (MetaStack *stack, meta_stack_windows_cmp (MetaStack *stack,
MetaWindow *window_a, MetaWindow *window_a,
MetaWindow *window_b) MetaWindow *window_b)
{ {
/* -1 means a below b */ /* -1 means a below b */
@ -1221,7 +1220,7 @@ compare_just_window_stack_position (void *a,
return 0; /* not reached */ return 0; /* not reached */
} }
GList* GList *
meta_stack_get_positions (MetaStack *stack) meta_stack_get_positions (MetaStack *stack)
{ {
GList *tmp; GList *tmp;

80
src/core/stack.h
View File

@ -108,7 +108,7 @@ G_DECLARE_FINAL_TYPE (MetaStack, meta_stack, META, STACK, GObject)
* *
* Returns: The new stack. * Returns: The new stack.
*/ */
MetaStack *meta_stack_new (MetaDisplay *display); MetaStack * meta_stack_new (MetaDisplay *display);
/** /**
* meta_stack_add: * meta_stack_add:
@ -118,8 +118,8 @@ MetaStack *meta_stack_new (MetaDisplay *display);
* Adds a window to the local stack. It is a fatal error to call this * Adds a window to the local stack. It is a fatal error to call this
* function on a window which already exists on the stack of any screen. * function on a window which already exists on the stack of any screen.
*/ */
void meta_stack_add (MetaStack *stack, void meta_stack_add (MetaStack *stack,
MetaWindow *window); MetaWindow *window);
/** /**
* meta_stack_remove: * meta_stack_remove:
@ -129,8 +129,8 @@ void meta_stack_add (MetaStack *stack,
* Removes a window from the local stack. It is a fatal error to call this * Removes a window from the local stack. It is a fatal error to call this
* function on a window which exists on the stack of any screen. * function on a window which exists on the stack of any screen.
*/ */
void meta_stack_remove (MetaStack *stack, void meta_stack_remove (MetaStack *stack,
MetaWindow *window); MetaWindow *window);
/** /**
* meta_stack_update_layer: * meta_stack_update_layer:
* @stack: The stack to recalculate * @stack: The stack to recalculate
@ -140,8 +140,8 @@ void meta_stack_remove (MetaStack *stack,
* and moves them about accordingly. * and moves them about accordingly.
* *
*/ */
void meta_stack_update_layer (MetaStack *stack, void meta_stack_update_layer (MetaStack *stack,
MetaWindow *window); MetaWindow *window);
/** /**
* meta_stack_update_transient: * meta_stack_update_transient:
@ -153,8 +153,8 @@ void meta_stack_update_layer (MetaStack *stack,
* *
* FIXME: What's with the dummy parameter? * FIXME: What's with the dummy parameter?
*/ */
void meta_stack_update_transient (MetaStack *stack, void meta_stack_update_transient (MetaStack *stack,
MetaWindow *window); MetaWindow *window);
/** /**
* meta_stack_raise: * meta_stack_raise:
@ -164,8 +164,8 @@ void meta_stack_update_transient (MetaStack *stack,
* *
* Move a window to the top of its layer. * Move a window to the top of its layer.
*/ */
void meta_stack_raise (MetaStack *stack, void meta_stack_raise (MetaStack *stack,
MetaWindow *window); MetaWindow *window);
/** /**
* meta_stack_lower: * meta_stack_lower:
* @stack: The stack to modify. * @stack: The stack to modify.
@ -173,8 +173,8 @@ void meta_stack_raise (MetaStack *stack,
* *
* Move a window to the bottom of its layer. * Move a window to the bottom of its layer.
*/ */
void meta_stack_lower (MetaStack *stack, void meta_stack_lower (MetaStack *stack,
MetaWindow *window); MetaWindow *window);
/** /**
* meta_stack_freeze: * meta_stack_freeze:
@ -187,7 +187,7 @@ void meta_stack_lower (MetaStack *stack,
* (Calls to meta_stack_freeze() nest, so that multiple calls to * (Calls to meta_stack_freeze() nest, so that multiple calls to
* meta_stack_freeze will require multiple calls to meta_stack_thaw().) * meta_stack_freeze will require multiple calls to meta_stack_thaw().)
*/ */
void meta_stack_freeze (MetaStack *stack); void meta_stack_freeze (MetaStack *stack);
/** /**
* meta_stack_thaw: * meta_stack_thaw:
@ -197,7 +197,7 @@ void meta_stack_freeze (MetaStack *stack);
* necessary during the freeze. It is an error to call this function if * necessary during the freeze. It is an error to call this function if
* the stack has not been frozen. * the stack has not been frozen.
*/ */
void meta_stack_thaw (MetaStack *stack); void meta_stack_thaw (MetaStack *stack);
/** /**
* meta_stack_get_top: * meta_stack_get_top:
@ -208,7 +208,7 @@ void meta_stack_thaw (MetaStack *stack);
* Returns: The top window on the stack, or %NULL in the vanishingly unlikely * Returns: The top window on the stack, or %NULL in the vanishingly unlikely
* event that you have no windows on your screen whatsoever. * event that you have no windows on your screen whatsoever.
*/ */
MetaWindow* meta_stack_get_top (MetaStack *stack); MetaWindow * meta_stack_get_top (MetaStack *stack);
/** /**
* meta_stack_get_bottom: * meta_stack_get_bottom:
@ -218,7 +218,7 @@ MetaWindow* meta_stack_get_top (MetaStack *stack);
* always the desktop, this isn't the most useful of functions, and nobody * always the desktop, this isn't the most useful of functions, and nobody
* actually calls it. We should probably get rid of it. * actually calls it. We should probably get rid of it.
*/ */
MetaWindow* meta_stack_get_bottom (MetaStack *stack); MetaWindow * meta_stack_get_bottom (MetaStack *stack);
/** /**
* meta_stack_get_above: * meta_stack_get_above:
@ -234,7 +234,7 @@ MetaWindow* meta_stack_get_bottom (MetaStack *stack);
* Returns: %NULL if there is no such window; * Returns: %NULL if there is no such window;
* the window above @window otherwise. * the window above @window otherwise.
*/ */
MetaWindow* meta_stack_get_above (MetaStack *stack, MetaWindow * meta_stack_get_above (MetaStack *stack,
MetaWindow *window, MetaWindow *window,
gboolean only_within_layer); gboolean only_within_layer);
@ -253,7 +253,7 @@ MetaWindow* meta_stack_get_above (MetaStack *stack,
* Returns: %NULL if there is no such window; * Returns: %NULL if there is no such window;
* the window below @window otherwise. * the window below @window otherwise.
*/ */
MetaWindow* meta_stack_get_below (MetaStack *stack, MetaWindow * meta_stack_get_below (MetaStack *stack,
MetaWindow *window, MetaWindow *window,
gboolean only_within_layer); gboolean only_within_layer);
@ -276,9 +276,9 @@ MetaWindow* meta_stack_get_below (MetaStack *stack,
* *
* Returns: The window matching all these constraints or %NULL if none does. * Returns: The window matching all these constraints or %NULL if none does.
*/ */
MetaWindow* meta_stack_get_default_focus_window (MetaStack *stack, MetaWindow * meta_stack_get_default_focus_window (MetaStack *stack,
MetaWorkspace *workspace, MetaWorkspace *workspace,
MetaWindow *not_this_one); MetaWindow *not_this_one);
/** /**
* meta_stack_get_default_focus_window_at_point: * meta_stack_get_default_focus_window_at_point:
@ -302,11 +302,11 @@ MetaWindow* meta_stack_get_default_focus_window (MetaStack *stack,
* *
* Returns: The window matching all these constraints or %NULL if none does. * Returns: The window matching all these constraints or %NULL if none does.
*/ */
MetaWindow* meta_stack_get_default_focus_window_at_point (MetaStack *stack, MetaWindow * meta_stack_get_default_focus_window_at_point (MetaStack *stack,
MetaWorkspace *workspace, MetaWorkspace *workspace,
MetaWindow *not_this_one, MetaWindow *not_this_one,
int root_x, int root_x,
int root_y); int root_y);
/** /**
* meta_stack_get_default_focus_candidates: * meta_stack_get_default_focus_candidates:
@ -320,8 +320,8 @@ MetaWindow* meta_stack_get_default_focus_window_at_point (MetaStack *stack,
* Returns: (transfer container) (element-type Meta.Window): * Returns: (transfer container) (element-type Meta.Window):
* A #GList of #MetaWindow, in stacking order, honouring layers. * A #GList of #MetaWindow, in stacking order, honouring layers.
*/ */
GList * meta_stack_get_default_focus_candidates (MetaStack *stack, GList * meta_stack_get_default_focus_candidates (MetaStack *stack,
MetaWorkspace *workspace); MetaWorkspace *workspace);
/** /**
* meta_stack_list_windows: * meta_stack_list_windows:
@ -332,10 +332,11 @@ GList * meta_stack_get_default_focus_candidates (MetaStack *stack,
* *
* Finds all the windows in the stack, in order. * Finds all the windows in the stack, in order.
* *
* Returns: A list of windows, in stacking order, honouring layers. * Returns: (transfer container) (element-type Meta.Window):
* A list of windows, in stacking order, honouring layers.
*/ */
GList* meta_stack_list_windows (MetaStack *stack, GList * meta_stack_list_windows (MetaStack *stack,
MetaWorkspace *workspace); MetaWorkspace *workspace);
/** /**
* meta_stack_windows_cmp: * meta_stack_windows_cmp:
@ -356,9 +357,9 @@ GList* meta_stack_list_windows (MetaStack *stack,
* \return -1 if window_a is below window_b, honouring layers; 1 if it's * \return -1 if window_a is below window_b, honouring layers; 1 if it's
* above it; 0 if you passed in the same window twice! * above it; 0 if you passed in the same window twice!
*/ */
int meta_stack_windows_cmp (MetaStack *stack, int meta_stack_windows_cmp (MetaStack *stack,
MetaWindow *window_a, MetaWindow *window_a,
MetaWindow *window_b); MetaWindow *window_b);
/** /**
* meta_window_set_stack_position: * meta_window_set_stack_position:
@ -380,12 +381,13 @@ void meta_window_set_stack_position (MetaWindow *window,
* *
* Returns the current stack state, allowing rudimentary transactions. * Returns the current stack state, allowing rudimentary transactions.
* *
* Returns: An opaque GList representing the current stack sort order; * Returns: (transfer container) (element-type Meta.Window):
* An opaque #GList representing the current stack sort order;
* it is the caller's responsibility to free it. * it is the caller's responsibility to free it.
* Pass this to meta_stack_set_positions() later if you want to restore * Pass this to meta_stack_set_positions() later if you want to restore
* the state to where it was when you called this function. * the state to where it was when you called this function.
*/ */
GList* meta_stack_get_positions (MetaStack *stack); GList * meta_stack_get_positions (MetaStack *stack);
/** /**
* meta_stack_set_positions: * meta_stack_set_positions:
@ -396,8 +398,8 @@ GList* meta_stack_get_positions (MetaStack *stack);
* meta_stack_get_positions(). * meta_stack_get_positions().
* *
*/ */
void meta_stack_set_positions (MetaStack *stack, void meta_stack_set_positions (MetaStack *stack,
GList *windows); GList *windows);
void meta_stack_update_window_tile_matches (MetaStack *stack, void meta_stack_update_window_tile_matches (MetaStack *stack,
MetaWorkspace *workspace); MetaWorkspace *workspace);