|
Graphics.UI.Gtk.ModelView.CellRendererText | Portability | portable (depends on GHC) | Stability | provisional | Maintainer | gtk2hs-users@lists.sourceforge.net |
|
|
|
|
|
Description |
A CellRenderer which displays a single-line text.
|
|
Synopsis |
|
|
|
|
Detail
|
|
A CellRendererText renders a given text in its cell, using the font,
color and style information provided by its attributes. The text will be
ellipsized if it is too long and the ellipsize property allows it.
If the cellMode is CellRendererModeEditable, the CellRendererText
allows the user to edit its text using an Entry widget.
|
|
Class Hierarchy
|
|
| GObject
| +----Object
| +----CellRenderer
| +----CellRendererText
| +----CellRendererCombo
|
|
Types
|
|
|
|
|
|
|
|
|
|
|
|
|
Constructors
|
|
|
Create a new CellRendererText object.
|
|
Methods
|
|
cellRendererTextSetFixedHeightFromFont | Source |
|
:: CellRendererTextClass self | | => self | numberOfRows - Number of rows of text each cell renderer is
allocated, or -1
| -> Int | | -> IO () | | Sets the height of a renderer to explicitly be determined by the
cellTextFont and Graphics.UI.Gtk.ModelView.CellRenderer.cellYPad
attribute set on it. Further changes in these properties do not affect the
height, so they must be accompanied by a subsequent call to this function.
Using this function is unflexible, and should really only be used if
calculating the size of a cell is too slow (ie, a massive number of cells
displayed). If numberOfRows is -1, then the fixed height is unset, and
the height is determined by the properties again.
|
|
|
Attributes
|
|
|
Define the attribute that specifies the text to be rendered. See
also cellTextMarkup.
|
|
|
Define a markup string instead of a text. See cellText.
|
|
|
Whether or not to keep all text in a single paragraph.
Default value: False
|
|
|
Text background color as a string.
Default value: ""
|
|
|
Text background color as a Color.
|
|
|
Whether the 'cellTextBackground'\/'cellTextBackgroundColor' attribute is set.
Default value: False
|
|
|
Text foreground color as a string.
Default value: ""
|
|
|
Text foreground color as a Color.
|
|
|
Whether the 'cellTextForeground'\/'cellTextForegroundColor' attribute is set.
Default value: False
|
|
|
Whether the text can be modified by the user.
|
|
|
Whether the cellTextEditable flag affects text editability.
|
|
|
Font description as a string.
|
|
|
Font description as a Graphics.Rendering.Pango.FontDescription.
|
|
|
Name of the font family, e.g. Sans, Helvetica, Times, Monospace.
|
|
|
Determines if cellTextFamily has an effect.
|
|
|
Font style (e.g. normal or italics).
|
|
|
Whether the cellTextStyle tag is used, default is False.
|
|
|
Font variant (e.g. small caps).
|
|
|
Whether the cellTextVariant tag is used, default is False.
|
|
|
Font weight, default: 400.
|
|
|
Whether the cellTextWeight tag is used, default is False.
|
|
|
Font stretch.
|
|
|
Whether the cellTextStretch tag is used, default is False.
|
|
|
Font size in points.
|
|
|
Font size in points.
Allowed values: >= 0
Default value: 0
|
|
|
Whether the cellTextSize tag is used, default is False.
|
|
|
Font scaling factor. Default is 1.
|
|
|
Whether the cellTextScale tag is used, default is False.
|
|
|
Offset of text above the baseline (below the baseline if rise is
negative).
Allowed values: >= -2147483647
Default value: 0
|
|
|
Whether the cellTextRise tag is used, default is False.
|
|
|
Whether to strike through the text.
|
|
|
Whether the cellTextStrikethrough tag is used, default is False.
|
|
|
Style of underline for this text.
|
|
|
Whether the cellTextUnderline tag is used, default is False.
|
|
|
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.
|
|
|
Whether the cellTextLanguage tag is used, default is False.
|
|
|
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 EllipsizeNone turns off
ellipsizing. See the cellTextWrapWidth property for another way of
making the text fit into a given width.
- Available in Gtk 2.6 or higher.
|
|
|
Whether the cellTextEllipsize tag affects the ellipsize mode.
- Available in Gtk 2.6 or higher.
|
|
|
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.
- Available in Gtk 2.6 or higher.
|
|
|
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 cellTextWrapWidth property is set.
- Available in Gtk 2.8 or higher.
|
|
|
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.
- Available in Gtk 2.8 or higher.
|
|
|
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
Graphics.UI.Gtk.ModelView.CellRenderer.cellXAlign property of
CellRenderer, on the other hand, sets the horizontal alignment of the
whole text.
Default value: Graphics.Rendering.Pango.Layout.AlignLeft
- Available since Gtk+ version 2.10
|
|
Signals
|
|
|
Emitted when the user finished editing a cell.
Whenever editing is finished successfully, this signal is emitted which
indicates that the model should be updated with the supplied value.
The value is always a string which matches the cellText attribute of
CellRendererText (and its derivates like CellRendererCombo).
- This signal is not emitted when editing is disabled (see
cellTextEditable) or when the user aborts editing.
|
|
Deprecated
|
|
|
|
|
|
Produced by Haddock version 2.6.0 |