Class gtk-cell-renderer-text

Package: gtk

Superclasses

gtk-cell-renderer, g-object, common-lisp:standard-object, common-lisp:t

Documented Subclasses

gtk-cell-renderer-accel, gtk-cell-renderer-combo, gtk-cell-renderer-spin

Direct Slots

align-set

The align-set property of type :boolean (Read / Write)
Whether this tag affects the alignment mode.
Default value: false

alignment

The alignment property of type pango-alignment (Read / Write)
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 gtk-cell-renderer, on the other hand, sets the horizontal alignment of the whole text.
Default value: :left

attributes

The attributes property of type pango-attr-list (Read / Write)
A list of style attributes to apply to the text of the renderer.

background

The background property of type :string (Write)
Background color as a string.
Default value: nil

background-gdk

The background-gdk property of type gdk-color (Read / Write)
Background color.
Warning: The background-gdk property has been deprecated since version 3.4 and should not be used in newly written code. Use the background-rgba property instead.

background-rgba

The background-rgba property of type gdk-rgba (Read / Write)
Background color.

background-set

The background-set property of type :boolean (Read / Write)
Whether this tag affects the background color.
Default value: false

editable

The editable property of type :boolean (Read / Write)
Whether the text can be modified by the user.
Default value: false

editable-set

The editable-set property of type :boolean (Read / Write)
Whether this tag affects text editability.
Default value: false

ellipsize

The ellipsize property of type pango-ellipsize-mode (Read / Write)
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 :none turns off ellipsizing. See the wrap-width property for another way of making the text fit into a given width.
Default value: :none

ellipsize-set

The ellipsize-set property of type :boolean (Read / Write)
Whether this tag affects the ellipsize mode.
Default value: false

family

The family property of type :string (Read / Write)
Name of the font family, e.g. Sans, Helvetica, Times, Monospace.
Default value: nil

family-set

The family-set property of type :boolean (Read / Write)
Whether this tag affects the font family.
Default value: false

font

The font property of type :string (Read / Write)
Font description as a string, e.g. "Sans Italic 12".
Default value: nil

font-desc

The font-desc property of type pango-font-description (Read / Write)
A Pango font description.

foreground

The foreground property of type :string (Write)
Foreground color as a string.
Default value: nil

foreground-gdk

The foreground-gdk property of type gdk-color (Read / Write)
Foreground color.
Warning: The foreground-gdk property has been deprecated since version 3.4 and should not be used in newly written code. Use the foreground-rgba property instead.

foreground-rgba

The foreground-rgba property of type gdk-rgba (Read / Write)
Foreground color.

foreground-set

The foreground-set property of type :boolean (Read / Write)
Whether this tag affects the foreground color.
Default value: false

language

The language property of type :string (Read / Write)
The language this text is in, as an ISO code. Pango can use this as a hint when rendering the text. If you do not understand this parameter, you probably do not need it.
Default value: nil

language-set

The language-set property of type :boolean (Read / Write)
Whether this tag affects the language the text is rendered as.
Default value: false

markup

The markup property of type :string (Write)
Marked up text to render.
Default value: nil

max-width-chars

The max-width-chars property of type :int (Read / Write)
The desired maximum width of the cell, in characters. If this property is set to -1, the width will be calculated automatically. 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 gtk-cell-layout and all of the cell's siblings have received their natural width.
Allowed values: >= -1
Default value: -1

placeholder-text

The placeholder-text property of type :string (Read / Write)
The text that will be displayed in the gtk-cell-renderer if editable is true and the cell is empty.
Default value: nil

rise

The rise property of type :int (Read / Write)
Offset of text above the baseline, below the baseline if rise is negative.
Allowed values: >= -2147483647
Default value: 0

rise-set

The rise-set property of type :boolean (Read / Write)
Whether this tag affects the rise.
Default value: false

scale

The scale property of type :double (Read / Write)
Font scaling factor.
Allowed values: >= 0
Default value: 1

scale-set

The scale-set property of type :boolean (Read / Write)
Whether this tag scales the font size by a factor.
Default value: false

single-paragraph-mode

The single-paragraph-mode property of type :boolean (Read / Write)
Whether to keep all text in a single paragraph.
Default value: false

size

The size property of type :int (Read / Write)
Font size.
Allowed values: >= 0
Default value: 0

size-points

The size-points property of type :double (Read / Write)
Font size in points.
Allowed values: >= 0
Default value: 0

size-set

The size-set property of type :boolean (Read / Write)
Whether this tag affects the font size.
Default value: false

stretch

The stretch property of type pango-stretch (Read / Write)
Font stretch.
Default value: :normal

stretch-set

The stretch-set property of type :boolean (Read / Write)
Whether this tag affects the font stretch.
Default value: false

strikethrough

The strikethrough property :boolean (Read / Write)
Whether to strike through the text.
Default value: false

strikethrough-set

The strikethrough-set property of type :boolean (Read / Write)
Whether this tag affects strikethrough.
Default value: false

style

The style property of type pango-style (Read / Write)
Font style.
Default value: :normal

style-set

The style-set property of type :boolean (Read / Write)
Whether this tag affects the font style.
Default value: false

text

The text property of type :string (Read / Write)
Text to render.
Default value: nil

underline

The underline property of type pango-underline (Read / Write)
Style of underline for this text.
Default value: :none

underline-set

The underline-set property of type :boolean (Read / Write)
Whether this tag affects underlining.
Default value: false

variant

The variant property of type pango-variant (Read / Write)
Font variant.
Default value: :normal

variant-set

The variant-set property of type :boolean (Read / Write)
Whether this tag affects the font variant.
Default value: false

weight

The weight property of type :int (Read / Write)
Font weight.
Allowed values: >= 0
Default value: 400

weight-set

The weight-set property of type :boolean (Read / Write)
Whether this tag affects the font weight.
Default value: false

width-chars

The width-chars property of type :int (Read / Write)
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.
Allowed values: >= -1
Default value: -1

wrap-mode

The wrap-mode property of type pango-wrap-mode (Read / Write)
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: :char

wrap-width

The wrap-width property of type :int (Read / Write)
Specifies the minimum 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.
Allowed values: >= -1
Default value: -1

Details

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

If the mode property is :editable, the gtk-cell-renderer-text allows to edit its text using a gtk-entry widget.

Signal Details

The "edited" signal

 lambda (renderer path text)    :run-last

The signal is emitted after renderer has been edited. It is the responsibility of the application to update the model and store text at the position indicated by path.

renderer: The gtk-cell-renderer-text object which received the signal.
path: A string with the path identifying the edited cell.
text: A string with the new text.