ECellText

ECellText

Functions

Description

Functions

e_cell_text_new ()

ECell *
e_cell_text_new (const gchar *fontname,
                 GtkJustification justify);

e_cell_text_new is deprecated and should not be used in newly-written code.

Creates a new ECell renderer that can be used to render strings that that come from the model. The value returned from the model is interpreted as being a gchar *.

The ECellText object support a large set of properties that can be configured through the Gtk argument system and allows the user to have a finer control of the way the string is displayed. The arguments supported allow the control of strikeout, underline, bold, and color.

The arguments "strikeout_column", "underline_column", "bold_column" and "color_column" set and return an integer that points to a column in the model that controls these settings. So controlling the way things are rendered is achieved by having special columns in the model that will be used to flag whether the text should be rendered with strikeout, or bolded. In the case of the "color_column" argument, the column in the model is expected to have a string that can be parsed by gdk_color_parse().

Parameters

fontname

this param is no longer used, but left here for api stability

 

justify

Justification of the string in the cell.

 

Returns

an ECell object that can be used to render strings.


e_cell_text_construct ()

ECell *
e_cell_text_construct (ECellText *cell,
                       const gchar *fontname,
                       GtkJustification justify);

e_cell_text_construct is deprecated and should not be used in newly-written code.

constructs the ECellText. To be used by subclasses and language bindings.

Parameters

cell

The cell to construct

 

fontname

this param is no longer used, but left here for api stability

 

justify

Justification of the string in the cell

 

Returns

The ECellText.


e_cell_text_get_text ()

gchar *
e_cell_text_get_text (ECellText *cell,
                      ETableModel *model,
                      gint col,
                      gint row);

e_cell_text_get_text is deprecated and should not be used in newly-written code.


e_cell_text_free_text ()

void
e_cell_text_free_text (ECellText *cell,
                       ETableModel *model,
                       gint col,
                       gchar *text);

e_cell_text_free_text is deprecated and should not be used in newly-written code.


e_cell_text_set_value ()

void
e_cell_text_set_value (ECellText *cell,
                       ETableModel *model,
                       gint col,
                       gint row,
                       const gchar *text);

e_cell_text_set_value is deprecated and should not be used in newly-written code.


e_cell_text_set_selection ()

gboolean
e_cell_text_set_selection (ECellView *cell_view,
                           gint col,
                           gint row,
                           gint start,
                           gint end);

e_cell_text_set_selection is deprecated and should not be used in newly-written code.

Sets the selection of given text cell. If the current editing cell is not the given cell, this function will return FALSE;

If success, the [start, end) part of the text will be selected.

This API is most likely to be used by a11y implementations.

Parameters

cell_view

the given cell view

 

col

column of the given cell in the view

 

row

row of the given cell in the view

 

start

start offset of the selection

 

end

end offset of the selection

 

Returns

whether the action is successful.


e_cell_text_get_selection ()

gboolean
e_cell_text_get_selection (ECellView *cell_view,
                           gint col,
                           gint row,
                           gint *start,
                           gint *end);

e_cell_text_get_selection is deprecated and should not be used in newly-written code.

Gets the selection of given text cell. If the current editing cell is not the given cell, this function will return FALSE;

This API is most likely to be used by a11y implementations.

Parameters

cell_view

the given cell view

 

col

column of the given cell in the view

 

row

row of the given cell in the view

 

start

a pointer to an gint value indicates the start offset of the selection

 

end

a pointer to an gint value indicates the end offset of the selection

 

Returns

whether the action is successful.


e_cell_text_copy_clipboard ()

void
e_cell_text_copy_clipboard (ECellView *cell_view,
                            gint col,
                            gint row);

e_cell_text_copy_clipboard is deprecated and should not be used in newly-written code.

Copys the selected text to clipboard.

This API is most likely to be used by a11y implementations.

Parameters

cell_view

the given cell view

 

col

column of the given cell in the view

 

row

row of the given cell in the view

 

e_cell_text_paste_clipboard ()

void
e_cell_text_paste_clipboard (ECellView *cell_view,
                             gint col,
                             gint row);

e_cell_text_paste_clipboard is deprecated and should not be used in newly-written code.

Pastes the text from the clipboardt.

This API is most likely to be used by a11y implementations.

Parameters

cell_view

the given cell view

 

col

column of the given cell in the view

 

row

row of the given cell in the view

 

e_cell_text_delete_selection ()

void
e_cell_text_delete_selection (ECellView *cell_view,
                              gint col,
                              gint row);

e_cell_text_delete_selection is deprecated and should not be used in newly-written code.

Deletes the selected text of the cell.

This API is most likely to be used by a11y implementations.

Parameters

cell_view

the given cell view

 

col

column of the given cell in the view

 

row

row of the given cell in the view

 

e_cell_text_get_text_by_view ()

gchar *
e_cell_text_get_text_by_view (ECellView *cell_view,
                              gint col,
                              gint row);

e_cell_text_get_text_by_view is deprecated and should not be used in newly-written code.

Get the cell's text directly from CellEdit, during editting this cell, the cell's text value maybe inconsistant with the text got from table_model. The caller should free the text after using it.

This API is most likely to be used by a11y implementations.

Parameters

cell_view

the given cell view

 

col

column of the given cell in the model

 

row

row of the given cell in the model

 

Types and Values