Commit b999e20d authored by Guido Gunther's avatar Guido Gunther Committed by Adrien Plazas
Browse files

Annotate APIs new in 0.0.6

parent 99bd91fc
Pipeline #2666 passed with stage
in 4 minutes and 10 seconds
......@@ -29,6 +29,8 @@
*
* It also supports setting a child as a prefix widget by specifying “prefix” as
* the “type” attribute of a <child> element.
*
* Since: 0.0.6
*/
typedef struct
......@@ -343,6 +345,8 @@ hdy_action_row_buildable_init (GtkBuildableIface *iface)
* Creates a new #HdyActionRow.
*
* Returns: a new #HdyActionRow
*
* Since: 0.0.6
*/
HdyActionRow *
hdy_action_row_new (void)
......@@ -357,6 +361,8 @@ hdy_action_row_new (void)
* Gets the title for @self.
*
* Returns: the title for @self.
*
* Since: 0.0.6
*/
const gchar *
hdy_action_row_get_title (HdyActionRow *self)
......@@ -376,6 +382,8 @@ hdy_action_row_get_title (HdyActionRow *self)
* @title: the title
*
* Sets the title for @self.
*
* Since: 0.0.6
*/
void
hdy_action_row_set_title (HdyActionRow *self,
......@@ -404,6 +412,8 @@ hdy_action_row_set_title (HdyActionRow *self,
* Gets the subtitle for @self.
*
* Returns: the subtitle for @self.
*
* Since: 0.0.6
*/
const gchar *
hdy_action_row_get_subtitle (HdyActionRow *self)
......@@ -423,6 +433,8 @@ hdy_action_row_get_subtitle (HdyActionRow *self)
* @subtitle: the subtitle
*
* Sets the subtitle for @self.
*
* Since: 0.0.6
*/
void
hdy_action_row_set_subtitle (HdyActionRow *self,
......@@ -451,6 +463,8 @@ hdy_action_row_set_subtitle (HdyActionRow *self,
* Gets the icon name for @self.
*
* Returns: the icon name for @self.
*
* Since: 0.0.6
*/
const gchar *
hdy_action_row_get_icon_name (HdyActionRow *self)
......@@ -473,6 +487,8 @@ hdy_action_row_get_icon_name (HdyActionRow *self)
* @icon_name: the icon name
*
* Sets the icon name for @self.
*
* Since: 0.0.6
*/
void
hdy_action_row_set_icon_name (HdyActionRow *self,
......@@ -505,6 +521,8 @@ hdy_action_row_set_icon_name (HdyActionRow *self,
*
* Returns: %TRUE if an embedded underline in the title and subtitle labels
* indicates the mnemonic accelerator keys.
*
* Since: 0.0.6
*/
gboolean
hdy_action_row_get_use_underline (HdyActionRow *self)
......@@ -525,6 +543,8 @@ hdy_action_row_get_use_underline (HdyActionRow *self)
*
* If true, an underline in the text of the title and subtitle labels indicates
* the next character should be used for the mnemonic accelerator key.
*
* Since: 0.0.6
*/
void
hdy_action_row_set_use_underline (HdyActionRow *self,
......@@ -554,6 +574,8 @@ hdy_action_row_set_use_underline (HdyActionRow *self,
* @widget: (allow-none): the action widget
*
* Adds an action widget to @self.
*
* Since: 0.0.6
*/
void
hdy_action_row_add_action (HdyActionRow *self,
......@@ -574,6 +596,8 @@ hdy_action_row_add_action (HdyActionRow *self,
* @widget: (allow-none): the prefix widget
*
* Adds a prefix widget to @self.
*
* Since: 0.0.6
*/
void
hdy_action_row_add_prefix (HdyActionRow *self,
......
......@@ -21,6 +21,8 @@
* The #HdyComboRow uses the model-view pattern; the list of valid choices
* is specified in the form of a #GListModel, and the display of the choices can
* be adapted to the data in the model via widget creation functions.
*
* Since: 0.0.6
*/
/*
......@@ -305,6 +307,8 @@ hdy_combo_row_init (HdyComboRow *self)
* Creates a new #HdyComboRow.
*
* Returns: a new #HdyComboRow
*
* Since: 0.0.6
*/
HdyComboRow *
hdy_combo_row_new (void)
......@@ -319,6 +323,8 @@ hdy_combo_row_new (void)
* Gets the model bound to @self, or %NULL if none is bound.
*
* Returns: (transfer none) (nullable): the #GListModel bound to @self or %NULL
*
* Since: 0.0.6
*/
GListModel *
hdy_combo_row_get_model (HdyComboRow *self)
......@@ -353,6 +359,8 @@ hdy_combo_row_get_model (HdyComboRow *self)
* The contents of @self are cleared and then filled with widgets that represent
* items from @model. @self is updated whenever @model changes. If @model is
* %NULL, @self is left empty.
*
* Since: 0.0.6
*/
void
hdy_combo_row_bind_model (HdyComboRow *self,
......@@ -414,6 +422,8 @@ hdy_combo_row_bind_model (HdyComboRow *self,
*
* This is more conventient to use than hdy_combo_row_bind_model() if you want
* to represent items of the model with names.
*
* Since: 0.0.6
*/
void
hdy_combo_row_bind_name_model (HdyComboRow *self,
......@@ -458,6 +468,8 @@ hdy_combo_row_bind_name_model (HdyComboRow *self,
* want to represent values of an enumeration with names.
*
* See hdy_enum_value_row_name().
*
* Since: 0.0.6
*/
void
hdy_combo_row_set_for_enum (HdyComboRow *self,
......@@ -488,6 +500,8 @@ hdy_combo_row_set_for_enum (HdyComboRow *self,
* will return it, otherwise it will return its name.
*
* Returns: (transfer full): a newly allocated displayable name that represents @value
*
* Since: 0.0.6
*/
gchar *
hdy_enum_value_row_name (HdyEnumValueObject *value,
......
......@@ -13,6 +13,8 @@
*
* The #HdyEnumValueObject object represents a #GEnumValue, allowing it to be
* used with #GListModel.
*
* Since: 0.0.6
*/
struct _HdyEnumValueObject
......
......@@ -16,6 +16,8 @@
* The #HdyExpanderRow allows the user to reveal of hide widgets below it. It
* also allows the user to enable the expansion of the row, allowing to disable
* all that the row contains.
*
* Since: 0.0.6
*/
typedef struct
......@@ -242,6 +244,8 @@ hdy_expander_row_init (HdyExpanderRow *self)
* Creates a new #HdyExpanderRow.
*
* Returns: a new #HdyExpanderRow
*
* Since: 0.0.6
*/
HdyExpanderRow *
hdy_expander_row_new (void)
......@@ -256,6 +260,8 @@ hdy_expander_row_new (void)
* Gets whether the expansion of @self is enabled.
*
* Returns: whether the expansion of @self is enabled.
*
* Since: 0.0.6
*/
gboolean
hdy_expander_row_get_enable_expansion (HdyExpanderRow *self)
......@@ -275,6 +281,8 @@ hdy_expander_row_get_enable_expansion (HdyExpanderRow *self)
* @enable_expansion: %TRUE to enable the expansion
*
* Sets whether the expansion of @self is enabled.
*
* Since: 0.0.6
*/
void
hdy_expander_row_set_enable_expansion (HdyExpanderRow *self,
......@@ -303,6 +311,8 @@ hdy_expander_row_set_enable_expansion (HdyExpanderRow *self,
* Gets whether the switch enabling the expansion of @self is visible.
*
* Returns: whether the switch enabling the expansion of @self is visible.
*
* Since: 0.0.6
*/
gboolean
hdy_expander_row_get_show_enable_switch (HdyExpanderRow *self)
......@@ -322,6 +332,8 @@ hdy_expander_row_get_show_enable_switch (HdyExpanderRow *self)
* @show_enable_switch: %TRUE to show the switch enabling the expansion
*
* Sets whether the switch enabling the expansion of @self is visible.
*
* Since: 0.0.6
*/
void
hdy_expander_row_set_show_enable_switch (HdyExpanderRow *self,
......
......@@ -12,6 +12,8 @@
* SECTION:hdy-list-box
* @short_description: Helper functions for #GtkListBox
* @Title: GtkListBox helpers
*
* Since: 0.0.6
*/
/**
......@@ -22,6 +24,8 @@
*
* Separates rows by using #GtkSeparator as headers. The first row doesn't have
* a separator as there is no row above it.
*
* Since: 0.0.6
*/
void
hdy_list_box_separator_header (GtkListBoxRow *row,
......
......@@ -73,6 +73,8 @@
* # CSS nodes
*
* HdySearchBar has a single CSS node with name searchbar.
*
* Since: 0.0.6
*/
typedef struct {
......@@ -243,6 +245,8 @@ hdy_search_bar_handle_event_for_entry (HdySearchBar *self,
* Returns: %GDK_EVENT_STOP if the key press event resulted
* in text being entered in the search entry (and revealing
* the search bar if necessary), %GDK_EVENT_PROPAGATE otherwise.
*
* Since: 0.0.6
*/
gboolean
hdy_search_bar_handle_event (HdySearchBar *self,
......@@ -503,6 +507,8 @@ hdy_search_bar_init (HdySearchBar *self)
* hdy_search_bar_connect_entry().
*
* Returns: a new #HdySearchBar
*
* Since: 0.0.6
*/
GtkWidget *
hdy_search_bar_new (void)
......@@ -546,6 +552,8 @@ hdy_search_bar_set_entry (HdySearchBar *self,
* this search bar. The entry should be a descendant of the search bar.
* This is only required if the entry isn’t the direct child of the
* search bar (as in our main example).
*
* Since: 0.0.6
*/
void
hdy_search_bar_connect_entry (HdySearchBar *self,
......@@ -564,6 +572,8 @@ hdy_search_bar_connect_entry (HdySearchBar *self,
* Returns whether the search mode is on or off.
*
* Returns: whether search mode is toggled on
*
* Since: 0.0.6
*/
gboolean
hdy_search_bar_get_search_mode (HdySearchBar *self)
......@@ -581,6 +591,8 @@ hdy_search_bar_get_search_mode (HdySearchBar *self)
* @search_mode: the new state of the search mode
*
* Switches the search mode on or off.
*
* Since: 0.0.6
*/
void
hdy_search_bar_set_search_mode (HdySearchBar *self,
......@@ -600,6 +612,8 @@ hdy_search_bar_set_search_mode (HdySearchBar *self,
* Returns whether the close button is shown.
*
* Returns: whether the close button is shown
*
* Since: 0.0.6
*/
gboolean
hdy_search_bar_get_show_close_button (HdySearchBar *self)
......@@ -620,6 +634,8 @@ hdy_search_bar_get_show_close_button (HdySearchBar *self)
* already have a “search” toggle button should not show a close
* button in their search bar, as it duplicates the role of the
* toggle button.
*
* Since: 0.0.6
*/
void
hdy_search_bar_set_show_close_button (HdySearchBar *self,
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment