diff options
| author | Soren Sandmann <sandmann@daimi.au.dk> | 2002-08-10 09:55:41 +0000 |
|---|---|---|
| committer | Søren Sandmann Pedersen <ssp@src.gnome.org> | 2002-08-10 09:55:41 +0000 |
| commit | 77eee887f3d1044a2e52ec7fd347842122d4719e (patch) | |
| tree | 017b7ab3c3f209dcb610be73ab38f615f749f81b /gtk | |
| parent | af1f560918354a567916edf8f9fa34ee4df170b8 (diff) | |
| download | gtk+-77eee887f3d1044a2e52ec7fd347842122d4719e.tar.gz | |
Minor documentation fixes
2002-08-10 Soren Sandmann <sandmann@daimi.au.dk>
* docs/reference/gtk/tree_widget.sgml,
docs/reference/gtk/tmpl/gtkdialog.sgml,
docs/reference/gtk/tmpl/gtkentry.sgml,
docs/reference/gtk/tmpl/gtkfilesel.sgml,
docs/reference/gtk/tmpl/gtkfontsel.sgml,
docs/reference/gtk/tmpl/gtkfontseldlg.sgml,
docs/reference/gtk/tmpl/gtktreemodel.sgml,
docs/reference/gtk/tmpl/gtkwidget.sgml, gdk/x11/gdkdisplay-x11.c,
gtk/gtkbbox.c, gtk/gtkbox.c, gtk/gtkbutton.c, gtk/gtkcellrenderer.c,
gtk/gtkcellrendererpixbuf.c, gtk/gtkcellrenderertext.c,
gtk/gtkcheckmenuitem.c, gtk/gtkcontainer.c, gtk/gtkcurve.c,
gtk/gtkdialog.h, gtk/gtkentry.c, gtk/gtkfilesel.c, gtk/gtkfontsel.c,
gtk/gtkframe.c, gtk/gtkhandlebox.c, gtk/gtkiconfactory.c,
gtk/gtkimage.c, gtk/gtkinvisible.c, gtk/gtkitemfactory.c,
gtk/gtklabel.c, gtk/gtklayout.c, gtk/gtkmenu.c, gtk/gtkprogress.c,
gtk/gtkprogressbar.c, gtk/gtkscrolledwindow.c, gtk/gtksizegroup.c,
gtk/gtktable.c, gtk/gtktextiter.c, gtk/gtktexttag.c,
gtk/gtktexttag.h, gtk/gtktextview.c, gtk/gtktogglebutton.c,
gtk/gtktoolbar.c, gtk/gtktreemodel.c, gtk/gtktreeselection.c,
gtk/gtktreestore.c, gtk/gtktreeview.c, gtk/gtktreeviewcolumn.c,
gtk/gtkviewport.c, gtk/gtkwidget.c, gtk/gtkwidget.h,
gtk/gtkwindow.c:
Minor documentation fixes
(#89254, patch from Brett Nash;
#85809, patch from daten@dnetc.org;
#76391, patch from Ross Burton;
#74559, Manuel Clos;
#73569, #72005, Alexey A. Malyshev;
#70061, patch from Dennis Bj"orklund;
#64566, #63388, #58328, #57499, #81007, #77349, Vitaly Tishkov;
#78932, Vitaly Tishkov, patch from Ross Burton;
#73306)
Diffstat (limited to 'gtk')
40 files changed, 185 insertions, 155 deletions
diff --git a/gtk/gtkbbox.c b/gtk/gtkbbox.c index 6d77e83358..e034741219 100644 --- a/gtk/gtkbbox.c +++ b/gtk/gtkbbox.c @@ -158,7 +158,7 @@ gtk_button_box_class_init (GtkButtonBoxClass *class) CHILD_PROP_SECONDARY, g_param_spec_boolean ("secondary", _("Secondary"), - _("If TRUE, the child appears in a secondary group of children, suitable for, e.g., help buttons."), + _("If TRUE, the child appears in a secondary group of children, suitable for, e.g., help buttons"), FALSE, G_PARAM_READWRITE)); } diff --git a/gtk/gtkbox.c b/gtk/gtkbox.c index 4b3aba0a1d..7558866330 100644 --- a/gtk/gtkbox.c +++ b/gtk/gtkbox.c @@ -123,7 +123,7 @@ gtk_box_class_init (GtkBoxClass *class) PROP_SPACING, g_param_spec_int ("spacing", _("Spacing"), - _("The amount of space between children."), + _("The amount of space between children"), 0, G_MAXINT, 0, @@ -133,7 +133,7 @@ gtk_box_class_init (GtkBoxClass *class) PROP_HOMOGENEOUS, g_param_spec_boolean ("homogeneous", _("Homogeneous"), - _("Whether the children should all be the same size."), + _("Whether the children should all be the same size"), FALSE, G_PARAM_READABLE | G_PARAM_WRITABLE)); diff --git a/gtk/gtkbutton.c b/gtk/gtkbutton.c index aab09a5311..2647ec0cef 100644 --- a/gtk/gtkbutton.c +++ b/gtk/gtkbutton.c @@ -187,7 +187,7 @@ gtk_button_class_init (GtkButtonClass *klass) PROP_LABEL, g_param_spec_string ("label", _("Label"), - _("Text of the label widget inside the button, if the button contains a label widget."), + _("Text of the label widget inside the button, if the button contains a label widget"), NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); @@ -211,7 +211,7 @@ gtk_button_class_init (GtkButtonClass *klass) PROP_RELIEF, g_param_spec_enum ("relief", _("Border relief"), - _("The border relief style."), + _("The border relief style"), GTK_TYPE_RELIEF_STYLE, GTK_RELIEF_NORMAL, G_PARAM_READABLE | G_PARAM_WRITABLE)); @@ -1127,13 +1127,13 @@ gtk_button_set_label (GtkButton *button, * @button: a #GtkButton * * Fetches the text from the label of the button, as set by - * gtk_button_set_label(). This string is owned by the widget - * and must not be modified or freed. If the label text has not - * been set the return value will be %NULL. This will be the + * gtk_button_set_label(). If the label text has not + * been set the return value will be %NULL. This will be the * case if you create an empty button with gtk_button_new() to * use as a container. * - * Return value: the text of the label widget. + * Return value: The text of the label widget. This string is owned + * by the widget and must not be modified or freed. **/ G_CONST_RETURN gchar * gtk_button_get_label (GtkButton *button) diff --git a/gtk/gtkcellrenderer.c b/gtk/gtkcellrenderer.c index 34dd331a52..d0fc40b171 100644 --- a/gtk/gtkcellrenderer.c +++ b/gtk/gtkcellrenderer.c @@ -137,7 +137,7 @@ gtk_cell_renderer_class_init (GtkCellRendererClass *class) PROP_XALIGN, g_param_spec_float ("xalign", _("xalign"), - _("The x-align."), + _("The x-align"), 0.0, 1.0, 0.0, @@ -148,7 +148,7 @@ gtk_cell_renderer_class_init (GtkCellRendererClass *class) PROP_YALIGN, g_param_spec_float ("yalign", _("yalign"), - _("The y-align."), + _("The y-align"), 0.0, 1.0, 0.5, @@ -159,7 +159,7 @@ gtk_cell_renderer_class_init (GtkCellRendererClass *class) PROP_XPAD, g_param_spec_uint ("xpad", _("xpad"), - _("The xpad."), + _("The xpad"), 0, 100, 2, @@ -170,7 +170,7 @@ gtk_cell_renderer_class_init (GtkCellRendererClass *class) PROP_YPAD, g_param_spec_uint ("ypad", _("ypad"), - _("The ypad."), + _("The ypad"), 0, 100, 2, @@ -181,7 +181,7 @@ gtk_cell_renderer_class_init (GtkCellRendererClass *class) PROP_WIDTH, g_param_spec_int ("width", _("width"), - _("The fixed width."), + _("The fixed width"), -1, 100, -1, @@ -192,7 +192,7 @@ gtk_cell_renderer_class_init (GtkCellRendererClass *class) PROP_HEIGHT, g_param_spec_int ("height", _("height"), - _("The fixed height."), + _("The fixed height"), -1, 100, -1, @@ -203,7 +203,7 @@ gtk_cell_renderer_class_init (GtkCellRendererClass *class) PROP_IS_EXPANDER, g_param_spec_boolean ("is_expander", _("Is Expander"), - _("Row has children."), + _("Row has children"), FALSE, G_PARAM_READABLE | G_PARAM_WRITABLE)); diff --git a/gtk/gtkcellrendererpixbuf.c b/gtk/gtkcellrendererpixbuf.c index e2d840f594..1252d2eef2 100644 --- a/gtk/gtkcellrendererpixbuf.c +++ b/gtk/gtkcellrendererpixbuf.c @@ -128,7 +128,7 @@ gtk_cell_renderer_pixbuf_class_init (GtkCellRendererPixbufClass *class) PROP_PIXBUF, g_param_spec_object ("pixbuf", _("Pixbuf Object"), - _("The pixbuf to render."), + _("The pixbuf to render"), GDK_TYPE_PIXBUF, G_PARAM_READABLE | G_PARAM_WRITABLE)); @@ -137,7 +137,7 @@ gtk_cell_renderer_pixbuf_class_init (GtkCellRendererPixbufClass *class) PROP_PIXBUF_EXPANDER_OPEN, g_param_spec_object ("pixbuf_expander_open", _("Pixbuf Expander Open"), - _("Pixbuf for open expander."), + _("Pixbuf for open expander"), GDK_TYPE_PIXBUF, G_PARAM_READABLE | G_PARAM_WRITABLE)); @@ -146,7 +146,7 @@ gtk_cell_renderer_pixbuf_class_init (GtkCellRendererPixbufClass *class) PROP_PIXBUF_EXPANDER_CLOSED, g_param_spec_object ("pixbuf_expander_closed", _("Pixbuf Expander Closed"), - _("Pixbuf for closed expander."), + _("Pixbuf for closed expander"), GDK_TYPE_PIXBUF, G_PARAM_READABLE | G_PARAM_WRITABLE)); diff --git a/gtk/gtkcellrenderertext.c b/gtk/gtkcellrenderertext.c index 19619cad49..87d5226d21 100644 --- a/gtk/gtkcellrenderertext.c +++ b/gtk/gtkcellrenderertext.c @@ -187,7 +187,7 @@ gtk_cell_renderer_text_class_init (GtkCellRendererTextClass *class) PROP_ATTRIBUTES, g_param_spec_boxed ("attributes", _("Attributes"), - _("A list of style attributes to apply to the text of the renderer."), + _("A list of style attributes to apply to the text of the renderer"), PANGO_TYPE_ATTR_LIST, G_PARAM_READWRITE)); diff --git a/gtk/gtkcheckmenuitem.c b/gtk/gtkcheckmenuitem.c index 954142bb17..cb5943aa63 100644 --- a/gtk/gtkcheckmenuitem.c +++ b/gtk/gtkcheckmenuitem.c @@ -113,7 +113,7 @@ gtk_check_menu_item_class_init (GtkCheckMenuItemClass *klass) PROP_ACTIVE, g_param_spec_boolean ("active", _("Active"), - _("Whether the menu item is checked."), + _("Whether the menu item is checked"), FALSE, G_PARAM_READWRITE)); @@ -121,7 +121,7 @@ gtk_check_menu_item_class_init (GtkCheckMenuItemClass *klass) PROP_INCONSISTENT, g_param_spec_boolean ("inconsistent", _("Inconsistent"), - _("Whether to display an \"inconsistent\" state."), + _("Whether to display an \"inconsistent\" state"), FALSE, G_PARAM_READWRITE)); diff --git a/gtk/gtkcontainer.c b/gtk/gtkcontainer.c index a72ae9028e..b27548b033 100644 --- a/gtk/gtkcontainer.c +++ b/gtk/gtkcontainer.c @@ -206,7 +206,7 @@ gtk_container_class_init (GtkContainerClass *class) PROP_BORDER_WIDTH, g_param_spec_uint ("border_width", _("Border width"), - _("The width of the empty border outside the containers children."), + _("The width of the empty border outside the containers children"), 0, G_MAXINT, 0, @@ -215,7 +215,7 @@ gtk_container_class_init (GtkContainerClass *class) PROP_CHILD, g_param_spec_object ("child", _("Child"), - _("Can be used to add a new child to the container."), + _("Can be used to add a new child to the container"), GTK_TYPE_WIDGET, G_PARAM_WRITABLE)); container_signals[ADD] = diff --git a/gtk/gtkcurve.c b/gtk/gtkcurve.c index 5f20d177bf..416c92a81f 100644 --- a/gtk/gtkcurve.c +++ b/gtk/gtkcurve.c @@ -138,7 +138,7 @@ gtk_curve_class_init (GtkCurveClass *class) PROP_MAX_X, g_param_spec_float ("max_x", _("Maximum X"), - _("Maximum possible X value."), + _("Maximum possible X value"), -G_MAXFLOAT, G_MAXFLOAT, 1.0, diff --git a/gtk/gtkdialog.h b/gtk/gtkdialog.h index 4dbaac8eb9..c39df01ee2 100644 --- a/gtk/gtkdialog.h +++ b/gtk/gtkdialog.h @@ -97,8 +97,9 @@ struct _GtkDialog { GtkWindow window; - GtkWidget *vbox; + /*< public >*/ GtkWidget *action_area; + GtkWidget *vbox; /*< private >*/ GtkWidget *separator; diff --git a/gtk/gtkentry.c b/gtk/gtkentry.c index c6fc15a9d4..7762a36130 100644 --- a/gtk/gtkentry.c +++ b/gtk/gtkentry.c @@ -433,7 +433,7 @@ gtk_entry_class_init (GtkEntryClass *class) PROP_CURSOR_POSITION, g_param_spec_int ("cursor_position", _("Cursor Position"), - _("The current position of the insertion cursor in chars."), + _("The current position of the insertion cursor in chars"), 0, MAX_SIZE, 0, @@ -443,7 +443,7 @@ gtk_entry_class_init (GtkEntryClass *class) PROP_SELECTION_BOUND, g_param_spec_int ("selection_bound", _("Selection Bound"), - _("The position of the opposite end of the selection from the cursor in chars."), + _("The position of the opposite end of the selection from the cursor in chars"), 0, MAX_SIZE, 0, @@ -461,7 +461,7 @@ gtk_entry_class_init (GtkEntryClass *class) PROP_MAX_LENGTH, g_param_spec_int ("max_length", _("Maximum length"), - _("Maximum number of characters for this entry. Zero if no maximum."), + _("Maximum number of characters for this entry. Zero if no maximum"), 0, MAX_SIZE, 0, @@ -478,7 +478,7 @@ gtk_entry_class_init (GtkEntryClass *class) PROP_HAS_FRAME, g_param_spec_boolean ("has_frame", _("Has Frame"), - _("FALSE removes outside bevel from entry."), + _("FALSE removes outside bevel from entry"), TRUE, G_PARAM_READABLE | G_PARAM_WRITABLE)); @@ -494,14 +494,14 @@ gtk_entry_class_init (GtkEntryClass *class) PROP_ACTIVATES_DEFAULT, g_param_spec_boolean ("activates_default", _("Activates default"), - _("Whether to activate the default widget (such as the default button in a dialog) when Enter is pressed."), + _("Whether to activate the default widget (such as the default button in a dialog) when Enter is pressed"), FALSE, G_PARAM_READABLE | G_PARAM_WRITABLE)); g_object_class_install_property (gobject_class, PROP_WIDTH_CHARS, g_param_spec_int ("width_chars", _("Width in chars"), - _("Number of characters to leave space for in the entry."), + _("Number of characters to leave space for in the entry"), -1, G_MAXINT, -1, @@ -737,7 +737,7 @@ gtk_entry_class_init (GtkEntryClass *class) gtk_settings_install_property (g_param_spec_boolean ("gtk-entry-select-on-focus", _("Select on focus"), - _("Whether to select the contents of an entry when it is focused."), + _("Whether to select the contents of an entry when it is focused"), TRUE, G_PARAM_READWRITE)); } @@ -3440,6 +3440,18 @@ gtk_entry_set_editable (GtkEntry *entry, gtk_editable_set_editable (GTK_EDITABLE (entry), editable); } +/** + * gtk_entry_get_text: + * @entry: a #GtkEntry + * + * Retrieves the contents of the entry widget. + * See also gtk_editable_get_chars(). + * + * Return value: a pointer to the contents of the widget as a + * string. This string points to internally allocated + * storage in the widget and must not be freed, modified or + * stored. + **/ G_CONST_RETURN gchar* gtk_entry_get_text (GtkEntry *entry) { diff --git a/gtk/gtkfilesel.c b/gtk/gtkfilesel.c index efc5b1bfff..d06ef2937e 100644 --- a/gtk/gtkfilesel.c +++ b/gtk/gtkfilesel.c @@ -534,14 +534,14 @@ gtk_file_selection_class_init (GtkFileSelectionClass *class) PROP_FILENAME, g_param_spec_string ("filename", _("Filename"), - _("The currently selected filename."), + _("The currently selected filename"), NULL, G_PARAM_READABLE | G_PARAM_WRITABLE)); g_object_class_install_property (gobject_class, PROP_SHOW_FILEOPS, g_param_spec_boolean ("show_fileops", _("Show file operations"), - _("Whether buttons for creating/manipulating files should be displayed."), + _("Whether buttons for creating/manipulating files should be displayed"), FALSE, G_PARAM_READABLE | G_PARAM_WRITABLE)); @@ -549,7 +549,7 @@ gtk_file_selection_class_init (GtkFileSelectionClass *class) PROP_SELECT_MULTIPLE, g_param_spec_boolean ("select_multiple", _("Select multiple"), - _("Whether to allow multiple files to be selected."), + _("Whether to allow multiple files to be selected"), FALSE, G_PARAM_READABLE | G_PARAM_WRITABLE)); diff --git a/gtk/gtkfontsel.c b/gtk/gtkfontsel.c index 6307d9d5b2..b5bc910a46 100644 --- a/gtk/gtkfontsel.c +++ b/gtk/gtkfontsel.c @@ -208,21 +208,21 @@ gtk_font_selection_class_init (GtkFontSelectionClass *klass) PROP_FONT_NAME, g_param_spec_string ("font_name", _("Font name"), - _("The X string that represents this font."), + _("The X string that represents this font"), NULL, G_PARAM_READWRITE)); g_object_class_install_property (gobject_class, PROP_FONT, g_param_spec_boxed ("font", _("Font"), - _("The GdkFont that is currently selected."), + _("The GdkFont that is currently selected"), GDK_TYPE_FONT, G_PARAM_READABLE)); g_object_class_install_property (gobject_class, PROP_PREVIEW_TEXT, g_param_spec_string ("preview_text", _("Preview text"), - _("The text to display in order to demonstrate the selected font."), + _("The text to display in order to demonstrate the selected font"), PREVIEW_TEXT, G_PARAM_READWRITE)); gobject_class->finalize = gtk_font_selection_finalize; diff --git a/gtk/gtkframe.c b/gtk/gtkframe.c index 6668d63bc5..bedf2c4ae8 100644 --- a/gtk/gtkframe.c +++ b/gtk/gtkframe.c @@ -123,7 +123,7 @@ gtk_frame_class_init (GtkFrameClass *class) PROP_LABEL, g_param_spec_string ("label", _("Label"), - _("Text of the frame's label."), + _("Text of the frame's label"), NULL, G_PARAM_READABLE | G_PARAM_WRITABLE)); @@ -131,7 +131,7 @@ gtk_frame_class_init (GtkFrameClass *class) PROP_LABEL_XALIGN, g_param_spec_float ("label_xalign", _("Label xalign"), - _("The horizontal alignment of the label."), + _("The horizontal alignment of the label"), 0.0, 1.0, 0.5, @@ -141,7 +141,7 @@ gtk_frame_class_init (GtkFrameClass *class) PROP_LABEL_YALIGN, g_param_spec_float ("label_yalign", _("Label yalign"), - _("The vertical alignment of the label."), + _("The vertical alignment of the label"), 0.0, 1.0, 0.5, @@ -150,7 +150,7 @@ gtk_frame_class_init (GtkFrameClass *class) g_object_class_install_property (gobject_class, PROP_SHADOW, g_param_spec_enum ("shadow", NULL, - _("Deprecated property, use shadow_type instead."), + _("Deprecated property, use shadow_type instead"), GTK_TYPE_SHADOW_TYPE, GTK_SHADOW_ETCHED_IN, G_PARAM_READABLE | G_PARAM_WRITABLE)); @@ -158,7 +158,7 @@ gtk_frame_class_init (GtkFrameClass *class) PROP_SHADOW_TYPE, g_param_spec_enum ("shadow_type", _("Frame shadow"), - _("Appearance of the frame border."), + _("Appearance of the frame border"), GTK_TYPE_SHADOW_TYPE, GTK_SHADOW_ETCHED_IN, G_PARAM_READABLE | G_PARAM_WRITABLE)); @@ -167,7 +167,7 @@ gtk_frame_class_init (GtkFrameClass *class) PROP_LABEL_WIDGET, g_param_spec_object ("label_widget", _("Label widget"), - _("A widget to display in place of the usual frame label."), + _("A widget to display in place of the usual frame label"), GTK_TYPE_WIDGET, G_PARAM_READABLE | G_PARAM_WRITABLE)); @@ -334,7 +334,8 @@ gtk_frame_set_label (GtkFrame *frame, * * Return value: the text in the label, or %NULL if there * was no label widget or the lable widget was not - * a #GtkLabel. This value must be freed with g_free(). + * a #GtkLabel. This string is owned by GTK+ and + * must not be modified or freed. **/ G_CONST_RETURN gchar * gtk_frame_get_label (GtkFrame *frame) diff --git a/gtk/gtkhandlebox.c b/gtk/gtkhandlebox.c index 73e198c18e..22ec053943 100644 --- a/gtk/gtkhandlebox.c +++ b/gtk/gtkhandlebox.c @@ -182,7 +182,7 @@ gtk_handle_box_class_init (GtkHandleBoxClass *class) g_object_class_install_property (gobject_class, PROP_SHADOW, g_param_spec_enum ("shadow", NULL, - _("Deprecated property, use shadow_type instead."), + _("Deprecated property, use shadow_type instead"), GTK_TYPE_SHADOW_TYPE, GTK_SHADOW_ETCHED_OUT, G_PARAM_READABLE | G_PARAM_WRITABLE)); @@ -190,7 +190,7 @@ gtk_handle_box_class_init (GtkHandleBoxClass *class) PROP_SHADOW_TYPE, g_param_spec_enum ("shadow_type", _("Shadow type"), - _("Appearance of the shadow that surrounds the container."), + _("Appearance of the shadow that surrounds the container"), GTK_TYPE_SHADOW_TYPE, GTK_SHADOW_ETCHED_OUT, G_PARAM_READABLE | G_PARAM_WRITABLE)); @@ -199,7 +199,7 @@ gtk_handle_box_class_init (GtkHandleBoxClass *class) PROP_HANDLE_POSITION, g_param_spec_enum ("handle_position", _("Handle position"), - _("Position of the handle relative to the child widget."), + _("Position of the handle relative to the child widget"), GTK_TYPE_POSITION_TYPE, GTK_POS_LEFT, G_PARAM_READABLE | G_PARAM_WRITABLE)); @@ -208,7 +208,7 @@ gtk_handle_box_class_init (GtkHandleBoxClass *class) PROP_SNAP_EDGE, g_param_spec_enum ("snap_edge", _("Snap edge"), - _("Side of the handlebox that's lined up with the docking point to dock the handlebox."), + _("Side of the handlebox that's lined up with the docking point to dock the handlebox"), GTK_TYPE_POSITION_TYPE, GTK_POS_TOP, G_PARAM_READABLE | G_PARAM_WRITABLE)); diff --git a/gtk/gtkiconfactory.c b/gtk/gtkiconfactory.c index 2f9ad888fe..548511cd12 100644 --- a/gtk/gtkiconfactory.c +++ b/gtk/gtkiconfactory.c @@ -1754,11 +1754,12 @@ gtk_icon_source_set_pixbuf (GtkIconSource *source, * gtk_icon_source_get_filename: * @source: a #GtkIconSource * - * Retrieves the source filename, or %NULL if none is set. The + * Retrieves the source filename, or %NULL if none is set. The * filename is not a copy, and should not be modified or expected to * persist beyond the lifetime of the icon source. * - * Return value: image filename + * Return value: image filename. This string must not be modified + * or freed. **/ G_CONST_RETURN gchar* gtk_icon_source_get_filename (const GtkIconSource *source) diff --git a/gtk/gtkimage.c b/gtk/gtkimage.c index ffb49be096..967fd29df5 100644 --- a/gtk/gtkimage.c +++ b/gtk/gtkimage.c @@ -127,7 +127,7 @@ gtk_image_class_init (GtkImageClass *class) PROP_PIXBUF, g_param_spec_object ("pixbuf", _("Pixbuf"), - _("A GdkPixbuf to display."), + _("A GdkPixbuf to display"), GDK_TYPE_PIXBUF, G_PARAM_READWRITE)); @@ -135,7 +135,7 @@ gtk_image_class_init (GtkImageClass *class) PROP_PIXMAP, g_param_spec_object ("pixmap", _("Pixmap"), - _("A GdkPixmap to display."), + _("A GdkPixmap to display"), GDK_TYPE_PIXMAP, G_PARAM_READWRITE)); @@ -143,7 +143,7 @@ gtk_image_class_init (GtkImageClass *class) PROP_IMAGE, g_param_spec_object ("image", _("Image"), - _("A GdkImage to display."), + _("A GdkImage to display"), GDK_TYPE_IMAGE, G_PARAM_READWRITE)); @@ -159,7 +159,7 @@ gtk_image_class_init (GtkImageClass *class) PROP_FILE, g_param_spec_string ("file", _("Filename"), - _("Filename to load and display."), + _("Filename to load and display"), NULL, G_PARAM_WRITABLE)); @@ -168,7 +168,7 @@ gtk_image_class_init (GtkImageClass *class) PROP_STOCK, g_param_spec_string ("stock", _("Stock ID"), - _("Stock ID for a stock image to display."), + _("Stock ID for a stock image to display"), NULL, G_PARAM_READWRITE)); @@ -176,7 +176,7 @@ gtk_image_class_init (GtkImageClass *class) PROP_ICON_SET, g_param_spec_boxed ("icon_set", _("Icon set"), - _("Icon set to display."), + _("Icon set to display"), GTK_TYPE_ICON_SET, G_PARAM_READWRITE)); @@ -184,7 +184,7 @@ gtk_image_class_init (GtkImageClass *class) PROP_ICON_SIZE, g_param_spec_int ("icon_size", _("Icon size"), - _("Size to use for stock icon or icon set."), + _("Size to use for stock icon or icon set"), 0, G_MAXINT, DEFAULT_ICON_SIZE, G_PARAM_READWRITE)); @@ -193,7 +193,7 @@ gtk_image_class_init (GtkImageClass *class) PROP_PIXBUF_ANIMATION, g_param_spec_object ("pixbuf_animation", _("Animation"), - _("GdkPixbufAnimation to display."), + _("GdkPixbufAnimation to display"), GDK_TYPE_PIXBUF_ANIMATION, G_PARAM_READWRITE)); @@ -201,7 +201,7 @@ gtk_image_class_init (GtkImageClass *class) PROP_STORAGE_TYPE, g_param_spec_enum ("storage_type", _("Storage type"), - _("The representation being used for image data."), + _("The representation being used for image data"), GTK_TYPE_IMAGE_TYPE, GTK_IMAGE_EMPTY, G_PARAM_READABLE)); diff --git a/gtk/gtkinvisible.c b/gtk/gtkinvisible.c index 0b23fd0853..5165c3e602 100644 --- a/gtk/gtkinvisible.c +++ b/gtk/gtkinvisible.c @@ -111,7 +111,7 @@ gtk_invisible_class_init (GtkInvisibleClass *class) PROP_SCREEN, g_param_spec_object ("screen", _("Screen"), - _("The screen where this window will be displayed."), + _("The screen where this window will be displayed"), GDK_TYPE_SCREEN, G_PARAM_READWRITE)); } diff --git a/gtk/gtkitemfactory.c b/gtk/gtkitemfactory.c index c2575b11d5..2229417ec4 100644 --- a/gtk/gtkitemfactory.c +++ b/gtk/gtkitemfactory.c @@ -590,8 +590,8 @@ gtk_item_factory_from_widget (GtkWidget *widget) /** * gtk_item_factory_path_from_widget: * @widget: a widget - * @returns: the full path to @widget if it been created by an item factory, - * %NULL otherwise. This value is owned by GTK+ and must not be + * @returns: the full path to @widget if it has been created by an item + * factory, %NULL otherwise. This value is owned by GTK+ and must not be * modified or freed. * * If @widget has been created by an item factory, returns the full path diff --git a/gtk/gtklabel.c b/gtk/gtklabel.c index 16912a52ff..90b7230385 100644 --- a/gtk/gtklabel.c +++ b/gtk/gtklabel.c @@ -278,21 +278,21 @@ gtk_label_class_init (GtkLabelClass *class) PROP_LABEL, g_param_spec_string ("label", _("Label"), - _("The text of the label."), + _("The text of the label"), NULL, G_PARAM_READWRITE)); g_object_class_install_property (gobject_class, PROP_ATTRIBUTES, g_param_spec_boxed ("attributes", _("Attributes"), - _("A list of style attributes to apply to the text of the label."), + _("A list of style attributes to apply to the text of the label"), PANGO_TYPE_ATTR_LIST, G_PARAM_READWRITE)); g_object_class_install_property (gobject_class, PROP_USE_MARKUP, g_param_spec_boolean ("use_markup", _("Use markup"), - _("The text of the label includes XML markup. See pango_parse_markup()."), + _("The text of the label includes XML markup. See pango_parse_markup()"), FALSE, G_PARAM_READWRITE)); g_object_class_install_property (gobject_class, @@ -307,7 +307,7 @@ gtk_label_class_init (GtkLabelClass *class) PROP_JUSTIFY, g_param_spec_enum ("justify", _("Justification"), - _("The alignment of the lines in the text of the label relative to each other. This does NOT affect the alignment of the label within its allocation. See GtkMisc::xalign for that."), + _("The alignment of the lines in the text of the label relative to each other. This does NOT affect the alignment of the label within its allocation. See GtkMisc::xalign for that"), GTK_TYPE_JUSTIFICATION, GTK_JUSTIFY_LEFT, G_PARAM_READWRITE)); @@ -316,7 +316,7 @@ gtk_label_class_init (GtkLabelClass *class) PROP_PATTERN, g_param_spec_string ("pattern", _("Pattern"), - _("A string with _ characters in positions correspond to characters in the text to underline."), + _("A string with _ characters in positions correspond to characters in the text to underline"), NULL, G_PARAM_WRITABLE)); @@ -324,21 +324,21 @@ gtk_label_class_init (GtkLabelClass *class) PROP_WRAP, g_param_spec_boolean ("wrap", _("Line wrap"), - _("If set, wrap lines if the text becomes too wide."), + _("If set, wrap lines if the text becomes too wide"), FALSE, G_PARAM_READWRITE)); g_object_class_install_property (gobject_class, PROP_SELECTABLE, g_param_spec_boolean ("selectable", _("Selectable"), - _("Whether the label text can be selected with the mouse."), + _("Whether the label text can be selected with the mouse"), FALSE, G_PARAM_READWRITE)); g_object_class_install_property (gobject_class, PROP_MNEMONIC_KEYVAL, g_param_spec_uint ("mnemonic_keyval", _("Mnemonic key"), - _("The mnemonic accelerator key for this label."), + _("The mnemonic accelerator key for this label"), 0, G_MAXUINT, GDK_VoidSymbol, @@ -348,7 +348,7 @@ gtk_label_class_init (GtkLabelClass *class) g_param_spec_object ("mnemonic_widget", _("Mnemonic widget"), _("The widget to be activated when the label's mnemonic " - "key is pressed."), + "key is pressed"), GTK_TYPE_WIDGET, G_PARAM_READWRITE)); @@ -356,7 +356,7 @@ gtk_label_class_init (GtkLabelClass *class) PROP_CURSOR_POSITION, g_param_spec_int ("cursor_position", _("Cursor Position"), - _("The current position of the insertion cursor in chars."), + _("The current position of the insertion cursor in chars"), 0, G_MAXINT, 0, @@ -366,7 +366,7 @@ gtk_label_class_init (GtkLabelClass *class) PROP_SELECTION_BOUND, g_param_spec_int ("selection_bound", _("Selection Bound"), - _("The position of the opposite end of the selection from the cursor in chars."), + _("The position of the opposite end of the selection from the cursor in chars"), 0, G_MAXINT, 0, @@ -929,7 +929,8 @@ gtk_label_set_text (GtkLabel *label, * * Sets a #PangoAttrList; the attributes in the list are applied to the * label text. The attributes set with this function will be ignored - * if label->use_underline or label->use_markup is %TRUE. + * if the "use_underline" property or the "use_markup" property + * is %TRUE. **/ void gtk_label_set_attributes (GtkLabel *label, diff --git a/gtk/gtklayout.c b/gtk/gtklayout.c index 1f636b1288..e48968fc1d 100644 --- a/gtk/gtklayout.c +++ b/gtk/gtklayout.c @@ -621,7 +621,7 @@ gtk_layout_class_init (GtkLayoutClass *class) PROP_HADJUSTMENT, g_param_spec_object ("hadjustment", _("Horizontal adjustment"), - _("The GtkAdjustment for the horizontal position."), + _("The GtkAdjustment for the horizontal position"), GTK_TYPE_ADJUSTMENT, G_PARAM_READWRITE)); @@ -629,7 +629,7 @@ gtk_layout_class_init (GtkLayoutClass *class) PROP_VADJUSTMENT, g_param_spec_object ("vadjustment", _("Vertical adjustment"), - _("The GtkAdjustment for the vertical position."), + _("The GtkAdjustment for the vertical position"), GTK_TYPE_ADJUSTMENT, G_PARAM_READWRITE)); @@ -637,7 +637,7 @@ gtk_layout_class_init (GtkLayoutClass *class) PROP_WIDTH, g_param_spec_uint ("width", _("Width"), - _("The width of the layout."), + _("The width of the layout"), 0, G_MAXINT, 100, @@ -646,7 +646,7 @@ gtk_layout_class_init (GtkLayoutClass *class) PROP_HEIGHT, g_param_spec_uint ("height", _("Height"), - _("The height of the layout."), + _("The height of the layout"), 0, G_MAXINT, 100, diff --git a/gtk/gtkmenu.c b/gtk/gtkmenu.c index feda2524e6..d2ff193052 100644 --- a/gtk/gtkmenu.c +++ b/gtk/gtkmenu.c @@ -223,7 +223,7 @@ gtk_menu_class_init (GtkMenuClass *class) PROP_TEAROFF_TITLE, g_param_spec_string ("tearoff-title", _("Tearoff Title"), - _("A title that may be displayed by the window manager when this menu is torn-off."), + _("A title that may be displayed by the window manager when this menu is torn-off"), "", G_PARAM_READABLE | G_PARAM_WRITABLE)); object_class->destroy = gtk_menu_destroy; @@ -293,7 +293,7 @@ gtk_menu_class_init (GtkMenuClass *class) gtk_settings_install_property (g_param_spec_boolean ("gtk-can-change-accels", _("Can change accelerators"), - _("Whether menu accelerators can be changed by pressing a key over the menu item."), + _("Whether menu accelerators can be changed by pressing a key over the menu item"), FALSE, G_PARAM_READWRITE)); } @@ -1286,7 +1286,8 @@ gtk_menu_set_title (GtkMenu *menu, * Returns the title of the menu. See gtk_menu_set_title(). * * Return value: the title of the menu, or %NULL if the menu has no - * title set on it. + * title set on it. This string is owned by the widget and should + * not be modified or freed. **/ G_CONST_RETURN gchar * gtk_menu_get_title (GtkMenu *menu) diff --git a/gtk/gtkprogress.c b/gtk/gtkprogress.c index ed85eab588..cd151ef997 100644 --- a/gtk/gtkprogress.c +++ b/gtk/gtkprogress.c @@ -120,7 +120,7 @@ gtk_progress_class_init (GtkProgressClass *class) PROP_ACTIVITY_MODE, g_param_spec_boolean ("activity_mode", _("Activity mode"), - _("If TRUE the GtkProgress is in activity mode, meaning that it signals something is happening, but not how much of the activity is finished. This is used when you're doing something that you don't know how long it will take."), + _("If TRUE the GtkProgress is in activity mode, meaning that it signals something is happening, but not how much of the activity is finished. This is used when you're doing something that you don't know how long it will take"), FALSE, G_PARAM_READWRITE)); diff --git a/gtk/gtkprogressbar.c b/gtk/gtkprogressbar.c index 98c07b0a43..7e6bb152f3 100644 --- a/gtk/gtkprogressbar.c +++ b/gtk/gtkprogressbar.c @@ -993,7 +993,8 @@ gtk_progress_bar_set_orientation (GtkProgressBar *pbar, * to the text, not a copy of it, so will become invalid * if you change the text in the progress bar. * - * Return value: text, or %NULL; don't free the string + * Return value: text, or %NULL; this string is owned by the widget + * and should not be modified or freed. **/ G_CONST_RETURN gchar* gtk_progress_bar_get_text (GtkProgressBar *pbar) diff --git a/gtk/gtkscrolledwindow.c b/gtk/gtkscrolledwindow.c index 2f917269ea..efdbc3e5d5 100644 --- a/gtk/gtkscrolledwindow.c +++ b/gtk/gtkscrolledwindow.c @@ -234,14 +234,14 @@ gtk_scrolled_window_class_init (GtkScrolledWindowClass *class) PROP_HADJUSTMENT, g_param_spec_object ("hadjustment", _("Horizontal Adjustment"), - _("The GtkAdjustment for the horizontal position."), + _("The GtkAdjustment for the horizontal position"), GTK_TYPE_ADJUSTMENT, G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); g_object_class_install_property (gobject_class, PROP_VADJUSTMENT, g_param_spec_object ("vadjustment", _("Vertical Adjustment"), - _("The GtkAdjustment for the vertical position."), + _("The GtkAdjustment for the vertical position"), GTK_TYPE_ADJUSTMENT, G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); g_object_class_install_property (gobject_class, diff --git a/gtk/gtksizegroup.c b/gtk/gtksizegroup.c index 28cf91b5f3..886d07b897 100644 --- a/gtk/gtksizegroup.c +++ b/gtk/gtksizegroup.c @@ -241,7 +241,7 @@ gtk_size_group_class_init (GtkSizeGroupClass *klass) g_param_spec_enum ("mode", _("Mode"), _("The directions in which the size group effects the requested sizes" - " of its component widgets."), + " of its component widgets"), GTK_TYPE_SIZE_GROUP_MODE, GTK_SIZE_GROUP_HORIZONTAL, G_PARAM_READWRITE)); diff --git a/gtk/gtktable.c b/gtk/gtktable.c index a8c7c82ae7..d7d66cf26a 100644 --- a/gtk/gtktable.c +++ b/gtk/gtktable.c @@ -226,7 +226,7 @@ gtk_table_class_init (GtkTableClass *class) CHILD_PROP_X_OPTIONS, g_param_spec_flags ("x_options", _("Horizontal options"), - _("Options specifying the horizontal behaviour of the child."), + _("Options specifying the horizontal behaviour of the child"), GTK_TYPE_ATTACH_OPTIONS, GTK_EXPAND | GTK_FILL, G_PARAM_READWRITE)); gtk_container_class_install_child_property (container_class, diff --git a/gtk/gtktextiter.c b/gtk/gtktextiter.c index 7f4e978ce1..6c6cd7fb54 100644 --- a/gtk/gtktextiter.c +++ b/gtk/gtktextiter.c @@ -853,7 +853,7 @@ gtk_text_iter_get_visible_line_index (const GtkTextIter *iter) * @iter: an iterator * * Returns the Unicode character at this iterator. (Equivalent to - * operator* on a C++ iterator.) If the iterator points at a + * operator* on a C++ iterator.) If the element at this iterator is a * non-character element, such as an image embedded in the buffer, the * Unicode "unknown" character 0xFFFC is returned. If invoked on * the end iterator, zero is returned; zero is not a valid Unicode character. @@ -999,8 +999,8 @@ gtk_text_iter_get_visible_text (const GtkTextIter *start, * gtk_text_iter_get_pixbuf: * @iter: an iterator * - * If the location pointed to by @iter contains a pixbuf, the pixbuf - * is returned (with no new reference count added). Otherwise, + * If the element at @iter is a pixbuf, the pixbuf is returned + * (with no new reference count added). Otherwise, * %NULL is returned. * * Return value: the pixbuf at @iter @@ -1029,7 +1029,7 @@ gtk_text_iter_get_pixbuf (const GtkTextIter *iter) * gtk_text_iter_get_child_anchor: * @iter: an iterator * - * If the location pointed to by @iter contains a child anchor, the + * If the location at @iter contains a child anchor, the * anchor is returned (with no new reference count added). Otherwise, * %NULL is returned. * @@ -3392,7 +3392,7 @@ gtk_text_iter_forward_cursor_position (GtkTextIter *iter) * * Like gtk_text_iter_forward_cursor_position(), but moves backward. * - * Return value: %TRUE if we moved and the new position is dereferenceable + * Return value: %TRUE if we moved **/ gboolean gtk_text_iter_backward_cursor_position (GtkTextIter *iter) diff --git a/gtk/gtktexttag.c b/gtk/gtktexttag.c index 3cb2fcad98..59653791c3 100644 --- a/gtk/gtktexttag.c +++ b/gtk/gtktexttag.c @@ -197,7 +197,7 @@ gtk_text_tag_class_init (GtkTextTagClass *klass) PROP_NAME, g_param_spec_string ("name", _("Tag name"), - _("Name used to refer to the text tag. NULL for anonymous tags."), + _("Name used to refer to the text tag. NULL for anonymous tags"), NULL, G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY)); @@ -308,7 +308,7 @@ gtk_text_tag_class_init (GtkTextTagClass *klass) PROP_STYLE, g_param_spec_enum ("style", _("Font style"), - _("Font style as a PangoStyle, e.g. PANGO_STYLE_ITALIC."), + _("Font style as a PangoStyle, e.g. PANGO_STYLE_ITALIC"), PANGO_TYPE_STYLE, PANGO_STYLE_NORMAL, G_PARAM_READABLE | G_PARAM_WRITABLE)); @@ -317,7 +317,7 @@ gtk_text_tag_class_init (GtkTextTagClass *klass) PROP_VARIANT, g_param_spec_enum ("variant", _("Font variant"), - _("Font variant as a PangoVariant, e.g. PANGO_VARIANT_SMALL_CAPS."), + _("Font variant as a PangoVariant, e.g. PANGO_VARIANT_SMALL_CAPS"), PANGO_TYPE_VARIANT, PANGO_VARIANT_NORMAL, G_PARAM_READABLE | G_PARAM_WRITABLE)); @@ -326,7 +326,7 @@ gtk_text_tag_class_init (GtkTextTagClass *klass) PROP_WEIGHT, g_param_spec_int ("weight", _("Font weight"), - _("Font weight as an integer, see predefined values in PangoWeight; for example, PANGO_WEIGHT_BOLD."), + _("Font weight as an integer, see predefined values in PangoWeight; for example, PANGO_WEIGHT_BOLD"), 0, G_MAXINT, PANGO_WEIGHT_NORMAL, @@ -337,7 +337,7 @@ gtk_text_tag_class_init (GtkTextTagClass *klass) PROP_STRETCH, g_param_spec_enum ("stretch", _("Font stretch"), - _("Font stretch as a PangoStretch, e.g. PANGO_STRETCH_CONDENSED."), + _("Font stretch as a PangoStretch, e.g. PANGO_STRETCH_CONDENSED"), PANGO_TYPE_STRETCH, PANGO_STRETCH_NORMAL, G_PARAM_READABLE | G_PARAM_WRITABLE)); @@ -346,7 +346,7 @@ gtk_text_tag_class_init (GtkTextTagClass *klass) PROP_SIZE, g_param_spec_int ("size", _("Font size"), - _("Font size in Pango units."), + _("Font size in Pango units"), 0, G_MAXINT, 0, @@ -356,7 +356,7 @@ gtk_text_tag_class_init (GtkTextTagClass *klass) PROP_SCALE, g_param_spec_double ("scale", _("Font scale"), - _("Font size as a scale factor relative to the default font size. This properly adapts to theme changes etc. so is recommended. Pango predefines some scales such as PANGO_SCALE_X_LARGE."), + _("Font size as a scale factor relative to the default font size. This properly adapts to theme changes etc. so is recommended. Pango predefines some scales such as PANGO_SCALE_X_LARGE"), 0.0, G_MAXDOUBLE, 1.0, @@ -385,7 +385,7 @@ gtk_text_tag_class_init (GtkTextTagClass *klass) PROP_LANGUAGE, g_param_spec_string ("language", _("Language"), - _("The language this text is in, as an ISO code. Pango can use this as a hint when rendering the text. If you don't understand this parameter, you probably don't need it."), + _("The language this text is in, as an ISO code. Pango can use this as a hint when rendering the text. If you don't understand this parameter, you probably don't need it"), NULL, G_PARAM_READABLE | G_PARAM_WRITABLE)); diff --git a/gtk/gtktexttag.h b/gtk/gtktexttag.h index 52f54fe6fa..f74df6b099 100644 --- a/gtk/gtktexttag.h +++ b/gtk/gtktexttag.h @@ -112,6 +112,7 @@ typedef struct _GtkTextAppearance GtkTextAppearance; struct _GtkTextAppearance { + /*< public >*/ GdkColor bg_color; GdkColor fg_color; GdkBitmap *bg_stipple; @@ -120,11 +121,13 @@ struct _GtkTextAppearance /* super/subscript rise, can be negative */ gint rise; + /*< private >*/ /* I'm not sure this can really be used without breaking some things * an app might do :-/ */ gpointer padding1; - + + /*< public >*/ guint underline : 4; /* PangoUnderline */ guint strikethrough : 1; @@ -142,6 +145,7 @@ struct _GtkTextAppearance guint inside_selection : 1; guint is_text : 1; + /*< private >*/ guint pad1 : 1; guint pad2 : 1; guint pad3 : 1; @@ -150,8 +154,10 @@ struct _GtkTextAppearance struct _GtkTextAttributes { + /*< private >*/ guint refcount; + /*< public >*/ GtkTextAppearance appearance; GtkJustification justification; @@ -183,11 +189,13 @@ struct _GtkTextAttributes PangoLanguage *language; + /*< private >*/ /* I'm not sure this can really be used without breaking some things * an app might do :-/ */ gpointer padding1; - + + /*< public >*/ /* hide the text */ guint invisible : 1; @@ -202,6 +210,7 @@ struct _GtkTextAttributes /* colors are allocated etc. */ guint realized : 1; + /*< private >*/ guint pad1 : 1; guint pad2 : 1; guint pad3 : 1; diff --git a/gtk/gtktogglebutton.c b/gtk/gtktogglebutton.c index 739fc5bc44..907f4a64c0 100644 --- a/gtk/gtktogglebutton.c +++ b/gtk/gtktogglebutton.c @@ -139,7 +139,7 @@ gtk_toggle_button_class_init (GtkToggleButtonClass *class) PROP_INCONSISTENT, g_param_spec_boolean ("inconsistent", _("Inconsistent"), - _("If the toggle button is in an \"in between\" state."), + _("If the toggle button is in an \"in between\" state"), FALSE, G_PARAM_READWRITE)); diff --git a/gtk/gtktreemodel.c b/gtk/gtktreemodel.c index 04bce527df..842e09c318 100644 --- a/gtk/gtktreemodel.c +++ b/gtk/gtktreemodel.c @@ -886,12 +886,15 @@ gtk_tree_model_iter_next (GtkTreeModel *tree_model, * gtk_tree_model_iter_children: * @tree_model: A #GtkTreeModel. * @iter: The new #GtkTreeIter to be set to the child. - * @parent: The #GtkTreeIter. + * @parent: The #GtkTreeIter, or %NULL * * Sets @iter to point to the first child of @parent. If @parent has no children, * %FALSE is returned and @iter is set to be invalid. @parent will remain a valid * node after this function has been called. * + * If @parent is %NULL returns the first node, equivalent to + * <literal>gtk_tree_model_get_iter_first (tree_model, iter);</literal> + * * Return value: %TRUE, if @child has been set to the first child. **/ gboolean diff --git a/gtk/gtktreeselection.c b/gtk/gtktreeselection.c index 739936052d..88df17bcba 100644 --- a/gtk/gtktreeselection.c +++ b/gtk/gtktreeselection.c @@ -866,7 +866,7 @@ gtk_tree_selection_path_is_selected (GtkTreeSelection *selection, * @selection: A #GtkTreeSelection * @iter: A valid #GtkTreeIter * - * Returns %TRUE if the row pointed to by @path is currently selected. + * Returns %TRUE if the row at @iter is currently selected. * * Return value: %TRUE, if @iter is selected **/ diff --git a/gtk/gtktreestore.c b/gtk/gtktreestore.c index 4c3f8bbf88..a312462532 100644 --- a/gtk/gtktreestore.c +++ b/gtk/gtktreestore.c @@ -1215,10 +1215,10 @@ gtk_tree_store_insert_before (GtkTreeStore *tree_store, * @sibling: A valid #GtkTreeIter, or %NULL * * Inserts a new row after @sibling. If @sibling is %NULL, then the row will be - * prepended to the beginning of the @parent 's children. If @parent and - * @sibling are %NULL, then the row will be prepended to the toplevel. If both - * @sibling and @parent are set, then @parent must be the parent of @sibling. - * When @sibling is set, @parent is optional. + * prepended to @parent 's children. If @parent and @sibling are %NULL, then + * the row will be prepended to the toplevel. If both @sibling and @parent are + * set, then @parent must be the parent of @sibling. When @sibling is set, + * @parent is optional. * * @iter will be changed to point to this new row. The row will be empty after * this function is called. To fill in values, you need to call diff --git a/gtk/gtktreeview.c b/gtk/gtktreeview.c index 16d9760e01..44681f83cf 100644 --- a/gtk/gtktreeview.c +++ b/gtk/gtktreeview.c @@ -600,7 +600,7 @@ gtk_tree_view_class_init (GtkTreeViewClass *class) gtk_widget_class_install_style_property (widget_class, g_param_spec_int ("expander_size", _("Expander Size"), - _("Size of the expander arrow."), + _("Size of the expander arrow"), 0, G_MAXINT, _TREE_VIEW_EXPANDER_SIZE, @@ -609,7 +609,7 @@ gtk_tree_view_class_init (GtkTreeViewClass *class) gtk_widget_class_install_style_property (widget_class, g_param_spec_int ("vertical_separator", _("Vertical Separator Width"), - _("Vertical space between cells. Must be an even number."), + _("Vertical space between cells. Must be an even number"), 0, G_MAXINT, _TREE_VIEW_VERTICAL_SEPARATOR, @@ -618,7 +618,7 @@ gtk_tree_view_class_init (GtkTreeViewClass *class) gtk_widget_class_install_style_property (widget_class, g_param_spec_int ("horizontal_separator", _("Horizontal Separator Width"), - _("Horizontal space between cells. Must be an even number."), + _("Horizontal space between cells. Must be an even number"), 0, G_MAXINT, _TREE_VIEW_HORIZONTAL_SEPARATOR, @@ -627,14 +627,14 @@ gtk_tree_view_class_init (GtkTreeViewClass *class) gtk_widget_class_install_style_property (widget_class, g_param_spec_boolean ("allow_rules", _("Allow Rules"), - _("Allow drawing of alternating color rows."), + _("Allow drawing of alternating color rows"), TRUE, G_PARAM_READABLE)); gtk_widget_class_install_style_property (widget_class, g_param_spec_boolean ("indent_expanders", _("Indent Expanders"), - _("Make the expanders indented."), + _("Make the expanders indented"), TRUE, G_PARAM_READABLE)); /* Signals */ diff --git a/gtk/gtktreeviewcolumn.c b/gtk/gtktreeviewcolumn.c index b57fed1903..957c8b793b 100644 --- a/gtk/gtktreeviewcolumn.c +++ b/gtk/gtktreeviewcolumn.c @@ -1905,9 +1905,10 @@ gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column, * gtk_tree_view_column_get_title: * @tree_column: A #GtkTreeViewColumn. * - * Returns the title of the widget. This value should not be modified. + * Returns the title of the widget. * - * Return value: the title of the column. + * Return value: the title of the column. This string should not be + * modified or freed. **/ G_CONST_RETURN gchar * gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column) diff --git a/gtk/gtkviewport.c b/gtk/gtkviewport.c index 7aaf5593e4..1a41d758a3 100644 --- a/gtk/gtkviewport.c +++ b/gtk/gtkviewport.c @@ -130,7 +130,7 @@ gtk_viewport_class_init (GtkViewportClass *class) PROP_HADJUSTMENT, g_param_spec_object ("hadjustment", _("Horizontal adjustment"), - _("The GtkAdjustment that determines the values of the horizontal position for this viewport."), + _("The GtkAdjustment that determines the values of the horizontal position for this viewport"), GTK_TYPE_ADJUSTMENT, G_PARAM_READWRITE)); @@ -138,7 +138,7 @@ gtk_viewport_class_init (GtkViewportClass *class) PROP_VADJUSTMENT, g_param_spec_object ("vadjustment", _("Vertical adjustment"), - _("The GtkAdjustment that determines the values of the vertical position for this viewport."), + _("The GtkAdjustment that determines the values of the vertical position for this viewport"), GTK_TYPE_ADJUSTMENT, G_PARAM_READWRITE)); @@ -146,7 +146,7 @@ gtk_viewport_class_init (GtkViewportClass *class) PROP_SHADOW_TYPE, g_param_spec_enum ("shadow_type", _("Shadow type"), - _("Determines how the shadowed box around the viewport is drawn."), + _("Determines how the shadowed box around the viewport is drawn"), GTK_TYPE_SHADOW_TYPE, GTK_SHADOW_IN, G_PARAM_READWRITE)); diff --git a/gtk/gtkwidget.c b/gtk/gtkwidget.c index f48ddab268..f971937dde 100644 --- a/gtk/gtkwidget.c +++ b/gtk/gtkwidget.c @@ -397,7 +397,7 @@ gtk_widget_class_init (GtkWidgetClass *klass) PROP_PARENT, g_param_spec_object ("parent", _("Parent widget"), - _("The parent widget of this widget. Must be a Container widget."), + _("The parent widget of this widget. Must be a Container widget"), GTK_TYPE_CONTAINER, G_PARAM_READWRITE)); @@ -405,7 +405,7 @@ gtk_widget_class_init (GtkWidgetClass *klass) PROP_WIDTH_REQUEST, g_param_spec_int ("width_request", _("Width request"), - _("Override for width request of the widget, or -1 if natural request should be used."), + _("Override for width request of the widget, or -1 if natural request should be used"), -1, G_MAXINT, -1, @@ -414,7 +414,7 @@ gtk_widget_class_init (GtkWidgetClass *klass) PROP_HEIGHT_REQUEST, g_param_spec_int ("height_request", _("Height request"), - _("Override for height request of the widget, or -1 if natural request should be used."), + _("Override for height request of the widget, or -1 if natural request should be used"), -1, G_MAXINT, -1, @@ -479,7 +479,7 @@ gtk_widget_class_init (GtkWidgetClass *klass) PROP_RECEIVES_DEFAULT, g_param_spec_boolean ("receives_default", _("Receives default"), - _("If TRUE, the widget will receive the default action when it is focused."), + _("If TRUE, the widget will receive the default action when it is focused"), FALSE, G_PARAM_READWRITE)); g_object_class_install_property (gobject_class, @@ -493,14 +493,14 @@ gtk_widget_class_init (GtkWidgetClass *klass) PROP_STYLE, g_param_spec_object ("style", _("Style"), - _("The style of the widget, which contains information about how it will look (colors etc)."), + _("The style of the widget, which contains information about how it will look (colors etc)"), GTK_TYPE_STYLE, G_PARAM_READWRITE)); g_object_class_install_property (gobject_class, PROP_EVENTS, g_param_spec_flags ("events", _("Events"), - _("The event mask that decides what kind of GdkEvents this widget gets."), + _("The event mask that decides what kind of GdkEvents this widget gets"), GDK_TYPE_EVENT_MASK, GDK_STRUCTURE_MASK, G_PARAM_READWRITE)); @@ -508,7 +508,7 @@ gtk_widget_class_init (GtkWidgetClass *klass) PROP_EXTENSION_EVENTS, g_param_spec_enum ("extension_events", _("Extension events"), - _("The mask that decides what kind of extension events this widget gets."), + _("The mask that decides what kind of extension events this widget gets"), GDK_TYPE_EXTENSION_MODE, GDK_EXTENSION_EVENTS_NONE, G_PARAM_READWRITE)); @@ -1058,27 +1058,27 @@ gtk_widget_class_init (GtkWidgetClass *klass) gtk_widget_class_install_style_property (klass, g_param_spec_boolean ("interior_focus", _("Interior Focus"), - _("Whether to draw the focus indicator inside widgets."), + _("Whether to draw the focus indicator inside widgets"), TRUE, G_PARAM_READABLE)); gtk_widget_class_install_style_property (klass, g_param_spec_int ("focus-line-width", _("Focus linewidth"), - _("Width, in pixels, of the focus indicator line."), + _("Width, in pixels, of the focus indicator line"), 0, G_MAXINT, 1, G_PARAM_READWRITE)); gtk_widget_class_install_style_property (klass, g_param_spec_string ("focus-line-pattern", _("Focus line dash pattern"), - _("Dash pattern used to draw the focus indicator."), + _("Dash pattern used to draw the focus indicator"), "\1\1", G_PARAM_READWRITE)); gtk_widget_class_install_style_property (klass, g_param_spec_int ("focus-padding", _("Focus padding"), - _("Width, in pixels, between focus indicator and the widget 'box'."), + _("Width, in pixels, between focus indicator and the widget 'box'"), 0, G_MAXINT, 1, G_PARAM_READWRITE)); gtk_widget_class_install_style_property (klass, @@ -1090,7 +1090,7 @@ gtk_widget_class_init (GtkWidgetClass *klass) gtk_widget_class_install_style_property (klass, g_param_spec_boxed ("secondary-cursor-color", _("Secondary cursor color"), - _("Color with which to draw the secondary insertion cursor when editing mixed right-to-left and left-to-right text."), + _("Color with which to draw the secondary insertion cursor when editing mixed right-to-left and left-to-right text"), GDK_TYPE_COLOR, G_PARAM_READABLE)); gtk_widget_class_install_style_property (klass, @@ -3560,11 +3560,11 @@ gtk_widget_set_name (GtkWidget *widget, * gtk_widget_get_name: * @widget: a #GtkWidget * - * Retrieves the name of a widget. The return value should not be - * freed. See gtk_widget_set_name() for the significance of widget - * names. + * Retrieves the name of a widget. See gtk_widget_set_name() for the + * significance of widget names. * - * Return value: name of the widget + * Return value: name of the widget. This string is owned by GTK+ and + * should not be modified or freed **/ G_CONST_RETURN gchar* gtk_widget_get_name (GtkWidget *widget) @@ -4476,7 +4476,11 @@ gtk_widget_create_pango_layout (GtkWidget *widget, * such as #GTK_ICON_SIZE_MENU. @detail should be a string that * identifies the widget or code doing the rendering, so that * theme engines can special-case rendering for that widget or code. - * + * + * The pixels in the returned #GdkPixbuf are shared with the rest of + * the application and should not be modified. The pixbuf should be freed + * after use with g_object_unref(). + * * Return value: a new pixbuf, or %NULL if the stock ID wasn't known **/ GdkPixbuf* diff --git a/gtk/gtkwidget.h b/gtk/gtkwidget.h index 3463c0ab3e..1429f5af6e 100644 --- a/gtk/gtkwidget.h +++ b/gtk/gtkwidget.h @@ -232,20 +232,15 @@ struct _GtkWidgetClass * pointer. */ GtkObjectClass parent_class; + + /*< public >*/ - /* The signal to emit when a widget of this class is activated, - * gtk_widget_activate() handles the emission. - * Implementation of this signal is optional. - */ guint activate_signal; - /* This signal is emitted when a widget of this class is added - * to a scrolling aware parent, gtk_widget_set_scroll_adjustments() - * handles the emission. - * Implementation of this signal is optional. - */ guint set_scroll_adjustments_signal; + /*< private >*/ + /* seldomly overidden */ void (*dispatch_child_properties_changed) (GtkWidget *widget, guint n_pspecs, diff --git a/gtk/gtkwindow.c b/gtk/gtkwindow.c index f0d5abe2aa..8113bbc29e 100644 --- a/gtk/gtkwindow.c +++ b/gtk/gtkwindow.c @@ -427,7 +427,7 @@ gtk_window_class_init (GtkWindowClass *klass) g_param_spec_boolean ("allow_shrink", _("Allow Shrink"), /* xgettext:no-c-format */ - _("If TRUE, the window has no mimimum size. Setting this to TRUE is 99% of the time a bad idea."), + _("If TRUE, the window has no mimimum size. Setting this to TRUE is 99% of the time a bad idea"), FALSE, G_PARAM_READWRITE)); @@ -435,7 +435,7 @@ gtk_window_class_init (GtkWindowClass *klass) PROP_ALLOW_GROW, g_param_spec_boolean ("allow_grow", _("Allow Grow"), - _("If TRUE, users can expand the window beyond its minimum size."), + _("If TRUE, users can expand the window beyond its minimum size"), TRUE, G_PARAM_READWRITE)); @@ -443,7 +443,7 @@ gtk_window_class_init (GtkWindowClass *klass) PROP_RESIZABLE, g_param_spec_boolean ("resizable", _("Resizable"), - _("If TRUE, users can resize the window."), + _("If TRUE, users can resize the window"), TRUE, G_PARAM_READWRITE)); @@ -451,7 +451,7 @@ gtk_window_class_init (GtkWindowClass *klass) PROP_MODAL, g_param_spec_boolean ("modal", _("Modal"), - _("If TRUE, the window is modal (other windows are not usable while this one is up)."), + _("If TRUE, the window is modal (other windows are not usable while this one is up)"), FALSE, G_PARAM_READWRITE)); @@ -459,7 +459,7 @@ gtk_window_class_init (GtkWindowClass *klass) PROP_WIN_POS, g_param_spec_enum ("window_position", _("Window Position"), - _("The initial position of the window."), + _("The initial position of the window"), GTK_TYPE_WINDOW_POSITION, GTK_WIN_POS_NONE, G_PARAM_READWRITE)); @@ -468,7 +468,7 @@ gtk_window_class_init (GtkWindowClass *klass) PROP_DEFAULT_WIDTH, g_param_spec_int ("default_width", _("Default Width"), - _("The default width of the window, used when initially showing the window."), + _("The default width of the window, used when initially showing the window"), -1, G_MAXINT, -1, @@ -478,7 +478,7 @@ gtk_window_class_init (GtkWindowClass *klass) PROP_DEFAULT_HEIGHT, g_param_spec_int ("default_height", _("Default Height"), - _("The default height of the window, used when initially showing the window."), + _("The default height of the window, used when initially showing the window"), -1, G_MAXINT, -1, @@ -504,7 +504,7 @@ gtk_window_class_init (GtkWindowClass *klass) PROP_SCREEN, g_param_spec_object ("screen", _("Screen"), - _("The screen where this window will be displayed."), + _("The screen where this window will be displayed"), GDK_TYPE_SCREEN, G_PARAM_READWRITE)); |