CellRendererText

Renders text in a cell

A gtk.cell_renderer_text.CellRendererText 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 GtkCellRendererText:ellipsize property allows it.

If the GtkCellRenderer:mode is gtk.types.CellRendererMode.Editable, the gtk.cell_renderer_text.CellRendererText allows to edit its text using an entry.

More...
class CellRendererText : CellRenderer {}

Constructors

this
this(void* ptr, Flag!"Take" take)
this
this()

Creates a new gtk.cell_renderer_text.CellRendererText. Adjust how text is drawn using object properties. Object properties can be set globally (with gobject.object.ObjectWrap.set). Also, with gtk.tree_view_column.TreeViewColumn, you can bind a property to a value in a gtk.tree_model.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.tree_view.TreeView.

Members

Functions

connectEdited
ulong connectEdited(T callback, Flag!"After" after)

Connect to Edited signal.

self
CellRendererText self()

Returns this, for use in with statements.

setFixedHeightFromFont
void setFixedHeightFromFont(int numberOfRows)

Sets the height of a renderer to explicitly be determined by the “font” and “y_pad” property 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 inflexible, and should really only be used if calculating the size of a cell is too slow (ie, 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.

Properties

alignSet
bool alignSet [@property getter]
alignSet
bool alignSet [@property setter]
alignment
pango.types.Alignment alignment [@property getter]

Get alignment property.

alignment
pango.types.Alignment alignment [@property setter]

Set alignment property.

attributes
pango.attr_list.AttrList attributes [@property getter]
attributes
pango.attr_list.AttrList attributes [@property setter]
background
string background [@property setter]
backgroundRgba
gdk.rgba.RGBA backgroundRgba [@property getter]

Get backgroundRgba property.

backgroundRgba
gdk.rgba.RGBA backgroundRgba [@property setter]

Set backgroundRgba property.

backgroundSet
bool backgroundSet [@property getter]
backgroundSet
bool backgroundSet [@property setter]
editable
bool editable [@property getter]
editable
bool editable [@property setter]
editableSet
bool editableSet [@property getter]
editableSet
bool editableSet [@property setter]
ellipsize
pango.types.EllipsizeMode ellipsize [@property getter]

Get ellipsize property.

ellipsize
pango.types.EllipsizeMode ellipsize [@property setter]

Set ellipsize property.

ellipsizeSet
bool ellipsizeSet [@property getter]
ellipsizeSet
bool ellipsizeSet [@property setter]
family
string family [@property getter]
family
string family [@property setter]
familySet
bool familySet [@property getter]
familySet
bool familySet [@property setter]
font
string font [@property getter]
font
string font [@property setter]
fontDesc
pango.font_description.FontDescription fontDesc [@property getter]
fontDesc
pango.font_description.FontDescription fontDesc [@property setter]
foreground
string foreground [@property setter]
foregroundRgba
gdk.rgba.RGBA foregroundRgba [@property getter]

Get foregroundRgba property.

foregroundRgba
gdk.rgba.RGBA foregroundRgba [@property setter]

Set foregroundRgba property.

foregroundSet
bool foregroundSet [@property getter]
foregroundSet
bool foregroundSet [@property setter]
gType
GType gType [@property getter]
language
string language [@property getter]
language
string language [@property setter]
languageSet
bool languageSet [@property getter]
languageSet
bool languageSet [@property setter]
markup
string markup [@property setter]
maxWidthChars
int maxWidthChars [@property getter]

Get maxWidthChars property.

maxWidthChars
int maxWidthChars [@property setter]

Set maxWidthChars property.

placeholderText
string placeholderText [@property getter]

Get placeholderText property.

placeholderText
string placeholderText [@property setter]

Set placeholderText property.

rise
int rise [@property getter]
rise
int rise [@property setter]
riseSet
bool riseSet [@property getter]
riseSet
bool riseSet [@property setter]
scale
double scale [@property getter]
scale
double scale [@property setter]
scaleSet
bool scaleSet [@property getter]
scaleSet
bool scaleSet [@property setter]
singleParagraphMode
bool singleParagraphMode [@property getter]
singleParagraphMode
bool singleParagraphMode [@property setter]
size
int size [@property getter]
size
int size [@property setter]
sizePoints
double sizePoints [@property getter]
sizePoints
double sizePoints [@property setter]
sizeSet
bool sizeSet [@property getter]
sizeSet
bool sizeSet [@property setter]
stretch
pango.types.Stretch stretch [@property getter]
stretch
pango.types.Stretch stretch [@property setter]
stretchSet
bool stretchSet [@property getter]
stretchSet
bool stretchSet [@property setter]
strikethrough
bool strikethrough [@property getter]
strikethrough
bool strikethrough [@property setter]
strikethroughSet
bool strikethroughSet [@property getter]
strikethroughSet
bool strikethroughSet [@property setter]
style
pango.types.Style style [@property getter]
style
pango.types.Style style [@property setter]
styleSet
bool styleSet [@property getter]
styleSet
bool styleSet [@property setter]
text
string text [@property getter]
text
string text [@property setter]
underline
pango.types.Underline underline [@property getter]
underline
pango.types.Underline underline [@property setter]
underlineSet
bool underlineSet [@property getter]
underlineSet
bool underlineSet [@property setter]
variant
pango.types.Variant variant [@property getter]
variant
pango.types.Variant variant [@property setter]
variantSet
bool variantSet [@property getter]
variantSet
bool variantSet [@property setter]
weight
int weight [@property getter]
weight
int weight [@property setter]
weightSet
bool weightSet [@property getter]
weightSet
bool weightSet [@property setter]
widthChars
int widthChars [@property getter]

Get widthChars property.

widthChars
int widthChars [@property setter]

Set widthChars property.

wrapMode
pango.types.WrapMode wrapMode [@property getter]

Get wrapMode property.

wrapMode
pango.types.WrapMode wrapMode [@property setter]

Set wrapMode property.

wrapWidth
int wrapWidth [@property getter]

Get wrapWidth property.

wrapWidth
int wrapWidth [@property setter]

Set wrapWidth property.

Static functions

getGType
GType getGType()

Inherited Members

From CellRenderer

getGType
GType getGType()
gType
GType gType [@property getter]
self
CellRenderer self()

Returns this, for use in with statements.

cellBackground
string cellBackground [@property setter]
cellBackgroundRgba
gdk.rgba.RGBA cellBackgroundRgba [@property getter]

Get cellBackgroundRgba property.

cellBackgroundRgba
gdk.rgba.RGBA cellBackgroundRgba [@property setter]

Set cellBackgroundRgba property.

cellBackgroundSet
bool cellBackgroundSet [@property getter]
cellBackgroundSet
bool cellBackgroundSet [@property setter]
editing
bool editing [@property getter]
height
int height [@property getter]
height
int height [@property setter]
isExpanded
bool isExpanded [@property getter]
isExpanded
bool isExpanded [@property setter]
isExpander
bool isExpander [@property getter]
isExpander
bool isExpander [@property setter]
mode
gtk.types.CellRendererMode mode [@property getter]
mode
gtk.types.CellRendererMode mode [@property setter]
sensitive
bool sensitive [@property getter]
sensitive
bool sensitive [@property setter]
visible
bool visible [@property getter]
visible
bool visible [@property setter]
width
int width [@property getter]
width
int width [@property setter]
xalign
float xalign [@property getter]
xalign
float xalign [@property setter]
xpad
uint xpad [@property getter]
xpad
uint xpad [@property setter]
yalign
float yalign [@property getter]
yalign
float yalign [@property setter]
ypad
uint ypad [@property getter]
ypad
uint ypad [@property setter]
activate
bool activate(gdk.event.Event event, gtk.widget.Widget widget, string path, gdk.rectangle.Rectangle backgroundArea, gdk.rectangle.Rectangle cellArea, gtk.types.CellRendererState flags)

Passes an activate event to the cell renderer for possible processing. Some cell renderers may use events; for example, gtk.cell_renderer_toggle.CellRendererToggle toggles when it gets a mouse click.

getAlignedArea
void getAlignedArea(gtk.widget.Widget widget, gtk.types.CellRendererState flags, gdk.rectangle.Rectangle cellArea, gdk.rectangle.Rectangle alignedArea)

Gets the aligned area used by cell inside cell_area. Used for finding the appropriate edit and focus rectangle.

getAlignment
void getAlignment(float xalign, float yalign)

Fills in xalign and yalign with the appropriate values of cell.

getFixedSize
void getFixedSize(int width, int height)

Fills in width and height with the appropriate size of cell.

getIsExpanded
bool getIsExpanded()

Checks whether the given gtk.cell_renderer.CellRenderer is expanded.

getIsExpander
bool getIsExpander()

Checks whether the given gtk.cell_renderer.CellRenderer is an expander.

getPadding
void getPadding(int xpad, int ypad)

Fills in xpad and ypad with the appropriate values of cell.

getPreferredHeight
void getPreferredHeight(gtk.widget.Widget widget, int minimumSize, int naturalSize)

Retrieves a renderer’s natural size when rendered to widget.

getPreferredHeightForWidth
void getPreferredHeightForWidth(gtk.widget.Widget widget, int width, int minimumHeight, int naturalHeight)

Retrieves a cell renderers’s minimum and natural height if it were rendered to widget with the specified width.

getPreferredSize
void getPreferredSize(gtk.widget.Widget widget, gtk.requisition.Requisition minimumSize, gtk.requisition.Requisition naturalSize)

Retrieves the minimum and natural size of a cell taking into account the widget’s preference for height-for-width management.

getPreferredWidth
void getPreferredWidth(gtk.widget.Widget widget, int minimumSize, int naturalSize)

Retrieves a renderer’s natural size when rendered to widget.

getPreferredWidthForHeight
void getPreferredWidthForHeight(gtk.widget.Widget widget, int height, int minimumWidth, int naturalWidth)

Retrieves a cell renderers’s minimum and natural width if it were rendered to widget with the specified height.

getRequestMode
gtk.types.SizeRequestMode getRequestMode()

Gets whether the cell renderer prefers a height-for-width layout or a width-for-height layout.

getSensitive
bool getSensitive()

Returns the cell renderer’s sensitivity.

getState
gtk.types.StateFlags getState(gtk.widget.Widget widget, gtk.types.CellRendererState cellState)

Translates the cell renderer state to gtk.types.StateFlags, based on the cell renderer and widget sensitivity, and the given gtk.cell_renderer.CellRendererState.

getVisible
bool getVisible()

Returns the cell renderer’s visibility.

isActivatable
bool isActivatable()

Checks whether the cell renderer can do something when activated.

setAlignment
void setAlignment(float xalign, float yalign)

Sets the renderer’s alignment within its available space.

setFixedSize
void setFixedSize(int width, int height)

Sets the renderer size to be explicit, independent of the properties set.

setIsExpanded
void setIsExpanded(bool isExpanded)

Sets whether the given gtk.cell_renderer.CellRenderer is expanded.

setIsExpander
void setIsExpander(bool isExpander)

Sets whether the given gtk.cell_renderer.CellRenderer is an expander.

setPadding
void setPadding(int xpad, int ypad)

Sets the renderer’s padding.

setSensitive
void setSensitive(bool sensitive)

Sets the cell renderer’s sensitivity.

setVisible
void setVisible(bool visible)

Sets the cell renderer’s visibility.

snapshot
void snapshot(gtk.snapshot.Snapshot snapshot, gtk.widget.Widget widget, gdk.rectangle.Rectangle backgroundArea, gdk.rectangle.Rectangle cellArea, gtk.types.CellRendererState flags)

Invokes the virtual render function of the gtk.cell_renderer.CellRenderer. The three passed-in rectangles are areas in cr. Most renderers will draw within cell_area; the xalign, yalign, xpad, and ypad fields of the gtk.cell_renderer.CellRenderer should be honored with respect to cell_area. background_area includes the blank space around the cell, and also the area containing the tree expander; so the background_area rectangles for all cells tile to cover the entire window.

startEditing
gtk.cell_editable.CellEditable startEditing(gdk.event.Event event, gtk.widget.Widget widget, string path, gdk.rectangle.Rectangle backgroundArea, gdk.rectangle.Rectangle cellArea, gtk.types.CellRendererState flags)

Starts editing the contents of this cell, through a new gtk.cell_editable.CellEditable widget created by the gtk.cell_renderer.CellRendererClass.start_editing virtual function.

stopEditing
void stopEditing(bool canceled)

Informs the cell renderer that the editing is stopped. If canceled is true, the cell renderer will emit the gtk.cell_renderer.CellRenderer::editing-canceled signal.

connectEditingCanceled
ulong connectEditingCanceled(T callback, Flag!"After" after)

Connect to EditingCanceled signal.

connectEditingStarted
ulong connectEditingStarted(T callback, Flag!"After" after)

Connect to EditingStarted signal.

Detailed Description

Deprecated: List views use widgets to display their contents. You should use gtk.inscription.Inscription or gtk.label.Label instead