6.4.14 cell-renderer-text

Superclass: cell-renderer

Subclasses: cell-renderer-spin cell-renderer-combo cell-renderer-accel

A cell-renderer-text 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 cell-renderer-text-ellipsize property allows it.

Slots:

• align-set. Type: boolean. Accessor: cell-renderer-text-align-set.

  Whether this tag affects the alignment mode.

  Default value: FALSE

• alignment. Type: PangoAlignment. Accessor: cell-renderer-text-alignment.

  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 cell-renderer, on the other hand, sets the horizontal alignment of the whole text.

  Default value: PANGO_ALIGN_LEFT

• attributes. Type: PangoAttrList. Accessor: cell-renderer-text-attributes.

  A list of style attributes to apply to the text of the renderer.

• background. Type: string. Accessor: cell-renderer-text-background. Write-only.

  Background color as a string.

  Default value: NIL

• background-gdk. Type: color. Accessor: cell-renderer-text-background-gdk.

  Background color as a color

• background-set. Type: boolean. Accessor: cell-renderer-text-background-set.

  Whether this tag affects the background color.

  Default value: FALSE

• editable. Type: boolean. Accessor: cell-renderer-text-editable.

  Whether the text can be modified by the user.

  Default value: FALSE

• editable-set. Type: boolean. Accessor: cell-renderer-text-editable-set.

  Whether this tag affects text editability.

  Default value: FALSE

• ellipsize. Type: PangoEllipsizeMode. Accessor: cell-renderer-text-ellipsize.

  Specifies the preferred place to ellipsize the string, if the cell renderer does not have enough room to display the entire string. Setting it to PANGO_ELLIPSIZE_NONE turns off ellipsizing. See the wrap-width property for another way of making the text fit into a given width.

  Default value: PANGO_ELLIPSIZE_NONE

• ellipsize-set. Type: boolean. Accessor: cell-renderer-text-ellipsize-set.

  Whether this tag affects the ellipsize mode.

  Default value: FALSE

• family. Type: string. Accessor: cell-renderer-text-family.

  Name of the font family, e.g. Sans, Helvetica, Times, Monospace.

  Default value: NIL

• family-set. Type: boolean. Accessor: cell-renderer-text-family-set.

  Whether this tag affects the font family.

  Default value: FALSE

• font. Type: string. Accessor: cell-renderer-text-font.

  Font description as a string, e.g. "Sans Italic 12".

  Default value: NULL

• font-desc. Type: PangoFontDescription. Accessor: cell-renderer-text-font-desc.

  Font description as a PangoFontDescription struct.

• foreground. Type: string. Accessor: cell-renderer-text-foreground. Write-only.

  Foreground color as a string.

  Default value: NULL

• foreground-gdk. Type: color. Accessor: cell-renderer-text-foreground-gdk.

  Foreground color as a color.

• foreground-set. Type: boolean. Accessor: cell-renderer-text-foreground-set.

  Whether this tag affects the foreground color.

  Default value: FALSE

• language. Type: string. Accessor: cell-renderer-text-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.

  Default value: NULL

• language-set. Type: boolean. Accessor: cell-renderer-text-language-set.

  Whether this tag affects the language the text is rendered as.

  Default value: FALSE

• markup. Type: string. Accessor: cell-renderer-text-markup. Write-only.

  Marked up text to render.

  Default value: NULL

• rise. Type: integer. Accessor: cell-renderer-text-rise.

  Offset of text above the baseline (below the baseline if rise is negative).

  Allowed values: >= -2147483647

  Default value: 0

• rise-set. Type: boolean. Accessor: cell-renderer-text-rise-set.

  Whether this tag affects the rise.

  Default value: FALSE

• scale. Type: double-float. Accessor: cell-renderer-text-scale.

  Font scaling factor.

  Allowed values: >= 0

  Default value: 1

• scale-set. Type: boolean. Accessor: cell-renderer-text-scale-set.

  Whether this tag scales the font size by a factor.

  Default value: FALSE

• single-paragraph-mode. Type: boolean. Accessor: cell-renderer-text-single-paragraph-mode.

  Whether or not to keep all text in a single paragraph.

  Default value: FALSE

• size. Type: integer. Accessor: cell-renderer-text-size.

  Font size.

  Allowed values: >= 0

  Default value: 0

• size-points. Type: double-float. Accessor: cell-renderer-text-size-points.

  Font size in points.

  Allowed values: >= 0

  Default value: 0

• size-set. Type: boolean. Accessor: cell-renderer-text-size-set.

  Whether this tag affects the font size.

  Default value: FALSE

• stretch. Type: PangoStretch. Accessor: cell-renderer-text-stretch.

  Font stretch.

  Default value: PANGO_STRETCH_NORMAL

• stretch-set. Type: boolean. Accessor: cell-renderer-text-stretch-set.

  Whether this tag affects the font stretch.

  Default value: FALSE

• strikethrough. Type: boolean. Accessor: cell-renderer-text-strikethrough.

  Whether to strike through the text.

  Default value: FALSE

• strikethrough-set. Type: boolean. Accessor: cell-renderer-text-strikethrough-set.

  Whether this tag affects strikethrough.

  Default value: FALSE

• style. Type: PangoStyle. Accessor: cell-renderer-text-style.

  Font style.

  Default value: PANGO_STYLE_NORMAL

• style-set. Type: boolean. Accessor: cell-renderer-text-style-set.

  Whether this tag affects the font style.

  Default value: FALSE

• text. Type: string. Accessor: cell-renderer-text-text.

  Text to render.

  Default value: NIL

• underline. Type: PangoUnderline. Accessor: cell-renderer-text-underline.

  Style of underline for this text.

  Default value: PANGO_UNDERLINE_NONE

• underline-set. Type: boolean. Accessor: cell-renderer-text-underline-set.

  Whether this tag affects underlining.

  Default value: FALSE

• variant. Type: PangoVariant. Accessor: cell-renderer-text-variant.

  Font variant.

  Default value: PANGO_VARIANT_NORMAL

• variant-set. Type: boolean. Accessor: cell-renderer-text-variant-set.

  Whether this tag affects the font variant.

  Default value: FALSE

• weight. Type: integer. Accessor: cell-renderer-text-weight.

  Font weight.

  Allowed values: >= 0

  Default value: 400

• weight-set. Type: boolean. Accessor: cell-renderer-text-weight-set.

  Whether this tag affects the font weight.

  Default value: FALSE

• width-chars. Type: integer. Accessor: cell-renderer-text-width-chars.

  The desired width of the cell, in characters. If this property is set to -1, the width will be calculated automatically, otherwise the cell will request either 3 characters or the property value, whichever is greater.

  Default value: -1

• wrap-mode. Type: PangoWrapMode. Accessor: cell-renderer-text-wrap-mode.

  Specifies how to break the string into multiple lines, if the cell renderer does not have enough room to display the entire string. This property has no effect unless the wrap-width property is set.

  Default value: PANGO_WRAP_CHAR

• wrap-width. Type: integer. Accessor: cell-renderer-text-wrap-width.

  Specifies the width at which the text is wrapped. The wrap-mode property can be used to influence at what character positions the line breaks can be placed. Setting wrap-width to -1 turns wrapping off.

  Default value: -1

Signals:

• "edited". Signature: (instance cell-renderer-text), (path string), (new-text string) => void. Options: run-last.

  This signal is emitted after renderer has been edited.

  It is the responsibility of the application to update the model and store new-text at the position indicated by path.