window: Deprecate gtk_window_present()

And expect gtk_window_present_with_time() to be used instead.
This commit is contained in:
Bastien Nocera 2018-07-25 17:18:55 +02:00
parent df6494d73a
commit 8438880906
2 changed files with 23 additions and 20 deletions

View File

@ -8736,23 +8736,11 @@ gtk_window_snapshot (GtkWidget *widget,
* gtk_window_present: * gtk_window_present:
* @window: a #GtkWindow * @window: a #GtkWindow
* *
* Presents a window to the user. This may mean raising the window * Presents a window to the user. This function should not be used
* in the stacking order, deiconifying it, moving it to the current * as when it is called, it is too late to gather a valid timestamp
* desktop, and/or giving it the keyboard focus, possibly dependent * to allow focus stealing prevention to work correctly.
* on the users platform, window manager, and preferences.
* *
* If @window is hidden, this function calls gtk_widget_show() * Deprecated: 4.0: Use gtk_window_present_with_time() instead.
* as well.
*
* This function should be used when the user tries to open a window
* thats already open. Say for example the preferences dialog is
* currently open, and the user chooses Preferences from the menu
* a second time; use gtk_window_present() to move the already-open dialog
* where the user can see it.
*
* If you are calling this function in response to a user interaction,
* it is preferable to use gtk_window_present_with_time().
*
**/ **/
void void
gtk_window_present (GtkWindow *window) gtk_window_present (GtkWindow *window)
@ -8766,9 +8754,24 @@ gtk_window_present (GtkWindow *window)
* @timestamp: the timestamp of the user interaction (typically a * @timestamp: the timestamp of the user interaction (typically a
* button or key press event) which triggered this call * button or key press event) which triggered this call
* *
* Presents a window to the user in response to a user interaction. * Presents a window to the user. This may mean raising the window
* If you need to present a window without a timestamp, use * in the stacking order, deiconifying it, moving it to the current
* gtk_window_present(). See gtk_window_present() for details. * desktop, and/or giving it the keyboard focus, possibly dependent
* on the users platform, window manager, and preferences.
*
* If @window is hidden, this function calls gtk_widget_show()
* as well.
*
* This function should be used when the user tries to open a window
* thats already open. Say for example the preferences dialog is
* currently open, and the user chooses Preferences from the menu
* a second time; use gtk_window_present() to move the already-open dialog
* where the user can see it.
*
* Presents a window to the user in response to a user interaction. The
* timestamp should be gathered when the window was requested to be shown
* (when clicking a link for example), rather than once the window is
* ready to be shown.
**/ **/
void void
gtk_window_present_with_time (GtkWindow *window, gtk_window_present_with_time (GtkWindow *window,

View File

@ -324,7 +324,7 @@ GDK_AVAILABLE_IN_ALL
gboolean gtk_window_propagate_key_event (GtkWindow *window, gboolean gtk_window_propagate_key_event (GtkWindow *window,
GdkEventKey *event); GdkEventKey *event);
GDK_AVAILABLE_IN_ALL GDK_DEPRECATED_IN_4_0_FOR(gtk_window_present_with_time)
void gtk_window_present (GtkWindow *window); void gtk_window_present (GtkWindow *window);
GDK_AVAILABLE_IN_ALL GDK_AVAILABLE_IN_ALL
void gtk_window_present_with_time (GtkWindow *window, void gtk_window_present_with_time (GtkWindow *window,