gtk.CellLayoutIF.CellLayoutIF Interface Reference

Inheritance diagram for gtk.CellLayoutIF.CellLayoutIF:

gtk.ComboBox.ComboBox gtk.ComboBoxEntry.ComboBoxEntry gtk.ComboBoxEntry.ComboBoxEntry List of all members.

Detailed Description

Description GtkCellLayout is an interface to be implemented by all objects which want to provide a GtkTreeViewColumn-like API for packing cells, setting attributes and data funcs.

One of the notable features provided by implementations of GtkCellLayout are attributes. Attributes let you set the properties in flexible ways. They can just be set to constant values like regular properties. But they can also be mapped to a column of the underlying tree model with gtk_cell_layout_set_attributes(), which means that the value of the attribute can change from cell to cell as they are rendered by the cell renderer. Finally, it is possible to specify a function with gtk_cell_layout_set_cell_data_func() that is called to determine the value of the attribute for each cell that is rendered.


Public Member Functions

GtkCellLayoutgetCellLayoutTStruct ()
void packStart (CellRenderer cell, int expand)
 Packs the cell into the beginning of cell_layout.
void packEnd (CellRenderer cell, int expand)
 Adds the cell to the end of cell_layout.
void reorder (CellRenderer cell, int position)
 Re-inserts cell at position.
void clear ()
 Unsets all the mappings on all renderers on cell_layout and removes all renderers from cell_layout.
void setAttributes (CellRenderer cell,...)
 Sets the attributes in list as the attributes of cell_layout.
void addAttribute (CellRenderer cell, char[] attribute, int column)
 Adds an attribute mapping to the list in cell_layout.
void setCellDataFunc (CellRenderer cell, GtkCellLayoutDataFunc func, void *funcData, GDestroyNotify destroy)
 Sets the GtkCellLayoutDataFunc to use for cell_layout.
void clearAttributes (CellRenderer cell)
 Clears all existing attributes previously set with gtk_cell_layout_set_attributes().

Protected Member Functions

void * getStruct ()
 the main Gtk struct as a void*


Member Function Documentation

void gtk.CellLayoutIF.CellLayoutIF.addAttribute ( CellRenderer  cell,
char[]  attribute,
int  column 
)

Adds an attribute mapping to the list in cell_layout.

The column is the column of the model to get a value from, and the attribute is the parameter on cell to be set from the value. So for example if column 2 of the model contains strings, you could have the "text" attribute of a GtkCellRendererText get its values from column 2. cell_layout: A GtkCellLayout. cell: A GtkCellRenderer. attribute: An attribute on the renderer. column: The column position on the model to get the attribute from. Since 2.4

void gtk.CellLayoutIF.CellLayoutIF.clear (  ) 

Unsets all the mappings on all renderers on cell_layout and removes all renderers from cell_layout.

cell_layout: A GtkCellLayout. Since 2.4

void gtk.CellLayoutIF.CellLayoutIF.clearAttributes ( CellRenderer  cell  ) 

Clears all existing attributes previously set with gtk_cell_layout_set_attributes().

cell_layout: A GtkCellLayout. cell: A GtkCellRenderer to clear the attribute mapping on. Since 2.4

GtkCellLayout* gtk.CellLayoutIF.CellLayoutIF.getCellLayoutTStruct (  ) 

void* gtk.CellLayoutIF.CellLayoutIF.getStruct (  )  [protected]

the main Gtk struct as a void*

Implemented in gtk.ComboBox.ComboBox, and gtk.ComboBoxEntry.ComboBoxEntry.

void gtk.CellLayoutIF.CellLayoutIF.packEnd ( CellRenderer  cell,
int  expand 
)

Adds the cell to the end of cell_layout.

If expand is FALSE, then the cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which expand is TRUE. Note that reusing the same cell renderer is not supported. cell_layout: A GtkCellLayout. cell: A GtkCellRenderer. expand: TRUE if cell is to be given extra space allocated to cell_layout. Since 2.4

void gtk.CellLayoutIF.CellLayoutIF.packStart ( CellRenderer  cell,
int  expand 
)

Packs the cell into the beginning of cell_layout.

If expand is FALSE, then the cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which expand is TRUE. Note that reusing the same cell renderer is not supported. cell_layout: A GtkCellLayout. cell: A GtkCellRenderer. expand: TRUE if cell is to be given extra space allocated to cell_layout. Since 2.4

void gtk.CellLayoutIF.CellLayoutIF.reorder ( CellRenderer  cell,
int  position 
)

Re-inserts cell at position.

Note that cell has already to be packed into cell_layout for this to function properly. cell_layout: A GtkCellLayout. cell: A GtkCellRenderer to reorder. position: New position to insert cell at. Since 2.4

void gtk.CellLayoutIF.CellLayoutIF.setAttributes ( CellRenderer  cell,
  ... 
)

Sets the attributes in list as the attributes of cell_layout.

The attributes should be in attribute/column order, as in gtk_cell_layout_add_attribute(). All existing attributes are removed, and replaced with the new attributes. cell_layout: A GtkCellLayout. cell: A GtkCellRenderer. ...: A NULL-terminated list of attributes. Since 2.4

void gtk.CellLayoutIF.CellLayoutIF.setCellDataFunc ( CellRenderer  cell,
GtkCellLayoutDataFunc  func,
void *  funcData,
GDestroyNotify  destroy 
)

Sets the GtkCellLayoutDataFunc to use for cell_layout.

This function is used instead of the standard attributes mapping for setting the column value, and should set the value of cell_layout's cell renderer(s) as appropriate. func may be NULL to remove and older one. cell_layout: A GtkCellLayout. cell: A GtkCellRenderer. func: The GtkCellLayoutDataFunc to use. func_data: The user data for func. destroy: The destroy notification for func_data. Since 2.4


SourceForge.net Logo DSource.org Logo digitalmars.com Logo