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

textchild: Convert docs

Browse Source
This commit is contained in:
Matthias Clasen 2021-02-28 13:13:35 -05:00 committed by Emmanuele Bassi
parent 720f6e7a17
commit 05b13dca55
2 changed files with 24 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
gtk/gtktextchild.c
View File

@ -398,12 +398,14 @@ gtk_text_child_anchor_class_init (GtkTextChildAnchorClass *klass)
/**
* gtk_text_child_anchor_new:
*
* Creates a new #GtkTextChildAnchor. Usually you would then insert
* it into a #GtkTextBuffer with gtk_text_buffer_insert_child_anchor().
* To perform the creation and insertion in one step, use the
* convenience function gtk_text_buffer_create_child_anchor().
* Creates a new `GtkTextChildAnchor`.
*
* Usually you would then insert it into a `GtkTextBuffer` with
* [method@Gtk.TextBuffer.insert_child_anchor]. To perform the
* creation and insertion in one step, use the convenience
* function [method@Gtk.TextBuffer.create_child_anchor].
*
* Returns: a new #GtkTextChildAnchor
* Returns: a new `GtkTextChildAnchor`
**/
GtkTextChildAnchor*
gtk_text_child_anchor_new (void)
@ -443,7 +445,7 @@ gtk_text_child_anchor_finalize (GObject *obj)
/**
* gtk_text_child_anchor_get_widgets:
* @anchor: a #GtkTextChildAnchor
* @anchor: a `GtkTextChildAnchor`
* @out_len: (out): return location for the length of the array
*
* Gets a list of all widgets anchored at this child anchor.
@ -452,7 +454,7 @@ gtk_text_child_anchor_finalize (GObject *obj)
*
* Returns: (array length=out_len) (transfer container): an
* array of widgets anchored at @anchor
**/
*/
GtkWidget **
gtk_text_child_anchor_get_widgets (GtkTextChildAnchor *anchor,
guint *out_len)
@ -491,17 +493,19 @@ gtk_text_child_anchor_get_widgets (GtkTextChildAnchor *anchor,
/**
* gtk_text_child_anchor_get_deleted:
* @anchor: a #GtkTextChildAnchor
*
* @anchor: a `GtkTextChildAnchor`
*
* Determines whether a child anchor has been deleted from
* the buffer. Keep in mind that the child anchor will be
* unreferenced when removed from the buffer, so you need to
* hold your own reference (with g_object_ref()) if you plan
* to use this function — otherwise all deleted child anchors
* will also be finalized.
*
* the buffer.
*
* Keep in mind that the child anchor will be unreferenced
* when removed from the buffer, so you need to hold your own
* reference (with g_object_ref()) if you plan to use this
* function — otherwise all deleted child anchors will also
* be finalized.
*
* Returns: %TRUE if the child anchor has been deleted from its buffer
**/
*/
gboolean
gtk_text_child_anchor_get_deleted (GtkTextChildAnchor *anchor)
{

7
gtk/gtktextchild.h
View File

@ -39,9 +39,10 @@ G_BEGIN_DECLS
/**
* GtkTextChildAnchor:
*
* A #GtkTextChildAnchor is a spot in the buffer where child widgets can
* be “anchored” (inserted inline, as if they were characters). The anchor
* can have multiple widgets anchored, to allow for multiple views.
* A `GtkTextChildAnchor` is a spot in a `GtkTextBuffer` where child widgets can
* be “anchored”.
*
* The anchor can have multiple widgets anchored, to allow for multiple views.
*/
typedef struct _GtkTextChildAnchor GtkTextChildAnchor;
typedef struct _GtkTextChildAnchorClass GtkTextChildAnchorClass;