AuroraMiddleware/gtk
1
0
Fork 1
mirror of https://gitlab.gnome.org/GNOME/gtk.git synced 2024-12-26 13:41:07 +00:00
Code Issues Projects Releases Wiki Activity

shortcutlabel: Convert docs

Browse Source
This commit is contained in:
Matthias Clasen 2021-03-01 22:54:37 -05:00 committed by Emmanuele Bassi
parent 7c442c1736
commit 9fbe61e01f
1 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
gtk/gtkshortcutlabel.c
View File

@ -26,13 +26,11 @@
#include "gtkintl.h"
/**
* SECTION:gtkshortcutlabel
* @Title: GtkShortcutLabel
* @Short_description: Displays a keyboard shortcut
* @See_also: #GtkCellRendererAccel
* GtkShortcutLabel:
*
* #GtkShortcutLabel is a widget that represents a single keyboard shortcut or gesture
* in the user interface.
* `GtkShortcutLabel` displays a single keyboard shortcut or gesture.
*
* The main use case for `GtkShortcutLabel` is inside a [class@Gtk.ShortcutsWindow].
*/
struct _GtkShortcutLabel
@ -476,9 +474,11 @@ gtk_shortcut_label_class_init (GtkShortcutLabelClass *klass)
object_class->set_property = gtk_shortcut_label_set_property;
/**
* GtkShortcutLabel:accelerator:
* GtkShortcutLabel:accelerator: (attributes org.gtk.Property.get=gtk_shortcut_label_get_accelerator org.gtk.Property.set=gtk_shortcut_label_set_accelerator)
*
* The accelerator that @self displays. See #GtkShortcutsShortcut:accelerator
* The accelerator that @self displays.
*
* See [property@Gtk.ShortcutsShortcut:accelerator]
* for the accepted syntax.
*/
properties[PROP_ACCELERATOR] =
@ -487,7 +487,7 @@ gtk_shortcut_label_class_init (GtkShortcutLabelClass *klass)
(G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GtkShortcutLabel:disabled-text:
* GtkShortcutLabel:disabled-text: (attributes org.gtk.Property.get=gtk_shortcut_label_get_disabled_text org.gtk.Property.set=gtk_shortcut_label_set_disabled_text)
*
* The text that is displayed when no accelerator is set.
*/
@ -513,9 +513,9 @@ gtk_shortcut_label_init (GtkShortcutLabel *self)
* gtk_shortcut_label_new:
* @accelerator: the initial accelerator
*
* Creates a new #GtkShortcutLabel with @accelerator set.
* Creates a new `GtkShortcutLabel` with @accelerator set.
*
* Returns: (transfer full): a newly-allocated #GtkShortcutLabel
* Returns: (transfer full): a newly-allocated `GtkShortcutLabel`
*/
GtkWidget *
gtk_shortcut_label_new (const char *accelerator)
@ -526,8 +526,8 @@ gtk_shortcut_label_new (const char *accelerator)
}
/**
* gtk_shortcut_label_get_accelerator:
* @self: a #GtkShortcutLabel
* gtk_shortcut_label_get_accelerator: (attributes org.gtk.Method.get_property=accelerator)
* @self: a `GtkShortcutLabel`
*
* Retrieves the current accelerator of @self.
*
@ -542,8 +542,8 @@ gtk_shortcut_label_get_accelerator (GtkShortcutLabel *self)
}
/**
* gtk_shortcut_label_set_accelerator:
* @self: a #GtkShortcutLabel
* gtk_shortcut_label_set_accelerator: (attributes org.gtk.Method.set_property=accelerator)
* @self: a `GtkShortcutLabel`
* @accelerator: the new accelerator
*
* Sets the accelerator to be displayed by @self.
@ -564,8 +564,8 @@ gtk_shortcut_label_set_accelerator (GtkShortcutLabel *self,
}
/**
* gtk_shortcut_label_get_disabled_text:
* @self: a #GtkShortcutLabel
* gtk_shortcut_label_get_disabled_text: (attributes org.gtk.Method.get_property=disabled-text)
* @self: a `GtkShortcutLabel`
*
* Retrieves the text that is displayed when no accelerator is set.
*
@ -581,8 +581,8 @@ gtk_shortcut_label_get_disabled_text (GtkShortcutLabel *self)
}
/**
* gtk_shortcut_label_set_disabled_text:
* @self: a #GtkShortcutLabel
* gtk_shortcut_label_set_disabled_text: (attributes org.gtk.Method.set_property=disabled-text)
* @self: a `GtkShortcutLabel`
* @disabled_text: the text to be displayed when no accelerator is set
*
* Sets the text to be displayed by @self when no accelerator is set.