gtk.CellRendererText

gtk.CellRendererText
Prev	Chapter 4. The gtk Class Reference	Next

Name

gtk.CellRendererText — an object that renders text into a gtk.TreeView cell

Synopsis

class gtk.CellRendererText(gtk.CellRenderer):
    gtk.CellRendererText()
    def set_fixed_height_from_font(number_of_rows)

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.CellRenderer
      +-- gtk.CellRendererText

Properties

"text"	Read/Write	Text to render
"markup"	Read/Write	Marked up text to render
"attributes"	Read/Write	A list of style attributes to apply to the text of the renderer.
"background"	Write	Background color as a string
"foreground"	Write	Foreground color as a string
"background-gdk"	Read/Write	Background color as a gtk.gdk.Color
"foreground-gdk"	Read/Write	Foreground color as a gtk.gdk.Color
"font"	Read/Write	Font description as a string
"font-desc"	Read/Write	Font description as a pango.FontDescription
"family"	Read/Write	Name of the font family, e.g. Sans, Helvetica, Times, Monospace
"style"	Read/Write	Font style
"variant"	Read/Write	Font variant
"weight"	Read/Write	Font weight
"stretch"	Read/Write	Font stretch
"size"	Read/Write	Font size
"size-points"	Read/Write	Font size in points
"scale"	Read/Write	Font scaling factor
"editable"	Read/Write	If `TRUE` the text can be modified by the user
"strikethrough"	Read/Write	If `TRUE` strike through the text
"underline"	Read/Write	Style of underline for this text
"rise"	Read/Write	Offset of text above the baseline (below the baseline if rise is negative)
"language"	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 don't understand this parameter, you probably don't need it. GTK+ 2.4 and above.
"single-paragraph-mode"	Read/Write	If `TRUE`, keep all text in a single paragraph. GTK+ 2.4 and above.
"background-set"	Read/Write	If `TRUE` this tag affects the background color
"foreground-set"	Read/Write	If `TRUE` this tag affects the foreground color
"family-set"	Read/Write	If `TRUE` this tag affects the font family
"style-set"	Read/Write	If `TRUE` this tag affects the font style
"variant-set"	Read/Write	If `TRUE` this tag affects the font variant
"weight-set"	Read/Write	If `TRUE` this tag affects the font weight
"stretch-set"	Read/Write	If `TRUE` this tag affects the font stretch
"size-set"	Read/Write	If `TRUE` this tag affects the font size
"scale-set"	Read/Write	If `TRUE` this tag scales the font
"editable-set"	Read/Write	If `TRUE` this tag affects the text editability
"strikethrough-set"	Read/Write	If `TRUE` this tag affects the strikethrough
"underline-set"	Read/Write	If `TRUE` this tag affects the text underlining
"rise-set"	Read/Write	If `TRUE` this tag affects the rise
"language-set"	Read/Write	If `TRUE` this tag affects the language used to render the text. GTK+ 2.4 and above.

Signal Prototypes

"edited" def callback(cellrenderertext, path, new_text, user_param1, ...)

Description

The gtk.CellRendererText manages the rendering of text into a gtk.TreeView cell.

Constructor

    gtk.CellRendererText()

Returns :

the new cell renderer

Creates a new gtk.CellRendererText. The way that text is drawn is changed using object properties. The object properties can be set globally (with set_property()). Also, with gtk.TreeViewColumn, you can bind a property to a value in a gtk.TreeModel. For example, you can bind the "text" property on the cell renderer to a string value in the model, thus rendering a different string in each row of the gtk.TreeView.

Methods

gtk.CellRendererText.set_fixed_height_from_font

    def set_fixed_height_from_font(number_of_rows)

number_of_rows : Number of rows of text each cell renderer is allocated, or -1

The set_fixed_height_from_font() sets the height of a renderer to explicitly be determined by the "font" and "ypad" properties set on it. This method must be called each time these properties are changed to affect the height. This function is inflexible, and should really only be used if calculating the size of a cell is too slow (i.e. a massive number of cells displayed). If number_of_rows is -1, then the fixed height is unset, and the height is determined by the properties again.

Signals

The "edited" gtk.CellRendererText Signal

    def callback(cellrenderertext, path, new_text, user_param1, ...)

`cellrenderertext` :	the cellrenderertext that received the "edited" signal
`path` :	the path string of the cellrenderertext
`new_text` :	the new text of the cellrenderertext
`user_param1` :	the first user parameter (if any) specified with the `connect`() method
`...` :	additional user parameters (if any)

The "edited" signal is emitted when the text in the cell has been edited.

Prev	Up	Next
gtk.CellRendererPixbuf	Home	gtk.CellRendererToggle