summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarco Melorio <marco.melorio@protonmail.com>2023-02-12 16:01:55 +0100
committerMarco Melorio <marco.melorio@protonmail.com>2023-02-12 16:09:25 +0100
commit3aac70f245a222e8139360883295f8d29f6643d4 (patch)
treecf6e6e0225abe463f4987d2a6a381d253304431a
parent157ef1d3959947593e914496f02a86e2f062a91c (diff)
downloadgtk+-3aac70f245a222e8139360883295f8d29f6643d4.tar.gz
docs: Mark everything in GtkAssistant as deprecated
-rw-r--r--gtk/deprecated/gtkassistant.c74
1 files changed, 74 insertions, 0 deletions
diff --git a/gtk/deprecated/gtkassistant.c b/gtk/deprecated/gtkassistant.c
index 0a96ed1931..485a0d3e19 100644
--- a/gtk/deprecated/gtkassistant.c
+++ b/gtk/deprecated/gtkassistant.c
@@ -60,12 +60,16 @@
*
* `GtkAssistant` has a single CSS node with the name window and style
* class .assistant.
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
/**
* GtkAssistantPage:
*
* `GtkAssistantPage` is an auxiliary object used by `GtkAssistant.
+ *
+ * Deprecated: 4.10: This object will be removed in GTK 5
*/
#include "config.h"
@@ -275,6 +279,8 @@ gtk_assistant_page_class_init (GtkAssistantPageClass *class)
* GtkAssistantPage:page-type:
*
* The type of the assistant page.
+ *
+ * Deprecated: 4.10: This object will be removed in GTK 5
*/
g_object_class_install_property (object_class,
CHILD_PROP_PAGE_TYPE,
@@ -287,6 +293,8 @@ gtk_assistant_page_class_init (GtkAssistantPageClass *class)
* GtkAssistantPage:title:
*
* The title of the page.
+ *
+ * Deprecated: 4.10: This object will be removed in GTK 5
*/
g_object_class_install_property (object_class,
CHILD_PROP_PAGE_TITLE,
@@ -301,6 +309,8 @@ gtk_assistant_page_class_init (GtkAssistantPageClass *class)
*
* GTK uses this information to control the sensitivity
* of the navigation buttons.
+ *
+ * Deprecated: 4.10: This object will be removed in GTK 5
*/
g_object_class_install_property (object_class,
CHILD_PROP_PAGE_COMPLETE,
@@ -312,6 +322,8 @@ gtk_assistant_page_class_init (GtkAssistantPageClass *class)
* GtkAssistantPage:child:
*
* The child widget.
+ *
+ * Deprecated: 4.10: This object will be removed in GTK 5
*/
g_object_class_install_property (object_class,
CHILD_PROP_CHILD,
@@ -518,6 +530,8 @@ gtk_assistant_class_init (GtkAssistantClass *class)
* @assistant: the `GtkAssistant`
*
* Emitted when then the cancel button is clicked.
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
signals[CANCEL] =
g_signal_new (I_("cancel"),
@@ -538,6 +552,8 @@ gtk_assistant_class_init (GtkAssistantClass *class)
*
* A handler for this signal can do any preparations which are
* necessary before showing @page.
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
signals[PREPARE] =
g_signal_new (I_("prepare"),
@@ -563,6 +579,8 @@ gtk_assistant_class_init (GtkAssistantClass *class)
* %GTK_ASSISTANT_PAGE_PROGRESS after the confirmation page and handle
* this operation within the [signal@Gtk.Assistant::prepare] signal of
* the progress page.
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
signals[APPLY] =
g_signal_new (I_("apply"),
@@ -580,6 +598,8 @@ gtk_assistant_class_init (GtkAssistantClass *class)
* Emitted either when the close button of a summary page is clicked,
* or when the apply button in the last page in the flow (of type
* %GTK_ASSISTANT_PAGE_CONFIRM) is clicked.
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
signals[CLOSE] =
g_signal_new (I_("close"),
@@ -595,6 +615,8 @@ gtk_assistant_class_init (GtkAssistantClass *class)
* @assistant: the `GtkAssistant`
*
* The action signal for the Escape binding.
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
signals[ESCAPE] =
g_signal_new_class_handler (I_("escape"),
@@ -618,6 +640,8 @@ gtk_assistant_class_init (GtkAssistantClass *class)
*
* For technical reasons, this property is declared as an integer
* property, but you should only set it to %TRUE or %FALSE.
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
g_object_class_install_property (gobject_class,
PROP_USE_HEADER_BAR,
@@ -1435,6 +1459,8 @@ gtk_assistant_close_request (GtkWindow *window)
* Creates a new `GtkAssistant`.
*
* Returns: a newly created `GtkAssistant`
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
GtkWidget*
gtk_assistant_new (void)
@@ -1455,6 +1481,8 @@ gtk_assistant_new (void)
* Returns: The index (starting from 0) of the current
* page in the @assistant, or -1 if the @assistant has no pages,
* or no current page
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
int
gtk_assistant_get_current_page (GtkAssistant *assistant)
@@ -1480,6 +1508,8 @@ gtk_assistant_get_current_page (GtkAssistant *assistant)
* Note that this will only be necessary in custom buttons,
* as the @assistant flow can be set with
* gtk_assistant_set_forward_page_func().
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
void
gtk_assistant_set_current_page (GtkAssistant *assistant,
@@ -1525,6 +1555,8 @@ gtk_assistant_set_current_page (GtkAssistant *assistant,
*
* This function is for use when creating pages of the
* %GTK_ASSISTANT_PAGE_CUSTOM type.
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
void
gtk_assistant_next_page (GtkAssistant *assistant)
@@ -1548,6 +1580,8 @@ gtk_assistant_next_page (GtkAssistant *assistant)
*
* This function is for use when creating pages of the
* %GTK_ASSISTANT_PAGE_CUSTOM type.
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
void
gtk_assistant_previous_page (GtkAssistant *assistant)
@@ -1581,6 +1615,8 @@ gtk_assistant_previous_page (GtkAssistant *assistant)
* Returns the number of pages in the @assistant
*
* Returns: the number of pages in the @assistant
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
int
gtk_assistant_get_n_pages (GtkAssistant *assistant)
@@ -1600,6 +1636,8 @@ gtk_assistant_get_n_pages (GtkAssistant *assistant)
*
* Returns: (nullable) (transfer none): the child widget, or %NULL
* if @page_num is out of bounds
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
GtkWidget*
gtk_assistant_get_nth_page (GtkAssistant *assistant,
@@ -1632,6 +1670,8 @@ gtk_assistant_get_nth_page (GtkAssistant *assistant,
* Prepends a page to the @assistant.
*
* Returns: the index (starting at 0) of the inserted page
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
int
gtk_assistant_prepend_page (GtkAssistant *assistant,
@@ -1651,6 +1691,8 @@ gtk_assistant_prepend_page (GtkAssistant *assistant,
* Appends a page to the @assistant.
*
* Returns: the index (starting at 0) of the inserted page
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
int
gtk_assistant_append_page (GtkAssistant *assistant,
@@ -1672,6 +1714,8 @@ gtk_assistant_append_page (GtkAssistant *assistant,
* Inserts a page in the @assistant at a given position.
*
* Returns: the index (starting from 0) of the inserted page
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
int
gtk_assistant_insert_page (GtkAssistant *assistant,
@@ -1770,6 +1814,8 @@ gtk_assistant_add_page (GtkAssistant *assistant,
* or -1 to remove the last page
*
* Removes the @page_num’s page from @assistant.
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
void
gtk_assistant_remove_page (GtkAssistant *assistant,
@@ -1805,6 +1851,8 @@ gtk_assistant_remove_page (GtkAssistant *assistant,
* Setting @page_func to %NULL will make the assistant to
* use the default forward function, which just goes to the
* next visible page.
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
void
gtk_assistant_set_forward_page_func (GtkAssistant *assistant,
@@ -1853,6 +1901,8 @@ add_to_action_area (GtkAssistant *assistant,
* @child: a `GtkWidget`
*
* Adds a widget to the action area of a `GtkAssistant`.
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
void
gtk_assistant_add_action_widget (GtkAssistant *assistant,
@@ -1881,6 +1931,8 @@ gtk_assistant_add_action_widget (GtkAssistant *assistant,
* @child: a `GtkWidget`
*
* Removes a widget from the action area of a `GtkAssistant`.
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
void
gtk_assistant_remove_action_widget (GtkAssistant *assistant,
@@ -1910,6 +1962,8 @@ gtk_assistant_remove_action_widget (GtkAssistant *assistant,
*
* The title is displayed in the header area of the assistant
* when @page is the current page.
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
void
gtk_assistant_set_page_title (GtkAssistant *assistant,
@@ -1939,6 +1993,8 @@ gtk_assistant_set_page_title (GtkAssistant *assistant,
* Gets the title for @page.
*
* Returns: the title for @page
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
const char *
gtk_assistant_get_page_title (GtkAssistant *assistant,
@@ -1968,6 +2024,8 @@ gtk_assistant_get_page_title (GtkAssistant *assistant,
* Sets the page type for @page.
*
* The page type determines the page behavior in the @assistant.
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
void
gtk_assistant_set_page_type (GtkAssistant *assistant,
@@ -1997,6 +2055,8 @@ gtk_assistant_set_page_type (GtkAssistant *assistant,
* Gets the page type of @page.
*
* Returns: the page type of @page
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
GtkAssistantPageType
gtk_assistant_get_page_type (GtkAssistant *assistant,
@@ -2027,6 +2087,8 @@ gtk_assistant_get_page_type (GtkAssistant *assistant,
*
* This will make @assistant update the buttons state
* to be able to continue the task.
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
void
gtk_assistant_set_page_complete (GtkAssistant *assistant,
@@ -2056,6 +2118,8 @@ gtk_assistant_set_page_complete (GtkAssistant *assistant,
* Gets whether @page is complete.
*
* Returns: %TRUE if @page is complete.
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
gboolean
gtk_assistant_get_page_complete (GtkAssistant *assistant,
@@ -2089,6 +2153,8 @@ gtk_assistant_get_page_complete (GtkAssistant *assistant,
* One situation where it can be necessary to call this
* function is when changing a value on the current page
* affects the future page flow of the assistant.
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
void
gtk_assistant_update_buttons_state (GtkAssistant *assistant)
@@ -2112,6 +2178,8 @@ gtk_assistant_update_buttons_state (GtkAssistant *assistant)
* or undone. For example, showing a progress page to track
* a long-running, unreversible operation after the user has
* clicked apply on a confirmation page.
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
void
gtk_assistant_commit (GtkAssistant *assistant)
@@ -2189,6 +2257,8 @@ gtk_assistant_buildable_custom_finished (GtkBuildable *buildable,
* Returns the `GtkAssistantPage` object for @child.
*
* Returns: (transfer none): the `GtkAssistantPage` for @child
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
GtkAssistantPage *
gtk_assistant_get_page (GtkAssistant *assistant,
@@ -2205,6 +2275,8 @@ gtk_assistant_get_page (GtkAssistant *assistant,
* Returns the child to which @page belongs.
*
* Returns: (transfer none): the child to which @page belongs
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
GtkWidget *
gtk_assistant_page_get_child (GtkAssistantPage *page)
@@ -2316,6 +2388,8 @@ gtk_assistant_pages_new (GtkAssistant *assistant)
* Gets a list model of the assistant pages.
*
* Returns: (transfer full) (attributes element-type=GtkAssistantPage): A list model of the pages.
+ *
+ * Deprecated: 4.10: This widget will be removed in GTK 5
*/
GListModel *
gtk_assistant_get_pages (GtkAssistant *assistant)