AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity

gtk: Clean up docs syntax

Browse Source 
Replace leftover gtk-doc syntax (#Type) with backquotes.
This commit is contained in:
Matthias Clasen 2021-05-20 09:17:04 -04:00
parent 2d266d107b
commit 91f7b9663f
230 changed files with 2641 additions and 2624 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
gtk/a11y/gtkatspicontext.c
View File

@ -1821,11 +1821,11 @@ gtk_at_spi_context_get_context_path (GtkAtSpiContext *self)
/*< private >
* gtk_at_spi_context_to_ref:
* @self: a #GtkAtSpiContext
* @self: a `GtkAtSpiContext`
*
* Returns an ATSPI object reference for the #GtkAtSpiContext.
* Returns an ATSPI object reference for the `GtkAtSpiContext`.
*
* Returns: (transfer floating): a #GVariant with the reference
* Returns: (transfer floating): a `GVariant` with the reference
*/
GVariant *
gtk_at_spi_context_to_ref (GtkAtSpiContext *self)

35
gtk/a11y/gtkatspipango.c
View File

@ -139,14 +139,15 @@ gtk_pango_get_font_attributes (PangoFontDescription *font,
/*
* gtk_pango_get_default_attributes:
* @attributes: a #AtkAttributeSet to add the attributes to
* @layout: the #PangoLayout from which to get attributes
* @layout: the `PangoLayout` from which to get attributes
* @builder: a `GVariantBuilder` to add to
*
* Adds the default text attributes from @layout to @attributes,
* after translating them from Pango attributes to atspi attributes.
* Adds the default text attributes from @layout to @builder,
* after translating them from Pango attributes to atspi
* attributes.
*
* This is a convenience function that can be used to implement
* support for the #AtkText interface in widgets using Pango
* support for the `AtkText` interface in widgets using Pango
* layouts.
*
* Returns: the modified @attributes
@ -212,8 +213,8 @@ gtk_pango_get_default_attributes (PangoLayout *layout,
/*
* gtk_pango_get_run_attributes:
* @layout: the #PangoLayout to get the attributes from
* @builder: GVariantBuilder to add to
* @layout: the `PangoLayout` to get the attributes from
* @builder: `GVariantBuilder` to add to
* @offset: the offset at which the attributes are wanted
* @start_offset: return location for the starting offset
* of the current run
@ -394,7 +395,7 @@ gtk_pango_get_run_attributes (PangoLayout *layout,
/*
* gtk_pango_move_chars:
* @layout: a #PangoLayout
* @layout: a `PangoLayout`
* @offset: a character offset in @layout
* @count: the number of characters to move from @offset
*
@ -438,7 +439,7 @@ gtk_pango_move_chars (PangoLayout *layout,
/*
* gtk_pango_move_words:
* @layout: a #PangoLayout
* @layout: a `PangoLayout`
* @offset: a character offset in @layout
* @count: the number of words to move from @offset
*
@ -484,7 +485,7 @@ gtk_pango_move_words (PangoLayout *layout,
/*
* gtk_pango_move_sentences:
* @layout: a #PangoLayout
* @layout: a `PangoLayout`
* @offset: a character offset in @layout
* @count: the number of sentences to move from @offset
*
@ -531,7 +532,7 @@ gtk_pango_move_sentences (PangoLayout *layout,
#if 0
/*
* gtk_pango_move_lines:
* @layout: a #PangoLayout
* @layout: a `PangoLayout`
* @offset: a character offset in @layout
* @count: the number of lines to move from @offset
*
@ -602,7 +603,7 @@ gtk_pango_move_lines (PangoLayout *layout,
/*
* gtk_pango_is_inside_word:
* @layout: a #PangoLayout
* @layout: a `PangoLayout`
* @offset: a character offset in @layout
*
* Returns whether the given position is inside
@ -631,7 +632,7 @@ gtk_pango_is_inside_word (PangoLayout *layout,
/*
* gtk_pango_is_inside_sentence:
* @layout: a #PangoLayout
* @layout: a `PangoLayout`
* @offset: a character offset in @layout
*
* Returns whether the given position is inside
@ -867,7 +868,7 @@ pango_layout_get_line_after (PangoLayout *layout,
/*
* gtk_pango_get_text_before:
* @layout: a #PangoLayout
* @layout: a `PangoLayout`
* @offset: a character offset in @layout
* @boundary_type: a #AtspiTextBoundaryType
* @start_offset: return location for the start of the returned text
@ -972,7 +973,7 @@ gtk_pango_get_text_before (PangoLayout *layout,
/*
* gtk_pango_get_text_after:
* @layout: a #PangoLayout
* @layout: a `PangoLayout`
* @offset: a character offset in @layout
* @boundary_type: a #AtspiTextBoundaryType
* @start_offset: return location for the start of the returned text
@ -1083,9 +1084,9 @@ gtk_pango_get_text_after (PangoLayout *layout,
/*
* gtk_pango_get_text_at:
* @layout: a #PangoLayout
* @layout: a `PangoLayout`
* @offset: a character offset in @layout
* @boundary_type: a #AtspiTextBoundaryType
* @boundary_type: a `AtspiTextBoundaryType`
* @start_offset: return location for the start of the returned text
* @end_offset: return location for the end of the return text
*

8
gtk/a11y/gtkatspiroot.c
View File

@ -585,7 +585,7 @@ root_register (gpointer data)
/*< private >
* gtk_at_spi_root_queue_register:
* @self: a #GtkAtSpiRoot
* @self: a `GtkAtSpiRoot`
*
* Queues the registration of the root object on the AT-SPI bus.
*/
@ -761,11 +761,11 @@ gtk_at_spi_root_get_cache (GtkAtSpiRoot *self)
/*< private >
* gtk_at_spi_root_to_ref:
* @self: a #GtkAtSpiRoot
* @self: a `GtkAtSpiRoot`
*
* Returns an ATSPI object reference for the #GtkAtSpiRoot node.
* Returns an ATSPI object reference for the `GtkAtSpiRoot` node.
*
* Returns: (transfer floating): a #GVariant with the root reference
* Returns: (transfer floating): a `GVariant` with the root reference
*/
GVariant *
gtk_at_spi_root_to_ref (GtkAtSpiRoot *self)

8
gtk/a11y/gtkatspiutils.c
View File

@ -28,9 +28,9 @@
/*< private >
* gtk_accessible_role_to_atspi_role:
* @role: a #GtkAccessibleRole
* @role: a `GtkAccessibleRole`
*
* Converts a #GtkAccessibleRole value to the equivalent ATSPI role.
* Converts a `GtkAccessibleRole` value to the equivalent ATSPI role.
*
* Returns: an #AtspiRole
*/
@ -282,10 +282,10 @@ gtk_accessible_role_to_atspi_role (GtkAccessibleRole role)
/*<private>
* gtk_atspi_role_for_context:
* @context: a #GtkATContext
* @context: a `GtkATContext`
*
* Returns a suitable ATSPI role for a context, taking into account
* both the #GtkAccessibleRole set on the context and the type
* both the `GtkAccessibleRole` set on the context and the type
* of accessible.
*
* Returns: an #AtspiRole

4
gtk/css/gtkcssdataurl.c
View File

@ -42,8 +42,8 @@
*
* Decodes a data URL according to RFC2397 and returns the decoded data.
*
* Returns: a new #GBytes with the decoded data
**/
* Returns: a new `GBytes` with the decoded data
*/
GBytes *
gtk_css_data_url_parse (const char *url,
char **out_mimetype,

2
gtk/css/gtkcssenums.h
View File

@ -64,7 +64,7 @@ typedef enum
*
* Warnings that can occur while parsing CSS.
*
* Unlike #GtkCssParserErrors, warnings do not cause the parser to
* Unlike `GtkCssParserError`s, warnings do not cause the parser to
* skip any input, but they indicate issues that should be fixed.
*/
typedef enum

4
gtk/css/gtkcsserror.h
View File

@ -29,7 +29,7 @@ G_BEGIN_DECLS
/**
* GTK_CSS_PARSER_ERROR:
*
* Domain for #GtkCssParser errors.
* Domain for `GtkCssParser` errors.
*/
#define GTK_CSS_PARSER_ERROR (gtk_css_parser_error_quark ())
@ -39,7 +39,7 @@ GQuark gtk_css_parser_error_quark (void);
/**
* GTK_CSS_PARSER_WARNING:
*
* Domain for #GtkCssParser warnings.
* Domain for `GtkCssParser` warnings.
*/
#define GTK_CSS_PARSER_WARNING (gtk_css_parser_warning_quark ())

36
gtk/css/gtkcssparser.c
View File

@ -152,7 +152,7 @@ gtk_css_parser_unref (GtkCssParser *self)
/**
* gtk_css_parser_get_file:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
*
* Gets the file being parsed. If no file is associated with @self -
* for example when raw data is parsed - %NULL is returned.
@ -167,7 +167,7 @@ gtk_css_parser_get_file (GtkCssParser *self)
/**
* gtk_css_parser_resolve_url:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
* @url: the URL to resolve
*
* Resolves a given URL against the parser's location.
@ -198,7 +198,7 @@ gtk_css_parser_resolve_url (GtkCssParser *self,
/**
* gtk_css_parser_get_start_location:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
*
* Queries the location of the current token.
*
@ -222,7 +222,7 @@ gtk_css_parser_get_start_location (GtkCssParser *self)
/**
* gtk_css_parser_get_end_location:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
* @out_location: (caller-allocates) Place to store the location
*
* Queries the location of the current token.
@ -247,7 +247,7 @@ gtk_css_parser_get_end_location (GtkCssParser *self)
/**
* gtk_css_parser_get_block_location:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
*
* Queries the start location of the token that started the current
* block that is being parsed.
@ -450,7 +450,7 @@ gtk_css_parser_end_block (GtkCssParser *self)
/*
* gtk_css_parser_skip:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
*
* Skips a component value.
*
@ -477,7 +477,7 @@ gtk_css_parser_skip (GtkCssParser *self)
/*
* gtk_css_parser_skip_until:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
* @token_type: type of token to skip to
*
* Repeatedly skips a token until a certain type is reached.
@ -700,7 +700,7 @@ gtk_css_parser_consume_function (GtkCssParser *self,
/**
* gtk_css_parser_has_token:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
* @token_type: type of the token to check
*
* Checks if the next token is of @token_type.
@ -720,7 +720,7 @@ gtk_css_parser_has_token (GtkCssParser *self,
/**
* gtk_css_parser_has_ident:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
* @ident: name of identifier
*
* Checks if the next token is an identifier with the given @name.
@ -752,7 +752,7 @@ gtk_css_parser_has_integer (GtkCssParser *self)
/**
* gtk_css_parser_has_function:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
* @name: name of function
*
* Checks if the next token is a function with the given @name.
@ -773,7 +773,7 @@ gtk_css_parser_has_function (GtkCssParser *self,
/**
* gtk_css_parser_try_delim:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
* @codepoint: unicode character codepoint to check
*
* Checks if the current token is a delimiter matching the given
@ -803,7 +803,7 @@ gtk_css_parser_try_delim (GtkCssParser *self,
/**
* gtk_css_parser_try_ident:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
* @ident: identifier to check for
*
* Checks if the current token is an identifier matching the given
@ -830,7 +830,7 @@ gtk_css_parser_try_ident (GtkCssParser *self,
/**
* gtk_css_parser_try_at_keyword:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
* @keyword: name of keyword to check for
*
* Checks if the current token is an at-keyword token with the
@ -857,7 +857,7 @@ gtk_css_parser_try_at_keyword (GtkCssParser *self,
/**
* gtk_css_parser_try_token:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
* @token_type: type of token to try
*
* Consumes the next token if it matches the given @token_type.
@ -886,7 +886,7 @@ gtk_css_parser_try_token (GtkCssParser *self,
/**
* gtk_css_parser_consume_ident:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
*
* If the current token is an identifier, consumes it and returns
* its name.
@ -918,7 +918,7 @@ gtk_css_parser_consume_ident (GtkCssParser *self)
/**
* gtk_css_parser_consume_string:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
*
* If the current token is a string, consumes it and return the string.
*
@ -963,11 +963,11 @@ gtk_css_parser_parse_url_arg (GtkCssParser *parser,
/**
* gtk_css_parser_consume_url:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
*
* If the parser matches the <url> token from the [CSS
* specification](https://drafts.csswg.org/css-values-4/#url-value),
* consumes it, resolves the URL and returns the resulting #GFile.
* consumes it, resolves the URL and returns the resulting `GFile`.
* On failure, an error is emitted and %NULL is returned.
*
* Returns: (nullable) (transfer full): the resulting URL

4
gtk/css/gtkcsssection.c
View File

@ -188,7 +188,7 @@ gtk_css_section_get_end_location (const GtkCssSection *section)
/**
* gtk_css_section_print:
* @section: a section
* @string: a #GString to print to
* @string: a `GString` to print to
*
* Prints the `section` into `string` in a human-readable form.
*
@ -235,7 +235,7 @@ gtk_css_section_print (const GtkCssSection *section,
/**
* gtk_css_section_to_string:
* @section: a #GtkCssSection
* @section: a `GtkCssSection`
*
* Prints the section into a human-readable text form using
* [method@Gtk.CssSection.print].

4
gtk/css/gtkcsstokenizer.c
View File

@ -151,7 +151,7 @@ append_string (GString *string,
/*
* gtk_css_token_is_finite:
* @token: a #GtkCssToken
* @token: a `GtkCssToken`
*
* A token is considered finite when it would stay the same no matter
* what bytes follow it in the data stream.
@ -213,7 +213,7 @@ gtk_css_token_is_finite (const GtkCssToken *token)
/*
* gtk_css_token_is_preserved:
* @token: a #GtkCssToken
* @token: a `GtkCssToken`
* @out_closing: (nullable): Type of the token that closes a block
* started with this token
*

4
gtk/gskpango.c
View File

@ -453,8 +453,8 @@ gsk_pango_renderer_release (GskPangoRenderer *renderer)
/**
* gtk_snapshot_append_layout:
* @snapshot: a #GtkSnapshot
* @layout: the #PangoLayout to render
* @snapshot: a `GtkSnapshot`
* @layout: the `PangoLayout` to render
* @color: the foreground color to render the layout in
*
* Creates render nodes for rendering @layout in the given foregound @color

6
gtk/gtkaccessible.c
View File

@ -78,7 +78,7 @@ gtk_accessible_default_init (GtkAccessibleInterface *iface)
/*< private >
* gtk_accessible_get_at_context:
* @self: a #GtkAccessible
* @self: a `GtkAccessible`
*
* Retrieves the `GtkATContext` for the given `GtkAccessible`.
*
@ -707,7 +707,7 @@ gtk_accessible_platform_changed (GtkAccessible *self,
*
* This functionality can be overridden by `GtkAccessible`
* implementations, e.g. to get platform state from an ignored
* child widget, as is the case for #GtkText wrappers.
* child widget, as is the case for `GtkText` wrappers.
*
* Returns: the value of @state for the accessible
*/
@ -754,7 +754,7 @@ gtk_accessible_bounds_changed (GtkAccessible *self)
* By default, hidden widgets are are among these, but there can
* be other reasons to return %FALSE, e.g. for widgets that are
* purely presentations, or for widgets whose functionality is
* represented elsewhere, as is the case for #GtkText widgets.
* represented elsewhere, as is the case for `GtkText` widgets.
*
* Returns: %TRUE if the widget should be represented
*/

23
gtk/gtkaccessibleattributeset.c
View File

@ -98,9 +98,9 @@ gtk_accessible_attribute_set_unref (GtkAccessibleAttributeSet *self)
/*< private >
* gtk_accessible_attribute_set_add:
* @self: a #GtkAccessibleAttributeSet
* @self: a `GtkAccessibleAttributeSet`
* @attribute: the attribute to set
* @value: (nullable): a #GtkAccessibleValue
* @value: (nullable): a `GtkAccessibleValue`
*
* Adds @attribute to the attributes set, and sets its value.
*
@ -143,10 +143,11 @@ gtk_accessible_attribute_set_add (GtkAccessibleAttributeSet *self,
/*< private >
* gtk_accessible_attribute_set_remove:
* @self: a #GtkAccessibleAttributeSet
* @self: a `GtkAccessibleAttributeSet`
* @attribute: the attribute to be removed
*
* Resets the @attribute in the given #GtkAccessibleAttributeSet to its default value.
* Resets the @attribute in the given `GtkAccessibleAttributeSet`
* to its default value.
*
* Returns: %TRUE if the set was modified, and %FALSE otherwise
*/
@ -178,7 +179,7 @@ gtk_accessible_attribute_set_contains (GtkAccessibleAttributeSet *self,
/*< private >
* gtk_accessible_attribute_set_get_value:
* @self: a #GtkAccessibleAttributeSet
* @self: a `GtkAccessibleAttributeSet`
* @attribute: the attribute to retrieve
*
* Retrieves the value of the given @attribute in the set.
@ -216,11 +217,11 @@ gtk_accessible_attribute_set_get_changed (GtkAccessibleAttributeSet *self)
/*< private >
* gtk_accessible_attribute_set_print:
* @self: a #GtkAccessibleAttributeSet
* @self: a `GtkAccessibleAttributeSet`
* @only_set: %TRUE if only the set attributes should be printed
* @buffer: a #GString
* @buffer: a `GString`
*
* Prints the contents of the #GtkAccessibleAttributeSet into @buffer.
* Prints the contents of the `GtkAccessibleAttributeSet` into @buffer.
*/
void
gtk_accessible_attribute_set_print (GtkAccessibleAttributeSet *self,
@ -254,12 +255,12 @@ gtk_accessible_attribute_set_print (GtkAccessibleAttributeSet *self,
/*< private >
* gtk_accessible_attribute_set_to_string:
* @self: a #GtkAccessibleAttributeSet
* @self: a `GtkAccessibleAttributeSet`
*
* Prints the contents of a #GtkAccessibleAttributeSet into a string.
* Prints the contents of a `GtkAccessibleAttributeSet` into a string.
*
* Returns: (transfer full): a newly allocated string with the contents
* of the #GtkAccessibleAttributeSet
* of the `GtkAccessibleAttributeSet`
*/
char *
gtk_accessible_attribute_set_to_string (GtkAccessibleAttributeSet *self)

121
gtk/gtkaccessiblevalue.c
View File

@ -22,7 +22,7 @@
* GtkAccessibleValue:
*
* GtkAccessibleValue is a reference counted, generic container for values used
* to represent the state and properties of a #GtkAccessible implementation.
* to represent the state and properties of a `GtkAccessible` implementation.
*
* There are two kinds of accessible value types:
*
@ -59,12 +59,12 @@ G_DEFINE_BOXED_TYPE (GtkAccessibleValue, gtk_accessible_value,
/*< private >
* gtk_accessible_value_alloc:
* @value_class: a #GtkAccessibleValueClass structure
* @value_class: a `GtkAccessibleValueClass` structure
*
* Allocates a new #GtkAccessibleValue subclass using @value_class as the
* Allocates a new `GtkAccessibleValue` subclass using @value_class as the
* type definition.
*
* Returns: (transfer full): the newly allocated #GtkAccessibleValue
* Returns: (transfer full): the newly allocated `GtkAccessibleValue`
*/
GtkAccessibleValue *
gtk_accessible_value_alloc (const GtkAccessibleValueClass *value_class)
@ -89,9 +89,9 @@ gtk_accessible_value_alloc (const GtkAccessibleValueClass *value_class)
/*< private >
* gtk_accessible_value_ref:
* @self: a #GtkAccessibleValue
* @self: a `GtkAccessibleValue`
*
* Acquires a reference on the given #GtkAccessibleValue.
* Acquires a reference on the given `GtkAccessibleValue`.
*
* Returns: (transfer full): the value, with an additional reference
*/
@ -107,9 +107,9 @@ gtk_accessible_value_ref (GtkAccessibleValue *self)
/*< private >
* gtk_accessible_value_unref:
* @self: (transfer full): a #GtkAccessibleValue
* @self: (transfer full): a `GtkAccessibleValue`
*
* Releases a reference on the given #GtkAccessibleValue.
* Releases a reference on the given `GtkAccessibleValue`.
*/
void
gtk_accessible_value_unref (GtkAccessibleValue *self)
@ -128,10 +128,10 @@ gtk_accessible_value_unref (GtkAccessibleValue *self)
/*< private >
* gtk_accessible_value_print:
* @self: a #GtkAccessibleValue
* @buffer: a #GString
* @self: a `GtkAccessibleValue`
* @buffer: a `GString`
*
* Prints the contents of a #GtkAccessibleValue into the given @buffer.
* Prints the contents of a `GtkAccessibleValue` into the given @buffer.
*/
void
gtk_accessible_value_print (const GtkAccessibleValue *self,
@ -146,9 +146,9 @@ gtk_accessible_value_print (const GtkAccessibleValue *self,
/*< private >
* gtk_accessible_value_to_string:
* @self: a #GtkAccessibleValue
* @self: a `GtkAccessibleValue`
*
* Fills a string with the contents of the given #GtkAccessibleValue.
* Fills a string with the contents of the given `GtkAccessibleValue`.
*
* Returns: (transfer full): a string with the contents of the value
*/
@ -166,14 +166,14 @@ gtk_accessible_value_to_string (const GtkAccessibleValue *self)
/*< private >
* gtk_accessible_value_equal:
* @value_a: (nullable): the first #GtkAccessibleValue
* @value_b: (nullable): the second #GtkAccessibleValue
* @value_a: (nullable): the first `GtkAccessibleValue`
* @value_b: (nullable): the second `GtkAccessibleValue`
*
* Checks whether @value_a and @value_b are equal.
*
* This function is %NULL-safe.
*
* Returns: %TRUE if the given #GtkAccessibleValue instances are equal,
* Returns: %TRUE if the given `GtkAccessibleValue` instances are equal,
* and %FALSE otherwise
*/
gboolean
@ -556,9 +556,10 @@ static const GtkAccessibleValueClass GTK_REFERENCE_LIST_ACCESSIBLE_VALUE = {
* gtk_reference_list_accessible_value_new:
* @value: (element-type GtkAccessible) (transfer full): a list of accessible objects
*
* Creates a new #GtkAccessible that stores a list of references to #GtkAccessible objects.
* Creates a new `GtkAccessible` that stores a list of references
* to `GtkAccessible` objects.
*
* Returns: (transfer full): the newly created #GtkAccessible
* Returns: (transfer full): the newly created `GtkAccessible`
*/
GtkAccessibleValue *
gtk_reference_list_accessible_value_new (GList *value)
@ -914,12 +915,12 @@ typedef void (* GtkAccessibleValueEnumInit) (GValue *va
/*< private >
* gtk_accessible_value_get_default_for_state:
* @state: a #GtkAccessibleState
* @state: a `GtkAccessibleState`
*
* Retrieves the #GtkAccessibleValue that contains the default for the
* Retrieves the `GtkAccessibleValue` that contains the default for the
* given @state.
*
* Returns: (transfer full): the #GtkAccessibleValue
* Returns: (transfer full): the `GtkAccessibleValue`
*/
GtkAccessibleValue *
gtk_accessible_value_get_default_for_state (GtkAccessibleState state)
@ -1542,19 +1543,19 @@ gtk_accessible_attribute_init_value (const GtkAccessibleCollect *cstate,
/*< private >
* gtk_accessible_value_collect_for_state:
* @state: a #GtkAccessibleState
* @error: return location for a #GError
* @state: a `GtkAccessibleState`
* @error: return location for a `GError`
* @args: a `va_list` reference
*
* Collects and consumes the next item in the @args variadic arguments list,
* and returns a #GtkAccessibleValue for it.
* and returns a `GtkAccessibleValue` for it.
*
* If the collection fails, @error is set and %NULL is returned.
*
* The returned value could be %NULL even on success, in which case the state
* should be reset to its default value by the caller.
*
* Returns: (transfer full) (nullable): a #GtkAccessibleValue
* Returns: (transfer full) (nullable): a `GtkAccessibleValue`
*/
GtkAccessibleValue *
gtk_accessible_value_collect_for_state (GtkAccessibleState state,
@ -1570,11 +1571,11 @@ gtk_accessible_value_collect_for_state (GtkAccessibleState state,
/*< private >
* gtk_accessible_value_collect_for_state_value:
* @state: a #GtkAccessibleState
* @value: a #GValue
* @error: return location for a #GError
* @state: a `GtkAccessibleState`
* @value: a `GValue`
* @error: return location for a `GError`
*
* Retrieves the value stored inside @value and returns a #GtkAccessibleValue
* Retrieves the value stored inside @value and returns a `GtkAccessibleValue`
* for the given @state.
*
* If the collection fails, @error is set and %NULL is returned.
@ -1582,7 +1583,7 @@ gtk_accessible_value_collect_for_state (GtkAccessibleState state,
* The returned value could be %NULL even on success, in which case the state
* should be reset to its default value by the caller.
*
* Returns: (transfer full) (nullable): a #GtkAccessibleValue
* Returns: (transfer full) (nullable): a `GtkAccessibleValue`
*/
GtkAccessibleValue *
gtk_accessible_value_collect_for_state_value (GtkAccessibleState state,
@ -1611,8 +1612,8 @@ gtk_accessible_value_parse_for_state (GtkAccessibleState state,
/**
* gtk_accessible_state_init_value:
* @state: a #GtkAccessibleState
* @value: an uninitialized #GValue
* @state: a `GtkAccessibleState`
* @value: an uninitialized `GValue`
*
* Initializes @value with the appropriate type for the @state.
*
@ -1632,12 +1633,12 @@ gtk_accessible_state_init_value (GtkAccessibleState state,
/*< private >
* gtk_accessible_value_get_default_for_property:
* @property: a #GtkAccessibleProperty
* @property: a `GtkAccessibleProperty`
*
* Retrieves the #GtkAccessibleValue that contains the default for the
* Retrieves the `GtkAccessibleValue` that contains the default for the
* given @property.
*
* Returns: (transfer full): the #GtkAccessibleValue
* Returns: (transfer full): the `GtkAccessibleValue`
*/
GtkAccessibleValue *
gtk_accessible_value_get_default_for_property (GtkAccessibleProperty property)
@ -1696,16 +1697,16 @@ gtk_accessible_value_get_default_for_property (GtkAccessibleProperty property)
/*< private >
* gtk_accessible_value_collect_for_property:
* @property: a #GtkAccessibleProperty
* @error: return location for a #GError
* @property: a `GtkAccessibleProperty`
* @error: return location for a `GError`
* @args: a `va_list` reference
*
* Collects and consumes the next item in the @args variadic arguments list,
* and returns a #GtkAccessibleValue for it.
* and returns a `GtkAccessibleValue` for it.
*
* If the collection fails, @error is set.
*
* Returns: (transfer full) (nullable): a #GtkAccessibleValue
* Returns: (transfer full) (nullable): a `GtkAccessibleValue`
*/
GtkAccessibleValue *
gtk_accessible_value_collect_for_property (GtkAccessibleProperty property,
@ -1721,11 +1722,11 @@ gtk_accessible_value_collect_for_property (GtkAccessibleProperty property,
/*< private >
* gtk_accessible_value_collect_for_property_value:
* @property: a #GtkAccessibleProperty
* @value: a #GValue
* @error: return location for a #GError
* @property: a `GtkAccessibleProperty`
* @value: a `GValue`
* @error: return location for a `GError`
*
* Retrieves the value stored inside @value and returns a #GtkAccessibleValue
* Retrieves the value stored inside @value and returns a `GtkAccessibleValue`
* for the given @property.
*
* If the collection fails, @error is set.
@ -1733,7 +1734,7 @@ gtk_accessible_value_collect_for_property (GtkAccessibleProperty property,
* The returned value could be %NULL even on success, in which case the property
* should be reset to its default value by the caller.
*
* Returns: (transfer full) (nullable): a #GtkAccessibleValue
* Returns: (transfer full) (nullable): a `GtkAccessibleValue`
*/
GtkAccessibleValue *
gtk_accessible_value_collect_for_property_value (GtkAccessibleProperty property,
@ -1762,8 +1763,8 @@ gtk_accessible_value_parse_for_property (GtkAccessibleProperty property,
/**
* gtk_accessible_property_init_value:
* @property: a #GtkAccessibleProperty
* @value: an uninitialized #GValue
* @property: a `GtkAccessibleProperty`
* @value: an uninitialized `GValue`
*
* Initializes @value with the appropriate type for the @property.
*
@ -1783,12 +1784,12 @@ gtk_accessible_property_init_value (GtkAccessibleProperty property,
/*< private >
* gtk_accessible_value_get_default_for_relation:
* @relation: a #GtkAccessibleRelation
* @relation: a `GtkAccessibleRelation`
*
* Retrieves the #GtkAccessibleValue that contains the default for the
* Retrieves the `GtkAccessibleValue` that contains the default for the
* given @relation.
*
* Returns: (transfer full): the #GtkAccessibleValue
* Returns: (transfer full): the `GtkAccessibleValue`
*/
GtkAccessibleValue *
gtk_accessible_value_get_default_for_relation (GtkAccessibleRelation relation)
@ -1836,19 +1837,19 @@ gtk_accessible_value_get_default_for_relation (GtkAccessibleRelation relation)
/*< private >
* gtk_accessible_value_collect_for_relation:
* @relation: a #GtkAccessibleRelation
* @error: return location for a #GError
* @relation: a `GtkAccessibleRelation`
* @error: return location for a `GError`
* @args: a `va_list` reference
*
* Collects and consumes the next item in the @args variadic arguments list,
* and returns a #GtkAccessibleValue for it.
* and returns a `GtkAccessibleValue` for it.
*
* If the collection fails, @error is set and %NULL is returned.
*
* The returned value could be %NULL even on success, in which case the relation
* should be reset to its default value by the caller.
*
* Returns: (transfer full) (nullable): a #GtkAccessibleValue
* Returns: (transfer full) (nullable): a `GtkAccessibleValue`
*/
GtkAccessibleValue *
gtk_accessible_value_collect_for_relation (GtkAccessibleRelation relation,
@ -1864,11 +1865,11 @@ gtk_accessible_value_collect_for_relation (GtkAccessibleRelation relation,
/*< private >
* gtk_accessible_value_collect_for_relation_value:
* @relation: a #GtkAccessibleRelation
* @value: a #GValue
* @error: return location for a #GError
* @relation: a `GtkAccessibleRelation`
* @value: a `GValue`
* @error: return location for a `GError`
*
* Retrieves the value stored inside @value and returns a #GtkAccessibleValue
* Retrieves the value stored inside @value and returns a `GtkAccessibleValue`
* for the given @relation.
*
* If the collection fails, @error is set and %NULL is returned.
@ -1876,7 +1877,7 @@ gtk_accessible_value_collect_for_relation (GtkAccessibleRelation relation,
* The returned value could be %NULL even on success, in which case the relation
* should be reset to its default value by the caller.
*
* Returns: (transfer full) (nullable): a #GtkAccessibleValue
* Returns: (transfer full) (nullable): a `GtkAccessibleValue`
*/
GtkAccessibleValue *
gtk_accessible_value_collect_for_relation_value (GtkAccessibleRelation relation,
@ -1905,8 +1906,8 @@ gtk_accessible_value_parse_for_relation (GtkAccessibleRelation relation,
/**
* gtk_accessible_relation_init_value:
* @relation: a #GtkAccessibleRelation
* @value: an uninitialized #GValue
* @relation: a `GtkAccessibleRelation`
* @value: an uninitialized `GValue`
*
* Initializes @value with the appropriate type for the @relation.
*

10
gtk/gtkactionhelper.c
View File

@ -368,10 +368,10 @@ gtk_action_helper_observer_iface_init (GtkActionObserverInterface *iface)
/*< private >
* gtk_action_helper_new:
* @widget: a #GtkWidget implementing #GtkActionable
* @widget: a `GtkWidget` implementing `GtkActionable`
*
* Creates a helper to track the state of a named action. This will
* usually be used by widgets implementing #GtkActionable.
* usually be used by widgets implementing `GtkActionable`.
*
* This helper class is usually used by @widget itself. In order to
* avoid reference cycles, the helper does not hold a reference on
@ -380,7 +380,7 @@ gtk_action_helper_observer_iface_init (GtkActionObserverInterface *iface)
* of the widget, you should take a ref on @widget for each ref you hold
* on the helper.
*
* Returns: a new #GtkActionHelper
* Returns: a new `GtkActionHelper`
*/
GtkActionHelper *
gtk_action_helper_new (GtkActionable *widget)
@ -478,8 +478,8 @@ gtk_action_helper_set_action_name (GtkActionHelper *helper,
/*< private >
* gtk_action_helper_set_action_target_value:
* @helper: a #GtkActionHelper
* @target_value: an action target, as per #GtkActionable
* @helper: a `GtkActionHelper`
* @target_value: an action target, as per `GtkActionable`
*
* This function consumes @action_target if it is floating.
*/

42
gtk/gtkactionmuxer.c
View File

@ -108,21 +108,21 @@ gtk_accels_remove (GtkAccels *accels,
*
* GtkActionMuxer aggregates and monitors actions from multiple sources.
*
* #GtkActionMuxer is #GtkActionObservable and #GtkActionObserver that
* offers a #GActionGroup-like api and is capable of containing other
* #GActionGroup instances. #GtkActionMuxer does not implement the
* #GActionGroup interface because it requires excessive signal emissions
* and has poor scalability. We use the #GtkActionObserver machinery
* `GtkActionMuxer` is `GtkActionObservable` and `GtkActionObserver` that
* offers a `GActionGroup`-like api and is capable of containing other
* `GActionGroup` instances. `GtkActionMuxer` does not implement the
* `GActionGroup` interface because it requires excessive signal emissions
* and has poor scalability. We use the `GtkActionObserver` machinery
* instead to propagate changes between action muxer instances and
* to other users.
*
* Beyond action groups, #GtkActionMuxer can incorporate actions that
* Beyond action groups, `GtkActionMuxer` can incorporate actions that
* are associated with widget classes (*class actions*) and actions
* that are associated with the parent widget, allowing for recursive
* lookup.
*
* In addition to the action attributes provided by #GActionGroup,
* #GtkActionMuxer maintains a *primary accelerator* string for
* In addition to the action attributes provided by `GActionGroup`,
* `GtkActionMuxer` maintains a *primary accelerator* string for
* actions that can be shown in menuitems.
*
* The typical use is aggregating all of the actions applicable to a
@ -134,11 +134,11 @@ gtk_accels_remove (GtkAccels *accels,
* application (such as “fullscreen”).
*
* In this case, each of these action groups could be added to a
* #GtkActionMuxer with the prefixes “app” and “win”, respectively.
* `GtkActionMuxer` with the prefixes “app” and “win”, respectively.
* This would expose the actions as “app.quit” and “win.fullscreen”
* on the #GActionGroup-like interface presented by the #GtkActionMuxer.
* on the `GActionGroup`-like interface presented by the `GtkActionMuxer`.
*
* Activations and state change requests on the #GtkActionMuxer are
* Activations and state change requests on the `GtkActionMuxer` are
* wired through to the underlying actions in the expected way.
*
* This class is typically only used at the site of “consumption” of
@ -1223,9 +1223,9 @@ gtk_action_muxer_class_init (GObjectClass *class)
/*< private >
* gtk_action_muxer_insert:
* @muxer: a #GtkActionMuxer
* @muxer: a `GtkActionMuxer`
* @prefix: the prefix string for the action group
* @action_group: a #GActionGroup
* @action_group: a `GActionGroup`
*
* Adds the actions in @action_group to the list of actions provided by
* @muxer. @prefix is prefixed to each action name, such that for each
@ -1236,7 +1236,7 @@ gtk_action_muxer_class_init (GObjectClass *class)
* contains an action called “`quit`”, then @muxer will
* now contain an action called “`app.quit`”.
*
* If any #GtkActionObservers are registered for actions in the group,
* If any `GtkActionObserver`s are registered for actions in the group,
* “action_added” notifications will be emitted, as appropriate.
*
* @prefix must not contain a dot ('.').
@ -1280,12 +1280,12 @@ gtk_action_muxer_insert (GtkActionMuxer *muxer,
/*< private >
* gtk_action_muxer_remove:
* @muxer: a #GtkActionMuxer
* @muxer: a `GtkActionMuxer`
* @prefix: the prefix of the action group to remove
*
* Removes a #GActionGroup from the #GtkActionMuxer.
* Removes a `GActionGroup` from the `GtkActionMuxer`.
*
* If any #GtkActionObservers are registered for actions in the group,
* If any `GtkActionObserver`s are registered for actions in the group,
* “action_removed” notifications will be emitted, as appropriate.
*/
void
@ -1319,7 +1319,7 @@ gtk_action_muxer_remove (GtkActionMuxer *muxer,
* gtk_action_muxer_new:
* @widget: the widget to which the muxer belongs
*
* Creates a new #GtkActionMuxer.
* Creates a new `GtkActionMuxer`.
*/
GtkActionMuxer *
gtk_action_muxer_new (GtkWidget *widget)
@ -1331,7 +1331,7 @@ gtk_action_muxer_new (GtkWidget *widget)
/*< private >
* gtk_action_muxer_get_parent:
* @muxer: a #GtkActionMuxer
* @muxer: a `GtkActionMuxer`
*
* Returns: (transfer none): the parent of @muxer, or NULL.
*/
@ -1345,8 +1345,8 @@ gtk_action_muxer_get_parent (GtkActionMuxer *muxer)
/*< private >
* gtk_action_muxer_set_parent:
* @muxer: a #GtkActionMuxer
* @parent: (nullable): the new parent #GtkActionMuxer
* @muxer: a `GtkActionMuxer`
* @parent: (nullable): the new parent `GtkActionMuxer`
*
* Sets the parent of @muxer to @parent.
*/

8
gtk/gtkactionobservable.c
View File

@ -30,9 +30,9 @@ gtk_action_observable_default_init (GtkActionObservableInterface *iface)
/**
* gtk_action_observable_register_observer:
* @observable: a #GtkActionObservable
* @observable: a `GtkActionObservable`
* @action_name: the name of the action
* @observer: the #GtkActionObserver to which the events will be reported
* @observer: the `GtkActionObserver` to which the events will be reported
*
* Registers @observer as being interested in changes to @action_name on
* @observable.
@ -50,9 +50,9 @@ gtk_action_observable_register_observer (GtkActionObservable *observable,
/**
* gtk_action_observable_unregister_observer:
* @observable: a #GtkActionObservable
* @observable: a `GtkActionObservable`
* @action_name: the name of the action
* @observer: the #GtkActionObserver to which the events will be reported
* @observer: the `GtkActionObserver` to which the events will be reported
*
* Removes the registration of @observer as being interested in changes
* to @action_name on @observable.

16
gtk/gtkactionobserver.c
View File

@ -26,11 +26,11 @@ G_DEFINE_INTERFACE (GtkActionObserver, gtk_action_observer, G_TYPE_OBJECT)
/*< private >
* GtkActionObserver:
*
* GtkActionObserver is a simple interface allowing objects that wish to
* `GtkActionObserver` is a simple interface allowing objects that wish to
* be notified of changes to actions to be notified of those changes.
*
* It is also possible to monitor changes to action groups using
* #GObject signals, but there are a number of reasons that this
* `GObject` signals, but there are a number of reasons that this
* approach could become problematic:
*
* - there are four separate signals that must be manually connected
@ -42,7 +42,7 @@ G_DEFINE_INTERFACE (GtkActionObserver, gtk_action_observer, G_TYPE_OBJECT)
* to all observers: signal detail. In order to use signal detail,
* each action name must be quarked, which is not always practical.
*
* - even if quarking is acceptable, #GObject signal details are
* - even if quarking is acceptable, `GObject` signal details are
* implemented by scanning a linked list, so there is no real
* decrease in complexity
*/
@ -54,7 +54,7 @@ gtk_action_observer_default_init (GtkActionObserverInterface *class)
/*< private >
* gtk_action_observer_action_added:
* @observer: a #GtkActionObserver
* @observer: a `GtkActionObserver`
* @observable: the source of the event
* @action_name: the name of the action
* @enabled: %TRUE if the action is now enabled
@ -83,7 +83,7 @@ gtk_action_observer_action_added (GtkActionObserver *observer,
/*< private >
* gtk_action_observer_action_enabled_changed:
* @observer: a #GtkActionObserver
* @observer: a `GtkActionObserver`
* @observable: the source of the event
* @action_name: the name of the action
* @enabled: %TRUE if the action is now enabled
@ -108,7 +108,7 @@ gtk_action_observer_action_enabled_changed (GtkActionObserver *observer,
/*< private >
* gtk_action_observer_action_state_changed:
* @observer: a #GtkActionObserver
* @observer: a `GtkActionObserver`
* @observable: the source of the event
* @action_name: the name of the action
* @state: the new state of the action
@ -133,7 +133,7 @@ gtk_action_observer_action_state_changed (GtkActionObserver *observer,
/*< private >
* gtk_action_observer_action_removed:
* @observer: a #GtkActionObserver
* @observer: a `GtkActionObserver`
* @observable: the source of the event
* @action_name: the name of the action
*
@ -156,7 +156,7 @@ gtk_action_observer_action_removed (GtkActionObserver *observer,
/*< private >
* gtk_action_observer_primary_accel_changed:
* @observer: a #GtkActionObserver
* @observer: a `GtkActionObserver`
* @observable: the source of the event
* @action_name: the name of the action
* @action_and_target: detailed action of the changed accel, in “action and target” format

4
gtk/gtkappchooserwidget.c
View File

@ -988,7 +988,7 @@ gtk_app_chooser_widget_class_init (GtkAppChooserWidgetClass *klass)
/**
* GtkAppChooserWidget::application-selected:
* @self: the object which received the signal
* @application: the selected #GAppInfo
* @application: the selected `GAppInfo`
*
* Emitted when an application item is selected from the widget's list.
*/
@ -1005,7 +1005,7 @@ gtk_app_chooser_widget_class_init (GtkAppChooserWidgetClass *klass)
/**
* GtkAppChooserWidget::application-activated:
* @self: the object which received the signal
* @application: the activated #GAppInfo
* @application: the activated `GAppInfo`
*
* Emitted when an application item is activated from the widget's list.
*

2
gtk/gtkapplication.c
View File

@ -1186,7 +1186,7 @@ gtk_application_handle_window_map (GtkApplication *application,
/**
* gtk_application_get_menu_by_id:
* @application: a #GtkApplication
* @application: a `GtkApplication`
* @id: the id of the menu to look up
*
* Gets a menu from automatically loaded resources.

4
gtk/gtkapplication.h
View File

@ -47,9 +47,9 @@ struct _GtkApplication
/**
* GtkApplicationClass:
* @parent_class: The parent class.
* @window_added: Signal emitted when a #GtkWindow is added to
* @window_added: Signal emitted when a `GtkWindow` is added to
* application through gtk_application_add_window().
* @window_removed: Signal emitted when a #GtkWindow is removed from
* @window_removed: Signal emitted when a `GtkWindow` is removed from
* application, either as a side-effect of being destroyed or
* explicitly through gtk_application_remove_window().
*/

2
gtk/gtkassistant.c
View File

@ -596,7 +596,7 @@ gtk_assistant_class_init (GtkAssistantClass *class)
/**
* GtkAssistant:use-header-bar:
*
* %TRUE if the assistant uses a #GtkHeaderBar for action buttons
* %TRUE if the assistant uses a `GtkHeaderBar` for action buttons
* instead of the action-area.
*
* For technical reasons, this property is declared as an integer

6
gtk/gtkatcontext.c
View File

@ -596,9 +596,9 @@ gtk_at_context_create (GtkAccessibleRole accessible_role,
* @role: the accessible role of the clone, or %GTK_ACCESSIBLE_ROLE_NONE to
* use the same accessible role of @self
* @accessible: (nullable): the accessible creating the context, or %NULL to
* use the same #GtkAccessible of @self
* use the same `GtkAccessible` of @self
* @display: (nullable): the display connection, or %NULL to use the same
* #GdkDisplay of @self
* `GdkDisplay` of @self
*
* Clones the state of the given `GtkATContext`, using @role, @accessible,
* and @display.
@ -710,7 +710,7 @@ gtk_at_context_update (GtkATContext *self)
* gtk_at_context_set_accessible_state:
* @self: a `GtkATContext`
* @state: a `GtkAccessibleState`
* @value: (nullable): #GtkAccessibleValue
* @value: (nullable): `GtkAccessibleValue`
*
* Sets the @value for the given @state of a `GtkATContext`.
*

2
gtk/gtkbookmarklist.c
View File

@ -489,7 +489,7 @@ gtk_bookmark_list_new (const char *filename,
* Sets the @attributes to be enumerated and starts the enumeration.
*
* If @attributes is %NULL, no attributes will be queried, but a list
* of #GFileInfos will still be created.
* of `GFileInfo`s will still be created.
*/
void
gtk_bookmark_list_set_attributes (GtkBookmarkList *self,

14
gtk/gtkborder.c
View File

@ -29,10 +29,10 @@
/**
* gtk_border_new:
*
* Allocates a new #GtkBorder-struct and initializes its elements to zero.
* Allocates a new `GtkBorder` struct and initializes its elements to zero.
*
* Returns: (transfer full): a newly allocated #GtkBorder-struct.
* Free with gtk_border_free()
* Returns: (transfer full): a newly allocated `GtkBorder` struct.
* Free with [method@Gtk.Border.free]
*/
GtkBorder *
gtk_border_new (void)
@ -42,9 +42,9 @@ gtk_border_new (void)
/**
* gtk_border_copy:
* @border_: a #GtkBorder-struct
* @border_: a `GtkBorder` struct
*
* Copies a #GtkBorder-struct.
* Copies a `GtkBorder`.
*
* Returns: (transfer full): a copy of @border_.
*/
@ -58,9 +58,9 @@ gtk_border_copy (const GtkBorder *border_)
/**
* gtk_border_free:
* @border_: a #GtkBorder-struct
* @border_: a `GtkBorder` struct
*
* Frees a #GtkBorder-struct.
* Frees a `GtkBorder`.
*/
void
gtk_border_free (GtkBorder *border_)

6
gtk/gtkbuildable.c
View File

@ -49,7 +49,7 @@ gtk_buildable_default_init (GtkBuildableInterface *iface)
/*< private >
* gtk_buildable_set_buildable_id:
* @buildable: a #GtkBuildable
* @buildable: a `GtkBuildable`
* @id: name to set
*
* Sets the ID of the @buildable object.
@ -162,7 +162,7 @@ gtk_buildable_parser_finished (GtkBuildable *buildable,
*
* Constructs a child of @buildable with the name @name.
*
* #GtkBuilder calls this function if a “constructor” has been
* `GtkBuilder` calls this function if a “constructor” has been
* specified in the UI definition.
*
* Returns: (transfer full): the constructed child
@ -190,7 +190,7 @@ gtk_buildable_construct_child (GtkBuildable *buildable,
* @builder: a `GtkBuilder` used to construct this object
* @child: (nullable): child object or %NULL for non-child tags
* @tagname: name of tag
* @parser: (out): a #GMarkupParser to fill in
* @parser: (out): a `GMarkupParser` to fill in
* @data: (out): return location for user data that will be passed in
* to parser functions
*

28
gtk/gtkbuildable.h
View File

@ -115,7 +115,7 @@ struct _GtkBuildableParser
* @custom_tag_start: Implement this if the buildable needs to parse
* content below <child>. To handle an element, the implementation
* must fill in the @parser and @user_data and return %TRUE.
* #GtkWidget implements this to parse accessible attributes specified
* `GtkWidget` implements this to parse accessible attributes specified
* in <accessibility> elements.
* Note that @user_data must be freed in @custom_tag_end or @custom_finished.
* @custom_tag_end: Called for the end tag of each custom element that is
@ -124,8 +124,8 @@ struct _GtkBuildableParser
* when the builder finishes parsing (see @custom_tag_start)
* @parser_finished: Called when a builder finishes the parsing
* of a UI definition. It is normally not necessary to implement this,
* unless you need to perform special cleanup actions. #GtkWindow sets
* the #GtkWidget:visible property here.
* unless you need to perform special cleanup actions. `GtkWindow` sets
* the `GtkWidget:visible` property here.
* @get_internal_child: Returns an internal child of a buildable.
* `GtkDialog` implements this to give access to its @vbox, making
* it possible to add children to the vbox in a UI definition.
@ -147,8 +147,8 @@ struct _GtkBuildableIface
/**
* GtkBuildableIface::add_child:
* @buildable: a #GtkBuildable
* @builder: a #GtkBuilder
* @buildable: a `GtkBuildable`
* @builder: a `GtkBuilder`
* @child: child to add
* @type: (nullable): kind of child or %NULL
*
@ -169,11 +169,11 @@ struct _GtkBuildableIface
/**
* GtkBuildableIface::custom_tag_start:
* @buildable: a #GtkBuildable
* @builder: a #GtkBuilder used to construct this object
* @buildable: a `GtkBuildable`
* @builder: a `GtkBuilder` used to construct this object
* @child: (nullable): child object or %NULL for non-child tags
* @tagname: name of tag
* @parser: (out): a #GtkBuildableParser to fill in
* @parser: (out): a `GtkBuildableParser` to fill in
* @data: (out): return location for user data that will be passed in
* to parser functions
*
@ -190,8 +190,8 @@ struct _GtkBuildableIface
gpointer *data);
/**
* GtkBuildableIface::custom_tag_end:
* @buildable: A #GtkBuildable
* @builder: #GtkBuilder used to construct this object
* @buildable: A `GtkBuildable`
* @builder: `GtkBuilder` used to construct this object
* @child: (nullable): child object or %NULL for non-child tags
* @tagname: name of tag
* @data: user data that will be passed in to parser functions
@ -206,8 +206,8 @@ struct _GtkBuildableIface
gpointer data);
/**
* GtkBuildableIface::custom_finished:
* @buildable: a #GtkBuildable
* @builder: a #GtkBuilder
* @buildable: a `GtkBuildable`
* @builder: a `GtkBuilder`
* @child: (nullable): child object or %NULL for non-child tags
* @tagname: the name of the tag
* @data: user data created in custom_tag_start
@ -225,8 +225,8 @@ struct _GtkBuildableIface
/**
* GtkBuildableIface::get_internal_child:
* @buildable: a #GtkBuildable
* @builder: a #GtkBuilder
* @buildable: a `GtkBuildable`
* @builder: a `GtkBuilder`
* @childname: name of child
*
* Retrieves the internal child called @childname of the @buildable object.

22
gtk/gtkbuilder.c
View File

@ -136,7 +136,7 @@
* been constructed by GTK as part of a composite widget, to set
* properties on them or to add further children (e.g. the content area
* of a `GtkDialog`). This can be achieved by setting the “internal-child”
* property of the `<child>` element to a true value. Note that #GtkBuilder
* property of the `<child>` element to a true value. Note that `GtkBuilder`
* still requires an `<object>` element for the internal child, even if it
* has already been constructed.
*
@ -302,7 +302,7 @@ gtk_builder_class_init (GtkBuilderClass *klass)
* The translation domain used when translating property values that
* have been marked as translatable.
*
* If the translation domain is %NULL, #GtkBuilder uses gettext(),
* If the translation domain is %NULL, `GtkBuilder` uses gettext(),
* otherwise g_dgettext().
*/
builder_props[PROP_TRANSLATION_DOMAIN] =
@ -2060,7 +2060,7 @@ error:
* @builder: a `GtkBuilder`
* @type: the `GType` of the value
* @string: the string representation of the value
* @value: (out): the #GValue to store the result in
* @value: (out): the `GValue` to store the result in
* @error: (nullable): return location for an error
*
* Demarshals a value from a string.
@ -2839,8 +2839,8 @@ gtk_builder_new_from_string (const char *string,
/*< private >
* _gtk_builder_prefix_error:
* @builder: a #GtkBuilder
* @context: the #GtkBuildableParseContext
* @builder: a `GtkBuilder`
* @context: the `GtkBuildableParseContext`
* @error: an error
*
* Calls g_prefix_error() to prepend a filename:line:column marker
@ -2865,8 +2865,8 @@ _gtk_builder_prefix_error (GtkBuilder *builder,
/*< private >
* _gtk_builder_error_unhandled_tag:
* @builder: a #GtkBuilder
* @context: the #GtkBuildableParseContext
* @builder: a `GtkBuilder`
* @context: the `GtkBuildableParseContext`
* @object: name of the object that is being handled
* @element_name: name of the element whose start tag is being handled
* @error: return location for the error
@ -2896,8 +2896,8 @@ _gtk_builder_error_unhandled_tag (GtkBuilder *builder,
}
/*< private >
* @builder: a #GtkBuilder
* @context: the #GtkBuildableParseContext
* @builder: a `GtkBuilder`
* @context: the `GtkBuildableParseContext`
* @parent_name: the name of the expected parent element
* @error: return location for an error
*
@ -2963,7 +2963,7 @@ gtk_builder_lookup_object (GtkBuilder *builder,
}
/*< private >
* @builder: a #GtkBuilder
* @builder: a `GtkBuilder`
* @name: object name to look up
* @line: line number where @name was encountered
* @col: column number where @name was encountered
@ -3005,7 +3005,7 @@ _gtk_builder_lookup_object (GtkBuilder *builder,
/*< private >
* _gtk_builder_lookup_failed:
* @GtkBuilder: a #GtkBuilder
* @GtkBuilder: a `GtkBuilder`
* @error: return location for error
*
* Finds whether any object lookups have failed.

16
gtk/gtkbuilder.h
View File

@ -42,18 +42,18 @@ typedef struct _GtkBuilderClass GtkBuilderClass;
/**
* GtkBuilderError:
* @GTK_BUILDER_ERROR_INVALID_TYPE_FUNCTION: A type-func attribute didn’t name
* a function that returns a #GType.
* @GTK_BUILDER_ERROR_UNHANDLED_TAG: The input contained a tag that #GtkBuilder
* a function that returns a `GType`.
* @GTK_BUILDER_ERROR_UNHANDLED_TAG: The input contained a tag that `GtkBuilder`
* can’t handle.
* @GTK_BUILDER_ERROR_MISSING_ATTRIBUTE: An attribute that is required by
* #GtkBuilder was missing.
* @GTK_BUILDER_ERROR_INVALID_ATTRIBUTE: #GtkBuilder found an attribute that
* `GtkBuilder` was missing.
* @GTK_BUILDER_ERROR_INVALID_ATTRIBUTE: `GtkBuilder` found an attribute that
* it doesn’t understand.
* @GTK_BUILDER_ERROR_INVALID_TAG: #GtkBuilder found a tag that
* @GTK_BUILDER_ERROR_INVALID_TAG: `GtkBuilder` found a tag that
* it doesn’t understand.
* @GTK_BUILDER_ERROR_MISSING_PROPERTY_VALUE: A required property value was
* missing.
* @GTK_BUILDER_ERROR_INVALID_VALUE: #GtkBuilder couldn’t parse
* @GTK_BUILDER_ERROR_INVALID_VALUE: `GtkBuilder` couldn’t parse
* some attribute value.
* @GTK_BUILDER_ERROR_VERSION_MISMATCH: The input file requires a newer version
* of GTK.
@ -69,7 +69,7 @@ typedef struct _GtkBuilderClass GtkBuilderClass;
* `gmodule-export-2.0` pkgconfig module can fix this problem.
*
* Error codes that identify various errors that can occur while using
* #GtkBuilder.
* `GtkBuilder`.
*/
typedef enum
{
@ -186,7 +186,7 @@ GClosure * gtk_builder_create_closure (GtkBuilder *builder,
/**
* GTK_BUILDER_WARN_INVALID_CHILD_TYPE:
* @object: the #GtkBuildable on which the warning occurred
* @object: the `GtkBuildable` on which the warning occurred
* @type: the unexpected type value
*
* This macro should be used to emit a warning about and unexpected @type value

18
gtk/gtkbuilderparser.c
View File

@ -207,14 +207,14 @@ gtk_buildable_parse_context_parse (GtkBuildableParseContext *context,
/**
* gtk_buildable_parse_context_push:
* @context: a #GtkBuildableParseContext
* @parser: a #GtkBuildableParser
* @user_data: user data to pass to #GtkBuildableParser functions
* @context: a `GtkBuildableParseContext`
* @parser: a `GtkBuildableParser`
* @user_data: user data to pass to `GtkBuildableParser` functions
*
* Temporarily redirects markup data to a sub-parser.
*
* This function may only be called from the start_element handler of
* a #GtkBuildableParser. It must be matched with a corresponding call to
* a `GtkBuildableParser`. It must be matched with a corresponding call to
* gtk_buildable_parse_context_pop() in the matching end_element handler
* (except in the case that the parser aborts due to an error).
*
@ -263,7 +263,7 @@ gtk_buildable_parse_context_push (GtkBuildableParseContext *context,
/**
* gtk_buildable_parse_context_pop:
* @context: a #GtkBuildableParseContext
* @context: a `GtkBuildableParseContext`
*
* Completes the process of a temporary sub-parser redirection.
*
@ -301,7 +301,7 @@ gtk_buildable_parse_context_pop (GtkBuildableParseContext *context)
/**
* gtk_buildable_parse_context_get_element:
* @context: a #GtkBuildablParseContext
* @context: a `GtkBuildablParseContext`
*
* Retrieves the name of the currently open element.
*
@ -321,11 +321,11 @@ gtk_buildable_parse_context_get_element (GtkBuildableParseContext *context)
/**
* gtk_buildable_parse_context_get_element_stack:
* @context: a #GtkBuildableParseContext
* @context: a `GtkBuildableParseContext`
*
* Retrieves the element stack from the internal state of the parser.
*
* The returned #GPtrArray is an array of strings where the last item is
* The returned `GPtrArray` is an array of strings where the last item is
* the currently open tag (as would be returned by
* gtk_buildable_parse_context_get_element()) and the previous item is its
* immediate parent.
@ -345,7 +345,7 @@ gtk_buildable_parse_context_get_element_stack (GtkBuildableParseContext *context
/**
* gtk_buildable_parse_context_get_position:
* @context: a #GtkBuildableParseContext
* @context: a `GtkBuildableParseContext`
* @line_number: (out) (optional): return location for a line number
* @char_number: (out) (optional): return location for a char-on-line number
*

2
gtk/gtkbuilderprecompile.c
View File

@ -300,7 +300,7 @@ marshal_tree (GString *marshaled,
* binary form that is more efficient to parse. This is a custom
* format that is only supported by GtkBuilder.
*
* returns: A #GByte with the precompiled data
* returns: A `GBytes` with the precompiled data
**/
GBytes *
_gtk_buildable_parser_precompile (const char *text,

8
gtk/gtkbuilderscope.h
View File

@ -51,15 +51,15 @@ typedef enum { /*< prefix=GTK_BUILDER_CLOSURE >*/
/**
* GtkBuilderScopeInterface:
* @get_type_from_name: Try to lookup a #GType via the its name. See
* @get_type_from_name: Try to lookup a `GType` via the its name. See
* gtk_builder_get_type_from_name() for more details.
* The C implementation will use g_type_from_name() and if that fails try to guess the
* correct function name for registering the type and then use dlsym() to load it.
* The default implementation just tries g_type_from_name() and otherwise fails.
* @get_type_from_function: Try to lookup a #GType via the given function name, specified
* @get_type_from_function: Try to lookup a `GType` via the given function name, specified
* explicitly in a GtkBuilder file, like via the "type-func" attribute in the "<object>" tag.
* This function is very rarely used.
* The C implementation will use dlsym() and call the resulting function as a #GTypeFunc.
* The C implementation will use dlsym() and call the resulting function as a `GTypeFunc`.
* The default implementation will fail and just return %G_TYPE_INVALID.
* @create_closure: Create a closure with the given arguments. See gtk_builder_create_closure()
* for more details on those.
@ -67,7 +67,7 @@ typedef enum { /*< prefix=GTK_BUILDER_CLOSURE >*/
* g_cclosure_new() to create a closure for the symbol.
* The default implementation just fails and returns %NULL.
*
* The virtual function table to implement for #GtkBuilderScope implementations.
* The virtual function table to implement for `GtkBuilderScope` implementations.
* Default implementations for each function do exist, but they usually just fail,
* so it is suggested that implementations implement all of them.
*/

4
gtk/gtkcalendar.c
View File

@ -1353,7 +1353,7 @@ gtk_calendar_new (void)
/**
* gtk_calendar_select_day:
* @self: a `GtkCalendar`.
* @date: (transfer none): a #GDateTime representing the day to select
* @date: (transfer none): a `GDateTime` representing the day to select
*
* Switches to @date's year and month and select its day.
*/
@ -1608,7 +1608,7 @@ gtk_calendar_unmark_day (GtkCalendar *calendar,
* gtk_calendar_get_date:
* @self: a `GtkCalendar`
*
* Returns a #GDateTime representing the shown
* Returns a `GDateTime` representing the shown
* year, month and the selected day.
*
* The returned date is in the local time zone.

390
gtk/gtkcellarea.c
View File

@ -24,15 +24,15 @@
*
* An abstract class for laying out GtkCellRenderers
*
* The #GtkCellArea is an abstract class for #GtkCellLayout widgets
* The `GtkCellArea` is an abstract class for `GtkCellLayout` widgets
* (also referred to as "layouting widgets") to interface with an
* arbitrary number of #GtkCellRenderers and interact with the user
* for a given #GtkTreeModel row.
* arbitrary number of `GtkCellRenderer`s and interact with the user
* for a given `GtkTreeModel` row.
*
* The cell area handles events, focus navigation, drawing and
* size requests and allocations for a given row of data.
*
* Usually users dont have to interact with the #GtkCellArea directly
* Usually users dont have to interact with the `GtkCellArea` directly
* unless they are implementing a cell-layouting widget themselves.
*
* # Requesting area sizes
@ -41,13 +41,13 @@
* [GtkWidget’s geometry management section][geometry-management],
* GTK uses a height-for-width
* geometry management system to compute the sizes of widgets and user
* interfaces. #GtkCellArea uses the same semantics to calculate the
* size of an area for an arbitrary number of #GtkTreeModel rows.
* interfaces. `GtkCellArea` uses the same semantics to calculate the
* size of an area for an arbitrary number of `GtkTreeModel` rows.
*
* When requesting the size of a cell area one needs to calculate
* the size for a handful of rows, and this will be done differently by
* different layouting widgets. For instance a #GtkTreeViewColumn
* always lines up the areas from top to bottom while a #GtkIconView
* different layouting widgets. For instance a `GtkTreeViewColumn`
* always lines up the areas from top to bottom while a `GtkIconView`
* on the other hand might enforce that all areas received the same
* width and wrap the areas around, requesting height for more cell
* areas when allocated less width.
@ -55,23 +55,23 @@
* It’s also important for areas to maintain some cell
* alignments with areas rendered for adjacent rows (cells can
* appear “columnized” inside an area even when the size of
* cells are different in each row). For this reason the #GtkCellArea
* uses a #GtkCellAreaContext object to store the alignments
* cells are different in each row). For this reason the `GtkCellArea`
* uses a `GtkCellArea`Context object to store the alignments
* and sizes along the way (as well as the overall largest minimum
* and natural size for all the rows which have been calculated
* with the said context).
*
* The #GtkCellAreaContext is an opaque object specific to the
* #GtkCellArea which created it (see gtk_cell_area_create_context()).
* The `GtkCellArea`Context is an opaque object specific to the
* `GtkCellArea` which created it (see gtk_cell_area_create_context()).
* The owning cell-layouting widget can create as many contexts as
* it wishes to calculate sizes of rows which should receive the
* same size in at least one orientation (horizontally or vertically),
* However, it’s important that the same #GtkCellAreaContext which
* was used to request the sizes for a given #GtkTreeModel row be
* However, it’s important that the same `GtkCellArea`Context which
* was used to request the sizes for a given `GtkTreeModel` row be
* used when rendering or processing events for that row.
*
* In order to request the width of all the rows at the root level
* of a #GtkTreeModel one would do the following:
* of a `GtkTreeModel` one would do the following:
*
* |[<!-- language="C" -->
* GtkTreeIter iter;
@ -93,17 +93,17 @@
* returned minimum and natural width of the area for each row
* unless the cell-layouting object is actually interested in the
* widths of individual rows. The overall width is however stored
* in the accompanying #GtkCellAreaContext object and can be consulted
* in the accompanying `GtkCellArea`Context object and can be consulted
* at any time.
*
* This can be useful since #GtkCellLayout widgets usually have to
* This can be useful since `GtkCellLayout` widgets usually have to
* support requesting and rendering rows in treemodels with an
* exceedingly large amount of rows. The #GtkCellLayout widget in
* exceedingly large amount of rows. The `GtkCellLayout` widget in
* that case would calculate the required width of the rows in an
* idle or timeout source (see g_timeout_add()) and when the widget
* is requested its actual width in [vfunc@Gtk.Widget.measure]
* it can simply consult the width accumulated so far in the
* #GtkCellAreaContext object.
* `GtkCellArea`Context object.
*
* A simple example where rows are rendered from top to bottom and
* take up the full width of the layouting widget would look like:
@ -127,17 +127,17 @@
* row sizes have been calculated (the amount of rows that Foo judged
* was appropriate to request space for in a single timeout iteration)
* before simply returning the amount of space required by the area via
* the #GtkCellAreaContext.
* the `GtkCellArea`Context.
*
* Requesting the height for width (or width for height) of an area is
* a similar task except in this case the #GtkCellAreaContext does not
* a similar task except in this case the `GtkCellArea`Context does not
* store the data (actually, it does not know how much space the layouting
* widget plans to allocate it for every row. It’s up to the layouting
* widget to render each row of data with the appropriate height and
* width which was requested by the #GtkCellArea).
* width which was requested by the `GtkCellArea`).
*
* In order to request the height for width of all the rows at the
* root level of a #GtkTreeModel one would do the following:
* root level of a `GtkTreeModel` one would do the following:
*
* |[<!-- language="C" -->
* GtkTreeIter iter;
@ -229,26 +229,26 @@
*
* Passing events to the area is as simple as handling events on any
* normal widget and then passing them to the gtk_cell_area_event()
* API as they come in. Usually #GtkCellArea is only interested in
* API as they come in. Usually `GtkCellArea` is only interested in
* button events, however some customized derived areas can be implemented
* who are interested in handling other events. Handling an event can
* trigger the #GtkCellArea::focus-changed signal to fire; as well as
* #GtkCellArea::add-editable in the case that an editable cell was
* trigger the `GtkCellArea`::focus-changed signal to fire; as well as
* `GtkCellArea`::add-editable in the case that an editable cell was
* clicked and needs to start editing. You can call
* gtk_cell_area_stop_editing() at any time to cancel any cell editing
* that is currently in progress.
*
* The #GtkCellArea drives keyboard focus from cell to cell in a way
* similar to #GtkWidget. For layouting widgets that support giving
* The `GtkCellArea` drives keyboard focus from cell to cell in a way
* similar to `GtkWidget`. For layouting widgets that support giving
* focus to cells it’s important to remember to pass %GTK_CELL_RENDERER_FOCUSED
* to the area functions for the row that has focus and to tell the
* area to paint the focus at render time.
*
* Layouting widgets that accept focus on cells should implement the
* [vfunc@Gtk.Widget.focus] virtual method. The layouting widget is always
* responsible for knowing where #GtkTreeModel rows are rendered inside
* responsible for knowing where `GtkTreeModel` rows are rendered inside
* the widget, so at [vfunc@Gtk.Widget.focus] time the layouting widget
* should use the #GtkCellArea methods to navigate focus inside the area
* should use the `GtkCellArea` methods to navigate focus inside the area
* and then observe the GtkDirectionType to pass the focus to adjacent
* rows and areas.
*
@ -318,13 +318,13 @@
*
* # Cell Properties
*
* The #GtkCellArea introduces cell properties for #GtkCellRenderers.
* The `GtkCellArea` introduces cell properties for `GtkCellRenderer`s.
* This provides some general interfaces for defining the relationship
* cell areas have with their cells. For instance in a #GtkCellAreaBox
* cell areas have with their cells. For instance in a `GtkCellArea`Box
* a cell might “expand” and receive extra space when the area is allocated
* more than its full natural request, or a cell might be configured to “align”
* with adjacent rows which were requested and rendered with the same
* #GtkCellAreaContext.
* `GtkCellArea`Context.
*
* Use gtk_cell_area_class_install_cell_property() to install cell
* properties for a cell area class and gtk_cell_area_class_find_cell_property()
@ -671,9 +671,9 @@ gtk_cell_area_class_init (GtkCellAreaClass *class)
/* Signals */
/**
* GtkCellArea::apply-attributes:
* @area: the #GtkCellArea to apply the attributes to
* @model: the #GtkTreeModel to apply the attributes from
* @iter: the #GtkTreeIter indicating which row to apply the attributes of
* @area: the `GtkCellArea` to apply the attributes to
* @model: the `GtkTreeModel` to apply the attributes from
* @iter: the `GtkTreeIter` indicating which row to apply the attributes of
* @is_expander: whether the view shows children for this row
* @is_expanded: whether the view is currently showing the children of this row
*
@ -696,12 +696,12 @@ gtk_cell_area_class_init (GtkCellAreaClass *class)
/**
* GtkCellArea::add-editable:
* @area: the #GtkCellArea where editing started
* @renderer: the #GtkCellRenderer that started the edited
* @editable: the #GtkCellEditable widget to add
* @cell_area: the #GtkWidget relative #GdkRectangle coordinates
* @area: the `GtkCellArea` where editing started
* @renderer: the `GtkCellRenderer` that started the edited
* @editable: the `GtkCellEditable` widget to add
* @cell_area: the `GtkWidget` relative `GdkRectangle` coordinates
* where @editable should be added
* @path: the #GtkTreePath string this edit was initiated for
* @path: the `GtkTreePath` string this edit was initiated for
*
* Indicates that editing has started on @renderer and that @editable
* should be added to the owning cell-layouting widget at @cell_area.
@ -722,9 +722,9 @@ gtk_cell_area_class_init (GtkCellAreaClass *class)
/**
* GtkCellArea::remove-editable:
* @area: the #GtkCellArea where editing finished
* @renderer: the #GtkCellRenderer that finished editeding
* @editable: the #GtkCellEditable widget to remove
* @area: the `GtkCellArea` where editing finished
* @renderer: the `GtkCellRenderer` that finished editeding
* @editable: the `GtkCellEditable` widget to remove
*
* Indicates that editing finished on @renderer and that @editable
* should be removed from the owning cell-layouting widget.
@ -742,9 +742,9 @@ gtk_cell_area_class_init (GtkCellAreaClass *class)
/**
* GtkCellArea::focus-changed:
* @area: the #GtkCellArea where focus changed
* @renderer: the #GtkCellRenderer that has focus
* @path: the current #GtkTreePath string set for @area
* @area: the `GtkCellArea` where focus changed
* @renderer: the `GtkCellRenderer` that has focus
* @path: the current `GtkTreePath` string set for @area
*
* Indicates that focus changed on this @area. This signal
* is emitted either as a result of focus handling or event
@ -1590,8 +1590,8 @@ gtk_cell_area_buildable_custom_tag_end (GtkBuildable *buildable,
/**
* gtk_cell_area_add:
* @area: a #GtkCellArea
* @renderer: the #GtkCellRenderer to add to @area
* @area: a `GtkCellArea`
* @renderer: the `GtkCellRenderer` to add to @area
*
* Adds @renderer to @area with the default child cell properties.
*/
@ -1607,8 +1607,8 @@ gtk_cell_area_add (GtkCellArea *area,
/**
* gtk_cell_area_remove:
* @area: a #GtkCellArea
* @renderer: the #GtkCellRenderer to remove from @area
* @area: a `GtkCellArea`
* @renderer: the `GtkCellRenderer` to remove from @area
*
* Removes @renderer from @area.
*/
@ -1659,8 +1659,8 @@ get_has_renderer (GtkCellRenderer *renderer,
/**
* gtk_cell_area_has_renderer:
* @area: a #GtkCellArea
* @renderer: the #GtkCellRenderer to check
* @area: a `GtkCellArea`
* @renderer: the `GtkCellRenderer` to check
*
* Checks if @area contains @renderer.
*
@ -1682,11 +1682,11 @@ gtk_cell_area_has_renderer (GtkCellArea *area,
/**
* gtk_cell_area_foreach:
* @area: a #GtkCellArea
* @callback: (scope call): the #GtkCellCallback to call
* @area: a `GtkCellArea`
* @callback: (scope call): the `GtkCellCallback` to call
* @callback_data: user provided data pointer
*
* Calls @callback for every #GtkCellRenderer in @area.
* Calls @callback for every `GtkCellRenderer` in @area.
*/
void
gtk_cell_area_foreach (GtkCellArea *area,
@ -1701,15 +1701,15 @@ gtk_cell_area_foreach (GtkCellArea *area,
/**
* gtk_cell_area_foreach_alloc:
* @area: a #GtkCellArea
* @context: the #GtkCellAreaContext for this row of data.
* @widget: the #GtkWidget that @area is rendering to
* @area: a `GtkCellArea`
* @context: the `GtkCellArea`Context for this row of data.
* @widget: the `GtkWidget` that @area is rendering to
* @cell_area: the @widget relative coordinates and size for @area
* @background_area: the @widget relative coordinates of the background area
* @callback: (scope call): the #GtkCellAllocCallback to call
* @callback: (scope call): the `GtkCellAllocCallback` to call
* @callback_data: user provided data pointer
*
* Calls @callback for every #GtkCellRenderer in @area with the
* Calls @callback for every `GtkCellRenderer` in @area with the
* allocated rectangle inside @cell_area.
*/
void
@ -1734,14 +1734,14 @@ gtk_cell_area_foreach_alloc (GtkCellArea *area,
/**
* gtk_cell_area_event:
* @area: a #GtkCellArea
* @context: the #GtkCellAreaContext for this row of data.
* @widget: the #GtkWidget that @area is rendering to
* @event: the #GdkEvent to handle
* @area: a `GtkCellArea`
* @context: the `GtkCellArea`Context for this row of data.
* @widget: the `GtkWidget` that @area is rendering to
* @event: the `GdkEvent` to handle
* @cell_area: the @widget relative coordinates for @area
* @flags: the #GtkCellRendererState for @area in this row.
* @flags: the `GtkCellRenderer`State for @area in this row.
*
* Delegates event handling to a #GtkCellArea.
* Delegates event handling to a `GtkCellArea`.
*
* Returns: %TRUE if the event was handled by @area.
*/
@ -1773,13 +1773,13 @@ gtk_cell_area_event (GtkCellArea *area,
/**
* gtk_cell_area_snapshot:
* @area: a #GtkCellArea
* @context: the #GtkCellAreaContext for this row of data.
* @widget: the #GtkWidget that @area is rendering to
* @snapshot: the #GtkSnapshot to draw to
* @area: a `GtkCellArea`
* @context: the `GtkCellArea`Context for this row of data.
* @widget: the `GtkWidget` that @area is rendering to
* @snapshot: the `GtkSnapshot` to draw to
* @background_area: the @widget relative coordinates for @area’s background
* @cell_area: the @widget relative coordinates for @area
* @flags: the #GtkCellRendererState for @area in this row.
* @flags: the `GtkCellRenderer`State for @area in this row.
* @paint_focus: whether @area should paint focus on focused cells for focused rows or not.
*
* Snapshots @area’s cells according to @area’s layout onto at
@ -1827,10 +1827,10 @@ get_cell_allocation (GtkCellRenderer *renderer,
/**
* gtk_cell_area_get_cell_allocation:
* @area: a #GtkCellArea
* @context: the #GtkCellAreaContext used to hold sizes for @area.
* @widget: the #GtkWidget that @area is rendering on
* @renderer: the #GtkCellRenderer to get the allocation for
* @area: a `GtkCellArea`
* @context: the `GtkCellArea`Context used to hold sizes for @area.
* @widget: the `GtkWidget` that @area is rendering on
* @renderer: the `GtkCellRenderer` to get the allocation for
* @cell_area: the whole allocated area for @area in @widget
* for this row
* @allocation: (out): where to store the allocation for @renderer
@ -1879,9 +1879,9 @@ get_cell_by_position (GtkCellRenderer *renderer,
/**
* gtk_cell_area_get_cell_at_position:
* @area: a #GtkCellArea
* @context: the #GtkCellAreaContext used to hold sizes for @area.
* @widget: the #GtkWidget that @area is rendering on
* @area: a `GtkCellArea`
* @context: the `GtkCellArea`Context used to hold sizes for @area.
* @widget: the `GtkWidget` that @area is rendering on
* @cell_area: the whole allocated area for @area in @widget
* for this row
* @x: the x position
@ -1889,10 +1889,10 @@ get_cell_by_position (GtkCellRenderer *renderer,
* @alloc_area: (out) (optional): where to store the inner allocated area of the
* returned cell renderer
*
* Gets the #GtkCellRenderer at @x and @y coordinates inside @area and optionally
* Gets the `GtkCellRenderer` at @x and @y coordinates inside @area and optionally
* returns the full cell allocation for it inside @cell_area.
*
* Returns: (transfer none): the #GtkCellRenderer at @x and @y.
* Returns: (transfer none): the `GtkCellRenderer` at @x and @y.
*/
GtkCellRenderer *
gtk_cell_area_get_cell_at_position (GtkCellArea *area,
@ -1926,16 +1926,16 @@ gtk_cell_area_get_cell_at_position (GtkCellArea *area,
*************************************************************/
/**
* gtk_cell_area_create_context:
* @area: a #GtkCellArea
* @area: a `GtkCellArea`
*
* Creates a #GtkCellAreaContext to be used with @area for
* all purposes. #GtkCellAreaContext stores geometry information
* Creates a `GtkCellArea`Context to be used with @area for
* all purposes. `GtkCellArea`Context stores geometry information
* for rows for which it was operated on, it is important to use
* the same context for the same row of data at all times (i.e.
* one should render and handle events with the same #GtkCellAreaContext
* one should render and handle events with the same `GtkCellArea`Context
* which was used to request the size of those rows of data).
*
* Returns: (transfer full): a newly created #GtkCellAreaContext which can be used with @area.
* Returns: (transfer full): a newly created `GtkCellArea`Context which can be used with @area.
*/
GtkCellAreaContext *
gtk_cell_area_create_context (GtkCellArea *area)
@ -1947,22 +1947,22 @@ gtk_cell_area_create_context (GtkCellArea *area)
/**
* gtk_cell_area_copy_context:
* @area: a #GtkCellArea
* @context: the #GtkCellAreaContext to copy
* @area: a `GtkCellArea`
* @context: the `GtkCellArea`Context to copy
*
* This is sometimes needed for cases where rows need to share
* alignments in one orientation but may be separately grouped
* in the opposing orientation.
*
* For instance, #GtkIconView creates all icons (rows) to have
* For instance, `GtkIconView` creates all icons (rows) to have
* the same width and the cells theirin to have the same
* horizontal alignments. However each row of icons may have
* a separate collective height. #GtkIconView uses this to
* a separate collective height. `GtkIconView` uses this to
* request the heights of each row based on a context which
* was already used to request all the row widths that are
* to be displayed.
*
* Returns: (transfer full): a newly created #GtkCellAreaContext copy of @context.
* Returns: (transfer full): a newly created `GtkCellArea`Context copy of @context.
*/
GtkCellAreaContext *
gtk_cell_area_copy_context (GtkCellArea *area,
@ -1976,12 +1976,12 @@ gtk_cell_area_copy_context (GtkCellArea *area,
/**
* gtk_cell_area_get_request_mode:
* @area: a #GtkCellArea
* @area: a `GtkCellArea`
*
* Gets whether the area prefers a height-for-width layout
* or a width-for-height layout.
*
* Returns: The #GtkSizeRequestMode preferred by @area.
* Returns: The `GtkSizeRequestMode` preferred by @area.
*/
GtkSizeRequestMode
gtk_cell_area_get_request_mode (GtkCellArea *area)
@ -1994,9 +1994,9 @@ gtk_cell_area_get_request_mode (GtkCellArea *area)
/**
* gtk_cell_area_get_preferred_width:
* @area: a #GtkCellArea
* @context: the #GtkCellAreaContext to perform this request with
* @widget: the #GtkWidget where @area will be rendering
* @area: a `GtkCellArea`
* @context: the `GtkCellArea`Context to perform this request with
* @widget: the `GtkWidget` where @area will be rendering
* @minimum_width: (out) (optional): location to store the minimum width
* @natural_width: (out) (optional): location to store the natural width
*
@ -2024,9 +2024,9 @@ gtk_cell_area_get_preferred_width (GtkCellArea *area,
/**
* gtk_cell_area_get_preferred_height_for_width:
* @area: a #GtkCellArea
* @context: the #GtkCellAreaContext which has already been requested for widths.
* @widget: the #GtkWidget where @area will be rendering
* @area: a `GtkCellArea`
* @context: the `GtkCellArea`Context which has already been requested for widths.
* @widget: the `GtkWidget` where @area will be rendering
* @width: the width for which to check the height of this area
* @minimum_height: (out) (optional): location to store the minimum height
* @natural_height: (out) (optional): location to store the natural height
@ -2066,9 +2066,9 @@ gtk_cell_area_get_preferred_height_for_width (GtkCellArea *area,
/**
* gtk_cell_area_get_preferred_height:
* @area: a #GtkCellArea
* @context: the #GtkCellAreaContext to perform this request with
* @widget: the #GtkWidget where @area will be rendering
* @area: a `GtkCellArea`
* @context: the `GtkCellArea`Context to perform this request with
* @widget: the `GtkWidget` where @area will be rendering
* @minimum_height: (out) (optional): location to store the minimum height
* @natural_height: (out) (optional): location to store the natural height
*
@ -2096,9 +2096,9 @@ gtk_cell_area_get_preferred_height (GtkCellArea *area,
/**
* gtk_cell_area_get_preferred_width_for_height:
* @area: a #GtkCellArea
* @context: the #GtkCellAreaContext which has already been requested for widths.
* @widget: the #GtkWidget where @area will be rendering
* @area: a `GtkCellArea`
* @context: the `GtkCellArea`Context which has already been requested for widths.
* @widget: the `GtkWidget` where @area will be rendering
* @height: the height for which to check the width of this area
* @minimum_width: (out) (optional): location to store the minimum width
* @natural_width: (out) (optional): location to store the natural width
@ -2141,13 +2141,13 @@ gtk_cell_area_get_preferred_width_for_height (GtkCellArea *area,
/**
* gtk_cell_area_attribute_connect:
* @area: a #GtkCellArea
* @renderer: the #GtkCellRenderer to connect an attribute for
* @area: a `GtkCellArea`
* @renderer: the `GtkCellRenderer` to connect an attribute for
* @attribute: the attribute name
* @column: the #GtkTreeModel column to fetch attribute values from
* @column: the `GtkTreeModel` column to fetch attribute values from
*
* Connects an @attribute to apply values from @column for the
* #GtkTreeModel in use.
* `GtkTreeModel` in use.
*/
void
gtk_cell_area_attribute_connect (GtkCellArea *area,
@ -2207,8 +2207,8 @@ gtk_cell_area_attribute_connect (GtkCellArea *area,
/**
* gtk_cell_area_attribute_disconnect:
* @area: a #GtkCellArea
* @renderer: the #GtkCellRenderer to disconnect an attribute for
* @area: a `GtkCellArea`
* @renderer: the `GtkCellRenderer` to disconnect an attribute for
* @attribute: the attribute name
*
* Disconnects @attribute for the @renderer in @area so that
@ -2249,8 +2249,8 @@ gtk_cell_area_attribute_disconnect (GtkCellArea *area,
/**
* gtk_cell_area_attribute_get_column:
* @area: a #GtkCellArea
* @renderer: a #GtkCellRenderer
* @area: a `GtkCellArea`
* @renderer: a `GtkCellRenderer`
* @attribute: an attribute on the renderer
*
* Returns the model column that an attribute has been mapped to,
@ -2286,9 +2286,9 @@ gtk_cell_area_attribute_get_column (GtkCellArea *area,
/**
* gtk_cell_area_apply_attributes:
* @area: a #GtkCellArea
* @tree_model: the #GtkTreeModel to pull values from
* @iter: the #GtkTreeIter in @tree_model to apply values for
* @area: a `GtkCellArea`
* @tree_model: the `GtkTreeModel` to pull values from
* @iter: the `GtkTreeIter` in @tree_model to apply values for
* @is_expander: whether @iter has children
* @is_expanded: whether @iter is expanded in the view and
* children are visible
@ -2313,15 +2313,15 @@ gtk_cell_area_apply_attributes (GtkCellArea *area,
/**
* gtk_cell_area_get_current_path_string:
* @area: a #GtkCellArea
* @area: a `GtkCellArea`
*
* Gets the current #GtkTreePath string for the currently
* applied #GtkTreeIter, this is implicitly updated when
* Gets the current `GtkTreePath` string for the currently
* applied `GtkTreeIter`, this is implicitly updated when
* gtk_cell_area_apply_attributes() is called and can be
* used to interact with renderers from #GtkCellArea
* used to interact with renderers from `GtkCellArea`
* subclasses.
*
* Returns: The current #GtkTreePath string for the current
* Returns: The current `GtkTreePath` string for the current
* attributes applied to @area. This string belongs to the area and
* should not be freed.
*/
@ -2341,9 +2341,9 @@ gtk_cell_area_get_current_path_string (GtkCellArea *area)
*************************************************************/
/**
* gtk_cell_area_class_install_cell_property:
* @aclass: a #GtkCellAreaClass
* @aclass: a `GtkCellAreaClass`
* @property_id: the id for the property
* @pspec: the #GParamSpec for the property
* @pspec: the `GParamSpec` for the property
*
* Installs a cell property on a cell area class.
*/
@ -2376,12 +2376,12 @@ gtk_cell_area_class_install_cell_property (GtkCellAreaClass *aclass,
/**
* gtk_cell_area_class_find_cell_property:
* @aclass: a #GtkCellAreaClass
* @aclass: a `GtkCellAreaClass`
* @property_name: the name of the child property to find
*
* Finds a cell property of a cell area class by name.
*
* Returns: (nullable) (transfer none): the #GParamSpec of the child property
* Returns: (transfer none): the `GParamSpec` of the child property
*/
GParamSpec*
gtk_cell_area_class_find_cell_property (GtkCellAreaClass *aclass,
@ -2398,13 +2398,13 @@ gtk_cell_area_class_find_cell_property (GtkCellAreaClass *aclass,
/**
* gtk_cell_area_class_list_cell_properties:
* @aclass: a #GtkCellAreaClass
* @aclass: a `GtkCellAreaClass`
* @n_properties: (out): location to return the number of cell properties found
*
* Returns all cell properties of a cell area class.
*
* Returns: (array length=n_properties) (transfer container): a newly
* allocated %NULL-terminated array of #GParamSpec*. The array
* allocated %NULL-terminated array of `GParamSpec`*. The array
* must be freed with g_free().
*/
GParamSpec**
@ -2427,8 +2427,8 @@ gtk_cell_area_class_list_cell_properties (GtkCellAreaClass *aclass,
/**
* gtk_cell_area_add_with_properties:
* @area: a #GtkCellArea
* @renderer: a #GtkCellRenderer to be placed inside @area
* @area: a `GtkCellArea`
* @renderer: a `GtkCellRenderer` to be placed inside @area
* @first_prop_name: the name of the first cell property to set
* @...: a %NULL-terminated list of property names and values, starting
* with @first_prop_name
@ -2466,8 +2466,8 @@ gtk_cell_area_add_with_properties (GtkCellArea *area,
/**
* gtk_cell_area_cell_set:
* @area: a #GtkCellArea
* @renderer: a #GtkCellRenderer which is a cell inside @area
* @area: a `GtkCellArea`
* @renderer: a `GtkCellRenderer` which is a cell inside @area
* @first_prop_name: the name of the first cell property to set
* @...: a %NULL-terminated list of property names and values, starting
* with @first_prop_name
@ -2492,8 +2492,8 @@ gtk_cell_area_cell_set (GtkCellArea *area,
/**
* gtk_cell_area_cell_get:
* @area: a #GtkCellArea
* @renderer: a #GtkCellRenderer which is inside @area
* @area: a `GtkCellArea`
* @renderer: a `GtkCellRenderer` which is inside @area
* @first_prop_name: the name of the first cell property to get
* @...: return location for the first cell property, followed
* optionally by more name/return location pairs, followed by %NULL
@ -2563,8 +2563,8 @@ area_set_cell_property (GtkCellArea *area,
/**
* gtk_cell_area_cell_set_valist:
* @area: a #GtkCellArea
* @renderer: a #GtkCellRenderer which inside @area
* @area: a `GtkCellArea`
* @renderer: a `GtkCellRenderer` which inside @area
* @first_property_name: the name of the first cell property to set
* @var_args: a %NULL-terminated list of property names and values, starting
* with @first_prop_name
@ -2623,8 +2623,8 @@ gtk_cell_area_cell_set_valist (GtkCellArea *area,
/**
* gtk_cell_area_cell_get_valist:
* @area: a #GtkCellArea
* @renderer: a #GtkCellRenderer inside @area
* @area: a `GtkCellArea`
* @renderer: a `GtkCellRenderer` inside @area
* @first_property_name: the name of the first property to get
* @var_args: return location for the first property, followed
* optionally by more name/return location pairs, followed by %NULL
@ -2681,8 +2681,8 @@ gtk_cell_area_cell_get_valist (GtkCellArea *area,
/**
* gtk_cell_area_cell_set_property:
* @area: a #GtkCellArea
* @renderer: a #GtkCellRenderer inside @area
* @area: a `GtkCellArea`
* @renderer: a `GtkCellRenderer` inside @area
* @property_name: the name of the cell property to set
* @value: the value to set the cell property to
*
@ -2717,8 +2717,8 @@ gtk_cell_area_cell_set_property (GtkCellArea *area,
/**
* gtk_cell_area_cell_get_property:
* @area: a #GtkCellArea
* @renderer: a #GtkCellRenderer inside @area
* @area: a `GtkCellArea`
* @renderer: a `GtkCellRenderer` inside @area
* @property_name: the name of the property to get
* @value: a location to return the value
*
@ -2786,7 +2786,7 @@ gtk_cell_area_cell_get_property (GtkCellArea *area,
/**
* gtk_cell_area_is_activatable:
* @area: a #GtkCellArea
* @area: a `GtkCellArea`
*
* Returns whether the area can do anything when activated,
* after applying new attributes to @area.
@ -2803,14 +2803,14 @@ gtk_cell_area_is_activatable (GtkCellArea *area)
/**
* gtk_cell_area_focus:
* @area: a #GtkCellArea
* @direction: the #GtkDirectionType
* @area: a `GtkCellArea`
* @direction: the `GtkDirectionType`
*
* This should be called by the @area’s owning layout widget
* when focus is to be passed to @area, or moved within @area
* for a given @direction and row data.
*
* Implementing #GtkCellArea classes should implement this
* Implementing `GtkCellArea` classes should implement this
* method to receive and navigate focus in its own way particular
* to how it lays out cells.
*
@ -2827,11 +2827,11 @@ gtk_cell_area_focus (GtkCellArea *area,
/**
* gtk_cell_area_activate:
* @area: a #GtkCellArea
* @context: the #GtkCellAreaContext in context with the current row data
* @widget: the #GtkWidget that @area is rendering on
* @area: a `GtkCellArea`
* @context: the `GtkCellArea`Context in context with the current row data
* @widget: the `GtkWidget` that @area is rendering on
* @cell_area: the size and location of @area relative to @widget’s allocation
* @flags: the #GtkCellRendererState flags for @area for this row of data.
* @flags: the `GtkCellRenderer`State flags for @area for this row of data.
* @edit_only: if %TRUE then only cell renderers that are %GTK_CELL_RENDERER_MODE_EDITABLE
* will be activated.
*
@ -2857,13 +2857,13 @@ gtk_cell_area_activate (GtkCellArea *area,
/**
* gtk_cell_area_set_focus_cell:
* @area: a #GtkCellArea
* @renderer: the #GtkCellRenderer to give focus to
* @area: a `GtkCellArea`
* @renderer: the `GtkCellRenderer` to give focus to
*
* Explicitly sets the currently focused cell to @renderer.
*
* This is generally called by implementations of
* #GtkCellAreaClass.focus() or #GtkCellAreaClass.event(),
* `GtkCellAreaClass.focus()` or `GtkCellAreaClass.event()`,
* however it can also be used to implement functions such
* as gtk_tree_view_set_cursor_on_cell().
*/
@ -2899,7 +2899,7 @@ gtk_cell_area_set_focus_cell (GtkCellArea *area,
/**
* gtk_cell_area_get_focus_cell:
* @area: a #GtkCellArea
* @area: a `GtkCellArea`
*
* Retrieves the currently focused cell for @area
*
@ -2922,9 +2922,9 @@ gtk_cell_area_get_focus_cell (GtkCellArea *area)
/**
* gtk_cell_area_add_focus_sibling:
* @area: a #GtkCellArea
* @renderer: the #GtkCellRenderer expected to have focus
* @sibling: the #GtkCellRenderer to add to @renderer’s focus area
* @area: a `GtkCellArea`
* @renderer: the `GtkCellRenderer` expected to have focus
* @sibling: the `GtkCellRenderer` to add to @renderer’s focus area
*
* Adds @sibling to @renderer’s focusable area, focus will be drawn
* around @renderer and all of its siblings if @renderer can
@ -2969,9 +2969,9 @@ gtk_cell_area_add_focus_sibling (GtkCellArea *area,
/**
* gtk_cell_area_remove_focus_sibling:
* @area: a #GtkCellArea
* @renderer: the #GtkCellRenderer expected to have focus
* @sibling: the #GtkCellRenderer to remove from @renderer’s focus area
* @area: a `GtkCellArea`
* @renderer: the `GtkCellRenderer` expected to have focus
* @sibling: the `GtkCellRenderer` to remove from @renderer’s focus area
*
* Removes @sibling from @renderer’s focus sibling list
* (see gtk_cell_area_add_focus_sibling()).
@ -3002,9 +3002,9 @@ gtk_cell_area_remove_focus_sibling (GtkCellArea *area,
/**
* gtk_cell_area_is_focus_sibling:
* @area: a #GtkCellArea
* @renderer: the #GtkCellRenderer expected to have focus
* @sibling: the #GtkCellRenderer to check against @renderer’s sibling list
* @area: a `GtkCellArea`
* @renderer: the `GtkCellRenderer` expected to have focus
* @sibling: the `GtkCellRenderer` to check against @renderer’s sibling list
*
* Returns whether @sibling is one of @renderer’s focus siblings
* (see gtk_cell_area_add_focus_sibling()).
@ -3038,12 +3038,12 @@ gtk_cell_area_is_focus_sibling (GtkCellArea *area,
/**
* gtk_cell_area_get_focus_siblings:
* @area: a #GtkCellArea
* @renderer: the #GtkCellRenderer expected to have focus
* @area: a `GtkCellArea`
* @renderer: the `GtkCellRenderer` expected to have focus
*
* Gets the focus sibling cell renderers for @renderer.
*
* Returns: (element-type GtkCellRenderer) (transfer none): A #GList of #GtkCellRenderers.
* Returns: (element-type GtkCellRenderer) (transfer none): A `GList` of `GtkCellRenderer`s.
* The returned list is internal and should not be freed.
*/
const GList *
@ -3060,19 +3060,19 @@ gtk_cell_area_get_focus_siblings (GtkCellArea *area,
/**
* gtk_cell_area_get_focus_from_sibling:
* @area: a #GtkCellArea
* @renderer: the #GtkCellRenderer
* @area: a `GtkCellArea`
* @renderer: the `GtkCellRenderer`
*
* Gets the #GtkCellRenderer which is expected to be focusable
* Gets the `GtkCellRenderer` which is expected to be focusable
* for which @renderer is, or may be a sibling.
*
* This is handy for #GtkCellArea subclasses when handling events,
* This is handy for `GtkCellArea` subclasses when handling events,
* after determining the renderer at the event location it can
* then chose to activate the focus cell for which the event
* cell may have been a sibling.
*
* Returns: (nullable) (transfer none): the #GtkCellRenderer for which @renderer
* is a sibling
* Returns: (nullable) (transfer none): the `GtkCellRenderer`
* for which @renderer is a sibling
*/
GtkCellRenderer *
gtk_cell_area_get_focus_from_sibling (GtkCellArea *area,
@ -3206,12 +3206,12 @@ gtk_cell_area_set_edit_widget (GtkCellArea *area,
/**
* gtk_cell_area_get_edited_cell:
* @area: a #GtkCellArea
* @area: a `GtkCellArea`
*
* Gets the #GtkCellRenderer in @area that is currently
* Gets the `GtkCellRenderer` in @area that is currently
* being edited.
*
* Returns: (transfer none): The currently edited #GtkCellRenderer
* Returns: (transfer none): The currently edited `GtkCellRenderer`
*/
GtkCellRenderer *
gtk_cell_area_get_edited_cell (GtkCellArea *area)
@ -3225,12 +3225,12 @@ gtk_cell_area_get_edited_cell (GtkCellArea *area)
/**
* gtk_cell_area_get_edit_widget:
* @area: a #GtkCellArea
* @area: a `GtkCellArea`
*
* Gets the #GtkCellEditable widget currently used
* Gets the `GtkCellEditable` widget currently used
* to edit the currently edited cell.
*
* Returns: (transfer none): The currently active #GtkCellEditable widget
* Returns: (transfer none): The currently active `GtkCellEditable` widget
*/
GtkCellEditable *
gtk_cell_area_get_edit_widget (GtkCellArea *area)
@ -3244,16 +3244,16 @@ gtk_cell_area_get_edit_widget (GtkCellArea *area)
/**
* gtk_cell_area_activate_cell:
* @area: a #GtkCellArea
* @widget: the #GtkWidget that @area is rendering onto
* @renderer: the #GtkCellRenderer in @area to activate
* @event: the #GdkEvent for which cell activation should occur
* @cell_area: the #GdkRectangle in @widget relative coordinates
* @area: a `GtkCellArea`
* @widget: the `GtkWidget` that @area is rendering onto
* @renderer: the `GtkCellRenderer` in @area to activate
* @event: the `GdkEvent` for which cell activation should occur
* @cell_area: the `GdkRectangle` in @widget relative coordinates
* of @renderer for the current row.
* @flags: the #GtkCellRendererState for @renderer
* @flags: the `GtkCellRenderer`State for @renderer
*
* This is used by #GtkCellArea subclasses when handling events
* to activate cells, the base #GtkCellArea class activates cells
* This is used by `GtkCellArea` subclasses when handling events
* to activate cells, the base `GtkCellArea` class activates cells
* for keyboard events for free in its own GtkCellArea->activate()
* implementation.
*
@ -3340,7 +3340,7 @@ gtk_cell_area_activate_cell (GtkCellArea *area,
/**
* gtk_cell_area_stop_editing:
* @area: a #GtkCellArea
* @area: a `GtkCellArea`
* @canceled: whether editing was canceled.
*
* Explicitly stops the editing of the currently edited cell.
@ -3394,14 +3394,14 @@ gtk_cell_area_stop_editing (GtkCellArea *area,
/**
* gtk_cell_area_inner_cell_area:
* @area: a #GtkCellArea
* @widget: the #GtkWidget that @area is rendering onto
* @area: a `GtkCellArea`
* @widget: the `GtkWidget` that @area is rendering onto
* @cell_area: the @widget relative coordinates where one of @area’s cells
* is to be placed
* @inner_area: (out): the return location for the inner cell area
*
* This is a convenience function for #GtkCellArea implementations
* to get the inner area where a given #GtkCellRenderer will be
* This is a convenience function for `GtkCellArea` implementations
* to get the inner area where a given `GtkCellRenderer` will be
* rendered. It removes any padding previously added by gtk_cell_area_request_renderer().
*/
void
@ -3431,16 +3431,16 @@ gtk_cell_area_inner_cell_area (GtkCellArea *area,
/**
* gtk_cell_area_request_renderer:
* @area: a #GtkCellArea
* @renderer: the #GtkCellRenderer to request size for
* @orientation: the #GtkOrientation in which to request size
* @widget: the #GtkWidget that @area is rendering onto
* @area: a `GtkCellArea`
* @renderer: the `GtkCellRenderer` to request size for
* @orientation: the `GtkOrientation` in which to request size
* @widget: the `GtkWidget` that @area is rendering onto
* @for_size: the allocation contextual size to request for, or -1 if
* the base request for the orientation is to be returned.
* @minimum_size: (out) (optional): location to store the minimum size
* @natural_size: (out) (optional): location to store the natural size
*
* This is a convenience function for #GtkCellArea implementations
* This is a convenience function for `GtkCellArea` implementations
* to request size for cell renderers. It’s important to use this
* function to request size and then use gtk_cell_area_inner_cell_area()
* at render and event time since this function will add padding

58
gtk/gtkcellarea.h
View File

@ -45,10 +45,10 @@ typedef struct _GtkCellAreaContext GtkCellAreaContext;
/**
* GTK_CELL_AREA_WARN_INVALID_CELL_PROPERTY_ID:
* @object: the #GObject on which set_cell_property() or get_cell_property()
* @object: the `GObject` on which set_cell_property() or get_cell_property()
* was called
* @property_id: the numeric id of the property
* @pspec: the #GParamSpec of the property
* @pspec: the `GParamSpec` of the property
*
* This macro should be used to emit a standard warning about unexpected
* properties in set_cell_property() and get_cell_property() implementations.
@ -62,7 +62,7 @@ typedef struct _GtkCellAreaContext GtkCellAreaContext;
* @data: (closure): user-supplied data
*
* The type of the callback functions used for iterating over
* the cell renderers of a #GtkCellArea, see gtk_cell_area_foreach().
* the cell renderers of a `GtkCellArea`, see gtk_cell_area_foreach().
*
* Returns: %TRUE to stop iterating over cells.
*/
@ -79,7 +79,7 @@ typedef gboolean (*GtkCellCallback) (GtkCellRenderer *renderer,
* @data: (closure): user-supplied data
*
* The type of the callback functions used for iterating over the
* cell renderers and their allocated areas inside a #GtkCellArea,
* cell renderers and their allocated areas inside a `GtkCellArea`,
* see gtk_cell_area_foreach_alloc().
*
* Returns: %TRUE to stop iterating over cells.
@ -99,73 +99,73 @@ struct _GtkCellArea
/**
* GtkCellAreaClass:
* @add: adds a #GtkCellRenderer to the area.
* @remove: removes a #GtkCellRenderer from the area.
* @foreach: calls the #GtkCellCallback function on every #GtkCellRenderer in
* @add: adds a `GtkCellRenderer` to the area.
* @remove: removes a `GtkCellRenderer` from the area.
* @foreach: calls the `GtkCellCallback` function on every `GtkCellRenderer` in
* the area with the provided user data until the callback returns %TRUE.
* @foreach_alloc: Calls the #GtkCellAllocCallback function on every
* #GtkCellRenderer in the area with the allocated area for the cell
* @foreach_alloc: Calls the `GtkCellAllocCallback` function on every
* `GtkCellRenderer` in the area with the allocated area for the cell
* and the provided user data until the callback returns %TRUE.
* @event: Handle an event in the area, this is generally used to activate
* a cell at the event location for button events but can also be used
* to generically pass events to #GtkWidgets drawn onto the area.
* to generically pass events to `GtkWidget`s drawn onto the area.
* @snapshot: Actually snapshot the area’s cells to the specified rectangle,
* @background_area should be correctly distributed to the cells
* corresponding background areas.
* @apply_attributes: Apply the cell attributes to the cells. This is
* implemented as a signal and generally #GtkCellArea subclasses don't
* implemented as a signal and generally `GtkCellArea` subclasses don't
* need to implement it since it is handled by the base class.
* @create_context: Creates and returns a class specific #GtkCellAreaContext
* to store cell alignment and allocation details for a said #GtkCellArea
* @create_context: Creates and returns a class specific `GtkCellAreaContext`
* to store cell alignment and allocation details for a said `GtkCellArea`
* class.
* @copy_context: Creates a new #GtkCellAreaContext in the same state as
* @copy_context: Creates a new `GtkCellAreaContext` in the same state as
* the passed @context with any cell alignment data and allocations intact.
* @get_request_mode: This allows an area to tell its layouting widget whether
* it prefers to be allocated in %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH or
* %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT mode.
* @get_preferred_width: Calculates the minimum and natural width of the
* areas cells with the current attributes applied while considering
* the particular layouting details of the said #GtkCellArea. While
* the particular layouting details of the said `GtkCellArea`. While
* requests are performed over a series of rows, alignments and overall
* minimum and natural sizes should be stored in the corresponding
* #GtkCellAreaContext.
* `GtkCellAreaContext`.
* @get_preferred_height_for_width: Calculates the minimum and natural height
* for the area if the passed @context would be allocated the given width.
* When implementing this virtual method it is safe to assume that @context
* has already stored the aligned cell widths for every #GtkTreeModel row
* has already stored the aligned cell widths for every `GtkTreeModel` row
* that @context will be allocated for since this information was stored
* at #GtkCellAreaClass.get_preferred_width() time. This virtual method
* at `GtkCellAreaClass.get_preferred_width()` time. This virtual method
* should also store any necessary alignments of cell heights for the
* case that the context is allocated a height.
* @get_preferred_height: Calculates the minimum and natural height of the
* areas cells with the current attributes applied. Essentially this is
* the same as #GtkCellAreaClass.get_preferred_width() only for areas
* the same as `GtkCellAreaClass.get_preferred_width()` only for areas
* that are being requested as %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT.
* @get_preferred_width_for_height: Calculates the minimum and natural width
* for the area if the passed @context would be allocated the given
* height. The same as #GtkCellAreaClass.get_preferred_height_for_width()
* height. The same as `GtkCellAreaClass.get_preferred_height_for_width()`
* only for handling requests in the %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT
* mode.
* @set_cell_property: This should be implemented to handle changes in child
* cell properties for a given #GtkCellRenderer that were previously
* installed on the #GtkCellAreaClass with gtk_cell_area_class_install_cell_property().
* cell properties for a given `GtkCellRenderer` that were previously
* installed on the `GtkCellAreaClass` with gtk_cell_area_class_install_cell_property().
* @get_cell_property: This should be implemented to report the values of
* child cell properties for a given child #GtkCellRenderer.
* child cell properties for a given child `GtkCellRenderer`.
* @focus: This virtual method should be implemented to navigate focus from
* cell to cell inside the #GtkCellArea. The #GtkCellArea should move
* cell to cell inside the `GtkCellArea`. The `GtkCellArea` should move
* focus from cell to cell inside the area and return %FALSE if focus
* logically leaves the area with the following exceptions: When the
* area contains no activatable cells, the entire area receives focus.
* Focus should not be given to cells that are actually “focus siblings”
* of other sibling cells (see gtk_cell_area_get_focus_from_sibling()).
* Focus is set by calling gtk_cell_area_set_focus_cell().
* @is_activatable: Returns whether the #GtkCellArea can respond to
* #GtkCellAreaClass.activate(), usually this does not need to be
* @is_activatable: Returns whether the `GtkCellArea` can respond to
* `GtkCellAreaClass.activate()`, usually this does not need to be
* implemented since the base class takes care of this however it can
* be enhanced if the #GtkCellArea subclass can handle activation in
* other ways than activating its #GtkCellRenderers.
* be enhanced if the `GtkCellArea` subclass can handle activation in
* other ways than activating its `GtkCellRenderers`.
* @activate: This is called when the layouting widget rendering the
* #GtkCellArea activates the focus cell (see gtk_cell_area_get_focus_cell()).
* `GtkCellArea` activates the focus cell (see gtk_cell_area_get_focus_cell()).
*/
struct _GtkCellAreaClass
{

34
gtk/gtkcellareabox.c
View File

@ -25,21 +25,21 @@
*
* A cell area that renders GtkCellRenderers into a row or a column
*
* The #GtkCellAreaBox renders cell renderers into a row or a column
* depending on its #GtkOrientation.
* The `GtkCellAreaBox` renders cell renderers into a row or a column
* depending on its `GtkOrientation`.
*
* GtkCellAreaBox uses a notion of packing. Packing
* refers to adding cell renderers with reference to a particular position
* in a #GtkCellAreaBox. There are two reference positions: the
* in a `GtkCellAreaBox`. There are two reference positions: the
* start and the end of the box.
* When the #GtkCellAreaBox is oriented in the %GTK_ORIENTATION_VERTICAL
* When the `GtkCellAreaBox` is oriented in the %GTK_ORIENTATION_VERTICAL
* orientation, the start is defined as the top of the box and the end is
* defined as the bottom. In the %GTK_ORIENTATION_HORIZONTAL orientation
* start is defined as the left side and the end is defined as the right
* side.
*
* Alignments of #GtkCellRenderers rendered in adjacent rows can be
* configured by configuring the #GtkCellAreaBox align child cell property
* Alignments of `GtkCellRenderer`s rendered in adjacent rows can be
* configured by configuring the `GtkCellAreaBox` align child cell property
* with gtk_cell_area_cell_set_property() or by specifying the "align"
* argument to gtk_cell_area_box_pack_start() and gtk_cell_area_box_pack_end().
*/
@ -2112,9 +2112,9 @@ _gtk_cell_area_box_group_visible (GtkCellAreaBox *box,
/**
* gtk_cell_area_box_new:
*
* Creates a new #GtkCellAreaBox.
* Creates a new `GtkCellAreaBox`.
*
* Returns: a newly created #GtkCellAreaBox
* Returns: a newly created `GtkCellAreaBox`
*/
GtkCellArea *
gtk_cell_area_box_new (void)
@ -2124,8 +2124,8 @@ gtk_cell_area_box_new (void)
/**
* gtk_cell_area_box_pack_start:
* @box: a #GtkCellAreaBox
* @renderer: the #GtkCellRenderer to add
* @box: a `GtkCellAreaBox`
* @renderer: the `GtkCellRenderer` to add
* @expand: whether @renderer should receive extra space when the area receives
* more than its natural size
* @align: whether @renderer should be aligned in adjacent rows
@ -2133,7 +2133,7 @@ gtk_cell_area_box_new (void)
*
* Adds @renderer to @box, packed with reference to the start of @box.
*
* The @renderer is packed after any other #GtkCellRenderer packed
* The @renderer is packed after any other `GtkCellRenderer` packed
* with reference to the start of @box.
*/
void
@ -2165,8 +2165,8 @@ gtk_cell_area_box_pack_start (GtkCellAreaBox *box,
/**
* gtk_cell_area_box_pack_end:
* @box: a #GtkCellAreaBox
* @renderer: the #GtkCellRenderer to add
* @box: a `GtkCellAreaBox`
* @renderer: the `GtkCellRenderer` to add
* @expand: whether @renderer should receive extra space when the area receives
* more than its natural size
* @align: whether @renderer should be aligned in adjacent rows
@ -2175,7 +2175,7 @@ gtk_cell_area_box_pack_start (GtkCellAreaBox *box,
* Adds @renderer to @box, packed with reference to the end of @box.
*
* The @renderer is packed after (away from end of) any other
* #GtkCellRenderer packed with reference to the end of @box.
* `GtkCellRenderer` packed with reference to the end of @box.
*/
void
gtk_cell_area_box_pack_end (GtkCellAreaBox *box,
@ -2206,7 +2206,7 @@ gtk_cell_area_box_pack_end (GtkCellAreaBox *box,
/**
* gtk_cell_area_box_get_spacing:
* @box: a #GtkCellAreaBox
* @box: a `GtkCellAreaBox`
*
* Gets the spacing added between cell renderers.
*
@ -2224,8 +2224,8 @@ gtk_cell_area_box_get_spacing (GtkCellAreaBox *box)
/**
* gtk_cell_area_box_set_spacing:
* @box: a #GtkCellAreaBox
* @spacing: the space to add between #GtkCellRenderers
* @box: a `GtkCellAreaBox`
* @spacing: the space to add between `GtkCellRenderer`s
*
* Sets the spacing to add between cell renderers in @box.
*/

84
gtk/gtkcellareacontext.c
View File

@ -24,15 +24,15 @@
*
* Stores geometrical information for a series of rows in a GtkCellArea
*
* The #GtkCellAreaContext object is created by a given #GtkCellArea
* implementation via its #GtkCellAreaClass.create_context() virtual
* The `GtkCellAreaContext` object is created by a given `GtkCellArea`
* implementation via its `GtkCellAreaClass.create_context()` virtual
* method and is used to store cell sizes and alignments for a series of
* #GtkTreeModel rows that are requested and rendered in the same context.
* `GtkTreeModel` rows that are requested and rendered in the same context.
*
* #GtkCellLayout widgets can create any number of contexts in which to
* `GtkCellLayout` widgets can create any number of contexts in which to
* request and render groups of data rows. However, it’s important that the
* same context which was used to request sizes for a given #GtkTreeModel
* row also be used for the same row when calling other #GtkCellArea APIs
* same context which was used to request sizes for a given `GtkTreeModel`
* row also be used for the same row when calling other `GtkCellArea` APIs
* such as gtk_cell_area_render() and gtk_cell_area_event().
*/
@ -105,7 +105,7 @@ gtk_cell_area_context_class_init (GtkCellAreaContextClass *class)
/**
* GtkCellAreaContext:area:
*
* The #GtkCellArea this context was created by
* The `GtkCellArea` this context was created by
*/
g_object_class_install_property (object_class,
PROP_CELL_AREA,
@ -118,8 +118,8 @@ gtk_cell_area_context_class_init (GtkCellAreaContextClass *class)
/**
* GtkCellAreaContext:minimum-width:
*
* The minimum width for the #GtkCellArea in this context
* for all #GtkTreeModel rows that this context was requested
* The minimum width for the `GtkCellArea` in this context
* for all `GtkTreeModel` rows that this context was requested
* for using gtk_cell_area_get_preferred_width().
*/
g_object_class_install_property (object_class,
@ -133,8 +133,8 @@ gtk_cell_area_context_class_init (GtkCellAreaContextClass *class)
/**
* GtkCellAreaContext:natural-width:
*
* The natural width for the #GtkCellArea in this context
* for all #GtkTreeModel rows that this context was requested
* The natural width for the `GtkCellArea` in this context
* for all `GtkTreeModel` rows that this context was requested
* for using gtk_cell_area_get_preferred_width().
*/
g_object_class_install_property (object_class,
@ -148,8 +148,8 @@ gtk_cell_area_context_class_init (GtkCellAreaContextClass *class)
/**
* GtkCellAreaContext:minimum-height:
*
* The minimum height for the #GtkCellArea in this context
* for all #GtkTreeModel rows that this context was requested
* The minimum height for the `GtkCellArea` in this context
* for all `GtkTreeModel` rows that this context was requested
* for using gtk_cell_area_get_preferred_height().
*/
g_object_class_install_property (object_class,
@ -163,8 +163,8 @@ gtk_cell_area_context_class_init (GtkCellAreaContextClass *class)
/**
* GtkCellAreaContext:natural-height:
*
* The natural height for the #GtkCellArea in this context
* for all #GtkTreeModel rows that this context was requested
* The natural height for the `GtkCellArea` in this context
* for all `GtkTreeModel` rows that this context was requested
* for using gtk_cell_area_get_preferred_height().
*/
g_object_class_install_property (object_class,
@ -303,20 +303,20 @@ gtk_cell_area_context_real_allocate (GtkCellAreaContext *context,
*************************************************************/
/**
* gtk_cell_area_context_get_area:
* @context: a #GtkCellAreaContext
* @context: a `GtkCellAreaContext`
*
* Fetches the #GtkCellArea this @context was created by.
* Fetches the `GtkCellArea` this @context was created by.
*
* This is generally unneeded by layouting widgets; however,
* it is important for the context implementation itself to
* fetch information about the area it is being used for.
*
* For instance at #GtkCellAreaContextClass.allocate() time
* For instance at `GtkCellAreaContextClass.allocate()` time
* it’s important to know details about any cell spacing
* that the #GtkCellArea is configured with in order to
* that the `GtkCellArea` is configured with in order to
* compute a proper allocation.
*
* Returns: (transfer none): the #GtkCellArea this context was created by.
* Returns: (transfer none): the `GtkCellArea` this context was created by.
*/
GtkCellArea *
gtk_cell_area_context_get_area (GtkCellAreaContext *context)
@ -330,12 +330,12 @@ gtk_cell_area_context_get_area (GtkCellAreaContext *context)
/**
* gtk_cell_area_context_reset:
* @context: a #GtkCellAreaContext
* @context: a `GtkCellAreaContext`
*
* Resets any previously cached request and allocation
* data.
*
* When underlying #GtkTreeModel data changes its
* When underlying `GtkTreeModel` data changes its
* important to reset the context if the content
* size is allowed to shrink. If the content size
* is only allowed to grow (this is usually an option
@ -365,10 +365,10 @@ gtk_cell_area_context_reset (GtkCellAreaContext *context)
/**
* gtk_cell_area_context_allocate:
* @context: a #GtkCellAreaContext
* @width: the allocated width for all #GtkTreeModel rows rendered
* @context: a `GtkCellAreaContext`
* @width: the allocated width for all `GtkTreeModel` rows rendered
* with @context, or -1
* @height: the allocated height for all #GtkTreeModel rows rendered
* @height: the allocated height for all `GtkTreeModel` rows rendered
* with @context, or -1
*
* Allocates a width and/or a height for all rows which are to be
@ -379,8 +379,8 @@ gtk_cell_area_context_reset (GtkCellAreaContext *context)
* side vertically or horizontally and share either the same width
* or the same height. Sometimes they are allocated in both horizontal
* and vertical orientations producing a homogeneous effect of the
* rows. This is generally the case for #GtkTreeView when
* #GtkTreeView:fixed-height-mode is enabled.
* rows. This is generally the case for `GtkTreeView` when
* `GtkTreeView:fixed-height-mode` is enabled.
*/
void
gtk_cell_area_context_allocate (GtkCellAreaContext *context,
@ -394,7 +394,7 @@ gtk_cell_area_context_allocate (GtkCellAreaContext *context,
/**
* gtk_cell_area_context_get_preferred_width:
* @context: a #GtkCellAreaContext
* @context: a `GtkCellAreaContext`
* @minimum_width: (out) (optional): location to store the minimum width
* @natural_width: (out) (optional): location to store the natural width
*
@ -402,7 +402,7 @@ gtk_cell_area_context_allocate (GtkCellAreaContext *context,
* requested with this context.
*
* After gtk_cell_area_context_reset() is called and/or before ever
* requesting the size of a #GtkCellArea, the returned values are 0.
* requesting the size of a `GtkCellArea`, the returned values are 0.
*/
void
gtk_cell_area_context_get_preferred_width (GtkCellAreaContext *context,
@ -422,7 +422,7 @@ gtk_cell_area_context_get_preferred_width (GtkCellAreaContext *context,
/**
* gtk_cell_area_context_get_preferred_height:
* @context: a #GtkCellAreaContext
* @context: a `GtkCellAreaContext`
* @minimum_height: (out) (optional): location to store the minimum height
* @natural_height: (out) (optional): location to store the natural height
*
@ -430,7 +430,7 @@ gtk_cell_area_context_get_preferred_width (GtkCellAreaContext *context,
* requested with this context.
*
* After gtk_cell_area_context_reset() is called and/or before ever
* requesting the size of a #GtkCellArea, the returned values are 0.
* requesting the size of a `GtkCellArea`, the returned values are 0.
*/
void
gtk_cell_area_context_get_preferred_height (GtkCellAreaContext *context,
@ -450,7 +450,7 @@ gtk_cell_area_context_get_preferred_height (GtkCellAreaContext *context,
/**
* gtk_cell_area_context_get_preferred_height_for_width:
* @context: a #GtkCellAreaContext
* @context: a `GtkCellAreaContext`
* @width: a proposed width for allocation
* @minimum_height: (out) (optional): location to store the minimum height
* @natural_height: (out) (optional): location to store the natural height
@ -459,7 +459,7 @@ gtk_cell_area_context_get_preferred_height (GtkCellAreaContext *context,
* which have been requested for the same said @width with this context.
*
* After gtk_cell_area_context_reset() is called and/or before ever
* requesting the size of a #GtkCellArea, the returned values are -1.
* requesting the size of a `GtkCellArea`, the returned values are -1.
*/
void
gtk_cell_area_context_get_preferred_height_for_width (GtkCellAreaContext *context,
@ -478,7 +478,7 @@ gtk_cell_area_context_get_preferred_height_for_width (GtkCellAreaContext *contex
/**
* gtk_cell_area_context_get_preferred_width_for_height:
* @context: a #GtkCellAreaContext
* @context: a `GtkCellAreaContext`
* @height: a proposed height for allocation
* @minimum_width: (out) (optional): location to store the minimum width
* @natural_width: (out) (optional): location to store the natural width
@ -487,7 +487,7 @@ gtk_cell_area_context_get_preferred_height_for_width (GtkCellAreaContext *contex
* have been requested for the same said @height with this context.
*
* After gtk_cell_area_context_reset() is called and/or before ever
* requesting the size of a #GtkCellArea, the returned values are -1.
* requesting the size of a `GtkCellArea`, the returned values are -1.
*/
void
gtk_cell_area_context_get_preferred_width_for_height (GtkCellAreaContext *context,
@ -506,7 +506,7 @@ gtk_cell_area_context_get_preferred_width_for_height (GtkCellAreaContext *contex
/**
* gtk_cell_area_context_get_allocation:
* @context: a #GtkCellAreaContext
* @context: a `GtkCellAreaContext`
* @width: (out) (optional): location to store the allocated width
* @height: (out) (optional): location to store the allocated height
*
@ -534,15 +534,15 @@ gtk_cell_area_context_get_allocation (GtkCellAreaContext *context,
/**
* gtk_cell_area_context_push_preferred_width:
* @context: a #GtkCellAreaContext
* @context: a `GtkCellAreaContext`
* @minimum_width: the proposed new minimum width for @context
* @natural_width: the proposed new natural width for @context
*
* Causes the minimum and/or natural width to grow if the new
* proposed sizes exceed the current minimum and natural width.
*
* This is used by #GtkCellAreaContext implementations during
* the request process over a series of #GtkTreeModel rows to
* This is used by `GtkCellAreaContext` implementations during
* the request process over a series of `GtkTreeModel` rows to
* progressively push the requested width over a series of
* gtk_cell_area_get_preferred_width() requests.
*/
@ -576,15 +576,15 @@ gtk_cell_area_context_push_preferred_width (GtkCellAreaContext *context,
/**
* gtk_cell_area_context_push_preferred_height:
* @context: a #GtkCellAreaContext
* @context: a `GtkCellAreaContext`
* @minimum_height: the proposed new minimum height for @context
* @natural_height: the proposed new natural height for @context
*
* Causes the minimum and/or natural height to grow if the new
* proposed sizes exceed the current minimum and natural height.
*
* This is used by #GtkCellAreaContext implementations during
* the request process over a series of #GtkTreeModel rows to
* This is used by `GtkCellAreaContext` implementations during
* the request process over a series of `GtkTreeModel` rows to
* progressively push the requested height over a series of
* gtk_cell_area_get_preferred_height() requests.
*/

44
gtk/gtkcelleditable.c
View File

@ -20,8 +20,8 @@
*
* Interface for widgets that can be used for editing cells
*
* The #GtkCellEditable interface must be implemented for widgets to be usable
* to edit the contents of a #GtkTreeView cell. It provides a way to specify how
* The `GtkCellEditable` interface must be implemented for widgets to be usable
* to edit the contents of a `GtkTreeView` cell. It provides a way to specify how
* temporary widgets should be configured for editing, get the new value, etc.
*/
@ -57,14 +57,14 @@ gtk_cell_editable_default_init (GtkCellEditableInterface *iface)
* This signal is a sign for the cell renderer to update its
* value from the @cell_editable.
*
* Implementations of #GtkCellEditable are responsible for
* Implementations of `GtkCellEditable` are responsible for
* emitting this signal when they are done editing, e.g.
* #GtkEntry emits this signal when the user presses Enter. Typical things to
* `GtkEntry` emits this signal when the user presses Enter. Typical things to
* do in a handler for ::editing-done are to capture the edited value,
* disconnect the @cell_editable from signals on the #GtkCellRenderer, etc.
* disconnect the @cell_editable from signals on the `GtkCellRenderer`, etc.
*
* gtk_cell_editable_editing_done() is a convenience method
* for emitting #GtkCellEditable::editing-done.
* for emitting `GtkCellEditable::editing-done`.
*/
g_signal_new (I_("editing-done"),
GTK_TYPE_CELL_EDITABLE,
@ -82,14 +82,14 @@ gtk_cell_editable_default_init (GtkCellEditableInterface *iface)
* editing, and the @cell_editable widget is being removed and may
* subsequently be destroyed.
*
* Implementations of #GtkCellEditable are responsible for
* Implementations of `GtkCellEditable` are responsible for
* emitting this signal when they are done editing. It must
* be emitted after the #GtkCellEditable::editing-done signal,
* be emitted after the `GtkCellEditable::editing-done` signal,
* to give the cell renderer a chance to update the cell's value
* before the widget is removed.
*
* gtk_cell_editable_remove_widget() is a convenience method
* for emitting #GtkCellEditable::remove-widget.
* for emitting `GtkCellEditable::remove-widget`.
*/
g_signal_new (I_("remove-widget"),
GTK_TYPE_CELL_EDITABLE,
@ -102,17 +102,17 @@ gtk_cell_editable_default_init (GtkCellEditableInterface *iface)
/**
* gtk_cell_editable_start_editing:
* @cell_editable: A #GtkCellEditable
* @event: (nullable): The #GdkEvent that began the editing process, or
* @cell_editable: A `GtkCellEditable`
* @event: (nullable): The `GdkEvent` that began the editing process, or
* %NULL if editing was initiated programmatically
*
*
* Begins editing on a @cell_editable.
*
* The #GtkCellRenderer for the cell creates and returns a #GtkCellEditable from
* gtk_cell_renderer_start_editing(), configured for the #GtkCellRenderer type.
* The `GtkCellRenderer` for the cell creates and returns a `GtkCellEditable` from
* gtk_cell_renderer_start_editing(), configured for the `GtkCellRenderer` type.
*
* gtk_cell_editable_start_editing() can then set up @cell_editable suitably for
* editing a cell, e.g. making the Esc key emit #GtkCellEditable::editing-done.
* editing a cell, e.g. making the Esc key emit `GtkCellEditable::editing-done`.
*
* Note that the @cell_editable is created on-demand for the current edit; its
* lifetime is temporary and does not persist across other edits and/or cells.
@ -128,10 +128,10 @@ gtk_cell_editable_start_editing (GtkCellEditable *cell_editable,
/**
* gtk_cell_editable_editing_done:
* @cell_editable: A #GtkCellEditable
*
* Emits the #GtkCellEditable::editing-done signal.
**/
* @cell_editable: A `GtkCellEditable`
*
* Emits the `GtkCellEditable::editing-done` signal.
*/
void
gtk_cell_editable_editing_done (GtkCellEditable *cell_editable)
{
@ -142,9 +142,9 @@ gtk_cell_editable_editing_done (GtkCellEditable *cell_editable)
/**
* gtk_cell_editable_remove_widget:
* @cell_editable: A #GtkCellEditable
*
* Emits the #GtkCellEditable::remove-widget signal.
* @cell_editable: A `GtkCellEditable`
*
* Emits the `GtkCellEditable::remove-widget` signal.
**/
void
gtk_cell_editable_remove_widget (GtkCellEditable *cell_editable)

62
gtk/gtkcelllayout.c
View File

@ -20,12 +20,12 @@
*
* An interface for packing cells
*
* #GtkCellLayout is an interface to be implemented by all objects which
* want to provide a #GtkTreeViewColumn like API for packing cells,
* `GtkCellLayout` is an interface to be implemented by all objects which
* want to provide a `GtkTreeViewColumn` like API for packing cells,
* setting attributes and data funcs.
*
* One of the notable features provided by implementations of
* GtkCellLayout are attributes. Attributes let you set the properties
* `GtkCellLayout` are attributes. Attributes let you set the properties
* in flexible ways. They can just be set to constant values like regular
* properties. But they can also be mapped to a column of the underlying
* tree model with gtk_cell_layout_set_attributes(), which means that the value
@ -37,8 +37,8 @@
* # GtkCellLayouts as GtkBuildable
*
* Implementations of GtkCellLayout which also implement the GtkBuildable
* interface (#GtkCellView, #GtkIconView, #GtkComboBox,
* #GtkEntryCompletion, #GtkTreeViewColumn) accept GtkCellRenderer objects
* interface (`GtkCellView`, `GtkIconView`, `GtkComboBox`,
* `GtkEntryCompletion`, `GtkTreeViewColumn`) accept `GtkCellRenderer` objects
* as <child> elements in UI definitions. They support a custom <attributes>
* element for their children, which can contain multiple <attribute>
* elements. Each <attribute> element has a name attribute which specifies
@ -57,7 +57,7 @@
* </object>
* ]|
*
* Furthermore for implementations of GtkCellLayout that use a #GtkCellArea
* Furthermore for implementations of GtkCellLayout that use a `GtkCellArea`
* to lay out cells (all GtkCellLayouts in GTK use a GtkCellArea)
* [cell properties][cell-properties] can also be defined in the format by
* specifying the custom <cell-packing> attribute which can contain multiple
@ -79,9 +79,9 @@
*
* # Subclassing GtkCellLayout implementations
*
* When subclassing a widget that implements #GtkCellLayout like
* #GtkIconView or #GtkComboBox, there are some considerations related
* to the fact that these widgets internally use a #GtkCellArea.
* When subclassing a widget that implements `GtkCellLayout` like
* `GtkIconView` or `GtkComboBox`, there are some considerations related
* to the fact that these widgets internally use a `GtkCellArea`.
* The cell area is exposed as a construct-only property by these
* widgets. This means that it is possible to e.g. do
*
@ -349,8 +349,8 @@ gtk_cell_layout_default_get_cells (GtkCellLayout *cell_layout)
/**
* gtk_cell_layout_pack_start:
* @cell_layout: a #GtkCellLayout
* @cell: a #GtkCellRenderer
* @cell_layout: a `GtkCellLayout`
* @cell: a `GtkCellRenderer`
* @expand: %TRUE if @cell is to be given extra space allocated to @cell_layout
*
* Packs the @cell into the beginning of @cell_layout. If @expand is %FALSE,
@ -372,8 +372,8 @@ gtk_cell_layout_pack_start (GtkCellLayout *cell_layout,
/**
* gtk_cell_layout_pack_end:
* @cell_layout: a #GtkCellLayout
* @cell: a #GtkCellRenderer
* @cell_layout: a `GtkCellLayout`
* @cell: a `GtkCellRenderer`
* @expand: %TRUE if @cell is to be given extra space allocated to @cell_layout
*
* Adds the @cell to the end of @cell_layout. If @expand is %FALSE, then the
@ -395,7 +395,7 @@ gtk_cell_layout_pack_end (GtkCellLayout *cell_layout,
/**
* gtk_cell_layout_clear:
* @cell_layout: a #GtkCellLayout
* @cell_layout: a `GtkCellLayout`
*
* Unsets all the mappings on all renderers on @cell_layout and
* removes all renderers from @cell_layout.
@ -432,8 +432,8 @@ gtk_cell_layout_set_attributesv (GtkCellLayout *cell_layout,
/**
* gtk_cell_layout_set_attributes:
* @cell_layout: a #GtkCellLayout
* @cell: a #GtkCellRenderer
* @cell_layout: a `GtkCellLayout`
* @cell: a `GtkCellRenderer`
* @...: a %NULL-terminated list of attributes
*
* Sets the attributes in list as the attributes of @cell_layout.
@ -459,8 +459,8 @@ gtk_cell_layout_set_attributes (GtkCellLayout *cell_layout,
/**
* gtk_cell_layout_add_attribute:
* @cell_layout: a #GtkCellLayout
* @cell: a #GtkCellRenderer
* @cell_layout: a `GtkCellLayout`
* @cell: a `GtkCellRenderer`
* @attribute: an attribute on the renderer
* @column: the column position on the model to get the attribute from
*
@ -469,7 +469,7 @@ gtk_cell_layout_set_attributes (GtkCellLayout *cell_layout,
* The @column is the column of the model to get a value from, and the
* @attribute is the parameter on @cell to be set from the value. So for
* example if column 2 of the model contains strings, you could have the
* “text” attribute of a #GtkCellRendererText get its values from column 2.
* “text” attribute of a `GtkCellRendererText` get its values from column 2.
*/
void
gtk_cell_layout_add_attribute (GtkCellLayout *cell_layout,
@ -487,13 +487,13 @@ gtk_cell_layout_add_attribute (GtkCellLayout *cell_layout,
/**
* gtk_cell_layout_set_cell_data_func:
* @cell_layout: a #GtkCellLayout
* @cell: a #GtkCellRenderer
* @func: (nullable): the #GtkCellLayoutDataFunc to use
* @cell_layout: a `GtkCellLayout`
* @cell: a `GtkCellRenderer`
* @func: (nullable): the `GtkCellLayout`DataFunc to use
* @func_data: (closure): user data for @func
* @destroy: destroy notify for @func_data
*
* Sets the #GtkCellLayoutDataFunc to use for @cell_layout.
* Sets the `GtkCellLayout`DataFunc to use for @cell_layout.
*
* This function is used instead of the standard attributes mapping
* for setting the column value, and should set the value of @cell_layout’s
@ -517,8 +517,8 @@ gtk_cell_layout_set_cell_data_func (GtkCellLayout *cell_layout,
/**
* gtk_cell_layout_clear_attributes:
* @cell_layout: a #GtkCellLayout
* @cell: a #GtkCellRenderer to clear the attribute mapping on
* @cell_layout: a `GtkCellLayout`
* @cell: a `GtkCellRenderer` to clear the attribute mapping on
*
* Clears all existing attributes previously set with
* gtk_cell_layout_set_attributes().
@ -535,8 +535,8 @@ gtk_cell_layout_clear_attributes (GtkCellLayout *cell_layout,
/**
* gtk_cell_layout_reorder:
* @cell_layout: a #GtkCellLayout
* @cell: a #GtkCellRenderer to reorder
* @cell_layout: a `GtkCellLayout`
* @cell: a `GtkCellRenderer` to reorder
* @position: new position to insert @cell at
*
* Re-inserts @cell at @position.
@ -557,7 +557,7 @@ gtk_cell_layout_reorder (GtkCellLayout *cell_layout,
/**
* gtk_cell_layout_get_cells:
* @cell_layout: a #GtkCellLayout
* @cell_layout: a `GtkCellLayout`
*
* Returns the cell renderers which have been added to @cell_layout.
*
@ -576,10 +576,10 @@ gtk_cell_layout_get_cells (GtkCellLayout *cell_layout)
/**
* gtk_cell_layout_get_area:
* @cell_layout: a #GtkCellLayout
* @cell_layout: a `GtkCellLayout`
*
* Returns the underlying #GtkCellArea which might be @cell_layout
* if called on a #GtkCellArea or might be %NULL if no #GtkCellArea
* Returns the underlying `GtkCellArea` which might be @cell_layout
* if called on a `GtkCellArea` or might be %NULL if no `GtkCellArea`
* is used by @cell_layout.
*
* Returns: (transfer none) (nullable): the cell area used by @cell_layout

12
gtk/gtkcelllayout.h
View File

@ -40,10 +40,10 @@ typedef struct _GtkCellLayoutIface GtkCellLayoutIface;
/* keep in sync with GtkTreeCellDataFunc */
/**
* GtkCellLayoutDataFunc:
* @cell_layout: a #GtkCellLayout
* @cell_layout: a `GtkCellLayout`
* @cell: the cell renderer whose value is to be set
* @tree_model: the model
* @iter: a #GtkTreeIter indicating the row to set the value for
* @iter: a `GtkTreeIter` indicating the row to set the value for
* @data: (closure): user data passed to gtk_cell_layout_set_cell_data_func()
*
* A function which should set the value of @cell_layout’s cell renderer(s)
@ -63,16 +63,16 @@ typedef void (* GtkCellLayoutDataFunc) (GtkCellLayout *cell_layout,
* removes all renderers from cell_layout.
* @add_attribute: Adds an attribute mapping to the list in
* cell_layout.
* @set_cell_data_func: Sets the #GtkCellLayoutDataFunc to use for
* @set_cell_data_func: Sets the `GtkCellLayout`DataFunc to use for
* cell_layout.
* @clear_attributes: Clears all existing attributes previously set
* with gtk_cell_layout_set_attributes().
* @reorder: Re-inserts cell at position.
* @get_cells: Get the cell renderers which have been added to
* cell_layout.
* @get_area: Get the underlying #GtkCellArea which might be
* cell_layout if called on a #GtkCellArea or might be NULL if no
* #GtkCellArea is used by cell_layout.
* @get_area: Get the underlying `GtkCellArea` which might be
* cell_layout if called on a `GtkCellArea` or might be NULL if no
* `GtkCellArea` is used by cell_layout.
*/
struct _GtkCellLayoutIface
{

168
gtk/gtkcellrenderer.c
View File

@ -32,38 +32,38 @@
*
* An object for rendering a single cell
*
* The #GtkCellRenderer is a base class of a set of objects used for
* rendering a cell to a #cairo_t. These objects are used primarily by
* the #GtkTreeView widget, though they aren’t tied to them in any
* specific way. It is worth noting that #GtkCellRenderer is not a
* #GtkWidget and cannot be treated as such.
* The `GtkCellRenderer` is a base class of a set of objects used for
* rendering a cell to a `cairo_t`. These objects are used primarily by
* the `GtkTreeView` widget, though they aren’t tied to them in any
* specific way. It is worth noting that `GtkCellRenderer` is not a
* `GtkWidget` and cannot be treated as such.
*
* The primary use of a #GtkCellRenderer is for drawing a certain graphical
* elements on a #cairo_t. Typically, one cell renderer is used to
* The primary use of a `GtkCellRenderer` is for drawing a certain graphical
* elements on a `cairo_t`. Typically, one cell renderer is used to
* draw many cells on the screen. To this extent, it isn’t expected that a
* CellRenderer keep any permanent state around. Instead, any state is set
* just prior to use using #GObjects property system. Then, the
* just prior to use using `GObject`s property system. Then, the
* cell is measured using gtk_cell_renderer_get_preferred_size(). Finally, the cell
* is rendered in the correct location using gtk_cell_renderer_snapshot().
*
* There are a number of rules that must be followed when writing a new
* #GtkCellRenderer. First and foremost, it’s important that a certain set
* `GtkCellRenderer`. First and foremost, it’s important that a certain set
* of properties will always yield a cell renderer of the same size,
* barring a style change. The #GtkCellRenderer also has a number of
* barring a style change. The `GtkCellRenderer` also has a number of
* generic properties that are expected to be honored by all children.
*
* Beyond merely rendering a cell, cell renderers can optionally
* provide active user interface elements. A cell renderer can be
* “activatable” like #GtkCellRendererToggle,
* “activatable” like `GtkCellRenderer`Toggle,
* which toggles when it gets activated by a mouse click, or it can be
* “editable” like #GtkCellRendererText, which
* “editable” like `GtkCellRenderer`Text, which
* allows the user to edit the text using a widget implementing the
* #GtkCellEditable interface, e.g. #GtkEntry.
* `GtkCellEditable` interface, e.g. `GtkEntry`.
* To make a cell renderer activatable or editable, you have to
* implement the #GtkCellRendererClass.activate or
* #GtkCellRendererClass.start_editing virtual functions, respectively.
* implement the `GtkCellRenderer`Class.activate or
* `GtkCellRenderer`Class.start_editing virtual functions, respectively.
*
* Many properties of #GtkCellRenderer and its subclasses have a
* Many properties of `GtkCellRenderer` and its subclasses have a
* corresponding “set” property, e.g. “cell-background-set” corresponds
* to “cell-background”. These “set” properties reflect whether a property
* has been set or not. You should not set them independently.
@ -228,13 +228,13 @@ gtk_cell_renderer_class_init (GtkCellRendererClass *class)
/**
* GtkCellRenderer::editing-started:
* @renderer: the object which received the signal
* @editable: the #GtkCellEditable
* @editable: the `GtkCellEditable`
* @path: the path identifying the edited cell
*
* This signal gets emitted when a cell starts to be edited.
* The intended use of this signal is to do special setup
* on @editable, e.g. adding a #GtkEntryCompletion or setting
* up additional columns in a #GtkComboBox.
* on @editable, e.g. adding a `GtkEntryCompletion` or setting
* up additional columns in a `GtkComboBox`.
*
* See gtk_cell_editable_start_editing() for information on the lifecycle of
* the @editable and a way to do setup that doesn’t depend on the @renderer.
@ -387,7 +387,7 @@ gtk_cell_renderer_class_init (GtkCellRendererClass *class)
/**
* GtkCellRenderer:cell-background-rgba:
*
* Cell background as a #GdkRGBA
* Cell background as a `GdkRGBA`
*/
g_object_class_install_property (object_class,
PROP_CELL_BACKGROUND_RGBA,
@ -654,17 +654,17 @@ set_cell_bg_color (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_snapshot:
* @cell: a #GtkCellRenderer
* @snapshot: a #GtkSnapshot to draw to
* @cell: a `GtkCellRenderer`
* @snapshot: a `GtkSnapshot` to draw to
* @widget: the widget owning @window
* @background_area: entire cell area (including tree expanders and maybe
* padding on the sides)
* @cell_area: area normally rendered by a cell renderer
* @flags: flags that affect rendering
*
* Invokes the virtual render function of the #GtkCellRenderer. The three
* Invokes the virtual render function of the `GtkCellRenderer`. The three
* passed-in rectangles are areas in @cr. Most renderers will draw within
* @cell_area; the xalign, yalign, xpad, and ypad fields of the #GtkCellRenderer
* @cell_area; the xalign, yalign, xpad, and ypad fields of the `GtkCellRenderer`
* should be honored with respect to @cell_area. @background_area includes the
* blank space around the cell, and also the area containing the tree expander;
* so the @background_area rectangles for all cells tile to cover the entire
@ -728,17 +728,17 @@ gtk_cell_renderer_snapshot (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_activate:
* @cell: a #GtkCellRenderer
* @event: a #GdkEvent
* @cell: a `GtkCellRenderer`
* @event: a `GdkEvent`
* @widget: widget that received the event
* @path: widget-dependent string representation of the event location;
* e.g. for #GtkTreeView, a string representation of #GtkTreePath
* @path: widget-dependent string representation of the event location;
* e.g. for `GtkTreeView`, a string representation of `GtkTreePath`
* @background_area: background area as passed to gtk_cell_renderer_render()
* @cell_area: cell area as passed to gtk_cell_renderer_render()
* @flags: render flags
*
* Passes an activate event to the cell renderer for possible processing.
* Some cell renderers may use events; for example, #GtkCellRendererToggle
* Passes an activate event to the cell renderer for possible processing.
* Some cell renderers may use events; for example, `GtkCellRendererToggle`
* toggles when it gets a mouse click.
*
* Returns: %TRUE if the event was consumed/handled
@ -775,19 +775,19 @@ gtk_cell_renderer_activate (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_start_editing:
* @cell: a #GtkCellRenderer
* @event: (nullable): a #GdkEvent
* @cell: a `GtkCellRenderer`
* @event: (nullable): a `GdkEvent`
* @widget: widget that received the event
* @path: widget-dependent string representation of the event location;
* e.g. for #GtkTreeView, a string representation of #GtkTreePath
* e.g. for `GtkTreeView`, a string representation of `GtkTreePath`
* @background_area: background area as passed to gtk_cell_renderer_render()
* @cell_area: cell area as passed to gtk_cell_renderer_render()
* @flags: render flags
*
* Starts editing the contents of this @cell, through a new #GtkCellEditable
* widget created by the #GtkCellRendererClass.start_editing virtual function.
* Starts editing the contents of this @cell, through a new `GtkCellEditable`
* widget created by the `GtkCellRenderer`Class.start_editing virtual function.
*
* Returns: (nullable) (transfer none): A new #GtkCellEditable for editing this
* Returns: (nullable) (transfer none): A new `GtkCellEditable` for editing this
* @cell, or %NULL if editing is not possible
**/
GtkCellEditable *
@ -836,7 +836,7 @@ gtk_cell_renderer_start_editing (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_set_fixed_size:
* @cell: A #GtkCellRenderer
* @cell: A `GtkCellRenderer`
* @width: the width of the cell renderer, or -1
* @height: the height of the cell renderer, or -1
*
@ -876,12 +876,12 @@ gtk_cell_renderer_set_fixed_size (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_get_fixed_size:
* @cell: A #GtkCellRenderer
* @cell: A `GtkCellRenderer`
* @width: (out) (optional): location to fill in with the fixed width of the cell
* @height: (out) (optional): location to fill in with the fixed height of the cell
*
* Fills in @width and @height with the appropriate size of @cell.
**/
*/
void
gtk_cell_renderer_get_fixed_size (GtkCellRenderer *cell,
int *width,
@ -901,7 +901,7 @@ gtk_cell_renderer_get_fixed_size (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_set_alignment:
* @cell: A #GtkCellRenderer
* @cell: A `GtkCellRenderer`
* @xalign: the x alignment of the cell renderer
* @yalign: the y alignment of the cell renderer
*
@ -942,12 +942,12 @@ gtk_cell_renderer_set_alignment (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_get_alignment:
* @cell: A #GtkCellRenderer
* @cell: A `GtkCellRenderer`
* @xalign: (out) (optional): location to fill in with the x alignment of the cell
* @yalign: (out) (optional): location to fill in with the y alignment of the cell
*
* Fills in @xalign and @yalign with the appropriate values of @cell.
**/
*/
void
gtk_cell_renderer_get_alignment (GtkCellRenderer *cell,
float *xalign,
@ -967,7 +967,7 @@ gtk_cell_renderer_get_alignment (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_set_padding:
* @cell: A #GtkCellRenderer
* @cell: A `GtkCellRenderer`
* @xpad: the x padding of the cell renderer
* @ypad: the y padding of the cell renderer
*
@ -1007,12 +1007,12 @@ gtk_cell_renderer_set_padding (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_get_padding:
* @cell: A #GtkCellRenderer
* @cell: A `GtkCellRenderer`
* @xpad: (out) (optional): location to fill in with the x padding of the cell
* @ypad: (out) (optional): location to fill in with the y padding of the cell
*
* Fills in @xpad and @ypad with the appropriate values of @cell.
**/
*/
void
gtk_cell_renderer_get_padding (GtkCellRenderer *cell,
int *xpad,
@ -1032,7 +1032,7 @@ gtk_cell_renderer_get_padding (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_set_visible:
* @cell: A #GtkCellRenderer
* @cell: A `GtkCellRenderer`
* @visible: the visibility of the cell
*
* Sets the cell renderer’s visibility.
@ -1056,7 +1056,7 @@ gtk_cell_renderer_set_visible (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_get_visible:
* @cell: A #GtkCellRenderer
* @cell: A `GtkCellRenderer`
*
* Returns the cell renderer’s visibility.
*
@ -1072,7 +1072,7 @@ gtk_cell_renderer_get_visible (GtkCellRenderer *cell)
/**
* gtk_cell_renderer_set_sensitive:
* @cell: A #GtkCellRenderer
* @cell: A `GtkCellRenderer`
* @sensitive: the sensitivity of the cell
*
* Sets the cell renderer’s sensitivity.
@ -1096,7 +1096,7 @@ gtk_cell_renderer_set_sensitive (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_get_sensitive:
* @cell: A #GtkCellRenderer
* @cell: A `GtkCellRenderer`
*
* Returns the cell renderer’s sensitivity.
*
@ -1113,7 +1113,7 @@ gtk_cell_renderer_get_sensitive (GtkCellRenderer *cell)
/**
* gtk_cell_renderer_is_activatable:
* @cell: A #GtkCellRenderer
* @cell: A `GtkCellRenderer`
*
* Checks whether the cell renderer can do something when activated.
*
@ -1136,16 +1136,16 @@ gtk_cell_renderer_is_activatable (GtkCellRenderer *cell)
/**
* gtk_cell_renderer_stop_editing:
* @cell: A #GtkCellRenderer
* @cell: A `GtkCellRenderer`
* @canceled: %TRUE if the editing has been canceled
*
* Informs the cell renderer that the editing is stopped.
* If @canceled is %TRUE, the cell renderer will emit the
* #GtkCellRenderer::editing-canceled signal.
*
* This function should be called by cell renderer implementations
* in response to the #GtkCellEditable::editing-done signal of
* #GtkCellEditable.
* Informs the cell renderer that the editing is stopped.
* If @canceled is %TRUE, the cell renderer will emit the
* `GtkCellRenderer`::editing-canceled signal.
*
* This function should be called by cell renderer implementations
* in response to the `GtkCellEditable::editing-done` signal of
* `GtkCellEditable`.
**/
void
gtk_cell_renderer_stop_editing (GtkCellRenderer *cell,
@ -1344,12 +1344,12 @@ _gtk_cell_renderer_calc_offset (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_get_request_mode:
* @cell: a #GtkCellRenderer instance
* @cell: a `GtkCellRenderer` instance
*
* Gets whether the cell renderer prefers a height-for-width layout
* or a width-for-height layout.
*
* Returns: The #GtkSizeRequestMode preferred by this renderer.
* Returns: The `GtkSizeRequestMode` preferred by this renderer.
*/
GtkSizeRequestMode
gtk_cell_renderer_get_request_mode (GtkCellRenderer *cell)
@ -1361,8 +1361,8 @@ gtk_cell_renderer_get_request_mode (GtkCellRenderer *cell)
/**
* gtk_cell_renderer_get_preferred_width:
* @cell: a #GtkCellRenderer instance
* @widget: the #GtkWidget this cell will be rendering to
* @cell: a `GtkCellRenderer` instance
* @widget: the `GtkWidget` this cell will be rendering to
* @minimum_size: (out) (optional): location to store the minimum size
* @natural_size: (out) (optional): location to store the natural size
*
@ -1407,8 +1407,8 @@ gtk_cell_renderer_get_preferred_width (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_get_preferred_height:
* @cell: a #GtkCellRenderer instance
* @widget: the #GtkWidget this cell will be rendering to
* @cell: a `GtkCellRenderer` instance
* @widget: the `GtkWidget` this cell will be rendering to
* @minimum_size: (out) (optional): location to store the minimum size
* @natural_size: (out) (optional): location to store the natural size
*
@ -1453,8 +1453,8 @@ gtk_cell_renderer_get_preferred_height (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_get_preferred_width_for_height:
* @cell: a #GtkCellRenderer instance
* @widget: the #GtkWidget this cell will be rendering to
* @cell: a `GtkCellRenderer` instance
* @widget: the `GtkWidget` this cell will be rendering to
* @height: the size which is available for allocation
* @minimum_width: (out) (optional): location for storing the minimum size
* @natural_width: (out) (optional): location for storing the preferred size
@ -1501,8 +1501,8 @@ gtk_cell_renderer_get_preferred_width_for_height (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_get_preferred_height_for_width:
* @cell: a #GtkCellRenderer instance
* @widget: the #GtkWidget this cell will be rendering to
* @cell: a `GtkCellRenderer` instance
* @widget: the `GtkWidget` this cell will be rendering to
* @width: the size which is available for allocation
* @minimum_height: (out) (optional): location for storing the minimum size
* @natural_height: (out) (optional): location for storing the preferred size
@ -1549,8 +1549,8 @@ gtk_cell_renderer_get_preferred_height_for_width (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_get_preferred_size:
* @cell: a #GtkCellRenderer instance
* @widget: the #GtkWidget this cell will be rendering to
* @cell: a `GtkCellRenderer` instance
* @widget: the `GtkWidget` this cell will be rendering to
* @minimum_size: (out) (optional): location for storing the minimum size
* @natural_size: (out) (optional): location for storing the natural size
*
@ -1608,8 +1608,8 @@ gtk_cell_renderer_get_preferred_size (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_get_aligned_area:
* @cell: a #GtkCellRenderer instance
* @widget: the #GtkWidget this cell will be rendering to
* @cell: a `GtkCellRenderer` instance
* @widget: the `GtkWidget` this cell will be rendering to
* @flags: render flags
* @cell_area: cell area which would be passed to gtk_cell_renderer_render()
* @aligned_area: (out): the return location for the space inside @cell_area
@ -1643,13 +1643,13 @@ gtk_cell_renderer_get_aligned_area (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_get_state:
* @cell: (nullable): a #GtkCellRenderer
* @widget: (nullable): a #GtkWidget
* @cell: (nullable): a `GtkCellRenderer`
* @widget: (nullable): a `GtkWidget`
* @cell_state: cell renderer state
*
* Translates the cell renderer state to #GtkStateFlags,
* Translates the cell renderer state to `GtkStateFlags`,
* based on the cell renderer and widget sensitivity, and
* the given #GtkCellRendererState.
* the given `GtkCellRenderer`State.
*
* Returns: the widget state flags applying to @cell
**/
@ -1692,10 +1692,10 @@ gtk_cell_renderer_get_state (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_set_is_expander:
* @cell: a #GtkCellRenderer
* @cell: a `GtkCellRenderer`
* @is_expander: whether @cell is an expander
*
* Sets whether the given #GtkCellRenderer is an expander.
* Sets whether the given `GtkCellRenderer` is an expander.
*/
void
gtk_cell_renderer_set_is_expander (GtkCellRenderer *cell,
@ -1717,9 +1717,9 @@ gtk_cell_renderer_set_is_expander (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_get_is_expander:
* @cell: a #GtkCellRenderer
* @cell: a `GtkCellRenderer`
*
* Checks whether the given #GtkCellRenderer is an expander.
* Checks whether the given `GtkCellRenderer` is an expander.
*
* Returns: %TRUE if @cell is an expander, and %FALSE otherwise
*/
@ -1735,10 +1735,10 @@ gtk_cell_renderer_get_is_expander (GtkCellRenderer *cell)
/**
* gtk_cell_renderer_set_is_expanded:
* @cell: a #GtkCellRenderer
* @cell: a `GtkCellRenderer`
* @is_expanded: whether @cell should be expanded
*
* Sets whether the given #GtkCellRenderer is expanded.
* Sets whether the given `GtkCellRenderer` is expanded.
*/
void
gtk_cell_renderer_set_is_expanded (GtkCellRenderer *cell,
@ -1760,9 +1760,9 @@ gtk_cell_renderer_set_is_expanded (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_get_is_expanded:
* @cell: a #GtkCellRenderer
* @cell: a `GtkCellRenderer`
*
* Checks whether the given #GtkCellRenderer is expanded.
* Checks whether the given `GtkCellRenderer` is expanded.
*
* Returns: %TRUE if the cell renderer is expanded
*/

6
gtk/gtkcellrenderer.h
View File

@ -99,9 +99,9 @@ struct _GtkCellRenderer
* @get_preferred_height: Called to get a renderer’s natural height.
* @get_preferred_width_for_height: Called to get a renderer’s natural width for height.
* @get_aligned_area: Called to get the aligned area used by @cell inside @cell_area.
* @snapshot: Called to snapshot the content of the #GtkCellRenderer.
* @activate: Called to activate the content of the #GtkCellRenderer.
* @start_editing: Called to initiate editing the content of the #GtkCellRenderer.
* @snapshot: Called to snapshot the content of the `GtkCellRenderer`.
* @activate: Called to activate the content of the `GtkCellRenderer`.
* @start_editing: Called to initiate editing the content of the `GtkCellRenderer`.
* @editing_canceled: Signal gets emitted when the user cancels the process of editing a cell.
* @editing_started: Signal gets emitted when a cell starts to be edited.
*/

4
gtk/gtkcellrendereraccel.c
View File

@ -37,7 +37,7 @@
*
* Renders a keyboard accelerator in a cell
*
* #GtkCellRendererAccel displays a keyboard accelerator (i.e. a key
* `GtkCellRendererAccel` displays a keyboard accelerator (i.e. a key
* combination like `Control + a`). If the cell renderer is editable,
* the accelerator can be changed by simply typing the new combination.
*/
@ -270,7 +270,7 @@ gtk_cell_renderer_accel_class_init (GtkCellRendererAccelClass *cell_accel_class)
/**
* gtk_cell_renderer_accel_new:
*
* Creates a new #GtkCellRendererAccel.
* Creates a new `GtkCellRendererAccel`.
*
* Returns: the new cell renderer
*/

34
gtk/gtkcellrenderercombo.c
View File

@ -33,16 +33,16 @@
*
* Renders a combobox in a cell
*
* #GtkCellRendererCombo renders text in a cell like #GtkCellRendererText from
* which it is derived. But while #GtkCellRendererText offers a simple entry to
* edit the text, #GtkCellRendererCombo offers a #GtkComboBox
* `GtkCellRendererCombo` renders text in a cell like `GtkCellRendererText` from
* which it is derived. But while `GtkCellRendererText` offers a simple entry to
* edit the text, `GtkCellRendererCombo` offers a `GtkComboBox`
* widget to edit the text. The values to display in the combo box are taken from
* the tree model specified in the #GtkCellRendererCombo:model property.
* the tree model specified in the `GtkCellRendererCombo`:model property.
*
* The combo cell renderer takes care of adding a text cell renderer to the combo
* box and sets it to display the column specified by its
* #GtkCellRendererCombo:text-column property. Further properties of the combo box
* can be set in a handler for the #GtkCellRenderer::editing-started signal.
* `GtkCellRendererCombo`:text-column property. Further properties of the combo box
* can be set in a handler for the `GtkCellRenderer::editing-started` signal.
*/
typedef struct _GtkCellRendererComboPrivate GtkCellRendererComboPrivate;
@ -146,7 +146,7 @@ gtk_cell_renderer_combo_class_init (GtkCellRendererComboClass *klass)
* not the model backing the tree view to which
* this cell renderer is attached.
*
* #GtkCellRendererCombo automatically adds a text cell renderer for
* `GtkCellRendererCombo` automatically adds a text cell renderer for
* this column to its combo box.
*/
g_object_class_install_property (object_class,
@ -221,16 +221,16 @@ gtk_cell_renderer_combo_init (GtkCellRendererCombo *self)
}
/**
* gtk_cell_renderer_combo_new:
*
* Creates a new #GtkCellRendererCombo.
* Adjust how text is drawn using object properties.
* Object properties can be set globally (with g_object_set()).
* Also, with #GtkTreeViewColumn, you can bind a property to a value
* in a #GtkTreeModel. For example, you can bind the “text” property
* on the cell renderer to a string value in the model, thus rendering
* a different string in each row of the #GtkTreeView.
*
* gtk_cell_renderer_combo_new:
*
* Creates a new `GtkCellRendererCombo`.
* Adjust how text is drawn using object properties.
* Object properties can be set globally (with g_object_set()).
* Also, with `GtkTreeViewColumn`, you can bind a property to a value
* in a `GtkTreeModel`. For example, you can bind the “text” property
* on the cell renderer to a string value in the model, thus rendering
* a different string in each row of the `GtkTreeView`.
*
* Returns: the new cell renderer
*/
GtkCellRenderer *

30
gtk/gtkcellrendererpixbuf.c
View File

@ -35,17 +35,17 @@
*
* Renders a pixbuf in a cell
*
* A #GtkCellRendererPixbuf can be used to render an image in a cell. It allows
* to render either a given #GdkPixbuf (set via the
* #GtkCellRendererPixbuf:pixbuf property) or a named icon (set via the
* #GtkCellRendererPixbuf:icon-name property).
* A `GtkCellRendererPixbuf` can be used to render an image in a cell. It allows
* to render either a given `GdkPixbuf` (set via the
* `GtkCellRendererPixbuf:pixbuf` property) or a named icon (set via the
* `GtkCellRendererPixbuf:icon-name` property).
*
* To support the tree view, #GtkCellRendererPixbuf also supports rendering two
* alternative pixbufs, when the #GtkCellRenderer:is-expander property is %TRUE.
* If the #GtkCellRenderer:is-expanded property is %TRUE and the
* #GtkCellRendererPixbuf:pixbuf-expander-open property is set to a pixbuf, it
* renders that pixbuf, if the #GtkCellRenderer:is-expanded property is %FALSE
* and the #GtkCellRendererPixbuf:pixbuf-expander-closed property is set to a
* To support the tree view, `GtkCellRendererPixbuf` also supports rendering two
* alternative pixbufs, when the `GtkCellRenderer:is-expander` property is %TRUE.
* If the `GtkCellRenderer:is-expanded property` is %TRUE and the
* `GtkCellRendererPixbuf:pixbuf-expander-open` property is set to a pixbuf, it
* renders that pixbuf, if the `GtkCellRenderer:is-expanded` property is %FALSE
* and the `GtkCellRendererPixbuf:pixbuf-expander-closed` property is set to a
* pixbuf, it renders that one.
*/
@ -230,7 +230,7 @@ gtk_cell_renderer_pixbuf_class_init (GtkCellRendererPixbufClass *class)
/**
* GtkCellRendererPixbuf:icon-size:
*
* The #GtkIconSize value that specifies the size of the rendered icon.
* The `GtkIconSize` value that specifies the size of the rendered icon.
*/
g_object_class_install_property (object_class,
PROP_ICON_SIZE,
@ -415,13 +415,13 @@ gtk_cell_renderer_pixbuf_set_property (GObject *object,
/**
* gtk_cell_renderer_pixbuf_new:
*
* Creates a new #GtkCellRendererPixbuf. Adjust rendering
* Creates a new `GtkCellRendererPixbuf`. Adjust rendering
* parameters using object properties. Object properties can be set
* globally (with g_object_set()). Also, with #GtkTreeViewColumn, you
* can bind a property to a value in a #GtkTreeModel. For example, you
* globally (with g_object_set()). Also, with `GtkTreeViewColumn`, you
* can bind a property to a value in a `GtkTreeModel`. For example, you
* can bind the “pixbuf” property on the cell renderer to a pixbuf value
* in the model, thus rendering a different image in each row of the
* #GtkTreeView.
* `GtkTreeView`.
*
* Returns: the new cell renderer
**/

4
gtk/gtkcellrendererprogress.c
View File

@ -39,7 +39,7 @@
*
* Renders numbers as progress bars
*
* #GtkCellRendererProgress renders a numeric value as a progress par in a cell.
* `GtkCellRendererProgress` renders a numeric value as a progress par in a cell.
* Additionally, it can display a text on top of the progress bar.
*/
@ -727,7 +727,7 @@ gtk_cell_renderer_progress_init (GtkCellRendererProgress *cellprogress)
/**
* gtk_cell_renderer_progress_new:
*
* Creates a new #GtkCellRendererProgress.
* Creates a new `GtkCellRendererProgress`.
*
* Returns: the new cell renderer
**/

20
gtk/gtkcellrendererspin.c
View File

@ -35,19 +35,19 @@
*
* Renders a spin button in a cell
*
* #GtkCellRendererSpin renders text in a cell like #GtkCellRendererText from
* which it is derived. But while #GtkCellRendererText offers a simple entry to
* edit the text, #GtkCellRendererSpin offers a #GtkSpinButton widget. Of course,
* `GtkCellRendererSpin` renders text in a cell like `GtkCellRendererText` from
* which it is derived. But while `GtkCellRendererText` offers a simple entry to
* edit the text, `GtkCellRendererSpin` offers a `GtkSpinButton` widget. Of course,
* that means that the text has to be parseable as a floating point number.
*
* The range of the spinbutton is taken from the adjustment property of the
* cell renderer, which can be set explicitly or mapped to a column in the
* tree model, like all properties of cell renders. #GtkCellRendererSpin
* also has properties for the #GtkCellRendererSpin:climb-rate and the number
* of #GtkCellRendererSpin:digits to display. Other #GtkSpinButton properties
* can be set in a handler for the #GtkCellRenderer::editing-started signal.
* tree model, like all properties of cell renders. `GtkCellRendererSpin`
* also has properties for the `GtkCellRendererSpin:climb-rate` and the number
* of `GtkCellRendererSpin:digits` to display. Other `GtkSpinButton` properties
* can be set in a handler for the `GtkCellRenderer::editing-started` signal.
*
* The #GtkCellRendererSpin cell renderer was added in GTK 2.10.
* The `GtkCellRendererSpin` cell renderer was added in GTK 2.10.
*/
typedef struct _GtkCellRendererSpinClass GtkCellRendererSpinClass;
@ -372,9 +372,9 @@ gtk_cell_renderer_spin_start_editing (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_spin_new:
*
* Creates a new #GtkCellRendererSpin.
* Creates a new `GtkCellRendererSpin`.
*
* Returns: a new #GtkCellRendererSpin
* Returns: a new `GtkCellRendererSpin`
*/
GtkCellRenderer *
gtk_cell_renderer_spin_new (void)

16
gtk/gtkcellrendererspinner.c
View File

@ -43,13 +43,13 @@
*
* Renders a spinning animation in a cell
*
* GtkCellRendererSpinner renders a spinning animation in a cell, very
* similar to #GtkSpinner. It can often be used as an alternative
* to a #GtkCellRendererProgress for displaying indefinite activity,
* `GtkCellRendererSpinner` renders a spinning animation in a cell, very
* similar to `GtkSpinner`. It can often be used as an alternative
* to a `GtkCellRendererProgress` for displaying indefinite activity,
* instead of actual progress.
*
* To start the animation in a cell, set the #GtkCellRendererSpinner:active
* property to %TRUE and increment the #GtkCellRendererSpinner:pulse property
* To start the animation in a cell, set the `GtkCellRendererSpinner:active`
* property to %TRUE and increment the `GtkCellRendererSpinner:pulse` property
* at regular intervals. The usual way to set the cell renderer properties
* for each cell is to bind them to columns in your tree model using e.g.
* gtk_tree_view_column_add_attribute().
@ -189,7 +189,7 @@ gtk_cell_renderer_spinner_class_init (GtkCellRendererSpinnerClass *klass)
* Pulse of the spinner. Increment this value to draw the next frame of the
* spinner animation. Usually, you would update this value in a timeout.
*
* By default, the #GtkSpinner widget draws one full cycle of the animation,
* By default, the `GtkSpinner` widget draws one full cycle of the animation,
* consisting of 12 frames, in 750 milliseconds.
*/
g_object_class_install_property (object_class,
@ -203,7 +203,7 @@ gtk_cell_renderer_spinner_class_init (GtkCellRendererSpinnerClass *klass)
/**
* GtkCellRendererSpinner:size:
*
* The #GtkIconSize value that specifies the size of the rendered spinner.
* The `GtkIconSize` value that specifies the size of the rendered spinner.
*/
g_object_class_install_property (object_class,
PROP_SIZE,
@ -229,7 +229,7 @@ gtk_cell_renderer_spinner_init (GtkCellRendererSpinner *cell)
* Returns a new cell renderer which will show a spinner to indicate
* activity.
*
* Returns: a new #GtkCellRenderer
* Returns: a new `GtkCellRenderer`
*/
GtkCellRenderer *
gtk_cell_renderer_spinner_new (void)

30
gtk/gtkcellrenderertext.c
View File

@ -38,12 +38,12 @@
*
* Renders text in a cell
*
* A #GtkCellRendererText renders a given text in its cell, using the font, color and
* A `GtkCellRendererText` renders a given text in its cell, using the font, color and
* style information provided by its properties. The text will be ellipsized if it is
* too long and the #GtkCellRendererText:ellipsize property allows it.
* too long and the `GtkCellRendererText:ellipsize` property allows it.
*
* If the #GtkCellRenderer:mode is %GTK_CELL_RENDERER_MODE_EDITABLE,
* the #GtkCellRendererText allows to edit its text using an entry.
* If the `GtkCellRenderer:mode` is %GTK_CELL_RENDERER_MODE_EDITABLE,
* the `GtkCellRendererText` allows to edit its text using an entry.
*/
@ -286,7 +286,7 @@ gtk_cell_renderer_text_class_init (GtkCellRendererTextClass *class)
/**
* GtkCellRendererText:background-rgba:
*
* Background color as a #GdkRGBA
* Background color as a `GdkRGBA`
*/
text_cell_renderer_props[PROP_BACKGROUND_RGBA] =
g_param_spec_boxed ("background-rgba",
@ -304,7 +304,7 @@ gtk_cell_renderer_text_class_init (GtkCellRendererTextClass *class)
/**
* GtkCellRendererText:foreground-rgba:
*
* Foreground color as a #GdkRGBA
* Foreground color as a `GdkRGBA`
*/
text_cell_renderer_props[PROP_FOREGROUND_RGBA] =
g_param_spec_boxed ("foreground-rgba",
@ -473,7 +473,7 @@ gtk_cell_renderer_text_class_init (GtkCellRendererTextClass *class)
* For cell renderers that ellipsize or wrap text; this property
* controls the maximum reported width of the cell. The
* cell should not receive any greater allocation unless it is
* set to expand in its #GtkCellLayout and all of the cell's siblings
* set to expand in its `GtkCellLayout` and all of the cell's siblings
* have received their natural width.
**/
text_cell_renderer_props[PROP_MAX_WIDTH_CHARS] =
@ -522,7 +522,7 @@ gtk_cell_renderer_text_class_init (GtkCellRendererTextClass *class)
* Specifies how to align the lines of text with respect to each other.
*
* Note that this property describes how to align the lines of text in
* case there are several of them. The "xalign" property of #GtkCellRenderer,
* case there are several of them. The "xalign" property of `GtkCellRenderer`,
* on the other hand, sets the horizontal alignment of the whole text.
*/
text_cell_renderer_props[PROP_ALIGN] =
@ -536,8 +536,8 @@ gtk_cell_renderer_text_class_init (GtkCellRendererTextClass *class)
/**
* GtkCellRendererText:placeholder-text:
*
* The text that will be displayed in the #GtkCellRenderer if
* #GtkCellRendererText:editable is %TRUE and the cell is empty.
* The text that will be displayed in the `GtkCellRenderer` if
* `GtkCellRendererText:editable` is %TRUE and the cell is empty.
*/
text_cell_renderer_props[PROP_PLACEHOLDER_TEXT] =
g_param_spec_string ("placeholder-text",
@ -1388,13 +1388,13 @@ gtk_cell_renderer_text_set_property (GObject *object,
/**
* gtk_cell_renderer_text_new:
*
* Creates a new #GtkCellRendererText. Adjust how text is drawn using
* Creates a new `GtkCellRendererText`. Adjust how text is drawn using
* object properties. Object properties can be
* set globally (with g_object_set()). Also, with #GtkTreeViewColumn,
* you can bind a property to a value in a #GtkTreeModel. For example,
* set globally (with g_object_set()). Also, with `GtkTreeViewColumn`,
* you can bind a property to a value in a `GtkTreeModel`. For example,
* you can bind the “text” property on the cell renderer to a string
* value in the model, thus rendering a different string in each row
* of the #GtkTreeView
* of the `GtkTreeView`.
*
* Returns: the new cell renderer
**/
@ -1847,7 +1847,7 @@ gtk_cell_renderer_text_start_editing (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_text_set_fixed_height_from_font:
* @renderer: A #GtkCellRendererText
* @renderer: A `GtkCellRendererText`
* @number_of_rows: Number of rows of text each cell renderer is allocated, or -1
*
* Sets the height of a renderer to explicitly be determined by the “font” and

30
gtk/gtkcellrenderertoggle.c
View File

@ -37,10 +37,10 @@
*
* Renders a toggle button in a cell
*
* #GtkCellRendererToggle renders a toggle button in a cell. The
* `GtkCellRendererToggle` renders a toggle button in a cell. The
* button is drawn as a radio or a checkbutton, depending on the
* #GtkCellRendererToggle:radio property.
* When activated, it emits the #GtkCellRendererToggle::toggled signal.
* `GtkCellRendererToggle:radio` property.
* When activated, it emits the `GtkCellRendererToggle::toggled` signal.
*/
@ -226,7 +226,7 @@ gtk_cell_renderer_toggle_class_init (GtkCellRendererToggleClass *class)
/**
* GtkCellRendererToggle::toggled:
* @cell_renderer: the object which received the signal
* @path: string representation of #GtkTreePath describing the
* @path: string representation of `GtkTreePath` describing the
* event location
*
* The ::toggled signal is emitted when the cell is toggled.
@ -324,10 +324,10 @@ gtk_cell_renderer_toggle_set_property (GObject *object,
/**
* gtk_cell_renderer_toggle_new:
*
* Creates a new #GtkCellRendererToggle. Adjust rendering
* Creates a new `GtkCellRendererToggle`. Adjust rendering
* parameters using object properties. Object properties can be set
* globally (with g_object_set()). Also, with #GtkTreeViewColumn, you
* can bind a property to a value in a #GtkTreeModel. For example, you
* globally (with g_object_set()). Also, with `GtkTreeViewColumn`, you
* can bind a property to a value in a `GtkTreeModel`. For example, you
* can bind the “active” property on the cell renderer to a boolean value
* in the model, thus causing the check button to reflect the state of
* the model.
@ -531,15 +531,15 @@ gtk_cell_renderer_toggle_activate (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_toggle_set_radio:
* @toggle: a #GtkCellRendererToggle
* @toggle: a `GtkCellRendererToggle`
* @radio: %TRUE to make the toggle look like a radio button
*
* If @radio is %TRUE, the cell renderer renders a radio toggle
* (i.e. a toggle in a group of mutually-exclusive toggles).
* If %FALSE, it renders a check toggle (a standalone boolean option).
* This can be set globally for the cell renderer, or changed just
* before rendering each cell in the model (for #GtkTreeView, you set
* up a per-row setting using #GtkTreeViewColumn to associate model
* before rendering each cell in the model (for `GtkTreeView`, you set
* up a per-row setting using `GtkTreeViewColumn` to associate model
* columns with cell renderer properties).
**/
void
@ -555,7 +555,7 @@ gtk_cell_renderer_toggle_set_radio (GtkCellRendererToggle *toggle,
/**
* gtk_cell_renderer_toggle_get_radio:
* @toggle: a #GtkCellRendererToggle
* @toggle: a `GtkCellRendererToggle`
*
* Returns whether we’re rendering radio toggles rather than checkboxes.
*
@ -573,7 +573,7 @@ gtk_cell_renderer_toggle_get_radio (GtkCellRendererToggle *toggle)
/**
* gtk_cell_renderer_toggle_get_active:
* @toggle: a #GtkCellRendererToggle
* @toggle: a `GtkCellRendererToggle`
*
* Returns whether the cell renderer is active. See
* gtk_cell_renderer_toggle_set_active().
@ -592,7 +592,7 @@ gtk_cell_renderer_toggle_get_active (GtkCellRendererToggle *toggle)
/**
* gtk_cell_renderer_toggle_set_active:
* @toggle: a #GtkCellRendererToggle.
* @toggle: a `GtkCellRendererToggle`.
* @setting: the value to set.
*
* Activates or deactivates a cell renderer.
@ -608,7 +608,7 @@ gtk_cell_renderer_toggle_set_active (GtkCellRendererToggle *toggle,
/**
* gtk_cell_renderer_toggle_get_activatable:
* @toggle: a #GtkCellRendererToggle
* @toggle: a `GtkCellRendererToggle`
*
* Returns whether the cell renderer is activatable. See
* gtk_cell_renderer_toggle_set_activatable().
@ -627,7 +627,7 @@ gtk_cell_renderer_toggle_get_activatable (GtkCellRendererToggle *toggle)
/**
* gtk_cell_renderer_toggle_set_activatable:
* @toggle: a #GtkCellRendererToggle.
* @toggle: a `GtkCellRendererToggle`.
* @setting: the value to set.
*
* Makes the cell renderer activatable.

86
gtk/gtkcellview.c
View File

@ -38,15 +38,15 @@
*
* A widget displaying a single row of a GtkTreeModel
*
* A #GtkCellView displays a single row of a #GtkTreeModel using a #GtkCellArea
* and #GtkCellAreaContext. A #GtkCellAreaContext can be provided to the
* #GtkCellView at construction time in order to keep the cellview in context
* A `GtkCellView` displays a single row of a `GtkTreeModel` using a `GtkCellArea`
* and `GtkCellAreaContext`. A `GtkCellAreaContext` can be provided to the
* `GtkCellView` at construction time in order to keep the cellview in context
* of a group of cell views, this ensures that the renderers displayed will
* be properly aligned with each other (like the aligned cells in the menus
* of #GtkComboBox).
* of `GtkComboBox`).
*
* #GtkCellView is #GtkOrientable in order to decide in which orientation
* the underlying #GtkCellAreaContext should be allocated. Taking the #GtkComboBox
* `GtkCellView` is `GtkOrientable` in order to decide in which orientation
* the underlying `GtkCellAreaContext` should be allocated. Taking the `GtkComboBox`
* menu as an example, cellviews should be oriented horizontally if the menus are
* listed top-to-bottom and thus all share the same width but may have separate
* individual heights (left-to-right menus should be allocated vertically since
@ -205,10 +205,10 @@ gtk_cell_view_class_init (GtkCellViewClass *klass)
/**
* GtkCellView:cell-area:
*
* The #GtkCellArea rendering cells
* The `GtkCellArea` rendering cells
*
* If no area is specified when creating the cell view with gtk_cell_view_new_with_context()
* a horizontally oriented #GtkCellAreaBox will be used.
* a horizontally oriented `GtkCellArea`Box will be used.
*
* since 3.0
*/
@ -223,13 +223,13 @@ gtk_cell_view_class_init (GtkCellViewClass *klass)
/**
* GtkCellView:cell-area-context:
*
* The #GtkCellAreaContext used to compute the geometry of the cell view.
* The `GtkCellAreaContext` used to compute the geometry of the cell view.
*
* A group of cell views can be assigned the same context in order to
* ensure the sizes and cell alignments match across all the views with
* the same context.
*
* #GtkComboBox menus uses this to assign the same context to all cell views
* `GtkComboBox` menus uses this to assign the same context to all cell views
* in the menu items for a single menu (each submenu creates its own
* context since the size of each submenu does not depend on parent
* or sibling menus).
@ -817,9 +817,9 @@ row_changed_cb (GtkTreeModel *model,
/**
* gtk_cell_view_new:
*
* Creates a new #GtkCellView widget.
* Creates a new `GtkCellView` widget.
*
* Returns: A newly created #GtkCellView widget.
* Returns: A newly created `GtkCellView` widget.
*/
GtkWidget *
gtk_cell_view_new (void)
@ -834,18 +834,18 @@ gtk_cell_view_new (void)
/**
* gtk_cell_view_new_with_context:
* @area: the #GtkCellArea to layout cells
* @context: the #GtkCellAreaContext in which to calculate cell geometry
* @area: the `GtkCellArea` to layout cells
* @context: the `GtkCellAreaContext` in which to calculate cell geometry
*
* Creates a new #GtkCellView widget with a specific #GtkCellArea
* to layout cells and a specific #GtkCellAreaContext.
* Creates a new `GtkCellView` widget with a specific `GtkCellArea`
* to layout cells and a specific `GtkCellAreaContext`.
*
* Specifying the same context for a handful of cells lets
* the underlying area synchronize the geometry for those cells,
* in this way alignments with cellviews for other rows are
* possible.
*
* Returns: A newly created #GtkCellView widget.
* Returns: A newly created `GtkCellView` widget.
*/
GtkWidget *
gtk_cell_view_new_with_context (GtkCellArea *area,
@ -864,10 +864,10 @@ gtk_cell_view_new_with_context (GtkCellArea *area,
* gtk_cell_view_new_with_text:
* @text: the text to display in the cell view
*
* Creates a new #GtkCellView widget, adds a #GtkCellRendererText
* Creates a new `GtkCellView` widget, adds a `GtkCellRendererText`
* to it, and makes it show @text.
*
* Returns: A newly created #GtkCellView widget.
* Returns: A newly created `GtkCellView` widget.
*/
GtkWidget *
gtk_cell_view_new_with_text (const char *text)
@ -894,11 +894,11 @@ gtk_cell_view_new_with_text (const char *text)
* gtk_cell_view_new_with_markup:
* @markup: the text to display in the cell view
*
* Creates a new #GtkCellView widget, adds a #GtkCellRendererText
* Creates a new `GtkCellView` widget, adds a `GtkCellRendererText`
* to it, and makes it show @markup. The text can be
* marked up with the [Pango text markup language][PangoMarkupFormat].
*
* Returns: A newly created #GtkCellView widget.
* Returns: A newly created `GtkCellView` widget.
*/
GtkWidget *
gtk_cell_view_new_with_markup (const char *markup)
@ -925,10 +925,10 @@ gtk_cell_view_new_with_markup (const char *markup)
* gtk_cell_view_new_with_texture:
* @texture: the image to display in the cell view
*
* Creates a new #GtkCellView widget, adds a #GtkCellRendererPixbuf
* Creates a new `GtkCellView` widget, adds a `GtkCellRendererPixbuf`
* to it, and makes it show @texture.
*
* Returns: A newly created #GtkCellView widget.
* Returns: A newly created `GtkCellView` widget.
*/
GtkWidget *
gtk_cell_view_new_with_texture (GdkTexture *texture)
@ -953,7 +953,7 @@ gtk_cell_view_new_with_texture (GdkTexture *texture)
/**
* gtk_cell_view_set_value:
* @cell_view: a #GtkCellView widget
* @cell_view: a `GtkCellView` widget
* @renderer: one of the renderers of @cell_view
* @property: the name of the property of @renderer to set
* @value: the new value to set the property to
@ -976,8 +976,8 @@ gtk_cell_view_set_value (GtkCellView *cell_view,
/**
* gtk_cell_view_set_model:
* @cell_view: a #GtkCellView
* @model: (nullable): a #GtkTreeModel
* @cell_view: a `GtkCellView`
* @model: (nullable): a `GtkTreeModel`
*
* Sets the model for @cell_view. If @cell_view already has a model
* set, it will remove it before setting the new model. If @model is
@ -1018,12 +1018,12 @@ gtk_cell_view_set_model (GtkCellView *cell_view,
/**
* gtk_cell_view_get_model:
* @cell_view: a #GtkCellView
* @cell_view: a `GtkCellView`
*
* Returns the model for @cell_view. If no model is used %NULL is
* returned.
*
* Returns: (nullable) (transfer none): a #GtkTreeModel used
* Returns: (nullable) (transfer none): a `GtkTreeModel` used
*/
GtkTreeModel *
gtk_cell_view_get_model (GtkCellView *cell_view)
@ -1037,15 +1037,15 @@ gtk_cell_view_get_model (GtkCellView *cell_view)
/**
* gtk_cell_view_set_displayed_row:
* @cell_view: a #GtkCellView
* @path: (nullable): a #GtkTreePath or %NULL to unset.
* @cell_view: a `GtkCellView`
* @path: (nullable): a `GtkTreePath` or %NULL to unset.
*
* Sets the row of the model that is currently displayed
* by the #GtkCellView. If the path is unset, then the
* by the `GtkCellView`. If the path is unset, then the
* contents of the cellview “stick” at their last value;
* this is not normally a desired result, but may be
* a needed intermediate state if say, the model for
* the #GtkCellView becomes temporarily empty.
* the `GtkCellView` becomes temporarily empty.
**/
void
gtk_cell_view_set_displayed_row (GtkCellView *cell_view,
@ -1071,9 +1071,9 @@ gtk_cell_view_set_displayed_row (GtkCellView *cell_view,
/**
* gtk_cell_view_get_displayed_row:
* @cell_view: a #GtkCellView
* @cell_view: a `GtkCellView`
*
* Returns a #GtkTreePath referring to the currently
* Returns a `GtkTreePath` referring to the currently
* displayed row. If no row is currently displayed,
* %NULL is returned.
*
@ -1094,7 +1094,7 @@ gtk_cell_view_get_displayed_row (GtkCellView *cell_view)
/**
* gtk_cell_view_get_draw_sensitive:
* @cell_view: a #GtkCellView
* @cell_view: a `GtkCellView`
*
* Gets whether @cell_view is configured to draw all of its
* cells in a sensitive state.
@ -1114,11 +1114,11 @@ gtk_cell_view_get_draw_sensitive (GtkCellView *cell_view)
/**
* gtk_cell_view_set_draw_sensitive:
* @cell_view: a #GtkCellView
* @cell_view: a `GtkCellView`
* @draw_sensitive: whether to draw all cells in a sensitive state.
*
* Sets whether @cell_view should draw all of its
* cells in a sensitive state, this is used by #GtkComboBox menus
* cells in a sensitive state, this is used by `GtkComboBox` menus
* to ensure that rows with insensitive cells that contain
* children appear sensitive in the parent menu item.
*/
@ -1140,13 +1140,13 @@ gtk_cell_view_set_draw_sensitive (GtkCellView *cell_view,
/**
* gtk_cell_view_get_fit_model:
* @cell_view: a #GtkCellView
* @cell_view: a `GtkCellView`
*
* Gets whether @cell_view is configured to request space
* to fit the entire #GtkTreeModel.
* to fit the entire `GtkTreeModel`.
*
* Returns: whether @cell_view requests space to fit
* the entire #GtkTreeModel.
* the entire `GtkTreeModel`.
*/
gboolean
gtk_cell_view_get_fit_model (GtkCellView *cell_view)
@ -1160,12 +1160,12 @@ gtk_cell_view_get_fit_model (GtkCellView *cell_view)
/**
* gtk_cell_view_set_fit_model:
* @cell_view: a #GtkCellView
* @cell_view: a `GtkCellView`
* @fit_model: whether @cell_view should request space for the whole model.
*
* Sets whether @cell_view should request space to fit the entire #GtkTreeModel.
* Sets whether @cell_view should request space to fit the entire `GtkTreeModel`.
*
* This is used by #GtkComboBox to ensure that the cell view displayed on
* This is used by `GtkComboBox` to ensure that the cell view displayed on
* the combo box’s button always gets enough space and does not resize
* when selection changes.
*/

2
gtk/gtkcolumnlistitemfactoryprivate.h
View File

@ -35,7 +35,7 @@ G_BEGIN_DECLS
/**
* GtkColumnListItemFactory:
*
* The object for the #GtkColumnListItemFactory.
* The object for the `GtkColumnListItemFactory`.
**/
typedef struct _GtkColumnListItemFactory GtkColumnListItemFactory;
typedef struct _GtkColumnListItemFactoryClass GtkColumnListItemFactoryClass;

2
gtk/gtkcolumnview.c
View File

@ -1371,7 +1371,7 @@ gtk_column_view_get_model (GtkColumnView *self)
/**
* gtk_column_view_set_model: (attributes org.gtk.Method.set_property=model)
* @self: a #GtkColumnView
* @self: a `GtkColumnView`
* @model: (nullable) (transfer none): the model to use
*
* Sets the model to use.

2
gtk/gtkcolumnviewcolumn.c
View File

@ -876,7 +876,7 @@ gtk_column_view_column_set_header_menu (GtkColumnViewColumn *self,
* Gets the menu model that is used to create the context menu
* for the column header.
*
* Returns: (transfer none) (nullable): the #GMenuModel
* Returns: (transfer none) (nullable): the `GMenuModel`
*/
GMenuModel *
gtk_column_view_column_get_header_menu (GtkColumnViewColumn *self)

2
gtk/gtkcombobox.c
View File

@ -731,7 +731,7 @@ gtk_combo_box_class_init (GtkComboBoxClass *klass)
P_("Entry Text Column"),
P_("The column in the combo box’s model to associate "
"with strings from the entry if the combo was "
"created with #GtkComboBox:has-entry = %TRUE"),
"created with GtkComboBox:has-entry = %TRUE"),
-1, G_MAXINT, -1,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));

22
gtk/gtkconstraint.c
View File

@ -182,9 +182,9 @@ gtk_constraint_class_init (GtkConstraintClass *klass)
*
* The target of the constraint.
*
* The constraint will set the #GtkConstraint:target-attribute of the
* target using the #GtkConstraint:source-attribute of the source
* widget.
* The constraint will set the [property@Gtk.Constraint:target-attribute]
* property of the target using the [property@Gtk.Constraint:source-attribute]
* property of the source widget.
*
*
*/
@ -196,10 +196,11 @@ gtk_constraint_class_init (GtkConstraintClass *klass)
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS |
G_PARAM_CONSTRUCT_ONLY);
/**
* GtkConstraint:target-attribute: (attributes org.gtk.Property.get=gtk_constraint_get_target_attribute)
*
* The attribute of the #GtkConstraint:target set by the constraint.
* The attribute of the [property@Gtk.Constraint:target] set by the constraint.
*/
obj_props[PROP_TARGET_ATTRIBUTE] =
g_param_spec_enum ("target-attribute",
@ -210,6 +211,7 @@ gtk_constraint_class_init (GtkConstraintClass *klass)
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS |
G_PARAM_CONSTRUCT_ONLY);
/**
* GtkConstraint:relation: (attributes org.gtk.Property.get=gtk_constraint_get_relation)
*
@ -224,14 +226,15 @@ gtk_constraint_class_init (GtkConstraintClass *klass)
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS |
G_PARAM_CONSTRUCT_ONLY);
/**
* GtkConstraint:source: (attributes org.gtk.Property.get=gtk_constraint_get_source)
*
* The source of the constraint.
*
* The constraint will set the [property@Gtk.Constraint:target-attribute]
* of the target using the [property@Gtk.Constraint:source-attribute]
* of the source.
* property of the target using the [property@Gtk.Constraint:source-attribute]
* property of the source.
*/
obj_props[PROP_SOURCE] =
g_param_spec_object ("source",
@ -256,6 +259,7 @@ gtk_constraint_class_init (GtkConstraintClass *klass)
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS |
G_PARAM_CONSTRUCT_ONLY);
/**
* GtkConstraint:multiplier: (attributes org.gtk.Property.get=gtk_constraint_get_multiplier)
*
@ -270,6 +274,7 @@ gtk_constraint_class_init (GtkConstraintClass *klass)
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS |
G_PARAM_CONSTRUCT_ONLY);
/**
* GtkConstraint:constant: (attributes org.gtk.Property.get=gtk_constraint_get_constant)
*
@ -283,6 +288,7 @@ gtk_constraint_class_init (GtkConstraintClass *klass)
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS |
G_PARAM_CONSTRUCT_ONLY);
/**
* GtkConstraint:strength: (attributes org.gtk.Property.get=gtk_constraint_get_strength)
*
@ -400,7 +406,7 @@ gtk_constraint_new_constant (gpointer target,
* If the targe is set to `NULL` at creation, the constraint will use
* the widget using the [class@Gtk.ConstraintLayout] as the target.
*
* Returns: (transfer none) (nullable): a #GtkConstraintTarget
* Returns: (transfer none) (nullable): a `GtkConstraintTarget`
*/
GtkConstraintTarget *
gtk_constraint_get_target (GtkConstraint *constraint)
@ -428,7 +434,7 @@ gtk_constraint_get_target_attribute (GtkConstraint *constraint)
/**
* gtk_constraint_get_source: (attributes org.gtk.Method.get_property=source)
* @constraint: a #GtkConstraint
* @constraint: a `GtkConstraint`
*
* Retrieves the [iface@Gtk.ConstraintTarget] used as the source for the
* constraint.

224
gtk/gtkconstraintexpression.c
View File

@ -70,14 +70,14 @@ gtk_constraint_variable_init (GtkConstraintVariable *variable,
* gtk_constraint_variable_new_dummy:
* @name: the name of the variable
*
* Allocates and initializes a new #GtkConstraintVariable for a "dummy"
* Allocates and initializes a new `GtkConstraintVariable` for a "dummy"
* symbol. Dummy symbols are typically used as markers inside a solver,
* and will not be factored in the solution when pivoting the tableau
* of the constraint equations.
*
* Only #GtkConstraintSolver should use this function.
* Only `GtkConstraintSolver` should use this function.
*
* Returns: a newly allocated #GtkConstraintVariable
* Returns: a newly allocated `GtkConstraintVariable`
*/
GtkConstraintVariable *
gtk_constraint_variable_new_dummy (const char *name)
@ -98,13 +98,13 @@ gtk_constraint_variable_new_dummy (const char *name)
* gtk_constraint_variable_new_objective:
* @name: the name of the variable
*
* Allocates and initializes a new #GtkConstraintVariable for an objective
* Allocates and initializes a new `GtkConstraintVariable` for an objective
* symbol. This is the constant value we wish to find as the result of the
* simplex optimization.
*
* Only #GtkConstraintSolver should use this function.
* Only `GtkConstraintSolver` should use this function.
*
* Returns: a newly allocated #GtkConstraintVariable
* Returns: a newly allocated `GtkConstraintVariable`
*/
GtkConstraintVariable *
gtk_constraint_variable_new_objective (const char *name)
@ -125,7 +125,7 @@ gtk_constraint_variable_new_objective (const char *name)
* gtk_constraint_variable_new_slack:
* @name: the name of the variable
*
* Allocates and initializes a new #GtkConstraintVariable for a "slack"
* Allocates and initializes a new `GtkConstraintVariable` for a "slack"
* symbol. Slack variables are introduced inside the tableau to turn
* inequalities, like:
*
@ -139,9 +139,9 @@ gtk_constraint_variable_new_objective (const char *name)
* expr - slack = 0
* ]|
*
* Only #GtkConstraintSolver should use this function.
* Only `GtkConstraintSolver` should use this function.
*
* Returns: a newly allocated #GtkConstraintVariable
* Returns: a newly allocated `GtkConstraintVariable`
*/
GtkConstraintVariable *
gtk_constraint_variable_new_slack (const char *name)
@ -163,15 +163,15 @@ gtk_constraint_variable_new_slack (const char *name)
* @prefix: (nullable): an optional prefix string for @name
* @name: (nullable): an optional name for the variable
*
* Allocates and initializes a new #GtkConstraintVariable for a regular
* Allocates and initializes a new `GtkConstraintVariable` for a regular
* symbol. All variables introduced by constraints are regular variables.
*
* Only #GtkConstraintSolver should use this function; a constraint layout
* manager should ask the #GtkConstraintSolver to create a variable, using
* Only `GtkConstraintSolver` should use this function; a constraint layout
* manager should ask the `GtkConstraintSolver` to create a variable, using
* gtk_constraint_solver_create_variable(), which will insert the variable
* in the solver's tableau.
*
* Returns: a newly allocated #GtkConstraintVariable
* Returns: a newly allocated `GtkConstraintVariable`
*/
GtkConstraintVariable *
gtk_constraint_variable_new (const char *prefix,
@ -191,11 +191,11 @@ gtk_constraint_variable_new (const char *prefix,
/*< private >
* gtk_constraint_variable_ref:
* @variable: a #GtkConstraintVariable
* @variable: a `GtkConstraintVariable`
*
* Acquires a reference to @variable.
*
* Returns: (transfer full): the given #GtkConstraintVariable, with its reference
* Returns: (transfer full): the given `GtkConstraintVariable`, with its reference
* count increased
*/
GtkConstraintVariable *
@ -208,7 +208,7 @@ gtk_constraint_variable_ref (GtkConstraintVariable *variable)
/*< private >
* gtk_constraint_variable_unref:
* @variable: (transfer full): a #GtkConstraintVariable
* @variable: (transfer full): a `GtkConstraintVariable`
*
* Releases a reference to @variable.
*/
@ -222,9 +222,9 @@ gtk_constraint_variable_unref (GtkConstraintVariable *variable)
/*< private >
* gtk_constraint_variable_set_value:
* @variable: a #GtkConstraintVariable
* @variable: a `GtkConstraintVariable`
*
* Sets the current value of a #GtkConstraintVariable.
* Sets the current value of a `GtkConstraintVariable`.
*/
void
gtk_constraint_variable_set_value (GtkConstraintVariable *variable,
@ -235,9 +235,9 @@ gtk_constraint_variable_set_value (GtkConstraintVariable *variable,
/*< private >
* gtk_constraint_variable_get_value:
* @variable: a #GtkConstraintVariable
* @variable: a `GtkConstraintVariable`
*
* Retrieves the current value of a #GtkConstraintVariable
* Retrieves the current value of a `GtkConstraintVariable`
*
* Returns: the value of the variable
*/
@ -249,7 +249,7 @@ gtk_constraint_variable_get_value (const GtkConstraintVariable *variable)
/*< private >
* gtk_constraint_variable_to_string:
* @variable: a #GtkConstraintVariable
* @variable: a `GtkConstraintVariable`
*
* Turns @variable into a string, for debugging purposes.
*
@ -311,7 +311,7 @@ gtk_constraint_variable_to_string (const GtkConstraintVariable *variable)
/*< private >
* gtk_constraint_variable_is_external:
* @variable: a #GtkConstraintVariable
* @variable: a `GtkConstraintVariable`
*
* Checks whether the @variable was introduced from outside the solver.
*
@ -325,7 +325,7 @@ gtk_constraint_variable_is_external (const GtkConstraintVariable *variable)
/*< private >
* gtk_constraint_variable_is_pivotable:
* @variable: a #GtkConstraintVariable
* @variable: a `GtkConstraintVariable`
*
* Checks whether the @variable can be used as a pivot.
*
@ -339,7 +339,7 @@ gtk_constraint_variable_is_pivotable (const GtkConstraintVariable *variable)
/*< private >
* gtk_constraint_variable_is_restricted:
* @variable: a #GtkConstraintVariable
* @variable: a `GtkConstraintVariable`
*
* Checks whether the @variable's use is restricted.
*
@ -353,7 +353,7 @@ gtk_constraint_variable_is_restricted (const GtkConstraintVariable *variable)
/*< private >
* gtk_constraint_variable_is_dummy:
* @variable: a #GtkConstraintVariable
* @variable: a `GtkConstraintVariable`
*
* Checks whether the @variable is a dummy symbol.
*
@ -380,9 +380,9 @@ struct _GtkConstraintVariableSet {
/*< private >
* gtk_constraint_variable_set_free:
* @set: a #GtkConstraintVariableSet
* @set: a `GtkConstraintVariable`Set
*
* Frees the resources associated to a #GtkConstraintVariableSet/
* Frees the resources associated to a `GtkConstraintVariable`Set/
*/
void
gtk_constraint_variable_set_free (GtkConstraintVariableSet *set)
@ -397,7 +397,7 @@ gtk_constraint_variable_set_free (GtkConstraintVariableSet *set)
/*< private >
* gtk_constraint_variable_set_new:
*
* Creates a new #GtkConstraintVariableSet.
* Creates a new `GtkConstraintVariable`Set.
*
* Returns: the newly created variable set
*/
@ -428,8 +428,8 @@ sort_by_variable_id (gconstpointer a,
/*< private >
* gtk_constraint_variable_set_add:
* @set: a #GtkConstraintVariableSet
* @variable: a #GtkConstraintVariable
* @set: a `GtkConstraintVariable`Set
* @variable: a `GtkConstraintVariable`
*
* Adds @variable to the given @set, if the @variable is not already
* in it.
@ -463,8 +463,8 @@ gtk_constraint_variable_set_add (GtkConstraintVariableSet *set,
/*< private >
* gtk_constraint_variable_set_remove:
* @set: a #GtkConstraintVariableSet
* @variable: a #GtkConstraintVariable
* @set: a `GtkConstraintVariable`Set
* @variable: a `GtkConstraintVariable`
*
* Removes @variable from the @set.
*
@ -493,7 +493,7 @@ gtk_constraint_variable_set_remove (GtkConstraintVariableSet *set,
/*< private >
* gtk_constraint_variable_set_size:
* @set: a #GtkConstraintVariableSet
* @set: a `GtkConstraintVariable`Set
*
* Retrieves the size of the @set.
*
@ -520,7 +520,7 @@ gtk_constraint_variable_set_is_singleton (GtkConstraintVariableSet *set)
/*< private >
* GtkConstraintVariableSetIter:
*
* An iterator type for #GtkConstraintVariableSet.
* An iterator type for `GtkConstraintVariable`Set.
*/
/* Keep in sync with GtkConstraintVariableSetIter */
typedef struct {
@ -533,8 +533,8 @@ typedef struct {
/*< private >
* gtk_constraint_variable_set_iter_init:
* @iter: a #GtkConstraintVariableSetIter
* @set: the #GtkConstraintVariableSet to iterate
* @iter: a `GtkConstraintVariable`SetIter
* @set: the `GtkConstraintVariable`Set to iterate
*
* Initializes @iter for iterating over @set.
*/
@ -554,10 +554,10 @@ gtk_constraint_variable_set_iter_init (GtkConstraintVariableSetIter *iter,
/*< private >
* gtk_constraint_variable_set_iter_next:
* @iter: a #GtkConstraintVariableSetIter
* @iter: a `GtkConstraintVariable`SetIter
* @variable_p: (out): the next variable in the set
*
* Advances the @iter to the next variable in the #GtkConstraintVariableSet.
* Advances the @iter to the next variable in the `GtkConstraintVariable`Set.
*
* Returns: %TRUE if the iterator was advanced, and %FALSE otherwise
*/
@ -583,15 +583,15 @@ gtk_constraint_variable_set_iter_next (GtkConstraintVariableSetIter *iter,
/*< private >
* gtk_constraint_variable_pair_new:
* @first: a #GtkConstraintVariable
* @second: a #GtkConstraintVariable
* @first: a `GtkConstraintVariable`
* @second: a `GtkConstraintVariable`
*
* Creates a new #GtkConstraintVariablePair, containing @first and @second.
* Creates a new `GtkConstraintVariable`Pair, containing @first and @second.
*
* The #GtkConstraintVariablePair acquires a reference over the two
* given #GtkConstraintVariables.
* The `GtkConstraintVariable`Pair acquires a reference over the two
* given `GtkConstraintVariable`s.
*
* Returns: a new #GtkConstraintVariablePair
* Returns: a new `GtkConstraintVariable`Pair
*/
GtkConstraintVariablePair *
gtk_constraint_variable_pair_new (GtkConstraintVariable *first,
@ -607,7 +607,7 @@ gtk_constraint_variable_pair_new (GtkConstraintVariable *first,
/*< private >
* gtk_constraint_variable_pair_free:
* @pair: a #GtkConstraintVariablePair
* @pair: a `GtkConstraintVariable`Pair
*
* Frees the resources associated by @pair.
*/
@ -626,7 +626,7 @@ gtk_constraint_variable_pair_free (GtkConstraintVariablePair *pair)
/*< private >
* Term:
* @variable: a #GtkConstraintVariable
* @variable: a `GtkConstraintVariable`
* @coefficient: the coefficient applied to the @variable
* @next: the next term in the expression
* @prev: the previous term in the expression;
@ -692,12 +692,12 @@ struct _GtkConstraintExpression
/*< private >
* gtk_constraint_expression_add_term:
* @self: a #GtkConstraintExpression
* @variable: a #GtkConstraintVariable
* @self: a `GtkConstraintExpression`
* @variable: a `GtkConstraintVariable`
* @coefficient: a coefficient for @variable
*
* Adds a new term formed by (@variable, @coefficient) into a
* #GtkConstraintExpression.
* `GtkConstraintExpression`.
*
* The @expression acquires a reference on @variable.
*/
@ -790,7 +790,7 @@ gtk_constraint_expression_remove_term (GtkConstraintExpression *self,
* gtk_constraint_expression_new:
* @constant: a constant for the expression
*
* Creates a new #GtkConstraintExpression with the given @constant.
* Creates a new `GtkConstraintExpression` with the given @constant.
*
* Returns: (transfer full): the newly created expression
*/
@ -810,9 +810,9 @@ gtk_constraint_expression_new (double constant)
/*< private >
* gtk_constraint_expression_new_from_variable:
* @variable: a #GtkConstraintVariable
* @variable: a `GtkConstraintVariable`
*
* Creates a new #GtkConstraintExpression with the given @variable.
* Creates a new `GtkConstraintExpression` with the given @variable.
*
* Returns: (transfer full): the newly created expression
*/
@ -828,7 +828,7 @@ gtk_constraint_expression_new_from_variable (GtkConstraintVariable *variable)
/*< private >
* gtk_constraint_expression_ref:
* @expression: a #GtkConstraintExpression
* @expression: a `GtkConstraintExpression`
*
* Acquires a reference on @expression.
*
@ -858,7 +858,7 @@ gtk_constraint_expression_clear (gpointer data)
/*< private >
* gtk_constraint_expression_unref:
* @expression: (transfer full): a #GtkConstraintExpression
* @expression: (transfer full): a `GtkConstraintExpression`
*
* Releases a reference on @expression.
*/
@ -870,7 +870,7 @@ gtk_constraint_expression_unref (GtkConstraintExpression *expression)
/*< private >
* gtk_constraint_expression_is_constant:
* @expression: a #GtkConstraintExpression
* @expression: a `GtkConstraintExpression`
*
* Checks whether @expression is a constant value, with no variable terms.
*
@ -884,7 +884,7 @@ gtk_constraint_expression_is_constant (const GtkConstraintExpression *expression
/*< private >
* gtk_constraint_expression_set_constant:
* @expression: a #GtkConstraintExpression
* @expression: a `GtkConstraintExpression`
* @constant: the value of the constant
*
* Sets the value of the constant part of @expression.
@ -900,7 +900,7 @@ gtk_constraint_expression_set_constant (GtkConstraintExpression *expression,
/*< private >
* gtk_constraint_expression_get_constant:
* @expression: a #GtkConstraintExpression
* @expression: a `GtkConstraintExpression`
*
* Retrieves the constant value of @expression.
*
@ -935,11 +935,11 @@ gtk_constraint_expression_clone (GtkConstraintExpression *expression)
/*< private >
* gtk_constraint_expression_add_variable:
* @expression: a #GtkConstraintExpression
* @variable: a #GtkConstraintVariable to add to @expression
* @expression: a `GtkConstraintExpression`
* @variable: a `GtkConstraintVariable` to add to @expression
* @coefficient: the coefficient of @variable
* @subject: (nullable): a #GtkConstraintVariable
* @solver: (nullable): a #GtkConstraintSolver
* @subject: (nullable): a `GtkConstraintVariable`
* @solver: (nullable): a `GtkConstraintSolver`
*
* Adds a `(@coefficient × @variable)` term to @expression.
*
@ -998,8 +998,8 @@ gtk_constraint_expression_add_variable (GtkConstraintExpression *expression,
/*< private >
* gtk_constraint_expression_remove_variable:
* @expression: a #GtkConstraintExpression
* @variable: a #GtkConstraintVariable
* @expression: a `GtkConstraintExpression`
* @variable: a `GtkConstraintVariable`
*
* Removes @variable from @expression.
*/
@ -1015,8 +1015,8 @@ gtk_constraint_expression_remove_variable (GtkConstraintExpression *expression,
/*< private >
* gtk_constraint_expression_set_variable:
* @expression: a #GtkConstraintExpression
* @variable: a #GtkConstraintVariable
* @expression: a `GtkConstraintExpression`
* @variable: a `GtkConstraintVariable`
* @coefficient: a coefficient for @variable
*
* Sets the @coefficient for @variable inside an @expression.
@ -1048,8 +1048,8 @@ gtk_constraint_expression_set_variable (GtkConstraintExpression *expression,
* @a_expr: first operand
* @b_expr: second operand
* @n: the multiplication factor for @b_expr
* @subject: (nullable): a #GtkConstraintVariable
* @solver: (nullable): a #GtkConstraintSolver
* @subject: (nullable): a `GtkConstraintVariable`
* @solver: (nullable): a `GtkConstraintSolver`
*
* Adds `(@n × @b_expr)` to @a_expr.
*
@ -1066,7 +1066,7 @@ gtk_constraint_expression_set_variable (GtkConstraintExpression *expression,
* a.x + a.width - b.x - b.width = 0
* ]|
*
* If @solver is not %NULL, this function will notify a #GtkConstraintSolver
* If @solver is not %NULL, this function will notify a `GtkConstraintSolver`
* of every variable that was added or removed from @a_expr.
*/
void
@ -1096,12 +1096,12 @@ gtk_constraint_expression_add_expression (GtkConstraintExpression *a_expr,
/*< private >
* gtk_constraint_expression_plus_constant:
* @expression: a #GtkConstraintExpression
* @expression: a `GtkConstraintExpression`
* @constant: a constant value
*
* Adds a @constant value to the @expression.
*
* This is the equivalent of creating a new #GtkConstraintExpression for
* This is the equivalent of creating a new `GtkConstraintExpression` for
* the @constant and calling gtk_constraint_expression_add_expression().
*
* Returns: the @expression
@ -1121,12 +1121,12 @@ gtk_constraint_expression_plus_constant (GtkConstraintExpression *expression,
/*< private >
* gtk_constraint_expression_minus_constant:
* @expression: a #GtkConstraintExpression
* @expression: a `GtkConstraintExpression`
* @constant: a constant value
*
* Removes a @constant value from the @expression.
*
* This is the equivalent of creating a new #GtkConstraintExpression for
* This is the equivalent of creating a new `GtkConstraintExpression` for
* the inverse of @constant and calling gtk_constraint_expression_add_expression().
*
* Returns: the @expression
@ -1140,8 +1140,8 @@ gtk_constraint_expression_minus_constant (GtkConstraintExpression *expression,
/*< private >
* gtk_constraint_expression_plus_variable:
* @expression: a #GtkConstraintExpression
* @variable: a #GtkConstraintVariable
* @expression: a `GtkConstraintExpression`
* @variable: a `GtkConstraintVariable`
*
* Adds a @variable to the @expression.
*
@ -1162,8 +1162,8 @@ gtk_constraint_expression_plus_variable (GtkConstraintExpression *expression,
/*< private >
* gtk_constraint_expression_minus_variable:
* @expression: a #GtkConstraintExpression
* @variable: a #GtkConstraintVariable
* @expression: a `GtkConstraintExpression`
* @variable: a `GtkConstraintVariable`
*
* Subtracts a @variable from the @expression.
*
@ -1184,7 +1184,7 @@ gtk_constraint_expression_minus_variable (GtkConstraintExpression *expression,
/*< private >
* gtk_constraint_expression_multiply_by:
* @expression: a #GtkConstraintExpression
* @expression: a `GtkConstraintExpression`
* @factor: the multiplication factor
*
* Multiplies the constant part and the coefficient of all terms
@ -1217,7 +1217,7 @@ gtk_constraint_expression_multiply_by (GtkConstraintExpression *expression,
/*< private >
* gtk_constraint_expression_divide_by:
* @expression: a #GtkConstraintExpression
* @expression: a `GtkConstraintExpression`
* @factor: the division factor
*
* Divides the constant part and the coefficient of all terms
@ -1237,12 +1237,12 @@ gtk_constraint_expression_divide_by (GtkConstraintExpression *expression,
/*< private >
* gtk_constraint_expression_new_subject:
* @expression: a #GtkConstraintExpression
* @subject: a #GtkConstraintVariable part of @expression
* @expression: a `GtkConstraintExpression`
* @subject: a `GtkConstraintVariable` part of @expression
*
* Modifies @expression to have a new @subject.
*
* A #GtkConstraintExpression is a linear expression in the form of
* A `GtkConstraintExpression` is a linear expression in the form of
* `@expression = 0`. If @expression contains @subject, for instance:
*
* |[
@ -1283,9 +1283,9 @@ gtk_constraint_expression_new_subject (GtkConstraintExpression *expression,
/*< private >
* gtk_constraint_expression_change_subject:
* @expression: a #GtkConstraintExpression
* @old_subject: the old subject #GtkConstraintVariable of @expression
* @new_subject: the new subject #GtkConstraintVariable of @expression
* @expression: a `GtkConstraintExpression`
* @old_subject: the old subject `GtkConstraintVariable` of @expression
* @new_subject: the new subject `GtkConstraintVariable` of @expression
*
* Turns an @expression in the form of:
*
@ -1318,8 +1318,8 @@ gtk_constraint_expression_change_subject (GtkConstraintExpression *expression,
/*< private >
* gtk_constraint_expression_get_coefficient:
* @expression: a #GtkConstraintExpression
* @variable: a #GtkConstraintVariable
* @expression: a `GtkConstraintExpression`
* @variable: a `GtkConstraintVariable`
*
* Retrieves the coefficient of the term for @variable inside @expression.
*
@ -1346,15 +1346,15 @@ gtk_constraint_expression_get_coefficient (GtkConstraintExpression *expression,
/*< private >
* gtk_constraint_expression_substitute_out:
* @expression: a #GtkConstraintExpression
* @expression: a `GtkConstraintExpression`
* @out_var: the variable to replace
* @expr: the expression used to replace @out_var
* @subject: (nullable): a #GtkConstraintVariable
* @solver: (nullable): a #GtkConstraintSolver
* @subject: (nullable): a `GtkConstraintVariable`
* @solver: (nullable): a `GtkConstraintSolver`
*
* Replaces every term containing @out_var inside @expression with @expr.
*
* If @solver is not %NULL, this function will notify the #GtkConstraintSolver
* If @solver is not %NULL, this function will notify the `GtkConstraintSolver`
* for every variable added to or removed from @expression.
*/
void
@ -1412,12 +1412,12 @@ gtk_constraint_expression_substitute_out (GtkConstraintExpression *expression,
/*< private >
* gtk_constraint_expression_get_pivotable_variable:
* @expression: a #GtkConstraintExpression
* @expression: a `GtkConstraintExpression`
*
* Retrieves the first #GtkConstraintVariable in @expression that
* Retrieves the first `GtkConstraintVariable` in @expression that
* is marked as pivotable.
*
* Returns: (transfer none) (nullable): a #GtkConstraintVariable
* Returns: (transfer none) (nullable): a `GtkConstraintVariable`
*/
GtkConstraintVariable *
gtk_constraint_expression_get_pivotable_variable (GtkConstraintExpression *expression)
@ -1446,7 +1446,7 @@ gtk_constraint_expression_get_pivotable_variable (GtkConstraintExpression *expre
/*< private >
* gtk_constraint_expression_to_string:
* @expression: a #GtkConstraintExpression
* @expression: a `GtkConstraintExpression`
*
* Creates a string containing @expression.
*
@ -1513,8 +1513,8 @@ typedef struct {
/*< private >
* gtk_constraint_expression_iter_init:
* @iter: a #GtkConstraintExpressionIter
* @expression: a #GtkConstraintExpression
* @iter: a `GtkConstraintExpression`Iter
* @expression: a `GtkConstraintExpression`
*
* Initializes an iterator over @expression.
*/
@ -1531,11 +1531,11 @@ gtk_constraint_expression_iter_init (GtkConstraintExpressionIter *iter,
/*< private >
* gtk_constraint_expression_iter_next:
* @iter: a valid #GtkConstraintExpressionIter
* @iter: a valid `GtkConstraintExpression`Iter
* @variable: (out): the variable of the next term
* @coefficient: (out): the coefficient of the next term
*
* Moves the given #GtkConstraintExpressionIter forwards to the next
* Moves the given `GtkConstraintExpression`Iter forwards to the next
* term in the expression, starting from the first term.
*
* Returns: %TRUE if the iterator was moved, and %FALSE if the iterator
@ -1566,11 +1566,11 @@ gtk_constraint_expression_iter_next (GtkConstraintExpressionIter *iter,
/*< private >
* gtk_constraint_expression_iter_prev:
* @iter: a valid #GtkConstraintExpressionIter
* @iter: a valid `GtkConstraintExpression`Iter
* @variable: (out): the variable of the previous term
* @coefficient: (out): the coefficient of the previous term
*
* Moves the given #GtkConstraintExpressionIter backwards to the previous
* Moves the given `GtkConstraintExpression`Iter backwards to the previous
* term in the expression, starting from the last term.
*
* Returns: %TRUE if the iterator was moved, and %FALSE if the iterator
@ -1618,11 +1618,11 @@ typedef struct
/*< private >
* gtk_constraint_expression_builder_init:
* @builder: a #GtkConstraintExpressionBuilder
* @solver: a #GtkConstraintSolver
* @builder: a `GtkConstraintExpression`Builder
* @solver: a `GtkConstraintSolver`
*
* Initializes the given #GtkConstraintExpressionBuilder for the
* given #GtkConstraintSolver.
* Initializes the given `GtkConstraintExpression`Builder for the
* given `GtkConstraintSolver`.
*
* You can use the @builder to construct expressions to be added to the
* @solver, in the form of constraints.
@ -1666,8 +1666,8 @@ gtk_constraint_expression_builder_init (GtkConstraintExpressionBuilder *builder,
/*< private >
* gtk_constraint_expression_builder_term:
* @builder: a #GtkConstraintExpressionBuilder
* @term: a #GtkConstraintVariable
* @builder: a `GtkConstraintExpression`Builder
* @term: a `GtkConstraintVariable`
*
* Adds a variable @term to the @builder.
*/
@ -1712,7 +1712,7 @@ gtk_constraint_expression_builder_term (GtkConstraintExpressionBuilder *builder,
/*< private >
* gtk_constraint_expression_builder_plus:
* @builder: a #GtkConstraintExpressionBuilder
* @builder: a `GtkConstraintExpression`Builder
*
* Adds a plus operator to the @builder.
*/
@ -1726,7 +1726,7 @@ gtk_constraint_expression_builder_plus (GtkConstraintExpressionBuilder *builder)
/*< private >
* gtk_constraint_expression_builder_minus:
* @builder: a #GtkConstraintExpressionBuilder
* @builder: a `GtkConstraintExpression`Builder
*
* Adds a minus operator to the @builder.
*/
@ -1740,7 +1740,7 @@ gtk_constraint_expression_builder_minus (GtkConstraintExpressionBuilder *builder
/*< private >
* gtk_constraint_expression_builder_divide_by:
* @builder: a #GtkConstraintExpressionBuilder
* @builder: a `GtkConstraintExpression`Builder
*
* Adds a division operator to the @builder.
*/
@ -1754,7 +1754,7 @@ gtk_constraint_expression_builder_divide_by (GtkConstraintExpressionBuilder *bui
/*< private >
* gtk_constraint_expression_builder_multiply_by:
* @builder: a #GtkConstraintExpressionBuilder
* @builder: a `GtkConstraintExpression`Builder
*
* Adds a multiplication operator to the @builder.
*/
@ -1769,7 +1769,7 @@ gtk_constraint_expression_builder_multiply_by (GtkConstraintExpressionBuilder *b
/*< private >
* gtk_constraint_expression_builder_constant:
* @builder: a #GtkConstraintExpressionBuilder
* @builder: a `GtkConstraintExpression`Builder
* @value: a constant value
*
* Adds a constant value to the @builder.
@ -1811,7 +1811,7 @@ gtk_constraint_expression_builder_constant (GtkConstraintExpressionBuilder *buil
/*< private >
* gtk_constraint_expression_builder_finish:
* @builder: a #GtkConstraintExpressionBuilder
* @builder: a `GtkConstraintExpression`Builder
*
* Closes the given expression builder, and returns the expression.
*

2
gtk/gtkconstraintexpressionprivate.h
View File

@ -253,7 +253,7 @@ gtk_constraint_expression_builder_finish (GtkConstraintExpressionBuilder *builde
/*< private >
* GtkConstraintExpressionIter:
*
* An iterator object for terms inside a #GtkConstraintExpression.
* An iterator object for terms inside a `GtkConstraintExpression`.
*/
typedef struct {
/*< private >*/

6
gtk/gtkconstraintlayout.c
View File

@ -106,7 +106,7 @@
* There can be "constant" and "multiplier" attributes.
*
* Additionally, the "constraints" element can also contain a description
* of the #GtkConstraintGuides used by the layout:
* of the `GtkConstraintGuides` used by the layout:
*
* ```xml
* <constraints>
@ -736,10 +736,10 @@ get_layout_attribute (GtkConstraintLayout *self,
* @self: a `GtkConstraintLayout`
* @constraint: a [class@Gtk.Constraint]
*
* Turns a #GtkConstraint into a #GtkConstraintRef inside the
* Turns a `GtkConstraint` into a `GtkConstraintRef` inside the
* constraint solver associated to @self.
*
* If @self does not have a #GtkConstraintSolver, because it
* If @self does not have a `GtkConstraintSolver`, because it
* has not been rooted yet, we just store the @constraint instance,
* and we're going to call this function when the layout manager
* gets rooted.

86
gtk/gtkconstraintsolver.c
View File

@ -637,9 +637,9 @@ gtk_constraint_solver_remove_row (GtkConstraintSolver *self,
/*< private >
* gtk_constraint_solver_substitute_out:
* @self: a #GtkConstraintSolver
* @old_variable: a #GtkConstraintVariable
* @expression: a #GtkConstraintExpression
* @self: a `GtkConstraintSolver`
* @old_variable: a `GtkConstraintVariable`
* @expression: a `GtkConstraintExpression`
*
* Replaces @old_variable in every row of the tableau with @expression.
*/
@ -678,11 +678,11 @@ gtk_constraint_solver_substitute_out (GtkConstraintSolver *self,
/*< private >
* gtk_constraint_solver_pivot:
* @self: a #GtkConstraintSolver
* @entry_var: a #GtkConstraintVariable
* @exit_var: a #GtkConstraintVariable
* @self: a `GtkConstraintSolver`
* @entry_var: a `GtkConstraintVariable`
* @exit_var: a `GtkConstraintVariable`
*
* Pivots the #GtkConstraintSolver.
* Pivots the `GtkConstraintSolver`.
*
* This function will move @entry_var into the basis of the tableau,
* making it a basic variable; and move @exit_var out of the basis of
@ -824,8 +824,8 @@ gtk_constraint_solver_optimize (GtkConstraintSolver *self,
/*< private >
* gtk_constraint_solver_new_expression:
* @self: a #GtkConstraintSolver
* @constraint: a #GtkConstraintRef
* @self: a `GtkConstraintSolver`
* @constraint: a `GtkConstraintRef`
* @eplus_p: (out) (optional): the positive error variable
* @eminus_p: (out) (optional): the negative error variable
* @prev_constant_p: the constant part of the @constraint's expression
@ -1368,9 +1368,9 @@ gtk_constraint_solver_add_constraint_internal (GtkConstraintSolver *self,
/*< private >
* gtk_constraint_solver_new:
*
* Creates a new #GtkConstraintSolver instance.
* Creates a new `GtkConstraintSolver` instance.
*
* Returns: the newly created #GtkConstraintSolver
* Returns: the newly created `GtkConstraintSolver`
*/
GtkConstraintSolver *
gtk_constraint_solver_new (void)
@ -1380,7 +1380,7 @@ gtk_constraint_solver_new (void)
/*< private >
* gtk_constraint_solver_freeze:
* @solver: a #GtkConstraintSolver
* @solver: a `GtkConstraintSolver`
*
* Freezes the solver; any constraint addition or removal will not
* be automatically solved until gtk_constraint_solver_thaw() is
@ -1399,9 +1399,9 @@ gtk_constraint_solver_freeze (GtkConstraintSolver *solver)
/*< private >
* gtk_constraint_solver_thaw:
* @solver: a #GtkConstraintSolver
* @solver: a `GtkConstraintSolver`
*
* Thaws a frozen #GtkConstraintSolver.
* Thaws a frozen `GtkConstraintSolver`.
*/
void
gtk_constraint_solver_thaw (GtkConstraintSolver *solver)
@ -1420,13 +1420,13 @@ gtk_constraint_solver_thaw (GtkConstraintSolver *solver)
/*< private >
* gtk_constraint_solver_note_added_variable:
* @self: a #GtkConstraintSolver
* @variable: a #GtkConstraintVariable
* @subject: a #GtkConstraintVariable
* @self: a `GtkConstraintSolver`
* @variable: a `GtkConstraintVariable`
* @subject: a `GtkConstraintVariable`
*
* Adds a new @variable into the tableau of a #GtkConstraintSolver.
* Adds a new @variable into the tableau of a `GtkConstraintSolver`.
*
* This function is typically called by #GtkConstraintExpression, and
* This function is typically called by `GtkConstraintExpression`, and
* should never be directly called.
*/
void
@ -1440,13 +1440,13 @@ gtk_constraint_solver_note_added_variable (GtkConstraintSolver *self,
/*< private >
* gtk_constraint_solver_note_removed_variable:
* @self: a #GtkConstraintSolver
* @variable: a #GtkConstraintVariable
* @subject: a #GtkConstraintVariable
* @self: a `GtkConstraintSolver`
* @variable: a `GtkConstraintVariable`
* @subject: a `GtkConstraintVariable`
*
* Removes a @variable from the tableau of a #GtkConstraintSolver.
* Removes a @variable from the tableau of a `GtkConstraintSolver`.
*
* This function is typically called by #GtkConstraintExpression, and
* This function is typically called by `GtkConstraintExpression`, and
* should never be directly called.
*/
void
@ -1463,7 +1463,7 @@ gtk_constraint_solver_note_removed_variable (GtkConstraintSolver *self,
/*< private >
* gtk_constraint_solver_create_variable:
* @self: a #GtkConstraintSolver
* @self: a `GtkConstraintSolver`
* @prefix: (nullable): the prefix of the variable
* @name: (nullable): the name of the variable
* @value: the initial value of the variable
@ -1490,7 +1490,7 @@ gtk_constraint_solver_create_variable (GtkConstraintSolver *self,
/*< private >
* gtk_constraint_solver_resolve:
* @solver: a #GtkConstraintSolver
* @solver: a `GtkConstraintSolver`
*
* Resolves the constraints currently stored in @solver.
*/
@ -1519,7 +1519,7 @@ gtk_constraint_solver_resolve (GtkConstraintSolver *solver)
/*< private >
* gtk_constraint_solver_add_constraint:
* @self: a #GtkConstraintSolver
* @self: a `GtkConstraintSolver`
* @variable: the subject of the constraint
* @relation: the relation of the constraint
* @expression: the expression of the constraint
@ -1531,7 +1531,7 @@ gtk_constraint_solver_resolve (GtkConstraintSolver *solver)
* variable relation expression (strength)
* |]
*
* into the #GtkConstraintSolver.
* into the `GtkConstraintSolver`.
*
* Returns: (transfer none): a reference to the newly created
* constraint; you can use the reference to remove the
@ -1597,8 +1597,8 @@ gtk_constraint_solver_add_constraint (GtkConstraintSolver *self,
/*< private >
* gtk_constraint_solver_add_stay_variable:
* @self: a #GtkConstraintSolver
* @variable: a stay #GtkConstraintVariable
* @self: a `GtkConstraintSolver`
* @variable: a stay `GtkConstraintVariable`
* @strength: the strength of the constraint
*
* Adds a constraint on a stay @variable with the given @strength.
@ -1646,7 +1646,7 @@ gtk_constraint_solver_add_stay_variable (GtkConstraintSolver *self,
/*< private >
* gtk_constraint_solver_remove_stay_variable:
* @self: a #GtkConstraintSolver
* @self: a `GtkConstraintSolver`
* @variable: a stay variable
*
* Removes the stay constraint associated to @variable.
@ -1675,14 +1675,14 @@ gtk_constraint_solver_remove_stay_variable (GtkConstraintSolver *self,
/*< private >
* gtk_constraint_solver_add_edit_variable:
* @self: a #GtkConstraintSolver
* @self: a `GtkConstraintSolver`
* @variable: an edit variable
* @strength: the strength of the constraint
*
* Adds an editable constraint to the @solver.
*
* Editable constraints can be used to suggest values to a
* #GtkConstraintSolver inside an edit phase, for instance: if
* `GtkConstraintSolver` inside an edit phase, for instance: if
* you want to change the value of a variable without necessarily
* insert a new constraint every time.
*
@ -1717,7 +1717,7 @@ gtk_constraint_solver_add_edit_variable (GtkConstraintSolver *self,
/*< private >
* gtk_constraint_solver_remove_edit_variable:
* @self: a #GtkConstraintSolver
* @self: a `GtkConstraintSolver`
* @variable: an edit variable
*
* Removes the edit constraint associated to @variable.
@ -1746,7 +1746,7 @@ gtk_constraint_solver_remove_edit_variable (GtkConstraintSolver *self,
/*< private >
* gtk_constraint_solver_remove_constraint:
* @self: a #GtkConstraintSolver
* @self: a `GtkConstraintSolver`
* @constraint: a constraint reference
*
* Removes a @constraint from the @solver.
@ -1956,8 +1956,8 @@ no_columns:
/*< private >
* gtk_constraint_solver_suggest_value:
* @self: a #GtkConstraintSolver
* @variable: a #GtkConstraintVariable
* @self: a `GtkConstraintSolver`
* @variable: a `GtkConstraintVariable`
* @value: the suggested value for @variable
*
* Suggests a new @value for an edit @variable.
@ -1995,8 +1995,8 @@ gtk_constraint_solver_suggest_value (GtkConstraintSolver *self,
/*< private >
* gtk_constraint_solver_has_stay_variable:
* @solver: a #GtkConstraintSolver
* @variable: a #GtkConstraintVariable
* @solver: a `GtkConstraintSolver`
* @variable: a `GtkConstraintVariable`
*
* Checks whether @variable is a stay variable.
*
@ -2014,8 +2014,8 @@ gtk_constraint_solver_has_stay_variable (GtkConstraintSolver *solver,
/*< private >
* gtk_constraint_solver_has_edit_variable:
* @solver: a #GtkConstraintSolver
* @variable: a #GtkConstraintVariable
* @solver: a `GtkConstraintSolver`
* @variable: a `GtkConstraintVariable`
*
* Checks whether @variable is an edit variable.
*
@ -2033,7 +2033,7 @@ gtk_constraint_solver_has_edit_variable (GtkConstraintSolver *solver,
/*< private >
* gtk_constraint_solver_begin_edit:
* @solver: a #GtkConstraintSolver
* @solver: a `GtkConstraintSolver`
*
* Begins the edit phase for a constraint system.
*
@ -2073,7 +2073,7 @@ edit_info_free (gpointer data)
/*< private >
* gtk_constraint_solver_end_edit:
* @solver: a #GtkConstraintSolver
* @solver: a `GtkConstraintSolver`
*
* Ends the edit phase for a constraint system, and clears
* all the edit variables introduced.

6
gtk/gtkconstrainttypesprivate.h
View File

@ -33,9 +33,9 @@ typedef struct _GtkConstraintExpressionBuilder GtkConstraintExpressionBuilder;
/*< private >
* GtkConstraintRef:
*
* A reference to a constraint stored inside the solver; while #GtkConstraint
* represent the public API, a #GtkConstraintRef represents data stored inside
* the solver. A #GtkConstraintRef is completely opaque, and should only be
* A reference to a constraint stored inside the solver; while `GtkConstraint`
* represent the public API, a `GtkConstraintRef` represents data stored inside
* the solver. A `GtkConstraintRef` is completely opaque, and should only be
* used to remove a constraint from the solver.
*/
typedef struct _GtkConstraintRef GtkConstraintRef;

6
gtk/gtkcountingbloomfilterprivate.h
View File

@ -82,7 +82,7 @@ static inline gboolean gtk_counting_bloom_filter_may_contain (const GtkCounti
/*
* gtk_counting_bloom_filter_add:
* @self: a #GtkCountingBloomFilter
* @self: a `GtkCountingBloomFilter`
* @hash: a hash value to add to the filter
*
* Adds the hash value to the filter.
@ -105,7 +105,7 @@ gtk_counting_bloom_filter_add (GtkCountingBloomFilter *self,
/*
* gtk_counting_bloom_filter_remove:
* @self: a #GtkCountingBloomFilter
* @self: a `GtkCountingBloomFilter`
* @hash: a hash value to remove from the filter
*
* Removes a hash value from the filter that has previously
@ -127,7 +127,7 @@ gtk_counting_bloom_filter_remove (GtkCountingBloomFilter *self,
/*
* gtk_counting_bloom_filter_may_contain:
* @self: a #GtkCountingBloomFilter
* @self: a `GtkCountingBloomFilter`
* @hash: the hash value to check
*
* Checks if @hash may be contained in @self.

2
gtk/gtkcssprovider.c
View File

@ -62,7 +62,7 @@
* [method@Gtk.CssProvider.load_from_file] or
* [method@Gtk.CssProvider.load_from_resource]
* and adding the provider with [method@Gtk.StyleContext.add_provider] or
* [func@Gtk.StyleContext.add_provider_for_display].
* [type_func@Gtk.StyleContext.add_provider_for_display].
* In addition, certain files will be read when GTK is initialized.
* First, the file `$XDG_CONFIG_HOME/gtk-4.0/gtk.css` is loaded if it

4
gtk/gtkcssstyle.c
View File

@ -308,8 +308,8 @@ gtk_css_style_get_static_style (GtkCssStyle *style)
/*
* gtk_css_style_print:
* @style: a #GtkCssStyle
* @string: the #GString to print to
* @style: a `GtkCssStyle`
* @string: the `GString` to print to
* @indent: level of indentation to use
* @skip_initial: %TRUE to skip properties that have their initial value
*

4
gtk/gtkcssvalue.c
View File

@ -315,7 +315,7 @@ _gtk_css_value_print (const GtkCssValue *value,
/**
* gtk_css_value_is_dynamic:
* @value: a #GtkCssValue
* @value: a `GtkCssValue`
*
* A "dynamic" value has a different value at different times. This means that
* the value needs to be animated when time is progressing.
@ -339,7 +339,7 @@ gtk_css_value_is_dynamic (const GtkCssValue *value)
/**
* gtk_css_value_get_dynamic_value:
* @value: a #GtkCssValue
* @value: a `GtkCssValue`
* @monotonic_time: the timestamp for which to get the dynamic value
*
* Gets the dynamic value for a given timestamp. If @monotonic_time is 0,

2
gtk/gtkcustomlayout.h
View File

@ -42,7 +42,7 @@ typedef GtkSizeRequestMode (* GtkCustomRequestModeFunc) (GtkWidget *widget);
* @minimum_baseline: (out): the measured minimum baseline of the widget
* @natural_baseline: (out): the measured natural baseline of the widget
*
* A function to be used by #GtkCustomLayout to measure a widget.
* A function to be used by `GtkCustomLayout` to measure a widget.
*/
typedef void (* GtkCustomMeasureFunc) (GtkWidget *widget,
GtkOrientation orientation,

2
gtk/gtkcustompaperunixdialog.c
View File

@ -390,7 +390,7 @@ gtk_custom_paper_unix_dialog_finalize (GObject *object)
*
* Creates a new custom paper dialog.
*
* Returns: the new #GtkCustomPaperUnixDialog
* Returns: the new `GtkCustomPaperUnixDialog`
*/
GtkWidget *
_gtk_custom_paper_unix_dialog_new (GtkWindow *parent,

4
gtk/gtkdialog.c
View File

@ -146,7 +146,7 @@
* on the “use-header-bar“ property. The response id has to be associated
* with the action widget using the <action-widgets> element.
*
* An example of a #GtkDialog UI definition fragment:
* An example of a `GtkDialog` UI definition fragment:
* ```xml
* <object class="GtkDialog" id="dialog1">
* <child type="action">
@ -1414,7 +1414,7 @@ gtk_dialog_get_header_bar (GtkDialog *dialog)
*
* Returns the content area of @dialog.
*
* Returns: (type Gtk.Box) (transfer none): the content area #GtkBox.
* Returns: (type Gtk.Box) (transfer none): the content area `GtkBox`.
*/
GtkWidget *
gtk_dialog_get_content_area (GtkDialog *dialog)

2
gtk/gtkdirectorylist.c
View File

@ -659,7 +659,7 @@ gtk_directory_list_update_monitoring (GtkDirectoryList *self)
/**
* gtk_directory_list_set_file: (attributes org.gtk.Method.set_property=file)
* @self: a `GtkDirectoryList`
* @file: (nullable): the #GFile to be enumerated
* @file: (nullable): the `GFile` to be enumerated
*
* Sets the @file to be enumerated and starts the enumeration.
*

4
gtk/gtkdragsource.c
View File

@ -708,7 +708,7 @@ gtk_drag_source_set_actions (GtkDragSource *source,
/**
* gtk_drag_source_set_icon:
* @source: a `GtkDragSource`
* @paintable: (nullable): the #GdkPaintable to use as icon
* @paintable: (nullable): the `GdkPaintable` to use as icon
* @hot_x: the hotspot X coordinate on the icon
* @hot_y: the hotspot Y coordinate on the icon
*
@ -776,7 +776,7 @@ gtk_drag_source_drag_cancel (GtkDragSource *source)
/**
* gtk_drag_check_threshold: (method)
* @widget: a #GtkWidget
* @widget: a `GtkWidget`
* @start_x: X coordinate of start of drag
* @start_y: Y coordinate of start of drag
* @current_x: current X coordinate

2
gtk/gtkdrawingarea.h
View File

@ -47,7 +47,7 @@ typedef struct _GtkDrawingAreaClass GtkDrawingAreaClass;
/**
* GtkDrawingAreaDrawFunc:
* @drawing_area: the #GtkDrawingArea to redraw
* @drawing_area: the `GtkDrawingArea` to redraw
* @cr: the context to draw to
* @width: the actual width of the contents. This value will be at least
* as wide as GtkDrawingArea:width.

2
gtk/gtkdroptarget.c
View File

@ -793,7 +793,7 @@ gtk_drop_target_class_init (GtkDropTargetClass *class)
/**
* GtkDropTarget::drop:
* @self: the `GtkDropTarget`
* @value: the #GValue being dropped
* @value: the `GValue` being dropped
* @x: the x coordinate of the current pointer position
* @y: the y coordinate of the current pointer position
*

12
gtk/gtkdroptargetasync.c
View File

@ -404,7 +404,7 @@ gtk_drop_target_async_class_init (GtkDropTargetAsyncClass *class)
/**
* GtkDropTargetAsync::accept:
* @self: the `GtkDropTargetAsync`
* @drop: the #GdkDrop
* @drop: the `GdkDrop`
*
* Emitted on the drop site when a drop operation is about to begin.
*
@ -437,7 +437,7 @@ gtk_drop_target_async_class_init (GtkDropTargetAsyncClass *class)
/**
* GtkDropTargetAsync::drag-enter:
* @self: the `GtkDropTargetAsync`
* @drop: the #GdkDrop
* @drop: the `GdkDrop`
* @x: the x coordinate of the current pointer position
* @y: the y coordinate of the current pointer position
*
@ -460,7 +460,7 @@ gtk_drop_target_async_class_init (GtkDropTargetAsyncClass *class)
/**
* GtkDropTargetAsync::drag-motion:
* @self: the `GtkDropTargetAsync`
* @drop: the #GdkDrop
* @drop: the `GdkDrop`
* @x: the x coordinate of the current pointer position
* @y: the y coordinate of the current pointer position
*
@ -481,7 +481,7 @@ gtk_drop_target_async_class_init (GtkDropTargetAsyncClass *class)
/**
* GtkDropTargetAsync::drag-leave:
* @self: the `GtkDropTargetAsync`
* @drop: the #GdkDrop
* @drop: the `GdkDrop`
*
* Emitted on the drop site when the pointer leaves the widget.
*
@ -501,7 +501,7 @@ gtk_drop_target_async_class_init (GtkDropTargetAsyncClass *class)
/**
* GtkDropTargetAsync::drop:
* @self: the `GtkDropTargetAsync`
* @drop: the #GdkDrop
* @drop: the `GdkDrop`
* @x: the x coordinate of the current pointer position
* @y: the y coordinate of the current pointer position
*
@ -648,7 +648,7 @@ gtk_drop_target_async_get_actions (GtkDropTargetAsync *self)
/**
* gtk_drop_target_async_reject_drop:
* @self: a `GtkDropTargetAsync`
* @drop: the #GdkDrop of an ongoing drag operation
* @drop: the `GdkDrop` of an ongoing drag operation
*
* Sets the @drop as not accepted on this drag site.
*

2
gtk/gtkeditable.c
View File

@ -66,7 +66,7 @@
* ## Implementing GtkEditable
*
* The most likely scenario for implementing `GtkEditable` on your own widget
* is that you will embed a #GtkText inside a complex widget, and want to
* is that you will embed a `GtkText` inside a complex widget, and want to
* delegate the editable functionality to that text widget. `GtkEditable`
* provides some utility functions to make this easy.
*

6
gtk/gtkeditablelabel.c
View File

@ -386,7 +386,7 @@ gtk_editable_label_class_init (GtkEditableLabelClass *class)
* The default bindings for this action are clicking
* on the widget and the Enter key.
*
* This action is disabled when #GtkEditableLabel:editing
* This action is disabled when `GtkEditableLabel:editing`
* is %FALSE.
*/
gtk_widget_class_install_action (widget_class, "editing.start", NULL, start_editing);
@ -397,12 +397,12 @@ gtk_editable_label_class_init (GtkEditableLabelClass *class)
*
* Switch the widget out of editing mode. If @commit
* is %TRUE, then the results of the editing are taken
* as the new value of #GtkEditable:text.
* as the new value of `GtkEditable:text`.
*
* The default binding for this action is the Escape
* key.
*
* This action is disabled when #GtkEditableLabel:editing
* This action is disabled when `GtkEditableLabel:editing`
* is %FALSE.
*/
gtk_widget_class_install_action (widget_class, "editing.stop", "b", stop_editing);

8
gtk/gtkentry.c
View File

@ -140,7 +140,7 @@
* The `GtkEntry` implementation of the `GtkBuildable` interface supports a
* custom <attributes> element, which supports any number of <attribute>
* elements. The <attribute> element has attributes named “name“, “value“,
* “start“ and “end“ and allows you to specify #PangoAttribute values for
* “start“ and “end“ and allows you to specify `PangoAttribute` values for
* this label.
*
* An example of a UI definition fragment specifying Pango attributes:
@ -333,7 +333,7 @@ G_DEFINE_TYPE_WITH_CODE (GtkEntry, gtk_entry, GTK_TYPE_WIDGET,
gtk_entry_cell_editable_init))
/* Implement the GtkAccessible interface, in order to obtain focus
* state from the #GtkText widget that we are wrapping. The GtkText
* state from the GtkText widget that we are wrapping. The GtkText
* widget is ignored for accessibility purposes (it has role NONE),
* and any a11y text functionality is implemented for GtkEntry and
* similar wrappers (GtkPasswordEntry, GtkSpinButton, etc).
@ -957,7 +957,7 @@ gtk_entry_class_init (GtkEntryClass *class)
*
* This is mainly useful to change the size or weight of the text.
*
* The #PangoAttribute's @start_index and @end_index must refer to the
* The `PangoAttribute`'s @start_index and @end_index must refer to the
* [class@Gtk.EntryBuffer] text, i.e. without the preedit string.
*/
entry_props[PROP_ATTRIBUTES] =
@ -2918,7 +2918,7 @@ gtk_entry_get_icon_at_pos (GtkEntry *entry,
* gtk_entry_set_icon_drag_source:
* @entry: a `GtkEntry`
* @icon_pos: icon position
* @provider: a #GdkContentProvider
* @provider: a `GdkContentProvider`
* @actions: a bitmask of the allowed drag actions
*
* Sets up the icon at the given position as drag source.

4
gtk/gtkentry.h
View File

@ -75,10 +75,10 @@ struct _GtkEntry
/**
* GtkEntryClass:
* @parent_class: The parent class.
* @activate: Class handler for the #GtkEntry::activate signal. The default
* @activate: Class handler for the `GtkEntry::activate` signal. The default
* implementation activates the gtk.activate-default action.
*
* Class structure for #GtkEntry. All virtual functions have a default
* Class structure for `GtkEntry`. All virtual functions have a default
* implementation. Derived classes may set the virtual function pointers for the
* signal handlers to %NULL, but must keep @get_text_area_size and
* @get_frame_size non-%NULL; either use the default implementation, or provide

8
gtk/gtkentrybuffer.c
View File

@ -378,7 +378,7 @@ gtk_entry_buffer_class_init (GtkEntryBufferClass *klass)
/**
* GtkEntryBuffer::inserted-text:
* @buffer: a #GtkEntryBuffer
* @buffer: a `GtkEntryBuffer`
* @position: the position the text was inserted at.
* @chars: The text that was inserted.
* @n_chars: The number of characters that were inserted.
@ -398,7 +398,7 @@ gtk_entry_buffer_class_init (GtkEntryBufferClass *klass)
/**
* GtkEntryBuffer::deleted-text:
* @buffer: a #GtkEntryBuffer
* @buffer: a `GtkEntryBuffer`
* @position: the position the text was deleted at.
* @n_chars: The number of characters that were deleted.
*
@ -466,7 +466,7 @@ gtk_entry_buffer_get_length (GtkEntryBuffer *buffer)
/**
* gtk_entry_buffer_get_bytes:
* @buffer: a #GtkEntryBuffer
* @buffer: a `GtkEntryBuffer`
*
* Retrieves the length in bytes of the buffer.
*
@ -582,7 +582,7 @@ gtk_entry_buffer_set_max_length (GtkEntryBuffer *buffer,
* Retrieves the maximum allowed length of the text in @buffer.
*
* Returns: the maximum allowed number of characters
* in #GtkEntryBuffer, or 0 if there is no maximum.
* in `GtkEntryBuffer`, or 0 if there is no maximum.
*/
int
gtk_entry_buffer_get_max_length (GtkEntryBuffer *buffer)

4
gtk/gtkentrycompletion.c
View File

@ -205,7 +205,7 @@ gtk_entry_completion_class_init (GtkEntryCompletionClass *klass)
*
* Applications may connect to this signal in order to insert only a
* smaller part of the @prefix into the entry - e.g. the entry used in
* the #GtkFileChooser inserts only the part of the prefix up to the
* the `GtkFileChooser` inserts only the part of the prefix up to the
* next '/'.
*
* Returns: %TRUE if the signal has been handled
@ -838,7 +838,7 @@ gtk_entry_completion_new (void)
/**
* gtk_entry_completion_new_with_area:
* @area: the #GtkCellArea used to layout cells
* @area: the `GtkCellArea` used to layout cells
*
* Creates a new `GtkEntryCompletion` object using the
* specified @area.

4
gtk/gtkentrycompletion.h
View File

@ -39,9 +39,9 @@ typedef struct _GtkEntryCompletion GtkEntryCompletion;
/**
* GtkEntryCompletionMatchFunc:
* @completion: the #GtkEntryCompletion
* @completion: the `GtkEntryCompletion`
* @key: the string to match, normalized and case-folded
* @iter: a #GtkTreeIter indicating the row to match
* @iter: a `GtkTreeIter` indicating the row to match
* @user_data: user data given to gtk_entry_completion_set_match_func()
*
* A function which decides whether the row indicated by @iter matches

28
gtk/gtkenums.h
View File

@ -927,7 +927,7 @@ typedef enum
* @GTK_LIMIT_NONE: Events are handled regardless of what their
* target is.
* @GTK_LIMIT_SAME_NATIVE: Events are only handled if their target
* is in the same #GtkNative as the event controllers widget. Note
* is in the same `GtkNative` as the event controllers widget. Note
* that some event types have two targets (origin and destination).
*
* Describes limits of a `GtkEventController` for handling events
@ -976,7 +976,7 @@ typedef enum
* @GTK_SHORTCUT_SCOPE_LOCAL: Shortcuts are handled inside
* the widget the controller belongs to.
* @GTK_SHORTCUT_SCOPE_MANAGED: Shortcuts are handled by
* the first ancestor that is a #GtkShortcutManager
* the first ancestor that is a `GtkShortcutManager`
* @GTK_SHORTCUT_SCOPE_GLOBAL: Shortcuts are handled by
* the root widget.
*
@ -994,7 +994,7 @@ typedef enum
* GtkPickFlags:
* @GTK_PICK_DEFAULT: The default behavior, include widgets that are receiving events
* @GTK_PICK_INSENSITIVE: Include widgets that are insensitive
* @GTK_PICK_NON_TARGETABLE: Include widgets that are marked as non-targetable. See #GtkWidget:can-target
* @GTK_PICK_NON_TARGETABLE: Include widgets that are marked as non-targetable. See `GtkWidget:can-target`
*
* Flags that influence the behavior of gtk_widget_pick().
*/
@ -1027,7 +1027,7 @@ typedef enum {
*
* The strength of a constraint, expressed as a symbolic constant.
*
* The strength of a #GtkConstraint can be expressed with any positive
* The strength of a `GtkConstraint` can be expressed with any positive
* integer; the values of this enumeration can be used for readability.
*/
typedef enum {
@ -1160,7 +1160,7 @@ typedef enum {
* @GTK_ACCESSIBLE_ROLE_GRID: A grid of items.
* @GTK_ACCESSIBLE_ROLE_GRID_CELL: An item in a grid or tree grid.
* @GTK_ACCESSIBLE_ROLE_GROUP: An element that groups multiple widgets. GTK uses
* this role for various containers, like #GtkBox, #GtkViewport, and #GtkHeaderBar.
* this role for various containers, like `GtkBox`, `GtkViewport`, and `GtkHeaderBar`.
* @GTK_ACCESSIBLE_ROLE_HEADING: Unused
* @GTK_ACCESSIBLE_ROLE_IMG: An image.
* @GTK_ACCESSIBLE_ROLE_INPUT: Abstract role.
@ -1322,22 +1322,22 @@ typedef enum {
* GtkAccessibleState:
* @GTK_ACCESSIBLE_STATE_BUSY: A “busy” state. This state has boolean values
* @GTK_ACCESSIBLE_STATE_CHECKED: A “checked” state; indicates the current
* state of a #GtkCheckButton. Value type: #GtkAccessibleTristate
* state of a `GtkCheckButton`. Value type: `GtkAccessibleTristate`
* @GTK_ACCESSIBLE_STATE_DISABLED: A “disabled” state; corresponds to the
* #GtkWidget:sensitive property on #GtkWidget. It indicates a UI element
* `GtkWidget:sensitive` property on `GtkWidget`. It indicates a UI element
* that is perceivable, but not editable or operable. Value type: boolean
* @GTK_ACCESSIBLE_STATE_EXPANDED: An “expanded” state; corresponds to the
* #GtkExpander:expanded property on #GtkExpander. Value type: boolean
* `GtkExpander:expanded` property on `GtkExpander`. Value type: boolean
* or undefined
* @GTK_ACCESSIBLE_STATE_HIDDEN: A “hidden” state; corresponds to the
* #GtkWidget:visible property on #GtkWidget. You can use this state
* `GtkWidget:visible` property on `GtkWidget`. You can use this state
* explicitly on UI elements that should not be exposed to an assistive
* technology. Value type: boolean
* See also: %GTK_ACCESSIBLE_STATE_DISABLED
* @GTK_ACCESSIBLE_STATE_INVALID: An “invalid” state; set when a widget
* is showing an error. Value type: #GtkAccessibleInvalidState
* is showing an error. Value type: `GtkAccessibleInvalidState`
* @GTK_ACCESSIBLE_STATE_PRESSED: A “pressed” state; indicates the current
* state of a #GtkToggleButton. Value type: #GtkAccessibleTristate
* state of a `GtkToggleButton`. Value type: `GtkAccessibleTristate`
* enumeration
* @GTK_ACCESSIBLE_STATE_SELECTED: A “selected” state; set when a widget
* is selected. Value type: boolean or undefined
@ -1368,7 +1368,7 @@ typedef enum {
* @GTK_ACCESSIBLE_PROPERTY_AUTOCOMPLETE: Indicates whether inputting text
* could trigger display of one or more predictions of the user's intended
* value for a combobox, searchbox, or textbox and specifies how predictions
* would be presented if they were made. Value type: #GtkAccessibleAutocomplete
* would be presented if they were made. Value type: `GtkAccessibleAutocomplete`
* @GTK_ACCESSIBLE_PROPERTY_DESCRIPTION: Defines a string value that describes
* or annotates the current element. Value type: string
* @GTK_ACCESSIBLE_PROPERTY_HAS_POPUP: Indicates the availability and type of
@ -1390,7 +1390,7 @@ typedef enum {
* boolean
* @GTK_ACCESSIBLE_PROPERTY_ORIENTATION: Indicates whether the element's
* orientation is horizontal, vertical, or unknown/ambiguous. Value type:
* #GtkOrientation
* `GtkOrientation`
* @GTK_ACCESSIBLE_PROPERTY_PLACEHOLDER: Defines a short hint (a word or short
* phrase) intended to aid the user with data entry when the control has no
* value. A hint could be a sample value or a brief description of the expected
@ -1403,7 +1403,7 @@ typedef enum {
* author-localized description for the role of an element. Value type: string
* @GTK_ACCESSIBLE_PROPERTY_SORT: Indicates if items in a table or grid are
* sorted in ascending or descending order. Possible property values are in
* the #GtkAccessibleSort enumeration. Value type: #GtkAccessibleSort
* the `GtkAccessibleSort` enumeration. Value type: `GtkAccessibleSort`
* @GTK_ACCESSIBLE_PROPERTY_VALUE_MAX: Defines the maximum allowed value for a
* range widget. Value type: double
* @GTK_ACCESSIBLE_PROPERTY_VALUE_MIN: Defines the minimum allowed value for a

6
gtk/gtkeventcontroller.c
View File

@ -377,8 +377,8 @@ gtk_event_controller_handle_event (GtkEventController *controller,
/*< private >
* gtk_event_controller_handle_crossing:
* @controller: a #GtkEventController
* @crossing: a #GtkCrossingData
* @controller: a `GtkEventController`
* @crossing: a `GtkCrossingData`
* @x: translated event coordinates
* @y: translated event coordinates
*
@ -410,7 +410,7 @@ gtk_event_controller_handle_crossing (GtkEventController *controller,
* gtk_event_controller_get_widget: (attributes org.gtk.Method.get_property=widget)
* @controller: a `GtkEventController`
*
* Returns the #GtkWidget this controller relates to.
* Returns the `GtkWidget` this controller relates to.
*
* Returns: (transfer none): a `GtkWidget`
**/

6
gtk/gtkeventcontrollerkey.c
View File

@ -194,7 +194,7 @@ gtk_event_controller_key_class_init (GtkEventControllerKeyClass *klass)
* @controller: the object which received the signal.
* @keyval: the pressed key.
* @keycode: the raw code of the pressed key.
* @state: the bitmask, representing the state of modifier keys and pointer buttons. See #GdkModifierType.
* @state: the bitmask, representing the state of modifier keys and pointer buttons. See `GdkModifierType`.
*
* Emitted whenever a key is pressed.
*
@ -216,7 +216,7 @@ gtk_event_controller_key_class_init (GtkEventControllerKeyClass *klass)
* @controller: the object which received the signal.
* @keyval: the released key.
* @keycode: the raw code of the released key.
* @state: the bitmask, representing the state of modifier keys and pointer buttons. See #GdkModifierType.
* @state: the bitmask, representing the state of modifier keys and pointer buttons. See `GdkModifierType`.
*
* Emitted whenever a key is released.
*/
@ -236,7 +236,7 @@ gtk_event_controller_key_class_init (GtkEventControllerKeyClass *klass)
* @controller: the object which received the signal.
* @keyval: the released key.
* @state: the bitmask, representing the new state of modifier keys and
* pointer buttons. See #GdkModifierType.
* pointer buttons. See `GdkModifierType`.
*
* Emitted whenever the state of modifier keys and pointer buttons change.
*/

2
gtk/gtkeventcontrollerprivate.h
View File

@ -65,7 +65,7 @@ typedef struct _GtkCrossingData GtkCrossingData;
* @new_descendent: the direct child of the receiving widget that
* is an ancestor of @new_target, or %NULL if @new_target is not
* a descendent of the receiving widget
* @drop: the #GdkDrop if this is info for a drop operation
* @drop: the `GdkDrop` if this is info for a drop operation
*
* The struct that is passed to gtk_event_controller_handle_crossing().
*

2
gtk/gtkexpander.c
View File

@ -924,7 +924,7 @@ gtk_expander_set_expanded (GtkExpander *expander,
* gtk_expander_get_expanded: (attributes org.gtk.Method.get_property=expanded)
* @expander:a `GtkExpander`
*
* Queries a #GtkExpander and returns its current state.
* Queries a `GtkExpander` and returns its current state.
*
* Returns %TRUE if the child widget is revealed.
*

6
gtk/gtkexpression.c
View File

@ -244,14 +244,14 @@ G_DEFINE_BOXED_TYPE (GtkExpressionWatch, gtk_expression_watch,
* GTK_DEFINE_EXPRESSION_TYPE:
* @TypeName: the type name, in camel case
* @type_name: the type name, in snake case
* @type_info: the address of the #GtkExpressionTypeInfo for the expression type
* @type_info: the address of the `GtkExpressionTypeInfo` for the expression type
*
* Registers a new #GtkExpression subclass with the given @TypeName and @type_info.
* Registers a new `GtkExpression` subclass with the given @TypeName and @type_info.
*
* Similarly to %G_DEFINE_TYPE, this macro will generate a `get_type()`
* function that registers the event type.
*
* You can specify code to be run after the type registration; the #GType of
* You can specify code to be run after the type registration; the `GType` of
* the event is available in the `gtk_define_expression_type_id` variable.
*/
#define GTK_DEFINE_EXPRESSION_TYPE(TypeName, type_name, type_info) \

4
gtk/gtkexpression.h
View File

@ -160,7 +160,7 @@ GtkExpression * gtk_cclosure_expression_new (GType
/**
* GTK_VALUE_HOLDS_EXPRESSION:
* @value: a #GValue
* @value: a `GValue`
*
* Evaluates to %TRUE if @value was initialized with %GTK_TYPE_EXPRESSION.
*/
@ -184,7 +184,7 @@ GtkExpression * gtk_value_dup_expression (const GValue *value);
/**
* GtkParamSpecExpression:
*
* A #GParamSpec for properties holding a #GtkExpression.
* A `GParamSpec` for properties holding a `GtkExpression`.
*/
typedef struct {
/*< private >*/

6
gtk/gtkfilechooser.c
View File

@ -372,7 +372,7 @@ gtk_file_chooser_unselect_all (GtkFileChooser *chooser)
* @file: the `GFile` for the new folder
* @error: location to store error
*
* Sets the current folder for @chooser from a #GFile.
* Sets the current folder for @chooser from a `GFile`.
*
* Returns: %TRUE if the folder could be changed successfully, %FALSE
* otherwise.
@ -393,7 +393,7 @@ gtk_file_chooser_set_current_folder (GtkFileChooser *chooser,
* gtk_file_chooser_get_current_folder:
* @chooser: a `GtkFileChooser`
*
* Gets the current folder of @chooser as #GFile.
* Gets the current folder of @chooser as `GFile`.
*
* Returns: (transfer full): the `GFile` for the current folder.
*/
@ -432,7 +432,7 @@ gtk_file_chooser_unselect_file (GtkFileChooser *chooser,
* @chooser: a `GtkFileChooser`
*
* Lists all the selected files and subfolders in the current folder
* of @chooser as #GFile.
* of @chooser as `GFile`.
*
* Returns: (transfer full): a list model containing a `GFile` for each
* selected file and subfolder in the current folder. Free the returned

33
gtk/gtkfilechooserentry.c
View File

@ -798,12 +798,12 @@ delete_text_callback (GtkFileChooserEntry *chooser_entry,
* @eat_tabs: If %FALSE, allow focus navigation with the tab key.
* @eat_escape: If %TRUE, capture Escape key presses and emit ::hide-entry
*
* Creates a new #GtkFileChooserEntry object. #GtkFileChooserEntry
* Creates a new `GtkFileChooserEntry` object. `GtkFileChooserEntry`
* is an internal implementation widget for the GTK file chooser
* which is an entry with completion with respect to a
* #GtkFileSystem object.
* `GtkFileSystem` object.
*
* Returns: the newly created #GtkFileChooserEntry
* Returns: the newly created `GtkFileChooserEntry`
**/
GtkWidget *
_gtk_file_chooser_entry_new (gboolean eat_tabs,
@ -820,7 +820,7 @@ _gtk_file_chooser_entry_new (gboolean eat_tabs,
/**
* _gtk_file_chooser_entry_set_base_folder:
* @chooser_entry: a #GtkFileChooserEntry
* @chooser_entry: a `GtkFileChooserEntry`
* @file: file for a folder in the chooser entries current file system.
*
* Sets the folder with respect to which completions occur.
@ -850,13 +850,14 @@ _gtk_file_chooser_entry_set_base_folder (GtkFileChooserEntry *chooser_entry,
/**
* _gtk_file_chooser_entry_get_current_folder:
* @chooser_entry: a #GtkFileChooserEntry
* @chooser_entry: a `GtkFileChooserEntry`
*
* Gets the current folder for the #GtkFileChooserEntry. If the
* user has only entered a filename, this will be in the base folder
* (see _gtk_file_chooser_entry_set_base_folder()), but if the
* user has entered a relative or absolute path, then it will
* be different. If the user has entered unparsable text, or text which
* Gets the current folder for the `GtkFileChooserEntry`.
*
* If the user has only entered a filename, this will be in the base
* folder (see _gtk_file_chooser_entry_set_base_folder()), but if the
* user has entered a relative or absolute path, then it will be
* different. If the user has entered unparsable text, or text which
* the entry cannot handle, this will return %NULL.
*
* Returns: (nullable) (transfer full): the file for the current folder
@ -873,7 +874,7 @@ _gtk_file_chooser_entry_get_current_folder (GtkFileChooserEntry *chooser_entry)
/**
* _gtk_file_chooser_entry_get_file_part:
* @chooser_entry: a #GtkFileChooserEntry
* @chooser_entry: a `GtkFileChooserEntry`
*
* Gets the non-folder portion of whatever the user has entered
* into the file selector. What is returned is a UTF-8 string,
@ -902,11 +903,11 @@ _gtk_file_chooser_entry_get_file_part (GtkFileChooserEntry *chooser_entry)
/**
* _gtk_file_chooser_entry_set_action:
* @chooser_entry: a #GtkFileChooserEntry
* @chooser_entry: a `GtkFileChooserEntry`
* @action: the action which is performed by the file selector using this entry
*
* Sets action which is performed by the file selector using this entry.
* The #GtkFileChooserEntry will use different completion strategies for
* Sets action which is performed by the file selector using this entry.
* The `GtkFileChooserEntry` will use different completion strategies for
* different actions.
**/
void
@ -949,7 +950,7 @@ _gtk_file_chooser_entry_set_action (GtkFileChooserEntry *chooser_entry,
/**
* _gtk_file_chooser_entry_get_action:
* @chooser_entry: a #GtkFileChooserEntry
* @chooser_entry: a `GtkFileChooserEntry`
*
* Gets the action for this entry.
*
@ -986,7 +987,7 @@ _gtk_file_chooser_entry_get_is_folder (GtkFileChooserEntry *chooser_entry,
/*
* _gtk_file_chooser_entry_select_filename:
* @chooser_entry: a #GtkFileChooserEntry
* @chooser_entry: a `GtkFileChooserEntry`
*
* Selects the filename (without the extension) for user edition.
*/

2
gtk/gtkfilechoosernative.c
View File

@ -152,7 +152,7 @@
* and %GTK_RESPONSE_CANCEL if he pressed cancel. It can also return
* %GTK_RESPONSE_DELETE_EVENT if the window was unexpectedly closed.
*
* ## Differences from #GtkFileChooserDialog
* ## Differences from `GtkFileChooserDialog`
*
* There are a few things in the [iface@Gtk.FileChooser] interface that
* are not possible to use with `GtkFileChooserNative`, as such use would

28
gtk/gtkfilechooserutils.c
View File

@ -71,15 +71,16 @@ static const char * delegate_get_choice (GtkFileChooser *chooser,
/**
* _gtk_file_chooser_install_properties:
* @klass: the class structure for a type deriving from #GObject
* @klass: the class structure for a type deriving from `GObject`
*
* Installs the necessary properties for a class implementing
* #GtkFileChooser. A #GtkParamSpecOverride property is installed
* for each property, using the values from the #GtkFileChooserProp
* enumeration. The caller must make sure itself that the enumeration
* values don’t collide with some other property values they
* are using.
**/
* `GtkFileChooser`.
*
* A `GtkParamSpecOverride` property is installed for each property,
* using the values from the `GtkFileChooserProp` enumeration. The
* caller must make sure itself that the enumeration values don’t
* collide with some other property values they are using.
*/
void
_gtk_file_chooser_install_properties (GObjectClass *klass)
{
@ -105,11 +106,12 @@ _gtk_file_chooser_install_properties (GObjectClass *klass)
/**
* _gtk_file_chooser_delegate_iface_init:
* @iface: a #GtkFileChoserIface structure
* @iface: a `GtkFileChoserIface` structure
*
* An interface-initialization function for use in cases where
* an object is simply delegating the methods, signals of
* the #GtkFileChooser interface to another object.
* the `GtkFileChooser` interface to another object.
*
* _gtk_file_chooser_set_delegate() must be called on each
* instance of the object so that the delegate object can
* be found.
@ -140,12 +142,12 @@ _gtk_file_chooser_delegate_iface_init (GtkFileChooserIface *iface)
/**
* _gtk_file_chooser_set_delegate:
* @receiver: a #GObject implementing #GtkFileChooser
* @delegate: another #GObject implementing #GtkFileChooser
* @receiver: a `GObject` implementing `GtkFileChooser`
* @delegate: another `GObject` implementing `GtkFileChooser`
*
* Establishes that calls on @receiver for #GtkFileChooser
* Establishes that calls on @receiver for `GtkFileChooser`
* methods should be delegated to @delegate, and that
* #GtkFileChooser signals emitted on @delegate should be
* `GtkFileChooser` signals emitted on @delegate should be
* forwarded to @receiver. Must be used in conjunction with
* _gtk_file_chooser_delegate_iface_init().
**/

97
gtk/gtkfilesystemmodel.c
View File

@ -1340,13 +1340,13 @@ _gtk_file_system_model_new_valist (GtkFileSystemModelGetValue get_func,
* @get_func: function to call for getting a value
* @get_data: user data argument passed to @get_func
* @n_columns: number of columns
* @...: @n_columns #GType types for the columns
* @...: @n_columns `GType` types for the columns
*
* Creates a new #GtkFileSystemModel object. You need to add files
* Creates a new `GtkFileSystemModel` object. You need to add files
* to the list using _gtk_file_system_model_add_and_query_file()
* or _gtk_file_system_model_update_file().
*
* Returns: the newly created #GtkFileSystemModel
* Returns: the newly created `GtkFileSystemModel`
**/
GtkFileSystemModel *
_gtk_file_system_model_new (GtkFileSystemModelGetValue get_func,
@ -1374,16 +1374,17 @@ _gtk_file_system_model_new (GtkFileSystemModelGetValue get_func,
* @get_func: function that the model should call to query data about a file
* @get_data: user data to pass to the @get_func
* @n_columns: number of columns
* @...: @n_columns #GType types for the columns
* @...: @n_columns `GType` types for the columns
*
* Creates a new #GtkFileSystemModel object. The #GtkFileSystemModel
* object wraps the given @directory as a #GtkTreeModel.
* The model will query the given directory with the given @attributes
* and add all files inside the directory automatically. If supported,
* it will also monitor the drectory and update the model's
* Creates a new `GtkFileSystemModel` object.
*
* The `GtkFileSystemModel` object wraps the given @directory as a
* `GtkTreeModel`. The model will query the given directory with the
* given @attributes and add all files inside the directory automatically.
* If supported, it will also monitor the drectory and update the model's
* contents to reflect changes, if the @directory supports monitoring.
*
* Returns: the newly created #GtkFileSystemModel
*
* Returns: the newly created `GtkFileSystemModel`
**/
GtkFileSystemModel *
_gtk_file_system_model_new_for_directory (GFile * dir,
@ -1432,10 +1433,10 @@ gtk_file_system_model_refilter_all (GtkFileSystemModel *model)
/**
* _gtk_file_system_model_set_show_hidden:
* @model: a #GtkFileSystemModel
* @model: a `GtkFileSystemModel`
* @show_hidden: whether hidden files should be displayed
*
* Sets whether hidden files should be included in the #GtkTreeModel
*
* Sets whether hidden files should be included in the `GtkTreeModel`
* for display.
**/
void
@ -1455,12 +1456,12 @@ _gtk_file_system_model_set_show_hidden (GtkFileSystemModel *model,
/**
* _gtk_file_system_model_set_show_folders:
* @model: a #GtkFileSystemModel
* @model: a `GtkFileSystemModel`
* @show_folders: whether folders should be displayed
*
* Sets whether folders should be included in the #GtkTreeModel for
* display.
**/
*
* Sets whether folders should be included in the `GtkTreeModel`
* for display.
*/
void
_gtk_file_system_model_set_show_folders (GtkFileSystemModel *model,
gboolean show_folders)
@ -1478,12 +1479,12 @@ _gtk_file_system_model_set_show_folders (GtkFileSystemModel *model,
/**
* _gtk_file_system_model_set_show_files:
* @model: a #GtkFileSystemModel
* @model: a `GtkFileSystemModel`
* @show_files: whether files (as opposed to folders) should be displayed.
*
* Sets whether files (as opposed to folders) should be included
* in the #GtkTreeModel for display.
**/
* in the `GtkTreeModel` for display.
*/
void
_gtk_file_system_model_set_show_files (GtkFileSystemModel *model,
gboolean show_files)
@ -1501,13 +1502,13 @@ _gtk_file_system_model_set_show_files (GtkFileSystemModel *model,
/**
* _gtk_file_system_model_set_filter_folders:
* @model: a #GtkFileSystemModel
* @model: a `GtkFileSystemModel`
* @filter_folders: whether the filter applies to folders
*
*
* Sets whether the filter set by _gtk_file_system_model_set_filter()
* applies to folders. By default, it does not and folders are always
* visible.
**/
*/
void
_gtk_file_system_model_set_filter_folders (GtkFileSystemModel *model,
gboolean filter_folders)
@ -1548,8 +1549,9 @@ _gtk_file_system_model_get_cancellable (GtkFileSystemModel *model)
* @iter: a valid iterator
*
* Checks if the iterator is visible. A visible iterator references
* a row that is currently exposed using the #GtkTreeModel API. If
* the iterator is invisible, it references a file that is not shown
* a row that is currently exposed using the `GtkTreeModel` API.
*
* If the iterator is invisible, it references a file that is not shown
* for some reason, such as being filtered out by the current filter or
* being a hidden file.
*
@ -1596,18 +1598,17 @@ _gtk_file_system_model_iter_is_filtered_out (GtkFileSystemModel *model,
/**
* _gtk_file_system_model_get_info:
* @model: a #GtkFileSystemModel
* @iter: a #GtkTreeIter pointing to a row of @model
*
* Gets the #GFileInfo-struct for a particular row
* @model: a `GtkFileSystemModel`
* @iter: a `GtkTreeIter` pointing to a row of @model
*
* Gets the `GFileInfo` for a particular row
* of @model.
*
* Returns: a #GFileInfo-struct. This value
* is owned by @model and must not be modified or freed.
* If you want to keep the information for later use,
* you must take a reference, since the #GFileInfo-struct may be
* freed on later changes to the file system.
**/
*
* Returns: a `GFileInfo`. This value is owned by @model and must not
* be modified or freed. If you want to keep the information for
* later use, you must take a reference, since the `GFileInfo` may
* be freed on later changes to the file system.
*/
GFileInfo *
_gtk_file_system_model_get_info (GtkFileSystemModel *model,
GtkTreeIter *iter)
@ -1624,9 +1625,9 @@ _gtk_file_system_model_get_info (GtkFileSystemModel *model,
/**
* _gtk_file_system_model_get_file:
* @model: a #GtkFileSystemModel
* @iter: a #GtkTreeIter pointing to a row of @model
*
* @model: a `GtkFileSystemModel`
* @iter: a `GtkTreeIter` pointing to a row of @model
*
* Gets the file for a particular row in @model.
*
* Returns: the file. This object is owned by @model and
@ -1648,8 +1649,8 @@ _gtk_file_system_model_get_file (GtkFileSystemModel *model,
/**
* _gtk_file_system_model_get_value:
* @model: a #GtkFileSystemModel
* @iter: a #GtkTreeIter pointing to a row of @model
* @model: a `GtkFileSystemModel`
* @iter: a `GtkTreeIter` pointing to a row of @model
* @column: the column to get the value for
*
* Gets the value associated with the given row @iter and @column.
@ -1932,7 +1933,7 @@ _gtk_file_system_model_update_files (GtkFileSystemModel *model,
/**
* _gtk_file_system_model_set_filter:
* @mode: a #GtkFileSystemModel
* @mode: a `GtkFileSystemModel`
* @filter: (nullable): %NULL or filter to use
*
* Sets a filter to be used for deciding if a row should be visible or not.
@ -1962,7 +1963,7 @@ _gtk_file_system_model_set_filter (GtkFileSystemModel *model,
/**
* freeze_updates:
* @model: a #GtkFileSystemModel
* @model: a `GtkFileSystemModel`
*
* Freezes most updates on the model, so that performing multiple operations on
* the files in the model do not cause any events. Use thaw_updates() to resume
@ -1979,7 +1980,7 @@ freeze_updates (GtkFileSystemModel *model)
/**
* thaw_updates:
* @model: a #GtkFileSystemModel
* @model: a `GtkFileSystemModel`
*
* Undoes the effect of a previous call to freeze_updates()
**/
@ -2019,7 +2020,7 @@ thaw_updates (GtkFileSystemModel *model)
/**
* _gtk_file_system_model_clear_cache:
* @model: a #GtkFileSystemModel
* @model: a `GtkFileSystemModel`
* @column: the column to clear or -1 for all columns
*
* Clears the cached values in the model for the given @column. Use
@ -2072,7 +2073,7 @@ _gtk_file_system_model_clear_cache (GtkFileSystemModel *model,
/**
* _gtk_file_system_model_add_and_query_file:
* @model: a #GtkFileSystemModel
* @model: a `GtkFileSystemModel`
* @file: the file to add
* @attributes: attributes to query before adding the file
*

18
gtk/gtkfilter.c
View File

@ -44,7 +44,7 @@
* various widgets to easily allow searches.
*
* However, in particular for large lists or complex search methods, it is
* also possible to subclass #GtkFilter and provide one's own filter.
* also possible to subclass `GtkFilter` and provide one's own filter.
*/
enum {
@ -81,7 +81,7 @@ gtk_filter_class_init (GtkFilterClass *class)
/**
* GtkFilter::changed:
* @self: The #GtkFilter
* @self: The `GtkFilter`
* @change: how the filter changed
*
* Emitted whenever the filter changed.
@ -136,15 +136,15 @@ gtk_filter_match (GtkFilter *self,
/**
* gtk_filter_get_strictness:
* @self: a #GtkFilter
* @self: a `GtkFilter`
*
* Gets the known strictness of @filters. If the strictness is not known,
* %GTK_FILTER_MATCH_SOME is returned.
*
* This value may change after emission of the #GtkFilter::changed signal.
* This value may change after emission of the `GtkFilter::changed` signal.
*
* This function is meant purely for optimization purposes, filters can
* choose to omit implementing it, but #GtkFilterListModel uses it.
* choose to omit implementing it, but `GtkFilterListModel` uses it.
*
* Returns: the strictness of @self
**/
@ -158,17 +158,17 @@ gtk_filter_get_strictness (GtkFilter *self)
/**
* gtk_filter_changed:
* @self: a #GtkFilter
* @self: a `GtkFilter`
* @change: How the filter changed
*
* Emits the #GtkFilter::changed signal to notify all users of the filter that
* Emits the `GtkFilter::changed` signal to notify all users of the filter that
* the filter changed. Users of the filter should then check items again via
* gtk_filter_match().
*
* Depending on the @change parameter, not all items need to be changed, but
* only some. Refer to the #GtkFilterChange documentation for details.
* only some. Refer to the `GtkFilterChange` documentation for details.
*
* This function is intended for implementors of #GtkFilter subclasses and
* This function is intended for implementors of `GtkFilter` subclasses and
* should not be called from other functions.
*/
void

2
gtk/gtkflowbox.c
View File

@ -3782,7 +3782,7 @@ gtk_flow_box_class_init (GtkFlowBoxClass *class)
/**
* GtkFlowBox::move-cursor:
* @box: the `GtkFlowBox` on which the signal is emitted
* @step: the granularity fo the move, as a #GtkMovementStep
* @step: the granularity fo the move, as a `GtkMovementStep`
* @count: the number of @step units to move
* @extend: whether to extend the selection
* @modify: whether to modify the selection

4
gtk/gtkfontchooser.h
View File

@ -31,8 +31,8 @@ G_BEGIN_DECLS
/**
* GtkFontFilterFunc:
* @family: a #PangoFontFamily
* @face: a #PangoFontFace belonging to @family
* @family: a `PangoFontFamily`
* @face: a `PangoFontFace` belonging to @family
* @data: (closure): user data passed to gtk_font_chooser_set_filter_func()
*
* The type of function that is used for deciding what fonts get

25
gtk/gtkfontchooserutils.c
View File

@ -110,14 +110,15 @@ _gtk_font_chooser_delegate_get_quark (void)
/**
* _gtk_font_chooser_install_properties:
* @klass: the class structure for a type deriving from #GObject
* @klass: the class structure for a type deriving from `GObject`
*
* Installs the necessary properties for a class implementing
* #GtkFontChooser. A #GtkParamSpecOverride property is installed
* for each property, using the values from the #GtkFontChooserProp
* enumeration. The caller must make sure itself that the enumeration
* values don’t collide with some other property values they
* are using.
* `GtkFontChooser`.
*
* A `GtkParamSpecOverride` property is installed for each property,
* using the values from the `GtkFontChooserProp` enumeration. The
* caller must make sure itself that the enumeration values don’t
* collide with some other property values they are using.
*/
void
_gtk_font_chooser_install_properties (GObjectClass *klass)
@ -147,11 +148,11 @@ _gtk_font_chooser_install_properties (GObjectClass *klass)
/**
* _gtk_font_chooser_delegate_iface_init:
* @iface: a #GtkFontChooserIface
* @iface: a `GtkFontChooserIface`
*
* An interface-initialization function for use in cases where
* an object is simply delegating the methods, signals of
* the #GtkFontChooser interface to another object.
* the `GtkFontChooser` interface to another object.
* _gtk_font_chooser_set_delegate() must be called on each
* instance of the object so that the delegate object can
* be found.
@ -169,12 +170,12 @@ _gtk_font_chooser_delegate_iface_init (GtkFontChooserIface *iface)
/**
* _gtk_font_chooser_set_delegate:
* @receiver: a #GObject implementing #GtkFontChooser
* @delegate: another #GObject implementing #GtkFontChooser
* @receiver: a `GObject` implementing `GtkFontChooser`
* @delegate: another `GObject` implementing `GtkFontChooser`
*
* Establishes that calls on @receiver for #GtkFontChooser
* Establishes that calls on @receiver for `GtkFontChooser`
* methods should be delegated to @delegate, and that
* #GtkFontChooser signals emitted on @delegate should be
* `GtkFontChooser` signals emitted on @delegate should be
* forwarded to @receiver. Must be used in conjunction with
* _gtk_font_chooser_delegate_iface_init().
*/

2
gtk/gtkgesture.c
View File

@ -936,7 +936,7 @@ gtk_gesture_get_device (GtkGesture *gesture)
/**
* gtk_gesture_get_sequence_state:
* @gesture: a `GtkGesture`
* @sequence: a #GdkEventSequence
* @sequence: a `GdkEventSequence`
*
* Returns the @sequence state, as seen by @gesture.
*

2
gtk/gtkgesturedrag.c
View File

@ -262,7 +262,7 @@ gtk_gesture_drag_get_start_point (GtkGestureDrag *gesture,
/**
* gtk_gesture_drag_get_offset:
* @gesture: a #GtkGesture
* @gesture: a `GtkGesture`
* @x: (out) (nullable): X offset for the current point
* @y: (out) (nullable): Y offset for the current point
*

8
gtk/gtkglarea.c
View File

@ -65,7 +65,7 @@
* render (GtkGLArea *area, GdkGLContext *context)
* {
* // inside this function it's safe to use GL; the given
* // #GdkGLContext has been made current to the drawable
* // GdkGLContext has been made current to the drawable
* // surface used by the `GtkGLArea` and the viewport has
* // already been set to be the size of the allocation
*
@ -110,7 +110,7 @@
*
* // If there were errors during the initialization or
* // when trying to make the context current, this
* // function will return a #GError for you to catch
* // function will return a GError for you to catch
* if (gtk_gl_area_get_error (area) != NULL)
* return;
*
@ -1019,7 +1019,7 @@ gtk_gl_area_set_error (GtkGLArea *area,
*
* Gets the current error set on the @area.
*
* Returns: (nullable) (transfer none): the #GError
* Returns: (nullable) (transfer none): the `GError`
*/
GError *
gtk_gl_area_get_error (GtkGLArea *area)
@ -1038,7 +1038,7 @@ gtk_gl_area_get_error (GtkGLArea *area)
*
* Sets whether the @area should create an OpenGL or an OpenGL ES context.
*
* You should check the capabilities of the #GdkGLContext before drawing
* You should check the capabilities of the `GdkGLContext` before drawing
* with either API.
*/
void

6
gtk/gtkglarea.h
View File

@ -47,9 +47,9 @@ struct _GtkGLArea
/**
* GtkGLAreaClass:
* @render: class closure for the #GtkGLArea::render signal
* @resize: class closeure for the #GtkGLArea::resize signal
* @create_context: class closure for the #GtkGLArea::create-context signal
* @render: class closure for the `GtkGLArea::render` signal
* @resize: class closeure for the `GtkGLArea::resize` signal
* @create_context: class closure for the `GtkGLArea::create-context` signal
*
* The `GtkGLAreaClass` structure contains only private data.
*/

Some files were not shown because too many files have changed in this diff Show More