Functions¶
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Details¶
- Gnm.acot(x)¶
- Gnm.acoth(x)¶
- Gnm.action_group_add_action(group, act)¶
- Parameters:
group (
Gtk.ActionGroup
) –act (
Gtk.Action
) –
- Gnm.action_group_add_actions(group, actions, n, user)¶
- Parameters:
group (
Gtk.ActionGroup
) –actions (
Gnm.ActionEntry
) –n (
int
) –
- Gnm.advanced_filter(wbc, dao, database, criteria, unique_only_flag)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –dao (
Gnm.data_analysis_output_t
) –database (
Gnm.Value
) –criteria (
Gnm.Value
) –unique_only_flag (
bool
) –
- Return type:
- Gnm.agm(a, b)¶
- Gnm.analysis_tool_advanced_filter_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_anova_single_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_anova_two_factor_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_auto_expression_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_calc_length(info)¶
- Parameters:
info (
Gnm.analysis_tools_data_generic_t
) –- Return type:
- Gnm.analysis_tool_chi_squared_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_correlation_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_covariance_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_descriptive_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_exponential_smoothing_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_fourier_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_frequency_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_ftest_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_get_function(name, dao)¶
- Parameters:
name (
str
) – name of functiondao (
Gnm.data_analysis_output_t
) –
- Returns:
the function named name or a placeholder. The usage
GOffice.count
of the function is incremented.- Return type:
- Gnm.analysis_tool_histogram_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_kaplan_meier_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_moving_average_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_normality_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_one_mean_test_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_principal_components_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_ranking_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_regression_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_sampling_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_sign_test_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_sign_test_two_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_signed_rank_test_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_signed_rank_test_two_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_table(dao, info, title, functionname, full_table)¶
- Parameters:
dao (
Gnm.data_analysis_output_t
) –info (
Gnm.analysis_tools_data_generic_t
) –title (
str
) –functionname (
str
) –full_table (
bool
) –
- Return type:
- Gnm.analysis_tool_ttest_eqvar_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_ttest_neqvar_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_ttest_paired_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_wilcoxon_mann_whitney_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tool_ztest_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.analysis_tools_write_label(val, dao, info, x, y, i)¶
- Parameters:
val (
Gnm.Value
) –dao (
Gnm.data_analysis_output_t
) –info (
Gnm.analysis_tools_data_generic_t
) –x (
int
) –y (
int
) –i (
int
) –
- Gnm.analysis_tools_write_label_ftest(val, dao, x, y, labels, i)¶
- Gnm.annual_year_basis(value_date, basis, date_conv)¶
- Parameters:
value_date (
Gnm.Value
) –basis (
GOffice.BasisType
) –date_conv (
GOffice.DateConventions
) –
- Return type:
- Gnm.auto_style_format_suggest(texpr, epos)¶
- Parameters:
texpr (
Gnm.ExprTop
) – AGnm.ExprTop
epos (
Gnm.EvalPos
) – AGnm.EvalPos
- Returns:
Suggested format.
- Return type:
Suggest a format for texpr.
- Gnm.autofill_fill(sheet, default_increment, base_col, base_row, w, h, end_col, end_row)¶
- Parameters:
An internal routine to autofill a region. It does NOT queue a recalc, flag a status update, or regen spans.
- Gnm.autofill_hint(sheet, default_increment, base_col, base_row, w, h, end_col, end_row)¶
- Gnm.beta(a, b)¶
- Gnm.canvas_get_position(canvas, x, y, px, py)¶
- Parameters:
canvas (
GOffice.Canvas
) –x (
int
) –y (
int
) –px (
int
) –py (
int
) –
- Gnm.canvas_get_screen_position(canvas, x, y, ix, iy)¶
- Parameters:
canvas (
GOffice.Canvas
) –x (
float
) –y (
float
) –ix (
int
) –iy (
int
) –
- Gnm.cell_set_array(sheet, r, texpr)¶
- Parameters:
sheet (
Gnm.Sheet
) – The sheet to set the array expression in.r (
Gnm.Range
) – The range to set.texpr (
Gnm.ExprTop
) – an expression (the inner expression, not a corner or element)
- Returns:
True
if the operation succeeded.NOTE : This adds a reference to the expression.
Does not regenerate spans, dimensions or autosize cols/rows.
DOES CHECK for array partitioning.
- Return type:
Set an array expression for a range. Uses cell_set_expr_internal to store the expr as an ‘array-formula’. The supplied expression is wrapped in an array operator for each cell in the range and scheduled for recalc.
- Gnm.cell_set_array_formula_undo(sr, texpr)¶
- Parameters:
sr (
Gnm.SheetRange
) –texpr (
Gnm.ExprTop
) –
- Returns:
the newly allocated
GOffice.Undo
.- Return type:
- Gnm.cell_set_comment(sheet, pos, author, text, markup)¶
- Parameters:
pos (
Gnm.CellPos
) – the position.author (
str
) –Gnm.comment
author.text (
str
) –Gnm.comment
text.markup (
Pango.AttrList
) –Gnm.comment
markup.
- Returns:
the newly allocated
Gnm.Comment
.- Return type:
- Gnm.cellpos_equal(a, b)¶
- Parameters:
a (
Gnm.CellPos
) –b (
Gnm.CellPos
) –
- Return type:
- Gnm.cellpos_hash(key)¶
- Parameters:
key (
Gnm.CellPos
) –- Return type:
- Gnm.cellpos_init_cellref(cp, cr, pos, base_sheet)¶
- Parameters:
cp (
Gnm.CellPos
) –cr (
Gnm.CellRef
) –pos (
Gnm.CellPos
) –base_sheet (
Gnm.Sheet
) –
- Gnm.cellpos_init_cellref_ss(res, cell_ref, pos, ss)¶
- Parameters:
res (
Gnm.CellPos
) –cell_ref (
Gnm.CellRef
) –pos (
Gnm.CellPos
) –ss (
Gnm.SheetSize
) –
- Gnm.cellregion_cmd_size(cr)¶
- Parameters:
cr (
Gnm.CellRegion
) –- Return type:
- Gnm.cellregion_invalidate_sheet(cr, sheet)¶
- Parameters:
cr (
Gnm.CellRegion
) –Gnm.CellRegion
Invalidate references from cell content, objects or style to sheet.
- Gnm.cellregion_ref(cr)¶
- Parameters:
cr (
Gnm.CellRegion
) –- Return type:
- Gnm.cellregion_to_string(cr, only_visible, date_conv)¶
- Parameters:
cr (
Gnm.CellRegion
) –only_visible (
bool
) –date_conv (
GOffice.DateConventions
) –
- Return type:
- Gnm.cellregion_to_xml(cr)¶
- Parameters:
cr (
Gnm.CellRegion
) – the content to store.- Returns:
None
on error- Return type:
- Gnm.cellregion_unref(cr)¶
- Parameters:
cr (
Gnm.CellRegion
) –
- Gnm.check_for_plugins_missing(ids, parent)¶
- Parameters:
ids (
str
) –parent (
Gtk.Window
) –
- Return type:
- Gnm.clipboard_copy_obj(sheet, objects)¶
- Parameters:
objects ([
Gnm.SheetObject
]) –GLib.SList
- Returns:
a cell region with copies of objects in list.
- Return type:
- Gnm.clipboard_copy_range(sheet, r)¶
- Parameters:
- Returns:
the copied contents of the given range.
- Return type:
- Gnm.clipboard_copy_range_undo(sheet, r)¶
- Parameters:
- Returns:
A
GOffice.Undo
object that will restore the contents of the given range.- Return type:
- Gnm.clipboard_copy_ranges_undo(sheet, ranges)¶
- Parameters:
- Returns:
A
GOffice.Undo
object that will restore the contents of the given range.- Return type:
- Gnm.clipboard_paste_region(cr, pt, cc)¶
- Parameters:
cr (
Gnm.CellRegion
) – TheGnm.CellRegion
to paste.pt (
Gnm.PasteTarget
) – Where to paste the values.cc (
GOffice.CmdContext
orNone
) – The context for error handling.
- Returns:
True
if there was a problem.- Return type:
Pastes the supplied
Gnm.CellRegion
(cr) into the suppliedGnm.PasteTarget
(pt). This operation is not undoable. It does not auto grow the destination if the target is a singleton. This is a simple interface to paste a region.
- Gnm.cmd_area_set_array_expr(wbc, sv, new_texpr)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sv (
Gnm.SheetView
) –new_texpr (
Gnm.ExprTop
) –
- Return type:
- Gnm.cmd_area_set_text(wbc, sv, text, markup)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sv (
Gnm.SheetView
) –text (
str
) –markup (
Pango.AttrList
) –
- Return type:
- Gnm.cmd_autofill(wbc, sheet, default_increment, base_col, base_row, w, h, end_col, end_row, inverse_autofill)¶
- Gnm.cmd_autofilter_add_remove(wbc)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –- Return type:
- Gnm.cmd_autofilter_set_condition(wbc, filter, i, cond)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –filter (
Gnm.Filter
) –i (
int
) –cond (
Gnm.FilterCondition
) –
- Return type:
- Gnm.cmd_autofit_selection(wbc, sv, sheet, fit_width, selectionlist)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sv (
Gnm.SheetView
) –sheet (
Gnm.Sheet
) –fit_width (
bool
) –selectionlist ([
object
]) –
- Return type:
- Gnm.cmd_cell_range_is_locked_effective(sheet, range, wbc, cmd_name)¶
- Parameters:
cmd_name (
str
) – the command name.
- Returns:
- Return type:
checks whether the cells are effectively locked
static
bool
Gnm.cmd_cell_range_is_locked_effective
Do not use this function unless the sheet is part of the
GOffice.workbook
with the given wbc (otherwise the results may be strange)
- Gnm.cmd_change_meta_data(wbc, changes, removed)¶
- Parameters:
changes ([
Gsf.DocMetaData
]) – the changed metadata.removed ([
Gsf.DocMetaData
]) – the removed metadata.
- Returns:
- Return type:
- Gnm.cmd_colrow_std_size(wbc, sheet, is_cols, new_default)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sheet (
Gnm.Sheet
) –is_cols (
bool
) –new_default (
float
) –
- Return type:
- Gnm.cmd_context_error_calc(cc, msg)¶
- Parameters:
cc (
GOffice.CmdContext
) –msg (
str
) –
- Gnm.cmd_context_error_splits_array(cc, cmd, array)¶
- Parameters:
cc (
GOffice.CmdContext
) –cmd (
str
) –array (
Gnm.Range
) –
- Gnm.cmd_context_error_splits_merge(cc, merge)¶
- Parameters:
cc (
GOffice.CmdContext
) –merge (
Gnm.Range
) –
- Gnm.cmd_copyrel(wbc, dx, dy, name)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –dx (
int
) –dy (
int
) –name (
str
) –
- Return type:
- Gnm.cmd_create_data_table(wbc, sheet, r, col_input, row_input)¶
- Gnm.cmd_data_shuffle(wbc, sc, sheet)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sheet (
Gnm.Sheet
) –
- Return type:
- Gnm.cmd_define_name(wbc, name, pp, texpr, descriptor)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –name (
str
) –pp (
Gnm.ParsePos
) –texpr (
Gnm.ExprTop
) –Gnm.ExprTop
descriptor (
str
) – optional descriptor.
- Returns:
- Return type:
If the name has never been defined in context pp create a new name If it is a placeholder, assign texpr to it and make it real If it already exists as a real name just assign expr.
- Gnm.cmd_delete_cols(wbc, sheet, start_col, count)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sheet (
Gnm.Sheet
) –start_col (
int
) –count (
int
) –
- Return type:
- Gnm.cmd_delete_rows(wbc, sheet, start_row, count)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sheet (
Gnm.Sheet
) –start_row (
int
) –count (
int
) –
- Return type:
- Gnm.cmd_generic(wbc, text, undo, redo)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –text (
str
) –undo (
GOffice.Undo
) –redo (
GOffice.Undo
) –
- Return type:
- Gnm.cmd_generic_with_size(wbc, text, size, undo, redo)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –text (
str
) –size (
int
) –undo (
GOffice.Undo
) –redo (
GOffice.Undo
) –
- Return type:
- Gnm.cmd_global_outline_change(wbc, is_cols, depth)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –is_cols (
bool
) –depth (
int
) –
- Return type:
- Gnm.cmd_goal_seek(wbc, cell, ov, nv)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –cell (
Gnm.Cell
) –ov (
Gnm.Value
) –nv (
Gnm.Value
) –
- Return type:
- Gnm.cmd_insert_cols(wbc, sheet, start_col, count)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sheet (
Gnm.Sheet
) –start_col (
int
) –count (
int
) –
- Return type:
- Gnm.cmd_insert_rows(wbc, sheet, start_row, count)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sheet (
Gnm.Sheet
) –start_row (
int
) –count (
int
) –
- Return type:
- Gnm.cmd_merge_cells(wbc, sheet, selection, center)¶
- Gnm.cmd_merge_data(wbc, sheet, merge_zone, merge_fields, merge_data)¶
- Gnm.cmd_object_raise(wbc, so, dir)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –so (
Gnm.SheetObject
) –dir (
Gnm.CmdObjectRaiseSelector
) –
- Return type:
- Gnm.cmd_objects_delete(wbc, objects, name)¶
- Parameters:
objects ([
Gnm.SheetObject
]) – the objects to delete.name (
str
) –
- Returns:
- Return type:
- Gnm.cmd_objects_move(wbc, objects, anchors, objects_created, name)¶
- Parameters:
objects ([
Gnm.SheetObject
]) – the objects to move.anchors ([
Gnm.SheetObjectAnchor
]) – the anchors for the objects.objects_created (
bool
) –name (
str
) –
- Returns:
- Return type:
- Gnm.cmd_page_break_toggle(wbc, sheet, is_vert)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sheet (
Gnm.Sheet
) –is_vert (
bool
) –
- Return type:
- Gnm.cmd_page_breaks_clear(wbc, sheet)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sheet (
Gnm.Sheet
) –
- Return type:
- Gnm.cmd_paste(wbc, pt)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –pt (
Gnm.PasteTarget
) –
Pastes the current cut buffer, copy buffer, or X selection to the destination sheet range.
When pasting a cut the destination MUST be the same size as the src.
When pasting a copy the destination can be a singleton, or an integer multiple of the size of the source. This is not tested here. Full undo support.
- Gnm.cmd_paste_copy(wbc, pt, content)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –pt (
Gnm.PasteTarget
) –content (
Gnm.CellRegion
) –
- Return type:
- Gnm.cmd_paste_cut(wbc, info, move_selection, cmd_descriptor)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –info (
Gnm.ExprRelocateInfo
) –move_selection (
bool
) –cmd_descriptor (
str
) –
- Return type:
- Gnm.cmd_paste_to_selection(wbc, dest_sv, paste_flags)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –GOffice.workbook
controldest_sv (
Gnm.SheetView
) – The sheet into which things should be pastedpaste_flags (
int
) – special paste flags (eg transpose)
Using the current selection as a target Full undo support.
- Gnm.cmd_print_setup(wbc, sheet, pi)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sheet (
Gnm.Sheet
) –pi (
Gnm.PrintInformation
) –
- Return type:
- Gnm.cmd_remove_name(wbc, nexpr)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –nexpr (
Gnm.NamedExpr
) – name to remove.
- Return type:
Returns
True
on error
- Gnm.cmd_rename_sheet(wbc, sheet, new_name)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sheet (
Gnm.Sheet
) –new_name (
str
) –
- Return type:
- Gnm.cmd_reorganize_sheets(wbc, old_state, undo_sheet)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –old_state (
Gnm.WorkbookSheetState
) –undo_sheet (
Gnm.Sheet
) –
- Return type:
- Gnm.cmd_rescope_name(wbc, nexpr, scope)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –nexpr (
Gnm.NamedExpr
) – name to rescope.scope (
Gnm.Sheet
) –
- Returns:
- Return type:
- Gnm.cmd_resize_colrow(wbc, sheet, is_col, selection, new_size)¶
- Gnm.cmd_resize_sheets(wbc, sheets, cols, rows)¶
- Gnm.cmd_scenario_mngr(wbc, sc, undo)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sc (
Gnm.Scenario
) –undo (
GOffice.Undo
) –
- Return type:
- Gnm.cmd_search_replace(wbc, sr)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sr (
Gnm.SearchReplace
) –
- Return type:
- Gnm.cmd_selection_autoformat(wbc, ft)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) – the context.ft (
Gnm.FT
) – The format template that was applied
- Returns:
- Return type:
- Gnm.cmd_selection_clear(wbc, clear_flags)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –clear_flags (
int
) –
- Return type:
- Gnm.cmd_selection_colrow_hide(wbc, is_cols, visible)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –is_cols (
bool
) –visible (
bool
) –
- Return type:
- Gnm.cmd_selection_format(wbc, style, borders, opt_translated_name)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –style (
Gnm.Style
) –borders (
Gnm.Border
) –opt_translated_name (
str
) –
- Return type:
- Gnm.cmd_selection_format_toggle_font_style(wbc, style, t)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –style (
Gnm.Style
) –t (
Gnm.StyleElement
) –
- Return type:
- Gnm.cmd_selection_group(wbc, is_cols, group)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –is_cols (
bool
) –group (
bool
) –
- Return type:
- Gnm.cmd_selection_hyperlink(wbc, style, opt_translated_name, opt_content)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) – theGOffice.workbook
control.style (
Gnm.Style
) – style to apply to the selectionopt_translated_name (
str
) – An optional name to use in place of ‘Hyperlink Cells’opt_content (
str
) – optional content for otherwise empty cells.
- Returns:
- Return type:
- Gnm.cmd_selection_outline_change(wbc, is_cols, index, depth)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –is_cols (
bool
) –index (
int
) –depth (
int
) –
- Return type:
- Gnm.cmd_set_comment(wbc, sheet, pos, new_text, attr, new_author)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sheet (
Gnm.Sheet
) –pos (
Gnm.CellPos
) –new_text (
str
) –attr (
Pango.AttrList
) –new_author (
str
) –
- Return type:
- Gnm.cmd_set_text(wbc, sheet, pos, new_text, markup, autocorrect)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sheet (
Gnm.Sheet
) –pos (
Gnm.CellPos
) –new_text (
str
) –markup (
Pango.AttrList
) –autocorrect (
bool
) –
- Return type:
- Gnm.cmd_shift_cols(wbc, sheet, start_col, end_col, row, count)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) – The error context.sheet (
Gnm.Sheet
) – the sheetstart_col (
int
) – first columnend_col (
int
) – end columnrow (
int
) –Gnm.row
marking the start of the shiftcount (
int
) – numbers of rows to shift. a negative numbers will deleteGOffice.count
rows, positive number will insertGOffice.count
rows.
Takes the cells in the region (start_col,:obj:Gnm.row):(end_col,MAX_ROW) and copies them count units (possibly negative) downwards.
- Gnm.cmd_shift_rows(wbc, sheet, col, start_row, end_row, count)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) – The error context. sheet the sheet col column marking the start of the shift start_row firstGnm.row
end_row endGnm.row
count numbers of columns to shift. negative numbers will deleteGOffice.count
columns, positive number will insertGOffice.count
columns.sheet (
Gnm.Sheet
) –col (
int
) –start_row (
int
) –end_row (
int
) –count (
int
) –
Takes the cells in the region (
Gnm.col
,start_row):(MAX_COL,end_row) and copies them count units (possibly negative) to the right.
- Gnm.cmd_slicer_refresh(wbc)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) – theGOffice.workbook
control.- Return type:
- Gnm.cmd_so_component_config(wbc, so, n_obj, o_obj)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –so (
Gnm.SheetObject
) –n_obj (
GObject.Object
) –o_obj (
GObject.Object
) –
- Return type:
- Gnm.cmd_so_graph_config(wbc, sog, n_graph, o_graph)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sog (
Gnm.SheetObject
) –n_graph (
GObject.Object
) –o_graph (
GObject.Object
) –
- Return type:
- Gnm.cmd_so_set_adjustment(wbc, so, lnk, horizontal, lower, upper, step, page, undo_label)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –so (
Gnm.SheetObject
) –lnk (
Gnm.ExprTop
) –horizontal (
bool
) –lower (
int
) –upper (
int
) –step (
int
) –page (
int
) –undo_label (
str
) –
- Return type:
- Gnm.cmd_so_set_button(wbc, so, lnk, old_label, new_label)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –so (
Gnm.SheetObject
) –lnk (
Gnm.ExprTop
) –old_label (
str
) –new_label (
str
) –
- Return type:
- Gnm.cmd_so_set_checkbox(wbc, so, lnk, old_label, new_label)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –so (
Gnm.SheetObject
) –lnk (
Gnm.ExprTop
) –old_label (
str
) –new_label (
str
) –
- Return type:
- Gnm.cmd_so_set_frame_label(wbc, so, old_label, new_label)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –so (
Gnm.SheetObject
) –old_label (
str
) –new_label (
str
) –
- Return type:
- Gnm.cmd_so_set_links(wbc, so, output, content, as_index)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –so (
Gnm.SheetObject
) –output (
Gnm.ExprTop
) –content (
Gnm.ExprTop
) –as_index (
bool
) –
- Return type:
- Gnm.cmd_so_set_radio_button(wbc, so, lnk, old_label, new_label, old_value, new_value)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –so (
Gnm.SheetObject
) –lnk (
Gnm.ExprTop
) –old_label (
str
) –new_label (
str
) –old_value (
Gnm.Value
) –new_value (
Gnm.Value
) –
- Return type:
- Gnm.cmd_so_set_value(wbc, text, pref, new_val, sheet)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –text (
str
) –pref (
Gnm.CellRef
) –new_val (
Gnm.Value
) –sheet (
Gnm.Sheet
) –
- Return type:
- Gnm.cmd_sort(wbc, data)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –data (
Gnm.SortData
) –
- Return type:
- Gnm.cmd_tabulate(wbc, data)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –
- Return type:
- Gnm.cmd_text_to_columns(wbc, src, src_sheet, target, target_sheet, content)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –src (
Gnm.Range
) –src_sheet (
Gnm.Sheet
) –target (
Gnm.Range
) –target_sheet (
Gnm.Sheet
) –content (
Gnm.CellRegion
) –
- Return type:
- Gnm.cmd_toggle_rtl(wbc, sheet)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sheet (
Gnm.Sheet
) –
- Return type:
- Gnm.cmd_trunc_descriptor(src, truncated)¶
- Parameters:
src (
GLib.String
) –truncated (
bool
) –
- Return type:
- Gnm.cmd_unmerge_cells(wbc, sheet, selection)¶
- Gnm.cmd_zoom(wbc, sheets, factor)¶
- Gnm.collect_floats_value(val, ep, flags, n, error)¶
- Parameters:
val (
Gnm.Value
) –ep (
Gnm.EvalPos
) –flags (
Gnm.CollectFlags
) –n (
int
) –error (
Gnm.Value
) –
- Return type:
- Gnm.collect_floats_value_with_info(val, ep, flags, n, info, error)¶
- Parameters:
ep (
Gnm.EvalPos
) –Gnm.EvalPos
flags (
Gnm.CollectFlags
) –Gnm.CollectFlags
n (
int
) –info ([
int
]) –error (
Gnm.Value
) –
- Return type:
Like
Gnm.collect_floats_value
, but keeps info on missing values
- Gnm.colrow_autofit(sheet, r, is_cols, ignore_strings, min_current, min_default, indices, sizes)¶
- Gnm.colrow_autofit_col(sheet, r)¶
- Gnm.colrow_autofit_row(sheet, r)¶
- Gnm.colrow_compute_pixel_scale(sheet, horizontal)¶
- Gnm.colrow_compute_pixels_from_pts(cri, sheet, horizontal, scale)¶
- Parameters:
cri (
Gnm.ColRowInfo
) –sheet (
Gnm.Sheet
) –horizontal (
bool
) –scale (
float
) –
- Gnm.colrow_compute_pts_from_pixels(cri, sheet, horizontal, scale)¶
- Parameters:
cri (
Gnm.ColRowInfo
) –sheet (
Gnm.Sheet
) –horizontal (
bool
) –scale (
float
) –
- Gnm.colrow_find_outline_bound(sheet, is_cols, index, depth, inc)¶
- Parameters:
- Return type:
find the next/prev
Gnm.col
/Gnm.row
at the designated depth starting from the supplied index.
- Gnm.colrow_free(cri)¶
- Parameters:
cri (
Gnm.ColRowInfo
) –
- Gnm.colrow_get_index_list(first, last, list)¶
-
Build an ordered list of pairs doing intelligent merging of overlapping regions.
- Gnm.colrow_index_list_copy(list)¶
- Gnm.colrow_index_list_to_string(list, is_cols, is_single)¶
- Parameters:
- Return type:
- Gnm.colrow_set_visibility(sheet, is_cols, visible, first, last)¶
- Parameters:
Change the visibility of the selected range of contiguous cols/rows. NOTE : only changes the collapsed state for the LAST+1 element.
- Gnm.colrow_set_visibility_list(sheet, is_cols, visible, list)¶
- Parameters:
This is the high level command that is wrapped by undo and redo. It should not be called by other commands.
- Gnm.colrow_state_group_destroy(set)¶
- Gnm.colrow_state_list_destroy(list)¶
- Gnm.colrow_state_list_foreach(list, sheet, is_cols, base, callback, *user_data)¶
- Parameters:
list ([
object
]) – The #ColRowStateList to iterate.base (
int
) – index of first column orGnm.row
.callback (
Gnm.ColRowHandler
) – A callback function which should returnTrue
to stop the iteration.
Iterates through the existing rows or columns within the range supplied. Currently only support left-to-right iteration. If a callback returns
True
, iteration stops.
- Gnm.combin(n, k)¶
- Gnm.complex_fact(z)¶
- Parameters:
z (
GOffice.Complex
) – a complex number- Returns:
the factorial function evaluated at z.
- expb:
Return location for power-of-base.
- Return type:
(
GOffice.Complex
, expb:int
)
- Gnm.complex_from_string(dst, src)¶
- Parameters:
dst (
GOffice.Complex
) – return locationsrc (
str
) – string to parse
- Returns:
zero on success, -1 otherwise.
This function differs from Excel’s parsing in at least the following ways: (1) We allow spaces before the imaginary unit used with an implied “1”. Therefore we allow “+ i”. (2) We do not allow a thousands separator as in “1,000i”.
- imunit:
return location of imaginary unit.
- Return type:
- Gnm.complex_gamma(z)¶
- Parameters:
z (
GOffice.Complex
) – a complex number- Returns:
the Gamma function evaluated at z.
- expb:
Return location for power-of-base
- Return type:
(
GOffice.Complex
, expb:int
)
- Gnm.complex_igamma(a, z, lower, regularized)¶
- Parameters:
a (
GOffice.Complex
) – a complex numberz (
GOffice.Complex
) – a complex numberlower (
bool
) – determines if upper or lower incomplete gamma is desired.regularized (
bool
) – determines if the result should be normalized by Gamma(a).
- Returns:
the incomplete gamma function evaluated at a and z.
- Return type:
- Gnm.complex_invalid_p(src)¶
- Parameters:
src (
GOffice.Complex
) –- Return type:
- Gnm.complex_to_string(src, imunit)¶
- Parameters:
src (
GOffice.Complex
) –imunit (
int
) –
- Return type:
- Gnm.conf_get_autocorrect_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_autocorrect_first_letter_list_node()¶
- Returns:
- Return type:
- Gnm.conf_get_autocorrect_first_letter_node()¶
- Returns:
- Return type:
- Gnm.conf_get_autocorrect_init_caps_list_node()¶
- Returns:
- Return type:
- Gnm.conf_get_autocorrect_init_caps_node()¶
- Returns:
- Return type:
- Gnm.conf_get_autocorrect_names_of_days_node()¶
- Returns:
- Return type:
- Gnm.conf_get_autocorrect_replace_node()¶
- Returns:
- Return type:
- Gnm.conf_get_autoformat_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_autoformat_extra_dirs_node()¶
- Returns:
- Return type:
- Gnm.conf_get_autoformat_sys_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_autoformat_usr_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_defaultfont_bold_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_defaultfont_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_defaultfont_italic_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_defaultfont_name_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_defaultfont_size_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_file_save_def_overwrite_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_file_save_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_file_save_extension_check_disabled_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_file_save_single_sheet_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_gui_cells_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_gui_cells_extension_markers_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_gui_cells_function_markers_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_gui_editing_autocomplete_min_chars_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_gui_editing_autocomplete_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_gui_editing_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_gui_editing_enter_moves_dir()¶
- Return type:
- Gnm.conf_get_core_gui_editing_enter_moves_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_gui_editing_function_argument_tooltips_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_gui_editing_function_name_tooltips_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_gui_editing_recalclag_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_gui_editing_transitionkeys_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_gui_screen_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_gui_screen_horizontaldpi_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_gui_screen_verticaldpi_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_gui_toolbars_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_gui_toolbars_format_position()¶
- Return type:
- Gnm.conf_get_core_gui_toolbars_format_position_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_gui_toolbars_format_visible_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_gui_toolbars_object_position()¶
- Return type:
- Gnm.conf_get_core_gui_toolbars_object_position_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_gui_toolbars_object_visible_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_gui_toolbars_standard_position()¶
- Return type:
- Gnm.conf_get_core_gui_toolbars_standard_position_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_gui_toolbars_standard_visible_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_gui_window_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_gui_window_x_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_gui_window_y_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_gui_window_zoom_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_sort_default_ascending_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_sort_default_by_case_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_sort_default_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_sort_default_retain_formats_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_sort_dialog_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_sort_dialog_max_initial_clauses_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_workbook_autosave_time_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_workbook_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_workbook_n_cols_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_workbook_n_rows_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_workbook_n_sheet_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_xml_compression_level_node()¶
- Returns:
- Return type:
- Gnm.conf_get_core_xml_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_cut_and_paste_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_cut_and_paste_prefer_clipboard_node()¶
- Returns:
- Return type:
- Gnm.conf_get_dialogs_rs_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_dialogs_rs_unfocused_node()¶
- Returns:
- Return type:
- Gnm.conf_get_functionselector_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_functionselector_num_of_recent_node()¶
- Returns:
- Return type:
- Gnm.conf_get_functionselector_recentfunctions_node()¶
- Returns:
- Return type:
- Gnm.conf_get_long_desc(node)¶
- Parameters:
node (
GOffice.ConfNode
) –GOffice.ConfNode
- Returns:
a description of node.
- Return type:
- Gnm.conf_get_page_setup()¶
- Returns:
the default
Gtk.PageSetup
.- Return type:
- Gnm.conf_get_plugin_glpk_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_plugin_glpk_glpsol_path_node()¶
- Returns:
- Return type:
- Gnm.conf_get_plugin_latex_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_plugin_latex_use_utf8_node()¶
- Returns:
- Return type:
- Gnm.conf_get_plugin_lpsolve_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_plugin_lpsolve_lpsolve_path_node()¶
- Returns:
- Return type:
- Gnm.conf_get_plugins_activate_newplugins_node()¶
- Returns:
- Return type:
- Gnm.conf_get_plugins_active_node()¶
- Returns:
- Return type:
- Gnm.conf_get_plugins_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_plugins_extra_dirs_node()¶
- Returns:
- Return type:
- Gnm.conf_get_plugins_file_states_node()¶
- Returns:
- Return type:
- Gnm.conf_get_plugins_known_node()¶
- Returns:
- Return type:
- Gnm.conf_get_print_settings()¶
- Returns:
the default
Gtk.PrintSettings
.- Return type:
- Gnm.conf_get_printer_decoration_font()¶
- Returns:
a style appropriate
Gnm.font
for headers and footers.- Return type:
- Gnm.conf_get_printsetup_across_then_down_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_all_sheets_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_center_horizontally_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_center_vertically_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_dir_node()¶
- Returns:
- Return type:
- Return type:
[
str
]
- Returns:
- Return type:
- Gnm.conf_get_printsetup_gtk_setting_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_header_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_hf_font_bold_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_hf_font_italic_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_hf_font_name_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_hf_font_size_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_hf_left_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_hf_middle_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_hf_right_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_margin_bottom_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_margin_gtk_bottom_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_margin_gtk_left_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_margin_gtk_right_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_margin_gtk_top_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_margin_top_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_paper_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_paper_orientation_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_preferred_unit_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_print_black_n_white_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_print_even_if_only_styles_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_print_grid_lines_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_print_titles_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_repeat_left_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_repeat_top_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_scale_height_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_scale_percentage_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_scale_percentage_value_node()¶
- Returns:
- Return type:
- Gnm.conf_get_printsetup_scale_width_node()¶
- Returns:
- Return type:
- Gnm.conf_get_root()¶
- Returns:
the root config node.
- Return type:
- Gnm.conf_get_searchreplace_change_cell_expressions_node()¶
- Returns:
- Return type:
- Gnm.conf_get_searchreplace_change_cell_other_node()¶
- Returns:
- Return type:
- Gnm.conf_get_searchreplace_change_cell_strings_node()¶
- Returns:
- Return type:
- Gnm.conf_get_searchreplace_change_comments_node()¶
- Returns:
- Return type:
- Gnm.conf_get_searchreplace_columnmajor_node()¶
- Returns:
- Return type:
- Gnm.conf_get_searchreplace_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_searchreplace_error_behaviour_node()¶
- Returns:
- Return type:
- Gnm.conf_get_searchreplace_ignore_case_node()¶
- Returns:
- Return type:
- Gnm.conf_get_searchreplace_keep_strings_node()¶
- Returns:
- Return type:
- Gnm.conf_get_searchreplace_preserve_case_node()¶
- Returns:
- Return type:
- Gnm.conf_get_searchreplace_query_node()¶
- Returns:
- Return type:
- Gnm.conf_get_searchreplace_regex_node()¶
- Returns:
- Return type:
- Gnm.conf_get_searchreplace_scope_node()¶
- Returns:
- Return type:
- Gnm.conf_get_searchreplace_search_results_node()¶
- Returns:
- Return type:
- Gnm.conf_get_searchreplace_whole_words_only_node()¶
- Returns:
- Return type:
- Gnm.conf_get_short_desc(node)¶
- Parameters:
node (
GOffice.ConfNode
) –GOffice.ConfNode
- Returns:
a brief description of node.
- Return type:
- Gnm.conf_get_stf_export_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_stf_export_encoding_node()¶
- Returns:
- Return type:
- Gnm.conf_get_stf_export_format()¶
- Return type:
- Gnm.conf_get_stf_export_format_node()¶
- Returns:
- Return type:
- Gnm.conf_get_stf_export_locale_node()¶
- Returns:
- Return type:
- Gnm.conf_get_stf_export_quoting()¶
- Return type:
- Gnm.conf_get_stf_export_quoting_node()¶
- Returns:
- Return type:
- Gnm.conf_get_stf_export_separator_node()¶
- Returns:
- Return type:
- Gnm.conf_get_stf_export_stringindicator_node()¶
- Returns:
- Return type:
- Gnm.conf_get_stf_export_terminator_node()¶
- Returns:
- Return type:
- Gnm.conf_get_stf_export_transliteration_node()¶
- Returns:
- Return type:
- Gnm.conf_get_toolbar_style()¶
- Return type:
- Gnm.conf_get_toolbar_style_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_undo_dir_node()¶
- Returns:
- Return type:
- Gnm.conf_get_undo_max_descriptor_width_node()¶
- Returns:
- Return type:
- Gnm.conf_get_undo_maxnum_node()¶
- Returns:
- Return type:
- Gnm.conf_get_undo_show_sheet_name_node()¶
- Returns:
- Return type:
- Gnm.conf_get_undo_size_node()¶
- Returns:
- Return type:
- Gnm.conf_set_core_gui_editing_enter_moves_dir(x)¶
- Parameters:
x (
GOffice.Direction
) –
- Gnm.conf_set_core_gui_toolbars_format_position(x)¶
- Parameters:
x (
Gtk.PositionType
) –
- Gnm.conf_set_core_gui_toolbars_object_position(x)¶
- Parameters:
x (
Gtk.PositionType
) –
- Gnm.conf_set_core_gui_toolbars_standard_position(x)¶
- Parameters:
x (
Gtk.PositionType
) –
- Gnm.conf_set_page_setup(setup)¶
- Parameters:
setup (
Gtk.PageSetup
) –
- Gnm.conf_set_persistence(persist)¶
- Parameters:
persist (
bool
) – whether to save changes
If persist is
True
, then changes from this point on will not be saved.
- Gnm.conf_set_print_settings(settings)¶
- Parameters:
settings (
Gtk.PrintSettings
) –
- Parameters:
x ([
str
]) – list of strings
- Gnm.conf_set_stf_export_format(x)¶
- Parameters:
x (
Gnm.StfFormatMode
) –
- Gnm.conf_set_stf_export_quoting(x)¶
- Parameters:
x (
Gsf.OutputCsvQuotingMode
) –
- Gnm.conf_set_toolbar_position(name, x)¶
- Parameters:
name (
str
) –x (
Gtk.PositionType
) –
- Gnm.conf_set_toolbar_style(x)¶
- Parameters:
x (
Gtk.ToolbarStyle
) –
- Gnm.convert_to_tooltip(ref_widget, widget)¶
- Parameters:
ref_widget (
Gtk.Widget
) –widget (
Gtk.Widget
) –
- Returns:
widget
- Return type:
- Gnm.cot(x)¶
- Gnm.coth(x)¶
- Parameters:
elements (
Gnm.PopupMenuElement
) –handler (
Gnm.PopupMenuHandler
) –display_filter (
int
) –sensitive_filter (
int
) –event (
Gdk.Event
) –
- Gnm.create_tooltip(ref_widget)¶
- Parameters:
ref_widget (
Gtk.Widget
) –- Returns:
the newly allocated
Gtk.Widget
.- Return type:
- Gnm.data_shuffling_free(st)¶
- Parameters:
st (
Gnm.data_shuffling_t
) –
- Gnm.data_shuffling_redo(st)¶
- Parameters:
st (
Gnm.data_shuffling_t
) –
- Gnm.datetime_value_to_g(res, v, conv)¶
- Parameters:
res (
GLib.Date
) –v (
Gnm.Value
) –conv (
GOffice.DateConventions
) –
- Return type:
- Gnm.datetime_value_to_seconds(v, conv)¶
- Parameters:
v (
Gnm.Value
) –conv (
GOffice.DateConventions
) –
- Return type:
- Gnm.datetime_value_to_serial(v, conv)¶
- Parameters:
v (
Gnm.Value
) –conv (
GOffice.DateConventions
) –
- Return type:
- Gnm.datetime_value_to_serial_raw(v, conv)¶
- Parameters:
v (
Gnm.Value
) –conv (
GOffice.DateConventions
) –
- Return type:
- Gnm.dbeta(x, a, b, give_log)¶
- Gnm.dbinom(x, n, psuc, give_log)¶
- Gnm.dbinom_raw(x, n, p, q, give_log)¶
- Gnm.dcauchy(x, location, scale, give_log)¶
- Gnm.dchisq(x, df, give_log)¶
- Gnm.dependent_managed_get_expr(dep)¶
- Parameters:
dep (
Gnm.DepManaged
) –- Return type:
- Gnm.dependent_managed_init(dep, sheet)¶
- Parameters:
dep (
Gnm.DepManaged
) –sheet (
Gnm.Sheet
) –
- Gnm.dependent_managed_set_expr(dep, texpr)¶
- Parameters:
dep (
Gnm.DepManaged
) –texpr (
Gnm.ExprTop
) –
- Gnm.dependent_managed_set_sheet(dep, sheet)¶
- Parameters:
dep (
Gnm.DepManaged
) –sheet (
Gnm.Sheet
) –
- Gnm.dependent_type_register(klass)¶
- Parameters:
klass (
Gnm.DependentClass
) –- Return type:
- Gnm.dependent_types_init()¶
- Gnm.dependent_types_shutdown()¶
- Gnm.dependents_dump(wb)¶
- Parameters:
wb (
Gnm.Workbook
) –
- Gnm.dependents_link(deps)¶
- Parameters:
deps ([
Gnm.Dependent
]) – An slist of dependents.
link a list of dependents. (The list used to get freed, but is not freed anymore.)
- Gnm.dependents_relocate(info)¶
- Parameters:
info (
Gnm.ExprRelocateInfo
) – the descriptor record for what is being moved where.- Returns:
a list of the locations and expressions that were changed outside of the region.
- Return type:
Fixes references to or from a region that is going to be moved.
- Gnm.dependents_workbook_destroy(wb)¶
- Parameters:
wb (
Gnm.Workbook
) –
- Gnm.dexp(x, scale, give_log)¶
- Gnm.df(x, n1, n2, give_log)¶
- Parameters:
- Returns:
density of the F distribution.
- Return type:
- Gnm.dgamma(x, shape, scale, give_log)¶
- Gnm.dgeom(x, psuc, give_log)¶
- Gnm.dhyper(x, r, b, n, give_log)¶
- Gnm.dialog_about(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.dialog_advanced_filter(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
Show the dialog (guru).
- Gnm.dialog_anova_single_factor_tool(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
- Return type:
- Gnm.dialog_anova_two_factor_tool(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
- Return type:
Show the dialog (guru).
- Gnm.dialog_auto_filter(wbcg, f, i, is_expr, cur)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –f (
Gnm.Filter
) –i (
int
) –is_expr (
bool
) –cur (
Gnm.FilterCondition
) –
- Gnm.dialog_autoformat(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) – the control that invoked this dialog
This function will show the AutoFormatTemplate dialog and apply the template the user chooses to the current selection in the active sheet of the
GOffice.workbook
if the user desires.
- Gnm.dialog_autosave(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.dialog_autosave_prompt(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –- Return type:
- Gnm.dialog_average_tool(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
- Return type:
Show the dialog (guru).
- Gnm.dialog_cell_comment(wbcg, sheet, pos)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –pos (
Gnm.CellPos
) –
- Gnm.dialog_cell_format(wbcg, pageno, pages)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –pageno (
Gnm.FormatDialogPosition_t
) –pages (
int
) –
- Gnm.dialog_cell_format_cond(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.dialog_cell_format_select_style(wbcg, pages, w, style, closure)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –pages (
int
) –w (
Gtk.Window
) –style (
Gnm.Style
) –
- Returns:
a
Gtk.Dialog
.- Return type:
- Gnm.dialog_cell_format_style_added(closure, style)¶
- Gnm.dialog_cell_sort(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.dialog_chi_square_tool(wbcg, sheet, independence)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –independence (
bool
) –
- Return type:
- Gnm.dialog_col_width(wbcg, set_default)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –set_default (
bool
) –
- Gnm.dialog_consolidate(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.dialog_correlation_tool(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
- Return type:
Show the dialog (guru).
- Gnm.dialog_covariance_tool(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
- Return type:
Show the dialog (guru).
- Gnm.dialog_data_slicer(wbcg, create)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –create (
bool
) –
- Gnm.dialog_data_table(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.dialog_define_names(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
Create and show the define names dialog.
- Gnm.dialog_delete_cells(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.dialog_descriptive_stat_tool(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
- Return type:
Show the dialog (guru).
- Gnm.dialog_doc_metadata_new(wbcg, page)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –Gnm.WBCGtk
page (
int
) –
Creates a new instance of the dialog.
- Gnm.dialog_exp_smoothing_tool(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
- Return type:
Show the dialog (guru).
- Gnm.dialog_fill_series(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.dialog_formula_guru(wbcg, func)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) – TheGOffice.workbook
to use as a parent window.func (
Gnm.Func
) –
Pop up a function selector then a formula guru.
- Gnm.dialog_fourier_tool(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
- Return type:
Show the dialog (guru).
- Gnm.dialog_frequency_tool(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
- Return type:
Show the dialog (guru).
- Gnm.dialog_ftest_tool(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
- Return type:
Show the dialog (guru).
- Gnm.dialog_function_select(wbcg, key)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –key (
str
) –
- Gnm.dialog_function_select_help(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.dialog_function_select_paste(wbcg, from_, to)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –from (
int
) –to (
int
) –
- Gnm.dialog_get_password(parent, filename)¶
- Parameters:
parent (
Gtk.Window
) –filename (
str
) –
- Return type:
- Gnm.dialog_goal_seek(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
Create the dialog (guru).
- Gnm.dialog_goto_cell(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.dialog_histogram_tool(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
- Return type:
Show the dialog (guru).
- Gnm.dialog_hyperlink(wbcg, sc)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sc (
Gnm.SheetControl
) –
- Gnm.dialog_insert_cells(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.dialog_kaplan_meier_tool(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
- Return type:
Show the dialog (guru).
- Gnm.dialog_merge(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.dialog_new_view(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.dialog_normality_tool(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
- Return type:
Show the dialog (guru).
- Gnm.dialog_one_mean_test_tool(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
- Return type:
- Gnm.dialog_paste_names(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
Create and show the define names dialog.
- Gnm.dialog_paste_special(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.dialog_plugin_manager(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.dialog_preferences(wbcg, page)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –page (
str
) –
- Gnm.dialog_principal_components_tool(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
- Return type:
Show the dialog (guru).
- Gnm.dialog_printer_setup(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
- Gnm.dialog_quit(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.dialog_raise_if_exists(wbcg, key)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) – AGnm.WBCGtk
key (
str
) – A key to identify the dialog
- Returns:
existing dialog
- Return type:
Gtk.Dialog
orNone
Raise the dialog identified by key if it is registered on the wbcg.
- Gnm.dialog_random_cor_tool(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
- Return type:
Show the dialog (guru).
- Gnm.dialog_random_tool(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
- Return type:
Show the dialog (guru).
- Gnm.dialog_ranking_tool(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
- Return type:
Show the dialog (guru).
- Gnm.dialog_recent_used(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.dialog_regression_tool(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
- Return type:
Show the dialog (guru).
- Gnm.dialog_row_height(wbcg, set_default)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –set_default (
bool
) –
- Gnm.dialog_sampling_tool(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
- Return type:
Show the dialog (guru).
- Gnm.dialog_scenario_add(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.dialog_scenarios(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.dialog_search(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.dialog_search_replace_query(wbcg, sr, location, old_text, new_text)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sr (
Gnm.SearchReplace
) –location (
str
) –old_text (
str
) –new_text (
str
) –
- Return type:
- Gnm.dialog_setup_destroy_handlers(dialog, wbcg, what)¶
- Parameters:
dialog (
Gtk.Dialog
) –wbcg (
Gnm.WBCGtk
) –what (
Gnm.DialogDestroyOptions
) –
- Gnm.dialog_sheet_compare(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.dialog_sheet_order(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.dialog_sheet_rename(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
- Gnm.dialog_sheet_resize(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.dialog_shuffle(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
Show the dialog (guru).
- Gnm.dialog_sign_test_tool(wbcg, sheet, type)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –type (
Gnm.signtest_type
) –
- Return type:
- Gnm.dialog_sign_test_two_tool(wbcg, sheet, type)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –type (
Gnm.signtest_type
) –
- Return type:
- Gnm.dialog_simulation(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
Show the dialog (guru).
- Gnm.dialog_so_list(wbcg, so)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –so (
GObject.Object
) –
- Gnm.dialog_so_size(wbcg, so)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –so (
GObject.Object
) –
- Gnm.dialog_so_styled(wbcg, so, default_style, title, extent)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –so (
GObject.Object
) –default_style (
GOffice.Style
) –title (
str
) –extent (
Gnm.so_styled_t
) –
- Gnm.dialog_solver(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
Create the dialog (guru).
- Gnm.dialog_tabulate(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
- Gnm.dialog_tool_preset_to_range(state)¶
- Parameters:
state (
Gnm.GenericToolState
) –
- Gnm.dialog_ttest_tool(wbcg, sheet, test)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –test (
Gnm.ttest_type
) –
- Return type:
Show the dialog (guru).
- Gnm.dialog_wilcoxon_m_w_tool(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
- Return type:
- Gnm.dialog_workbook_attr(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.dialog_zoom(wbcg, sheet)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –sheet (
Gnm.Sheet
) –
- Gnm.diff_sheets(actions, user, old_sheet, new_sheet)¶
- Gnm.diff_workbooks(actions, user, old_wb, new_wb)¶
- Parameters:
actions (
Gnm.DiffActions
) –old_wb (
Gnm.Workbook
) –new_wb (
Gnm.Workbook
) –
- Return type:
- Gnm.digamma(x)¶
- Gnm.discpfuncinverter(p, shape, lower_tail, log_p, xlow, xhigh, x0, pfunc)¶
- Parameters:
- Return type:
Discrete pfuncs only. (Specifically: only integer x are allowed).
- Gnm.dlnorm(x, logmean, logsd, give_log)¶
- Parameters:
- Returns:
density of the log-normal distribution.
- Return type:
- Gnm.dnbinom(x, n, psuc, give_log)¶
- Gnm.dnorm(x, mu, sigma, give_log)¶
- Gnm.do_tabulation(wbc, data)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) – controldata (
Gnm.TabulateInfo
) –
- Return type:
[
int
]
- Gnm.dpois(x, lambda_, give_log)¶
- Gnm.dpois_raw(x, lambda_, give_log)¶
- Gnm.drayleigh(x, scale, give_log)¶
- Gnm.dt(x, n, give_log)¶
- Gnm.dweibull(x, shape, scale, give_log)¶
- Gnm.editable_enters(window, editable)¶
- Parameters:
window (
Gtk.Window
) – dialog to affect.editable (
Gtk.Widget
) – Editable to affect.
Make the “activate” signal of an editable click the default dialog button.
This is a literal copy of gnome_dialog_editable_enters, but not restricted to GnomeDialogs.
Normally if there’s an editable widget (such as
Gtk.Entry
) in your dialog, pressing Enter will activate the editable rather than the default dialog button. However, in most cases, the user expects to type something in and then press enter to close the dialog. This function enables that behavior.
- Gnm.entry_to_float_with_format(entry, the_float, update, format)¶
- Parameters:
entry (
Gtk.Entry
) –the_float (
float
) –update (
bool
) –format (
GOffice.Format
) –
- Return type:
- Gnm.entry_to_float_with_format_default(entry, the_float, update, format, num)¶
- Gnm.entry_to_int(entry, the_int, update)¶
-
Retrieve an int from an entry field parsing all reasonable formats
- Gnm.error_in_entry(state, entry, err_str)¶
- Parameters:
state (
Gnm.GenericToolState
) –entry (
Gtk.Widget
) –err_str (
str
) –
Show an error dialog and select corresponding entry
- Gnm.eval_info_get_arg_count(ei)¶
- Parameters:
ei (
Gnm.FuncEvalInfo
) –- Return type:
- Gnm.eval_info_get_func(ei)¶
- Parameters:
ei (
Gnm.FuncEvalInfo
) –Gnm.FuncEvalInfo
- Returns:
the called function.
- Return type:
- Gnm.excel_search_impl(needle, haystack, skip)¶
- Parameters:
needle (
str
) – the pattern to search for, seeGnm.regcomp_XL
.haystack (
str
) – the string to search in.skip (
int
) – zero-based search start point in characters.
- Returns:
-1 for a non-match, or zero-based location in characters.
The is the implementation of Excel’s SEARCH function. However, note that skip and return
GOffice.value
are zero-based.- Return type:
- Gnm.expmx2h(x)¶
- Gnm.expr_cell_deriv(y, x)¶
- Parameters:
- Returns:
The derivative of cell y with respect to cell x.
- Return type:
Gnm.ExprTop
orNone
- Gnm.expr_cell_deriv_value(y, x)¶
- Gnm.expr_conv_quote(convs, str)¶
- Parameters:
convs (
Gnm.Conventions
) –Gnm.Conventions
str (
str
) – string to quote
- Returns:
A quoted string according to convs. If no quoting is necessary, a literal copy of str will be returned.
- Return type:
- Gnm.expr_deriv_shutdown_()¶
- Gnm.expr_lex_all(str, pp, flags, convs)¶
- Parameters:
str (
str
) –pp (
Gnm.ParsePos
) –flags (
Gnm.ExprParseFlags
) –convs (
Gnm.Conventions
) –
- Return type:
- Gnm.expr_list_as_string(argc, argv, out)¶
- Parameters:
argc (
int
) –argv (
Gnm.Expr
) –out (
Gnm.ConventionsOut
) –
- Gnm.expr_list_copy(list)¶
- Gnm.expr_list_unref(list)¶
- Parameters:
list ([
object
]) – expression list
This frees list and all the expressions in it.
- Gnm.expr_name_add_dep(nexpr, dep)¶
- Parameters:
nexpr (
Gnm.NamedExpr
) –dep (
Gnm.Dependent
) –
- Gnm.expr_name_as_string(nexpr, pp, fmt)¶
- Parameters:
nexpr (
Gnm.NamedExpr
) – AGnm.NamedExpr
pp (
Gnm.ParsePos
orNone
) – Position where name was defined.fmt (
Gnm.Conventions
) –Gnm.Conventions
describing how to render nexpr
- Returns:
The rendering of nexpr given convention fmt.
- Return type:
- Gnm.expr_name_check_for_loop(name, texpr)¶
- Parameters:
name (
str
) – tentative nametexpr (
Gnm.ExprTop
) – tentative expression
- Returns:
True
if defining the tentative name would cause a circular name reference.NOTE: if we already have a circular reference beforehand, we will come to serious grief.
- Return type:
- Gnm.expr_name_cmp_by_name(a, b)¶
- Parameters:
a (
Gnm.NamedExpr
) –b (
Gnm.NamedExpr
) –
- Return type:
- Gnm.expr_name_downgrade_to_placeholder(nexpr)¶
- Parameters:
nexpr (
Gnm.NamedExpr
) –
Takes a real non-placeholder name and converts it to being a placeholder. unrefing its expression
- Gnm.expr_name_eval(nexpr, pos, flags)¶
- Parameters:
nexpr (
Gnm.NamedExpr
) – AGnm.NamedExpr
pos (
Gnm.EvalPos
) – Position where evaluation takes placeflags (
Gnm.ExprEvalFlags
) –Gnm.ExprEvalFlags
flags describing context.
- Returns:
The resulting
GOffice.value
.- Return type:
- Gnm.expr_name_in_use(nexpr)¶
- Parameters:
nexpr (
Gnm.NamedExpr
) – A named expression.- Returns:
True
, if the named expression appears to be in use. This is an approximation only, as we only look at theGOffice.workbook
in which the name is defined.- Return type:
- Gnm.expr_name_is_active(nexpr)¶
- Parameters:
nexpr (
Gnm.NamedExpr
) –- Return type:
- Gnm.expr_name_is_placeholder(ne)¶
- Parameters:
ne (
Gnm.NamedExpr
) –- Returns:
True
if ne is a placeholder for an unknown name- Return type:
- Gnm.expr_name_lookup(pos, name)¶
- Parameters:
pos (
Gnm.ParsePos
) –Gnm.ParsePos
identifying aGnm.Sheet
or aGnm.Workbook
.name (
str
) – name ofGnm.NamedExpr
to look up.
- Returns:
Gnm.NamedExpr
named name in the scope given by pos;None
if no suchGnm.NamedExpr
exists.- Return type:
- Gnm.expr_name_name(nexpr)¶
- Parameters:
nexpr (
Gnm.NamedExpr
) –- Return type:
- Gnm.expr_name_new(name)¶
- Parameters:
name (
str
) –- Return type:
Creates a new name without linking it into any container.
- Gnm.expr_name_perm_add(sheet, name, texpr, is_editable)¶
- Parameters:
sheet (
Gnm.Sheet
) –name (
str
) – nametexpr (
Gnm.ExprTop
) – string to be theGOffice.value
of the nameis_editable (
bool
) – whether this is a predefined action
This is a wrapper around expr_name_add to set this as permanent name.
- Gnm.expr_name_ref(nexpr)¶
- Parameters:
nexpr (
Gnm.NamedExpr
) –- Return type:
- Gnm.expr_name_remove(nexpr)¶
- Parameters:
nexpr (
Gnm.NamedExpr
) –
Remove a nexpr from its container and deactivate it. NOTE : nexpr may continue to exist if things still have references to it, but they will evaluate to #REF!
- Gnm.expr_name_remove_dep(nexpr, dep)¶
- Parameters:
nexpr (
Gnm.NamedExpr
) –dep (
Gnm.Dependent
) –
- Gnm.expr_name_set_expr(nexpr, texpr)¶
- Parameters:
nexpr (
Gnm.NamedExpr
) –Gnm.NamedExpr
to changetexpr (
Gnm.ExprTop
orNone
) – the new contents
Set the content of nexpr to texpr.
- Gnm.expr_name_set_expr_undo_new(nexpr)¶
- Parameters:
nexpr (
Gnm.NamedExpr
) –Gnm.NamedExpr
- Return type:
- Gnm.expr_name_set_is_placeholder(nexpr, is_placeholder)¶
- Parameters:
nexpr (
Gnm.NamedExpr
) –is_placeholder (
bool
) –
- Gnm.expr_name_set_name(nexpr, new_name)¶
- Parameters:
nexpr (
Gnm.NamedExpr
) – the named expressionnew_name (
str
) – the new name of the expression
- Returns:
True
on error.- Return type:
- Gnm.expr_name_set_pos(nexpr, pp)¶
- Parameters:
nexpr (
Gnm.NamedExpr
) – the named expressionpp (
Gnm.ParsePos
) – the new position
- Return type:
Returns a translated error string which the caller must free if something goes wrong.
- Gnm.expr_name_unref(nexpr)¶
- Parameters:
nexpr (
Gnm.NamedExpr
) –
- Gnm.expr_name_validate(name)¶
- Gnm.expr_parse_str(str, pp, flags, convs, error)¶
- Parameters:
str (
str
) –pp (
Gnm.ParsePos
) –flags (
Gnm.ExprParseFlags
) –convs (
Gnm.Conventions
) –error (
Gnm.ParseError
) –
- Return type:
- Gnm.fact(x)¶
- Gnm.file_saver_common_export_option(fs, wb, key, value)¶
- Parameters:
fs (
GOffice.FileSaver
) –wb (
Gnm.Workbook
) –key (
str
) –value (
str
) –
- Raises:
- Return type:
- Gnm.file_saver_get_sheet(fs, wbv)¶
- Parameters:
wbv (
Gnm.WorkbookView
) –Gnm.WorkbookView
- Returns:
the sheet to export
- Return type:
For a single-sheet saver, this function determines what sheet to save.
- Gnm.file_saver_get_sheets(fs, wbv, default_all)¶
- Parameters:
wbv (
Gnm.WorkbookView
) –Gnm.WorkbookView
default_all (
bool
) – IfTrue
, all sheets will be selected by default; ifFalse
, this function will returnNone
if no sheets were explicitly selected.
- Returns:
the sheets to export
Note: the return
GOffice.value
should be unreffed, not freed.- Return type:
This function determines what sheets to save.
- Gnm.fill_series_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.filter_show_all(wbc)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –
- Gnm.find_column_of_field(ep, database, field)¶
- Parameters:
ep (
Gnm.EvalPos
) –database (
Gnm.Value
) –field (
Gnm.Value
) –
- Return type:
- Gnm.find_rows_that_match(sheet, first_col, first_row, last_col, last_row, criterias, unique_only)¶
- Parameters:
- Returns:
the list of matching rows.
- Return type:
[
int
]
Finds the rows from the given database that match the criteria.
- Gnm.float_range_function(argv, ei, func, flags, func_error)¶
- Parameters:
argv ([
Gnm.Expr
]) – function argumentsei (
Gnm.FuncEvalInfo
) –Gnm.FuncEvalInfo
describing evaluation contextfunc (
Gnm.float_range_function_t
) – implementation functionflags (
Gnm.CollectFlags
) –Gnm.CollectFlags
flags describing the collection and interpretation of values from argv.func_error (
Gnm.StdError
) – AGnm.StdError
to use to func indicates an error.
- Returns:
Function result or error
GOffice.value
.- Return type:
This implements a Gnumeric sheet function that operates on a list of numbers. This function collects the arguments and uses func to do the actual computation.
- Gnm.float_range_function2(val0, val1, ei, func, flags, func_error)¶
- Parameters:
val0 (
Gnm.Value
) – First rangeval1 (
Gnm.Value
) – Second rangeei (
Gnm.FuncEvalInfo
) –Gnm.FuncEvalInfo
describing evaluation contextfunc (
Gnm.float_range_function2_t
) – implementation functionflags (
Gnm.CollectFlags
) –Gnm.CollectFlags
flags describing the collection and interpretation of values from val0 and val1.func_error (
Gnm.StdError
) – AGnm.StdError
to use to func indicates an error.
- Returns:
Function result or error
GOffice.value
.- Return type:
This implements a Gnumeric sheet function that operates on a matched pair of ranges. This function collects the arguments and uses func to do the actual computation.
- Gnm.float_range_function2d(val0, val1, ei, func, flags, func_error, *data)¶
- Parameters:
val0 (
Gnm.Value
) – First rangeval1 (
Gnm.Value
) – Second rangeei (
Gnm.FuncEvalInfo
) –Gnm.FuncEvalInfo
describing evaluation contextfunc (
Gnm.float_range_function2d_t
) – implementation functionflags (
Gnm.CollectFlags
) –Gnm.CollectFlags
flags describing the collection and interpretation of values from val0 and val1.func_error (
Gnm.StdError
) – AGnm.StdError
to use to func indicates an error.
- Returns:
Function result or error
GOffice.value
.- Return type:
This implements a Gnumeric sheet function that operates on a matched pair of ranges. This function collects the arguments and uses func to do the actual computation.
- Gnm.font_override_codepage(font_name)¶
-
Returns a codepage for the named Win32
Gnm.font
, or -1 if no such codepage is known.
- Gnm.format_has_hour(fmt, value)¶
- Parameters:
fmt (
GOffice.Format
) –value (
Gnm.Value
) –
- Return type:
- Gnm.format_import(fmt, flags)¶
- Parameters:
fmt (
str
) –flags (
Gnm.FormatImportFlags
) –
- Return type:
- Gnm.format_is_date_for_value(fmt, value)¶
- Parameters:
fmt (
GOffice.Format
) –value (
Gnm.Value
) –
- Return type:
- Gnm.format_is_time_for_value(fmt, value)¶
- Parameters:
fmt (
GOffice.Format
) –value (
Gnm.Value
) –
- Return type:
- Gnm.format_layout(result, metrics, format, value, col_width, date_conv, unicode_minus)¶
- Parameters:
result (
Pango.Layout
) –metrics (
GOffice.FontMetrics
) –format (
GOffice.Format
) –value (
Gnm.Value
) –col_width (
int
) –date_conv (
GOffice.DateConventions
) –unicode_minus (
bool
) –
- Return type:
- Gnm.format_match(text, cur_fmt, date_conv)¶
- Parameters:
text (
str
) – The text to parsecur_fmt (
GOffice.Format
orNone
) – The current format for theGOffice.value
date_conv (
GOffice.DateConventions
) – optional date convention
- Return type:
Attempts to parse the supplied string to see if it matches a known
GOffice.value
format. The caller is responsible for releasing the resultingGOffice.value
.
- Gnm.format_match_datetime(text, date_conv, month_before_day, add_format, presume_date)¶
- Gnm.format_match_decimal_number_with_locale(text, family, curr, thousand, decimal)¶
- Parameters:
text (
str
) –family (
GOffice.FormatFamily
) –curr (
GLib.String
) –thousand (
GLib.String
) –decimal (
GLib.String
) –
- Return type:
- Gnm.format_match_number(text, cur_fmt, date_conv)¶
- Parameters:
text (
str
) – The text to parsecur_fmt (
GOffice.Format
orNone
) – The current format for theGOffice.value
date_conv (
GOffice.DateConventions
) – optional date convention
- Return type:
Attempts to parse the supplied string to see if it matches a known
GOffice.value
format. Will eventually use the current cell format in preference to canned formats. If format is supplied it will get a copy of the matching format with no additional references. The caller is responsible for releasing the resultingGOffice.value
. Will ONLY return numbers.
- Gnm.format_match_simple(text)¶
-
Attempt to match the supplied string as a simple
GOffice.value
.WARNING WARNING WARNING : This routine should NEVER be changed to match
Gnm.ValueType.STRING
that will break the parsers handling of named expressions.
- Gnm.format_month_before_day(fmt, value)¶
- Parameters:
fmt (
GOffice.Format
) –value (
Gnm.Value
) –
- Return type:
- Gnm.format_sel_new()¶
- Returns:
a new format selector
- Return type:
- Gnm.format_sel_set_value(nfs, value)¶
- Parameters:
nfs (
GOffice.FormatSel
) –value (
Gnm.Value
) –
- Gnm.format_specialize(fmt, value)¶
- Parameters:
fmt (
GOffice.Format
) –value (
Gnm.Value
) –
- Return type:
- Gnm.format_value(format, value, col_width, date_conv)¶
- Parameters:
format (
GOffice.Format
) –value (
Gnm.Value
) –col_width (
int
) –date_conv (
GOffice.DateConventions
) –
- Return type:
- Gnm.format_value_gstring(str, format, value, col_width, date_conv)¶
- Parameters:
str (
GLib.String
) – append the result here.format (
GOffice.Format
orNone
) –GOffice.Format
.col_width (
int
) – maximum width in characters, -1 for unlimiteddate_conv (
GOffice.DateConventions
) –GOffice.DateConventions
.
- Return type:
- Gnm.format_value_layout(layout, format, value, col_width, date_conv)¶
- Parameters:
layout (
Pango.Layout
) – APango.Layout
format (
GOffice.Format
orNone
) –GOffice.Format
.col_width (
int
) – optional limit on width, -1 for unlimiteddate_conv (
GOffice.DateConventions
) –GOffice.DateConventions
.
- Return type:
- Gnm.free_criterias(criterias)¶
- Parameters:
criterias ([
Gnm.Criteria
]) – the criteria to be freed. Frees the allocated memory.
- Gnm.ft_category_group_cmp(a, b)¶
- Gnm.ft_category_group_list_free(category_groups)¶
- Parameters:
category_groups ([
Gnm.FTCategoryGroup
]) – the list to free.
- Gnm.ft_category_group_list_get()¶
- Returns:
the list of
Gnm.FTCategoryGroup
which should be freed usingGnm.FTCategoryGroup.list_free
().- Return type:
- Gnm.ft_compare_name(a, b)¶
- Gnm.func_group_fetch(name, translation)¶
- Parameters:
- Return type:
- Gnm.function_call_with_exprs(ei)¶
- Parameters:
ei (
Gnm.FuncEvalInfo
) – EvalInfo containing valid fn_def!- Return type:
Do the guts of calling a function.
Returns the result.
- Gnm.function_call_with_values(ep, name, argc, values)¶
- Parameters:
ep (
Gnm.EvalPos
) –name (
str
) –argc (
int
) –values (
Gnm.Value
) –
- Return type:
- Gnm.function_def_call_with_values(ep, fn, argc, values)¶
- Parameters:
ep (
Gnm.EvalPos
) –fn (
Gnm.Func
) –argc (
int
) –values (
Gnm.Value
) –
- Return type:
- Gnm.function_iterate_argument_values(ep, callback, callback_closure, argc, argv, strict, iter_flags)¶
- Parameters:
ep (
Gnm.EvalPos
) – The position in aGOffice.workbook
at which to evaluatecallback (
Gnm.FunctionIterateCB
) – The routine to be invoked for everyGOffice.value
computedcallback_closure (
object
orNone
) – Closure for the callback.argc (
int
) –argv (
Gnm.Expr
) –strict (
bool
) – IfTrue
, the function is considered “strict”. This means that if an errorGOffice.value
occurs as an argument, the iteration will stop and that error will be returned. IfFalse
, an error will be passed on to the callback (as aGnm.Value
* of typeGnm.ValueType.ERROR
).iter_flags (
Gnm.CellIterFlags
) –
- Returns:
None
: if no errors were reported.Gnm.Value
* : if an error was found during strict evaluation VALUE_TERMINATE : if the callback requested termination of the iteration.This routine provides a simple way for internal functions with variable number of arguments to be written: this would iterate over a list of expressions (expr_node_list) and will invoke the callback for every
Gnm.Value
found on the list (this means that ranges get properly expanded).- Return type:
- Gnm.gamma(x)¶
- Gnm.get_link_color(widget, res)¶
- Parameters:
widget (
Gtk.Widget
) –res (
Gdk.RGBA
) –
- Gnm.get_pango_attributes_from_buffer(buffer)¶
- Parameters:
buffer (
Gtk.TextBuffer
) –- Return type:
- Gnm.global_range_contained(sheet, a, b)¶
- Gnm.global_range_list_foreach(gr_list, ep, flags, handler, closure)¶
- Parameters:
gr_list ([
Gnm.Range
]) – list of ranges.ep (
Gnm.EvalPos
) –flags (
Gnm.CellIterFlags
) –handler (
Gnm.CellIterFunc
) –
- Return type:
- Gnm.global_range_list_parse(sheet, str)¶
- Parameters:
- Returns:
a
GLib.SList
ofGnm.Value
.- Return type:
Parses a list of ranges, relative to the sheet and returns a list with the results.
- Gnm.go_data_foreach_dep(dat, so, func, user)¶
- Parameters:
dat (
GOffice.Data
) –GOffice.Data
so (
Gnm.SheetObject
) –Gnm.SheetObject
func (
Gnm.SheetObjectForeachDepFunc
) –
- Gnm.go_data_get_expr(dat)¶
- Parameters:
dat (
GOffice.Data
) –- Return type:
- Gnm.go_data_get_sheet(dat)¶
- Parameters:
dat (
GOffice.Data
) –GOffice.Data
- Returns:
the sheet.
- Return type:
- Gnm.go_data_set_sheet(dat, sheet)¶
- Parameters:
dat (
GOffice.Data
) –sheet (
Gnm.Sheet
) –
- Gnm.go_error_info_dialog_create(error)¶
- Parameters:
error (
GOffice.ErrorInfo
) –- Returns:
the newly allocated dialog.
- Return type:
SHOULD BE IN GOFFICE
- Gnm.go_error_info_dialog_show(parent, error)¶
- Parameters:
parent (
Gtk.Window
) –error (
GOffice.ErrorInfo
) –
- Gnm.go_error_info_list_dialog_show(parent, errs)¶
- Parameters:
parent (
Gtk.Window
) –errs ([
GOffice.ErrorInfo
]) –
- Gnm.goal_seek_bisection(f, data, *user_data)¶
- Parameters:
f (
Gnm.GoalSeekFunction
) – object functiondata (
Gnm.GoalSeekData
) –Gnm.GoalSeekData
state.
- Return type:
Seek a goal (root) using bisection methods.
The supplied function must (should) be continuous over the interval.
Caller must have located a positive and a negative point.
This method will find a root steadily using bisection to narrow the interval in which a root lies.
It alternates between mid-point-bisection (semi-slow, but guaranteed progress), secant-bisection (usually quite fast, but sometimes gets nowhere), and Ridder’s Method (usually fast, harder to fool than the secant method).
- Gnm.goal_seek_cell(data, celldata)¶
- Parameters:
data (
Gnm.GoalSeekData
) –celldata (
Gnm.GoalSeekCellData
) –
- Return type:
- Gnm.goal_seek_eval_cell(x, data)¶
- Parameters:
- Returns:
An status indicating whether evaluation went ok.
- y:
location to store result
- Return type:
(
Gnm.GoalSeekStatus
, y:float
)
- Gnm.goal_seek_initialize(data)¶
- Parameters:
data (
Gnm.GoalSeekData
) –
- Gnm.goal_seek_newton(f, df, data, user_data, x0)¶
- Parameters:
f (
Gnm.GoalSeekFunction
) – object functiondf (
Gnm.GoalSeekFunction
orNone
) – object function derivativedata (
Gnm.GoalSeekData
) –Gnm.GoalSeekData
statex0 (
float
) – root guess
- Return type:
Seek a goal (root) using Newton’s iterative method.
The supplied function must (should) be continuously differentiable in the supplied interval. If df is
None
, this function will estimate the derivative.This method will find a root rapidly provided the initial guess, x0, is sufficiently close to the root. (The number of significant digits (asymptotically) goes like i^2 unless the root is a multiple root in which case it is only like c*i.)
- Gnm.goal_seek_point(f, data, user_data, x0)¶
- Parameters:
f (
Gnm.GoalSeekFunction
) – object functiondata (
Gnm.GoalSeekData
) –Gnm.GoalSeekData
statex0 (
float
) – root guess
- Return type:
Seek a goal using a single point.
- Gnm.goal_seek_trawl_normally(f, data, user_data, mu, sigma, points)¶
- Parameters:
f (
Gnm.GoalSeekFunction
) – object functiondata (
Gnm.GoalSeekData
) –Gnm.GoalSeekData
statemu (
float
) – search meansigma (
float
) – search standard deviationpoints (
int
) – number of points to try.
- Return type:
- Gnm.goal_seek_trawl_uniformly(f, data, user_data, xmin, xmax, points)¶
- Parameters:
f (
Gnm.GoalSeekFunction
) – object functiondata (
Gnm.GoalSeekData
) –Gnm.GoalSeekData
statexmin (
float
) – lower search boundxmax (
float
) – upper search boundpoints (
int
) – number of points to try.
- Return type:
- Gnm.gtk_builder_load(uifile, domain, cc)¶
- Parameters:
- Returns:
the newly allocated
Gtk.Builder
.- Return type:
Simple utility to open ui files
- Gnm.gtk_print_cell_range(context, sheet, range, base_x, base_y, pinfo)¶
- Parameters:
context (
cairo.Context
) –sheet (
Gnm.Sheet
) –range (
Gnm.Range
) –base_x (
float
) –base_y (
float
) –pinfo (
Gnm.PrintInformation
) –
- Gnm.gtk_radio_group_get_selected(radio_group)¶
- Parameters:
radio_group ([
Gtk.RadioButton
]) – list of radio buttons.- Returns:
the index of the selected radio button starting from list end.
- Return type:
- Gnm.gui_file_export_repeat(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –- Return type:
- Gnm.gui_file_open(wbcg, type, default_format)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –type (
Gnm.FileOpenStyle
) –default_format (
str
) –
- Gnm.gui_file_read(wbcg, file_name, optional_format, optional_encoding)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –file_name (
str
) –optional_format (
GOffice.FileOpener
) –optional_encoding (
str
) –
- Returns:
the new
Gnm.WorkbookView
for the file read.- Return type:
- Gnm.gui_file_save(wbcg, wbv)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –wbv (
Gnm.WorkbookView
) –
- Return type:
- Gnm.gui_file_save_as(wbcg, wbv, type, default_format)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –wbv (
Gnm.WorkbookView
) –type (
Gnm.FileSaveAsStyle
) –default_format (
str
) –
- Return type:
- Gnm.gui_file_template(wbcg, uri)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –uri (
str
) –
- Return type:
- Gnm.gui_wb_view_show(wbcg, wbv)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –wbv (
Gnm.WorkbookView
) –
- Gnm.gutils_init()¶
- Gnm.gutils_shutdown()¶
- Gnm.hash_table_foreach_ordered(h, callback, order, user)¶
- Parameters:
callback (
GLib.HFunc
) –GLib.HFunc
order (
Gnm.HashTableOrder
) – Ordering function
Like
GLib.HashTable.foreach
, but with an ordering imposed.
- Gnm.history_item_label(uri, accel_number)¶
- Gnm.ifs_func(data, crits, vals, fun, err, ep, flags)¶
- Parameters:
data ([
Gnm.Value
]) –crits ([
Gnm.Criteria
]) – criteriavals (
Gnm.Value
) –fun (
Gnm.float_range_function_t
) – function to evaluate on filtered dataerr (
Gnm.StdError
) – errorGOffice.value
in case fun fails.ep (
Gnm.EvalPos
) – evaluation positionflags (
Gnm.CollectFlags
) –Gnm.CollectFlags
flags describing the collection and interpretation of values from data.
- Returns:
Function result or error
GOffice.value
.- Return type:
This implements a Gnumeric sheet database function of the “*IFS” type This function collects the arguments and uses fun to do the actual computation.
- Gnm.init()¶
- Gnm.init_help_button(w, lnk)¶
- Parameters:
w (
Gtk.Widget
) –lnk (
str
) –
- Gnm.insert_meta_date(doc, name)¶
- Parameters:
doc (
GOffice.Doc
) –name (
str
) –
- Gnm.keyed_dialog(wbcg, dialog, key)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) – AGnm.WBCGtk
dialog (
Gtk.Window
) – A transient windowkey (
str
) – A key to identify the dialog
Make dialog a transient child of wbcg, attaching to wbcg object data to identify the dialog. The object data makes it possible to ensure that only one dialog of a kind can be displayed for a wbcg. Deallocation of the object data is managed here.
- Gnm.lambert_w(x, k)¶
- Gnm.lbeta3(a, b)¶
- Parameters:
- Returns:
the logarithm of the absolute
GOffice.value
of the Beta function evaluated at a and b. The sign will be stored in sign as -1 or +1. This function is useful because the result of the beta function can be too large for doubles.- sign:
the sign
- Return type:
- Gnm.linear_solve(A, b, x)¶
- Parameters:
A (
Gnm.Matrix
) –b (
float
) –x (
float
) –
- Return type:
- Gnm.linear_solve_multiple(A, B)¶
- Parameters:
A (
Gnm.Matrix
) –B (
Gnm.Matrix
) –
- Return type:
- Gnm.linear_solve_posdef(A, b, x)¶
- Parameters:
A (
Gnm.Matrix
) –b (
float
) –x (
float
) –
- Return type:
- Gnm.link_button_and_entry(button, entry)¶
- Parameters:
button (
Gtk.Widget
) –entry (
Gtk.Widget
) –
- Gnm.load_pango_attributes_into_buffer(markup, buffer, str)¶
- Parameters:
markup (
Pango.AttrList
) –buffer (
Gtk.TextBuffer
) –str (
str
) –
- Gnm.log1pmx(x)¶
- Gnm.logcf(x, i, d, tol)¶
- Gnm.make_rangeref(dx0, dy0, dx1, dy1)¶
- Gnm.mathfunc_init()¶
- Gnm.matrix_from_value(v, ep)¶
- Parameters:
ep (
Gnm.EvalPos
) – Evaluation location
- Returns:
A new
Gnm.Matrix
,None
on error.- perr:
Gnm.Value
with errorGOffice.value
- Return type:
(
Gnm.Matrix
orNone
, perr:Gnm.Value
)
- Gnm.message_dialog_create(parent, flags, type, primary_message, secondary_message)¶
- Parameters:
parent (
Gtk.Window
) –flags (
Gtk.DialogFlags
) –type (
Gtk.MessageType
) –primary_message (
str
) –secondary_message (
str
) –
- Returns:
a
Gtk.Dialog
, without buttons.- Return type:
A convenience function to build HIG compliant message dialogs.
parent : transient parent, or
None
for none. flags type : type of dialog primary_message : message displayed in bold secondary_message : message displayed below
- Gnm.object_get_bool(o, name)¶
- Parameters:
o (
object
orNone
) –GObject.Object
name (
str
) – property name
- Returns:
the
GOffice.value
of o's boolean property name.- Return type:
- Gnm.object_has_readable_prop(obj, property, typ)¶
- Parameters:
obj (
object
orNone
) –GObject.Object
property (
str
) – property nametyp (
GObject.GType
) – property’s type orGObject.TYPE_NONE
. (Exact type, not is-a.)
- Returns:
True
if obj has a readable property named property of type typ.- pres:
location to store property
GOffice.value
.
- Return type:
- Gnm.page_setup_get_paper(page_setup)¶
- Parameters:
page_setup (
Gtk.PageSetup
) –- Return type:
- Gnm.page_setup_set_paper(page_setup, paper)¶
- Parameters:
page_setup (
Gtk.PageSetup
) –paper (
str
) –
- Return type:
- Gnm.pango_attr_list_equal(l1, l2)¶
- Parameters:
l1 (
Pango.AttrList
) –l2 (
Pango.AttrList
) –
- Return type:
- Gnm.pango_context_get()¶
- Return type:
Simple wrapper to handle windowless operation
- Gnm.parse_criteria(crit_val, date_conv, anchor_end)¶
- Parameters:
date_conv (
GOffice.DateConventions
) –GOffice.DateConventions
anchor_end (
bool
) –
- Returns:
Gnm.Criteria
which caller must free.”>=:obj:GOffice.value" “<=:obj:GOffice.value" “<>:obj:GOffice.value" “<
GOffice.value
" “>:obj:GOffice.value" “=:obj:GOffice.value" “pattern”- Return type:
- Gnm.parse_database_criteria(ep, database, criteria)¶
- Parameters:
ep (
Gnm.EvalPos
) –Gnm.EvalPos
- Return type:
Parses the criteria cell range.
- Gnm.parse_text_value_or_expr(pos, text)¶
- Parameters:
pos (
Gnm.ParsePos
) – If the string looks like an expression parse it at this location.text (
str
) – The text to be parsed.
- Returns:
- val:
Returns a
Gnm.Value
if the text was aGOffice.value
, otherwiseNone
.- texpr:
Returns a
Gnm.ExprTop
if the text was an expression, otherwiseNone
.
- Return type:
(val:
Gnm.Value
, texpr:Gnm.ExprTop
orNone
)
Utility routine to parse a string and convert it into an expression or
GOffice.value
.If there is a parse failure for an expression an error
Gnm.Value
with the syntax error is returned in val.
- Gnm.parse_util_init()¶
- Gnm.parse_util_shutdown()¶
- Gnm.parsepos_as_string(pp)¶
- Parameters:
pp (
Gnm.ParsePos
) –- Return type:
- Gnm.pattern_background_set(mstyle, cr, is_selected, ctxt)¶
- Parameters:
mstyle (
Gnm.Style
) –cr (
cairo.Context
) –is_selected (
bool
) –ctxt (
Gtk.StyleContext
) –
- Returns:
True
if there is a background to paint.Set up a cairo context to paint the background of a cell.
- Return type:
- Gnm.pbeta(x, a, b, lower_tail, log_p)¶
- Parameters:
- Returns:
cumulative density of the beta distribution.
- Return type:
- Gnm.pbinom(x, n, psuc, lower_tail, log_p)¶
- Parameters:
- Returns:
cumulative density of the binomial distribution.
- Return type:
- Gnm.pbinom2(x0, x1, n, p)¶
- Gnm.pcauchy(x, location, scale, lower_tail, log_p)¶
- Gnm.pchisq(x, df, lower_tail, log_p)¶
- Parameters:
- Returns:
cumulative density of the 𝜒² distribution.
- Return type:
- Gnm.pexp(x, scale, lower_tail, log_p)¶
- Parameters:
- Returns:
cumulative density of the exponential distribution.
- Return type:
- Gnm.pf(x, n1, n2, lower_tail, log_p)¶
- Parameters:
x (
float
) – observationn1 (
float
) – the first number of degrees of freedom of the distributionn2 (
float
) – the first number of degrees of freedom of the distributionlower_tail (
bool
) – ifTrue
, the lower tail of the distribution is considered.log_p (
bool
) – ifTrue
, log of the result will be returned instead
- Returns:
cumulative density of the F distribution.
- Return type:
- Gnm.pfuncinverter(p, shape, lower_tail, log_p, xlow, xhigh, x0, pfunc, dpfunc_dx)¶
- Gnm.pgamma(x, shape, scale, lower_tail, log_p)¶
- Parameters:
- Returns:
cumulative density of the gamma distribution.
- Return type:
- Gnm.pgeom(x, psuc, lower_tail, log_p)¶
- Parameters:
- Returns:
cumulative density of the geometric distribution.
- Return type:
- Gnm.phyper(x, r, b, n, lower_tail, log_p)¶
- Parameters:
- Returns:
cumulative density of the hypergeometric distribution.
- Return type:
- Gnm.plnorm(x, logmean, logsd, lower_tail, log_p)¶
- Parameters:
x (
float
) – observationlogmean (
float
) – mean of the underlying normal distributionlogsd (
float
) – standard deviation of the underlying normal distributionlower_tail (
bool
) – ifTrue
, the lower tail of the distribution is considered.log_p (
bool
) – ifTrue
, log of the result will be returned instead
- Returns:
cumulative density of the log-normal distribution.
- Return type:
- Gnm.plugins_init(c)¶
- Parameters:
c (
GOffice.CmdContext
) –
- Gnm.pnbinom(x, n, psuc, lower_tail, log_p)¶
- Parameters:
- Returns:
cumulative density of the negative binomial distribution.
- Return type:
- Gnm.pnorm(x, mu, sigma, lower_tail, log_p)¶
- Parameters:
- Returns:
cumulative density of the normal distribution.
- Return type:
- Gnm.pochhammer(x, n)¶
- Parameters:
- Returns:
Pochhammer’s symbol (x)_`n`.
- Return type:
This function computes Pochhammer’s symbol at x and n, i.e., Gamma(x+`n`)/Gamma(x). This is well defined unless x or x+`n` is a non-negative integer. The ratio has a removable singlularity at n=0 and the result is 1.
-
Bring up a popup and if event is non-
None
ensure that the popup is on the right screen.
- Gnm.position_tooltip(tip, px, py, horizontal)¶
- Parameters:
tip (
Gtk.Widget
) –px (
int
) –py (
int
) –horizontal (
bool
) –
- Gnm.pow1p(x, y)¶
- Gnm.pow1pm1(x, y)¶
- Gnm.ppois(x, lambda_, lower_tail, log_p)¶
- Parameters:
- Returns:
cumulative density of the Poisson distribution.
- Return type:
- Gnm.prayleigh(x, scale, lower_tail, log_p)¶
- Gnm.pre_parse_init(argc, argv)¶
-
Initialization to be done before cmd line arguments are handled. Needs to be called first, before any other initialization.
- Gnm.pre_parse_shutdown()¶
- Gnm.prepare_input_range(input_range, group_by)¶
- Parameters:
input_range ([
Gnm.Range
]) –group_by (
Gnm.group_by_t
) –
- Return type:
input_range: [
Gnm.Range
]
- Gnm.print_hf_format_render(format, info, render_type)¶
- Parameters:
format (
str
) –info (
Gnm.PrintHFRenderInfo
) –render_type (
Gnm.PrintHFRenderType
) –
- Return type:
- Gnm.print_info_dup(pi)¶
- Parameters:
pi (
Gnm.PrintInformation
) –- Return type:
- Gnm.print_info_free(pi)¶
- Parameters:
pi (
Gnm.PrintInformation
) –
- Gnm.print_info_get_margins(pi)¶
- Gnm.print_info_get_page_setup(pi)¶
- Parameters:
- Returns:
the page setup.
- Return type:
- Gnm.print_info_get_paper(pi)¶
- Parameters:
pi (
Gnm.PrintInformation
) –- Return type:
- Gnm.print_info_get_paper_display_name(pi)¶
- Parameters:
- Returns:
the name of the selected paper type
- Return type:
- Gnm.print_info_get_paper_height(pi, unit)¶
- Parameters:
pi (
Gnm.PrintInformation
) –unit (
Gtk.Unit
) –
- Return type:
- Gnm.print_info_get_paper_orientation(pi)¶
- Parameters:
pi (
Gnm.PrintInformation
) –- Return type:
- Gnm.print_info_get_paper_size(pi)¶
- Parameters:
pi (
Gnm.PrintInformation
) –- Return type:
- Gnm.print_info_get_paper_width(pi, unit)¶
- Parameters:
pi (
Gnm.PrintInformation
) –unit (
Gtk.Unit
) –
- Return type:
- Gnm.print_info_get_printrange(pi)¶
- Parameters:
pi (
Gnm.PrintInformation
) –- Return type:
- Gnm.print_info_get_printtofile_uri(pi)¶
- Parameters:
pi (
Gnm.PrintInformation
) – GnmPrintInformation- Returns:
The uri used for print-to-file.
- Return type:
- Gnm.print_info_has_manual_breaks(pi)¶
- Parameters:
pi (
Gnm.PrintInformation
) –- Return type:
- Gnm.print_info_load_defaults(pi)¶
- Parameters:
NOTE: This reads from a globally stored configuration. If a configuration is stored along with a sheet then that will override these global defaults.
- Gnm.print_info_save(pi)¶
- Parameters:
pi (
Gnm.PrintInformation
) –
- Gnm.print_info_set_breaks(pi, breaks)¶
- Parameters:
breaks (
Gnm.PageBreaks
) –Gnm.PageBreaks
- Parameters:
pi (
Gnm.PrintInformation
) –e_f (
float
) –
- Gnm.print_info_set_edge_to_below_header(pi, e_h)¶
- Parameters:
pi (
Gnm.PrintInformation
) –e_h (
float
) –
- Gnm.print_info_set_from_settings(pi, settings)¶
- Parameters:
pi (
Gnm.PrintInformation
) –settings (
Gtk.PrintSettings
) –
- Parameters:
pi (
Gnm.PrintInformation
) –footer (
float
) –
- Gnm.print_info_set_margin_header(pi, header)¶
- Parameters:
pi (
Gnm.PrintInformation
) –header (
float
) –
- Gnm.print_info_set_margin_left(pi, left)¶
- Parameters:
pi (
Gnm.PrintInformation
) –left (
float
) –
- Gnm.print_info_set_margin_right(pi, right)¶
- Parameters:
pi (
Gnm.PrintInformation
) –right (
float
) –
- Gnm.print_info_set_margins(pi, header, footer, left, right)¶
- Parameters:
pi (
Gnm.PrintInformation
) –header (
float
) –footer (
float
) –left (
float
) –right (
float
) –
- Gnm.print_info_set_page_setup(pi, page_setup)¶
- Parameters:
page_setup (
Gtk.PageSetup
) –Gtk.PageSetup
Absorb a ref to page_setup.
WHY WHY WHY 1) The life cycle in here is a tad odd, the load_defaults does nothing for the case of an existing page_setup, and seems like it should be ignored for the case of a new one.
Why not copy the page_setup in here and make the arg const ?
- Gnm.print_info_set_paper(pi, paper)¶
- Parameters:
pi (
Gnm.PrintInformation
) –paper (
str
) –
- Return type:
- Gnm.print_info_set_paper_orientation(pi, orientation)¶
- Parameters:
pi (
Gnm.PrintInformation
) –orientation (
Gtk.PageOrientation
) –
- Gnm.print_info_set_printrange(pi, pr)¶
- Parameters:
pi (
Gnm.PrintInformation
) –pr (
Gnm.PrintRange
) –
- Gnm.print_info_set_printtofile_from_settings(pi, settings, default_uri)¶
- Parameters:
pi (
Gnm.PrintInformation
) –settings (
Gtk.PrintSettings
) –default_uri (
str
) –
- Gnm.print_info_set_printtofile_uri(pi, uri)¶
- Parameters:
pi (
Gnm.PrintInformation
) –uri (
str
) –
- Gnm.print_load_repeat_range(str, r, sheet)¶
- Gnm.print_sheet(wbc, sheet, preview, default_range, export_dst)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sheet (
Gnm.Sheet
) –preview (
bool
) –default_range (
Gnm.PrintRange
) –export_dst (
Gsf.Output
) –
- Gnm.print_sheet_objects(cr, sheet, range, base_x, base_y)¶
- Parameters:
cr (
cairo.Context
) –sheet (
Gnm.Sheet
) –range (
Gnm.Range
) –base_x (
float
) –base_y (
float
) –
- Gnm.print_so(wbc, sos, export_dst)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sos ([
Gnm.SheetObject
]) –export_dst (
Gsf.Output
) –
- Gnm.pt(x, n, lower_tail, log_p)¶
- Parameters:
- Returns:
cumulative density of the Student t distribution.
- Return type:
- Gnm.ptukey(x, nmeans, df, nranges, lower_tail, log_p)¶
- Gnm.pweibull(x, shape, scale, lower_tail, log_p)¶
- Parameters:
- Returns:
cumulative density of the Weibull distribution.
- Return type:
- Gnm.qbeta(p, a, b, lower_tail, log_p)¶
- Parameters:
- Returns:
the observation with cumulative probability p for the beta distribution.
- Return type:
- Gnm.qbinom(p, n, psuc, lower_tail, log_p)¶
- Parameters:
- Returns:
the observation with cumulative probability p for the binomial distribution.
- Return type:
- Gnm.qcauchy(p, location, scale, lower_tail, log_p)¶
- Parameters:
- Returns:
the observation with cumulative probability p for the Cauchy distribution.
- Return type:
- Gnm.qchisq(p, df, lower_tail, log_p)¶
- Parameters:
- Returns:
the observation with cumulative probability p for the 𝜒² distribution.
- Return type:
- Gnm.qexp(p, scale, lower_tail, log_p)¶
- Parameters:
- Returns:
the observation with cumulative probability p for the exponential distribution.
- Return type:
- Gnm.qf(p, n1, n2, lower_tail, log_p)¶
- Parameters:
- Returns:
the observation with cumulative probability p for the F distribution.
- Return type:
- Gnm.qfactf(x, mant, expb)¶
- Parameters:
x (
float
) –mant (
GOffice.Quad
) –expb (
int
) –
- Return type:
- Gnm.qgamma(p, shape, scale, lower_tail, log_p)¶
- Parameters:
- Returns:
the observation with cumulative probability p for the gamma distribution.
- Return type:
- Gnm.qgeom(p, psuc, lower_tail, log_p)¶
- Parameters:
- Returns:
the observation with cumulative probability p for the geometric distribution.
- Return type:
- Gnm.qhyper(p, r, b, n, lower_tail, log_p)¶
- Parameters:
- Returns:
the observation with cumulative probability p for the hypergeometric distribution.
- Return type:
- Gnm.qlnorm(p, logmean, logsd, lower_tail, log_p)¶
- Parameters:
- Returns:
the observation with cumulative probability p for the log-normal distribution.
- Return type:
- Gnm.qnbinom(p, n, psuc, lower_tail, log_p)¶
- Parameters:
- Returns:
the observation with cumulative probability p for the negative binomial distribution.
- Return type:
- Gnm.qnorm(p, mu, sigma, lower_tail, log_p)¶
- Parameters:
- Returns:
the observation with cumulative probability p for the normal distribution.
- Return type:
- Gnm.qpois(p, lambda_, lower_tail, log_p)¶
- Parameters:
- Returns:
the observation with cumulative probability p for the Poisson distribution.
- Return type:
- Gnm.qrayleigh(p, scale, lower_tail, log_p)¶
- Parameters:
- Returns:
the observation with cumulative probability p for the Rayleigh distribution.
- Return type:
- Gnm.qt(p, n, lower_tail, log_p)¶
- Parameters:
- Returns:
the observation with cumulative probability p for the Student t distribution.
- Return type:
- Gnm.qtukey(p, nmeans, df, nranges, lower_tail, log_p)¶
- Gnm.qweibull(p, shape, scale, lower_tail, log_p)¶
- Parameters:
- Returns:
the observation with cumulative probability p for the Weibull distribution.
- Return type:
- Gnm.random_hypergeometric(n1, n2, t)¶
- Gnm.random_levy_skew(c, alpha, beta)¶
- Gnm.random_uniform_int(n)¶
- Gnm.random_uniform_integer(l, h)¶
- Gnm.range_adtest(xs, n, p, statistics)¶
- Gnm.range_concatenate(data, user)¶
- Gnm.range_correl_pop(xs, ys, n, res)¶
- Gnm.range_covar_est(xs, ys, n, res)¶
- Gnm.range_covar_pop(xs, ys, n, res)¶
- Gnm.range_geometric_mean(xs, n, res)¶
- Gnm.range_harmonic_mean(xs, n, res)¶
- Gnm.range_kurtosis_m3_est(xs, n, res)¶
- Gnm.range_kurtosis_m3_pop(xs, n, res)¶
- Gnm.range_list_destroy(ranges)¶
- Parameters:
ranges ([
Gnm.Value
]) – a list ofGOffice.value
ranges to destroy.
Destroys a list of ranges returned from parse_cell_range_list. Note: the element type here is
Gnm.Value
, notGnm.Range
.
- Gnm.range_multinomial(xs, n, res)¶
- Gnm.range_rsq_pop(xs, ys, n, res)¶
- Gnm.range_simplify(arr)¶
- Parameters:
arr ([
Gnm.Range
]) – array of ranges to simplify- Returns:
array of ranges to simplify
- Return type:
arr: [
Gnm.Range
]
Simplifies the array of ranges by merging small ranges into larger ones.
- Gnm.reduce_pi(x, e)¶
- Parameters:
- Returns:
a
GOffice.value
, xr, such that x = xr + j * Pi/2^`e` for some integer number j and |xr| <= Pi/2^(e+1). The lower e+1 bits of j will be returned in k.- k:
location to return lower e+1 bits of reduction
GOffice.count
- Return type:
This function performs range reduction for trigonometric functions.
- Gnm.regcomp_XL(preg, pattern, cflags, anchor_start, anchor_end)¶
- Gnm.restore_window_geometry(dialog, key)¶
- Parameters:
dialog (
Gtk.Window
) –key (
str
) –
- Gnm.row_calc_spans(ri, row, sheet)¶
- Parameters:
ri (
Gnm.ColRowInfo
) –row (
int
) –sheet (
Gnm.Sheet
) –
- Gnm.row_destroy_span(ri)¶
- Parameters:
ri (
Gnm.ColRowInfo
) –
- Gnm.row_span_get(ri, col)¶
- Parameters:
ri (
Gnm.ColRowInfo
) –col (
int
) –
- Return type:
- Gnm.rows_height_update(sheet, range, shrink)¶
- Parameters:
Use this function having changed the
Gnm.font
size to auto-resize theGnm.row
heights to make the text fit nicely.
- Gnm.rvc_free(rvc)¶
- Parameters:
rvc (
Gnm.RenderedValueCollection
) –
- Gnm.rvc_remove(rvc, cell)¶
- Parameters:
rvc (
Gnm.RenderedValueCollection
) –cell (
Gnm.Cell
) –
- Gnm.rvc_store(rvc, cell, rv)¶
- Parameters:
rvc (
Gnm.RenderedValueCollection
) –cell (
Gnm.Cell
) –rv (
Gnm.RenderedValue
) –
- Gnm.sc_ant(sc)¶
- Parameters:
sc (
Gnm.SheetControl
) –
- Gnm.sc_cursor_bound(sc, r)¶
- Parameters:
sc (
Gnm.SheetControl
) –r (
Gnm.Range
) –
- Gnm.sc_freeze_object_view(sc, freeze)¶
- Parameters:
sc (
Gnm.SheetControl
) –freeze (
bool
) –
- Gnm.sc_make_cell_visible(sc, col, row, couple_panes)¶
- Parameters:
sc (
Gnm.SheetControl
) –col (
int
) –row (
int
) –couple_panes (
bool
) –
- Gnm.sc_mode_edit(sc)¶
- Parameters:
sc (
Gnm.SheetControl
) –
- Gnm.sc_object_create_view(sc, so)¶
- Parameters:
sc (
Gnm.SheetControl
) –so (
Gnm.SheetObject
) –
- Gnm.sc_recompute_visible_region(sc, full_recompute)¶
- Parameters:
sc (
Gnm.SheetControl
) –full_recompute (
bool
) –
- Gnm.sc_redraw_all(sc, headers)¶
- Parameters:
sc (
Gnm.SheetControl
) –headers (
bool
) –
- Gnm.sc_redraw_headers(sc, col, row, r)¶
- Parameters:
sc (
Gnm.SheetControl
) –col (
bool
) –row (
bool
) –r (
Gnm.Range
) –
- Gnm.sc_redraw_range(sc, r)¶
- Parameters:
sc (
Gnm.SheetControl
) –r (
Gnm.Range
) –
- Gnm.sc_resize(sc, force_scroll)¶
- Parameters:
sc (
Gnm.SheetControl
) –force_scroll (
bool
) –
- Gnm.sc_scale_changed(sc)¶
- Parameters:
sc (
Gnm.SheetControl
) –
- Gnm.sc_scrollbar_config(sc)¶
- Parameters:
sc (
Gnm.SheetControl
) –
- Gnm.sc_set_panes(sc)¶
- Parameters:
sc (
Gnm.SheetControl
) –
- Gnm.sc_set_top_left(sc, col, row)¶
- Parameters:
sc (
Gnm.SheetControl
) –col (
int
) –row (
int
) –
- Gnm.sc_sheet(sc)¶
- Parameters:
sc (
Gnm.SheetControl
) –Gnm.SheetControl
- Returns:
the sheet.
- Return type:
- Gnm.sc_show_im_tooltip(sc, im, pos)¶
- Parameters:
sc (
Gnm.SheetControl
) –im (
Gnm.InputMsg
) –pos (
Gnm.CellPos
) –
- Gnm.sc_unant(sc)¶
- Parameters:
sc (
Gnm.SheetControl
) –
- Gnm.sc_view(sc)¶
- Parameters:
sc (
Gnm.SheetControl
) –Gnm.SheetControl
- Returns:
the sheet view.
- Return type:
- Gnm.sc_wbc(sc)¶
- Parameters:
sc (
Gnm.SheetControl
) –Gnm.SheetControl
- Returns:
the
GOffice.workbook
control.- Return type:
- Gnm.scg_adjust_preferences(scg)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –
- Gnm.scg_colrow_distance_get(scg, is_cols, from_, to)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –is_cols (
bool
) –from (
int
) –to (
int
) –
- Return type:
- Gnm.scg_colrow_select(scg, is_cols, index, modifiers)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –is_cols (
bool
) –index (
int
) –modifiers (
int
) –
- Return type:
- Gnm.scg_colrow_size_set(scg, is_cols, index, new_size_pixels)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –is_cols (
bool
) –index (
int
) –new_size_pixels (
int
) –
- Gnm.scg_comment_display(scg, cc, x, y)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) – TheGnm.SheetControl
cc (
Gnm.Comment
) – A cellGnm.comment
x (
int
) –y (
int
) –
- Gnm.scg_comment_select(scg, cc, x, y)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) – TheGnm.SheetControl
cc (
Gnm.Comment
) – A cellGnm.comment
x (
int
) –y (
int
) –
Prepare cc for display.
- Gnm.scg_comment_unselect(scg, cc)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) – TheGnm.SheetControl
cc (
Gnm.Comment
) – A cellGnm.comment
If cc is the current cell
Gnm.comment
being edited/displayed shutdown the display mechanism.
- Parameters:
scg (
Gnm.SheetControlGUI
) –event (
Gdk.Event
) –is_col (
bool
) –is_row (
bool
) –
- Gnm.scg_cursor_extend(scg, n, jump_to_bound, horiz)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) – The scgn (
int
) – Units to extend the selectionjump_to_bound (
bool
) – Move to transitions between cells and blanks, or move in single steps.horiz (
bool
) – extend vertically or horizontally.
- Gnm.scg_cursor_move(scg, dir, jump_to_bound, horiz)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) – The scgdir (
int
) – Number of units to move theGnm.cursor
jump_to_bound (
bool
) – skip from the start to the end of ranges of filled or unfilled cells.horiz (
bool
) – is the movement horizontal or vertical
Moves the
Gnm.cursor
GOffice.count
rows
- Gnm.scg_cursor_visible(scg, is_visible)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –is_visible (
bool
) –
- Gnm.scg_delete_sheet_if_possible(scg)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –
- Gnm.scg_drag_data_get(scg, selection_data)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –selection_data (
Gtk.SelectionData
) –
- Gnm.scg_drag_data_received(scg, source_widget, x, y, selection_data)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –source_widget (
Gtk.Widget
) –x (
float
) –y (
float
) –selection_data (
Gtk.SelectionData
) –
- Gnm.scg_edit_start(scg)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –
- Gnm.scg_edit_stop(scg)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –
- Gnm.scg_make_cell_visible(scg, col, row, force_scroll, couple_panes)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) – The gui controlcol (
int
) –row (
int
) –force_scroll (
bool
) – Completely recalibrate the offsets to the new positioncouple_panes (
bool
) – Scroll scroll dynamic panes back to bounds if target is in frozen segment.
Ensure that cell (
Gnm.col
,Gnm.row
) is visible.Gnm.Sheet
is scrolled if cell is outside viewport.
- Gnm.scg_mode_edit(scg)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) – The sheet control
Put sheet into the standard state ‘edit mode’. This shuts down any object editing and frees any objects that are created but not realized.
- Gnm.scg_object_anchor_to_coords(scg, anchor, coords)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –anchor (
Gnm.SheetObjectAnchor
) –coords (
float
) –
- Gnm.scg_object_coords_to_anchor(scg, coords, in_out)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –coords (
float
) –in_out (
Gnm.SheetObjectAnchor
) –
- Gnm.scg_object_select(scg, so)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) – TheGnm.SheetControl
to edit in.so (
Gnm.SheetObject
) – TheGnm.SheetObject
to select.
Adds so to the set of selected objects and prepares it for user editing. Adds a reference to ref if it is selected.
- Gnm.scg_object_select_next(scg, reverse)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –reverse (
bool
) –
- Gnm.scg_object_unselect(scg, so)¶
- Parameters:
so (
Gnm.SheetObject
) –Gnm.SheetObject
(optionallyNone
)
unselect the supplied object, and drop out of edit mode if this is the last one. If so ==
None
unselect _all_ objects.
- Gnm.scg_objects_drag(scg, gcanvas, primary, dx, dy, drag_type, symmetric, snap_to_grid, is_mouse_move)¶
- Parameters:
gcanvas (
Gnm.Pane
) –primary (
Gnm.SheetObject
) –Gnm.SheetObject
(optionallyNone
)dx (
float
) –dy (
float
) –drag_type (
int
) –symmetric (
bool
) –snap_to_grid (
bool
) –is_mouse_move (
bool
) –
Move the control points and
Gnm.drag
views of the currently selected objects to a new position. This movement is only made in scg not in the actual objects.
- Gnm.scg_objects_drag_commit(scg, drag_type, created_objects, pundo, predo, undo_title)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –drag_type (
int
) –created_objects (
bool
) –pundo (
GOffice.Undo
) –predo (
GOffice.Undo
) –undo_title (
str
) –
- Gnm.scg_objects_nudge(scg, gcanvas, drag_type, dx, dy, symmetric, snap_to_grid)¶
- Gnm.scg_paste_image(scg, where, data, len)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –where (
Gnm.Range
) –data (
int
) –len (
int
) –
- Gnm.scg_queue_movement(scg, handler, n, jump, horiz)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –handler (
Gnm.SCGUIMoveFunc
) – The movement handlern (
int
) – how far
Do motion compression when possible to avoid redrawing an area that will disappear when we scroll again.
- Gnm.scg_rangesel_bound(scg, base_col, base_row, move_col, move_row)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –base_col (
int
) –base_row (
int
) –move_col (
int
) –move_row (
int
) –
- Gnm.scg_rangesel_extend(scg, n, jump_to_bound, horiz)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –n (
int
) –jump_to_bound (
bool
) –horiz (
bool
) –
- Gnm.scg_rangesel_extend_to(scg, col, row)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –col (
int
) –row (
int
) –
- Gnm.scg_rangesel_move(scg, dir, jump_to_bound, horiz)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –dir (
int
) –jump_to_bound (
bool
) –horiz (
bool
) –
- Gnm.scg_rangesel_start(scg, base_col, base_row, move_col, move_row)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –base_col (
int
) –base_row (
int
) –move_col (
int
) –move_row (
int
) –
- Gnm.scg_rangesel_stop(scg, clear_str)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –clear_str (
bool
) –
- Gnm.scg_reload_item_edits(scg)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –
- Gnm.scg_select_all(scg)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –
- Gnm.scg_set_display_cursor(scg)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –
Set the displayed
Gnm.cursor
type.
- Gnm.scg_set_left_col(scg, new_first_col)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –new_first_col (
int
) –
- Gnm.scg_set_top_row(scg, new_first_row)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –new_first_row (
int
) –
- Gnm.scg_sheet(scg)¶
- Parameters:
- Returns:
the sheet.
- Return type:
- Gnm.scg_size_guide_motion(scg, vert, guide_pos)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –vert (
bool
) –guide_pos (
int
) –
- Gnm.scg_size_guide_start(scg, vert, colrow, is_colrow_resize)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –vert (
bool
) –colrow (
int
) –is_colrow_resize (
bool
) –
- Gnm.scg_size_guide_stop(scg)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –
- Gnm.scg_special_cursor_bound_set(scg, r)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –r (
Gnm.Range
) –
- Return type:
- Gnm.scg_special_cursor_start(scg, style, button)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –style (
int
) –button (
int
) –
- Gnm.scg_special_cursor_stop(scg)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –
- Gnm.scg_take_focus(scg)¶
- Parameters:
scg (
Gnm.SheetControlGUI
) –
- Gnm.scg_view(scg)¶
- Parameters:
- Returns:
the sheet view.
- Return type:
- Gnm.scg_wbc(scg)¶
- Parameters:
- Returns:
the
GOffice.workbook
control.- Return type:
- Gnm.scg_wbcg(scg)¶
- Parameters:
- Returns:
the
Gnm.WBCGtk
.- Return type:
- Gnm.search_collect_cells(sr)¶
- Parameters:
- Returns:
the newly created array.
- Return type:
Collect a list of all cells subject to search.
- Gnm.search_collect_cells_free(cells)¶
- Parameters:
cells ([
Gnm.EvalPos
]) –
- Gnm.search_filter_matching(sr, cells)¶
- Parameters:
sr (
Gnm.SearchReplace
) – The search spec.cells ([
Gnm.EvalPos
]) – Cell positions to filter, presumably a result ofGnm.search_collect_cells
.
- Returns:
matches
- Return type:
- Gnm.search_filter_matching_free(matches)¶
- Parameters:
matches ([
Gnm.SearchFilterResult
]) – matches
- Gnm.selection_first_range(sv, cc, cmd_name)¶
- Parameters:
sv (
Gnm.SheetView
) – TheGnm.SheetView
whose selection we are testing.cc (
GOffice.CmdContext
) – The command context to report errors tocmd_name (
str
) – A string naming the operation requiring a single range.
- Returns:
the first range, if a control is supplied it displays an error if there is more than one range.
- Return type:
- Gnm.selection_get_ranges(sv, allow_intersection)¶
- Parameters:
sv (
Gnm.SheetView
) –Gnm.SheetView
allow_intersection (
bool
) – Divide the selection into nonoverlapping subranges.
- Return type:
Caller is responsible for free the list and the content.
- Gnm.selection_to_string(sv, include_sheet_name_prefix)¶
- Parameters:
sv (
Gnm.SheetView
) –include_sheet_name_prefix (
bool
) –
- Return type:
- Gnm.set_cell_text_col(dao, col, row, text)¶
- Parameters:
dao (
Gnm.data_analysis_output_t
) –col (
int
) –row (
int
) –text (
str
) –
- Gnm.set_cell_text_row(dao, col, row, text)¶
- Parameters:
dao (
Gnm.data_analysis_output_t
) –col (
int
) –row (
int
) –text (
str
) –
- Gnm.set_uifilename(name, actions, nb)¶
- Parameters:
name (
str
) –actions (
Gnm.ActionEntry
) –nb (
int
) –
- Gnm.sheet_range_set_text(pos, r, str)¶
- Parameters:
pos (
Gnm.ParsePos
) – The position from which to parse an expression.r (
Gnm.Range
) – The range toGOffice.fill
str (
str
) – The text to be parsed and assigned.
Does NOT check for array division. Does NOT redraw Does NOT generate spans.
- Gnm.shutdown()¶
- Gnm.simulation_tool(wbc, dao, sim)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –dao (
Gnm.data_analysis_output_t
) –sim (
Gnm.simulation_t
) –
- Return type:
- Gnm.simulation_tool_destroy(sim)¶
- Parameters:
sim (
Gnm.simulation_t
) –
- Gnm.slist_sort_merge(list_1, list_2)¶
- Parameters:
- Returns:
the mergedlist.
- Return type:
[
int
]
Gnm.slist_sort_merge
merges two lists of unsigned integers.
- Gnm.sort_contents(data, cc)¶
- Parameters:
data (
Gnm.SortData
) –cc (
GOffice.CmdContext
) –
- Return type:
- Gnm.sort_position(data, perm, cc)¶
- Parameters:
data (
Gnm.SortData
) –perm (
int
) –cc (
GOffice.CmdContext
) –
- Gnm.stf_dialog_csv_page_cleanup(pagedata)¶
- Parameters:
pagedata (
Gnm.StfDialogData
) – mother struct
Will cleanup csv page run-time data
- Gnm.stf_dialog_csv_page_init(gui, pagedata)¶
- Parameters:
gui (
Gtk.Builder
) –pagedata (
Gnm.StfDialogData
) –
- Gnm.stf_dialog_csv_page_prepare(pagedata)¶
- Parameters:
pagedata (
Gnm.StfDialogData
) – mother struct
Will prepare the csv page
- Gnm.stf_dialog_fixed_page_cleanup(pagedata)¶
- Parameters:
pagedata (
Gnm.StfDialogData
) – mother struct
Will cleanup fixed page run-time data
- Gnm.stf_dialog_fixed_page_init(gui, pagedata)¶
- Parameters:
gui (
Gtk.Builder
) –pagedata (
Gnm.StfDialogData
) –
- Gnm.stf_dialog_fixed_page_prepare(pagedata)¶
- Parameters:
pagedata (
Gnm.StfDialogData
) – mother struct
Will prepare the fixed page
- Gnm.stf_dialog_format_page_cleanup(pagedata)¶
- Parameters:
pagedata (
Gnm.StfDialogData
) –
- Gnm.stf_dialog_format_page_init(gui, pagedata)¶
- Parameters:
gui (
Gtk.Builder
) –pagedata (
Gnm.StfDialogData
) –
- Gnm.stf_dialog_format_page_prepare(pagedata)¶
- Parameters:
pagedata (
Gnm.StfDialogData
) – mother struct
This will prepare the widgets on the format page before the page gets displayed
- Gnm.stf_dialog_main_page_cleanup(pagedata)¶
- Parameters:
pagedata (
Gnm.StfDialogData
) –
- Gnm.stf_dialog_main_page_init(gui, pagedata)¶
- Parameters:
gui (
Gtk.Builder
) –pagedata (
Gnm.StfDialogData
) –
- Gnm.stf_dialog_main_page_prepare(pagedata)¶
- Parameters:
pagedata (
Gnm.StfDialogData
) – mother struct
This will prepare the widgets on the format page before the page gets displayed
- Gnm.stf_dialog_result_attach_formats_to_cr(dialogresult, cr)¶
- Parameters:
dialogresult (
Gnm.DialogStfResult_t
) – a dialogresult structcr (
Gnm.CellRegion
) – a cell region
Attach the formats of the dialogresult to the given cell region.
- Gnm.stf_dialog_result_free(dialogresult)¶
- Parameters:
dialogresult (
Gnm.DialogStfResult_t
) – a dialogresult struct
This routine will properly free the members of dialogresult and dialogresult itself
- Gnm.stf_export(export_options)¶
- Parameters:
export_options (
Gnm.StfExport
) – an export options struct- Returns:
- Return type:
Exports the sheets given in stfe
- Gnm.stf_file_saver_create(id)¶
- Parameters:
id (
str
) –- Returns:
the newly allocated
GOffice.FileSaver
.- Return type:
- Gnm.stf_get_stfe(obj)¶
- Parameters:
obj (
GObject.Object
) –GObject.Object
with aGnm.StfExport
attached as data.- Returns:
the
Gnm.StfExport
.- Return type:
If none is found, a new one is created and attached to obj.
- Gnm.stf_parse_find_line(parseoptions, data, line)¶
- Parameters:
parseoptions (
Gnm.StfParseOptions_t
) –data (
str
) –line (
int
) –
- Return type:
- Gnm.stf_parse_options_guess(data)¶
- Parameters:
data (
str
) – the input data.- Returns:
the guessed options.
- Return type:
- Gnm.stf_parse_options_guess_csv(data)¶
- Parameters:
data (
str
) – the CSV input data.- Returns:
the guessed options.
- Return type:
- Gnm.stf_parse_region(parseoptions, data, data_end, wb)¶
- Parameters:
parseoptions (
Gnm.StfParseOptions_t
) –data (
str
) –data_end (
str
) –wb (
Gnm.Workbook
) –
- Return type:
- Gnm.stf_parse_sheet(parseoptions, data, data_end, sheet, start_col, start_row)¶
- Gnm.stf_preview_find_column(renderdata, x, pcol, dx)¶
- Parameters:
renderdata (
Gnm.RenderData_t
) –x (
int
) –pcol (
int
) –dx (
int
) –
- Gnm.stf_text_to_columns(wbc, cc)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) – The control making the requestcc (
GOffice.CmdContext
) –
Main routine, handles importing a file including all dialog mumbo-jumbo
- Gnm.string_add_number(buf, d)¶
- Parameters:
buf (
GLib.String
) –d (
float
) –
- Gnm.strip_missing(data, missing)¶
- Parameters:
- Returns:
Array
- Return type:
data: [
float
]
This removes the data elements from data whose indices are given by missing. n is the number of elements and it updated upon return.
- Gnm.style_border_fetch(line_type, color, orientation)¶
- Parameters:
line_type (
Gnm.StyleBorderType
) – dash styleorientation (
Gnm.StyleBorderOrientation
) – Not currently used.
- Returns:
- Return type:
- Gnm.style_border_get_orientation(type)¶
- Parameters:
type (
Gnm.StyleBorderLocation
) –- Return type:
- Gnm.style_border_get_width(line_type)¶
- Parameters:
line_type (
Gnm.StyleBorderType
) –- Return type:
- Gnm.style_border_none()¶
- Returns:
A
Gnm.Border
with no borders.- Return type:
- Gnm.style_border_none_set_color(color)¶
-
This function updates the color of
Gnm.Style.border_none
when the wanted grid color is known.Gnm.Style.border_none
tells how to render the grid. Because the grid color may be different for different sheets, the functions which render the grid call this function first. The rule for selecting the grid color, which is the same as in Excel, is: - if the auto pattern color is default (which is black), the grid color is gray, as returned byGnm.Style.color_grid
(). - otherwise, the auto pattern color is used for the grid.
- Gnm.style_border_ref(border)¶
- Parameters:
border (
Gnm.Border
orNone
) –Gnm.Border
- Returns:
a reference to border
- Return type:
Gnm.Border
orNone
- Gnm.style_border_set_dash(i, context)¶
- Parameters:
i (
Gnm.StyleBorderType
) –context (
cairo.Context
) –
- Gnm.style_border_unref(border)¶
- Parameters:
border (
Gnm.Border
orNone
) –Gnm.Border
- Gnm.style_border_visible_in_blank(border)¶
- Parameters:
border (
Gnm.Border
) –- Return type:
- Gnm.style_borders_row_draw(prev_vert, sr, cr, x, y1, y2, colwidths, draw_vertical, dir)¶
- Parameters:
prev_vert (
Gnm.Border
) –sr (
Gnm.StyleRow
) –cr (
cairo.Context
) –x (
int
) –y1 (
int
) –y2 (
int
) –colwidths (
int
) –draw_vertical (
bool
) –dir (
int
) –
TODO : This is not the final resting place for this. It will move into the gui layer eventually.
- Gnm.style_borders_row_print_gtk(prev_vert, sr, context, x, y1, y2, sheet, draw_vertical, dir)¶
- Parameters:
prev_vert (
Gnm.Border
) –sr (
Gnm.StyleRow
) –context (
cairo.Context
) –x (
float
) –y1 (
float
) –y2 (
float
) –sheet (
Gnm.Sheet
) –draw_vertical (
bool
) –dir (
int
) –
- Gnm.style_color_auto_pattern()¶
- Return type:
Normally black, but follows grid color if so told.
- Gnm.style_color_grid(context)¶
- Parameters:
context (
Gtk.StyleContext
) –- Return type:
- Gnm.style_context_get_color(context, state, color)¶
- Parameters:
context (
Gtk.StyleContext
) –state (
Gtk.StateFlags
) –color (
Gdk.RGBA
) –
- Gnm.style_list_free(l)¶
- Parameters:
l ([
object
]) – the list to free
Free up the resources in the style list. This includes unreferencing the styles.
- Gnm.style_list_get_style(l, col, row)¶
- Parameters:
- Returns:
The style found.
- Return type:
Attempts to find the style associated with the pos offset within the 0,0 based style list.
- Gnm.style_row_init(prev_vert, sr, next_sr, start_col, end_col, mem, hide_grid)¶
- Parameters:
prev_vert (
Gnm.Border
) –sr (
Gnm.StyleRow
) –next_sr (
Gnm.StyleRow
) –start_col (
int
) –end_col (
int
) –hide_grid (
bool
) –
A small utility routine to initialize the grid drawing
Gnm.StyleRow
data structure.
- Gnm.sv_is_colrow_selected(sv, colrow, is_col)¶
- Parameters:
sv (
Gnm.SheetView
) –colrow (
int
) –is_col (
bool
) –
- Return type:
- Gnm.sv_is_full_colrow_selected(sv, is_cols, index)¶
- Gnm.sv_is_full_range_selected(sv, r)¶
- Parameters:
sv (
Gnm.SheetView
) –r (
Gnm.Range
) –
- Returns:
True
if all of r is contained by the selection in sv.- Return type:
- Gnm.sv_is_pos_selected(sv, col, row)¶
- Parameters:
sv (
Gnm.SheetView
) –col (
int
) –row (
int
) –
- Returns:
True
if the supplied position is selected in view sv.- Return type:
- Gnm.sv_is_range_selected(sv, r)¶
- Parameters:
sv (
Gnm.SheetView
) –r (
Gnm.Range
) –
- Returns:
True
If r overlaps with any part of the selection in sv.- Return type:
- Gnm.sv_is_singleton_selected(sv)¶
- Parameters:
sv (
Gnm.SheetView
) –Gnm.SheetView
- Returns:
A
Gnm.CellPos
if the selection is a singleton- Return type:
Gnm.CellPos
orNone
See if the 1st selected region is a singleton.
- Gnm.sv_select_cur_array(sv)¶
- Parameters:
sv (
Gnm.SheetView
) – The sheet view
If the editpos is part of an array clear the selection and select the array.
- Gnm.sv_select_cur_col(sv)¶
- Parameters:
sv (
Gnm.SheetView
) – The sheet view
Selects an entire column
- Gnm.sv_select_cur_depends(sv)¶
- Parameters:
sv (
Gnm.SheetView
) – The sheet view
Select all cells that depend on the expression in the current cell.
- Gnm.sv_select_cur_inputs(sv)¶
- Parameters:
sv (
Gnm.SheetView
) – The sheet view
Select all cells that are direct potential inputs to the current cell.
- Gnm.sv_select_cur_row(sv)¶
- Parameters:
sv (
Gnm.SheetView
) – The sheet view
Selects an entire
Gnm.row
- Gnm.sv_selection_add_full(sv, edit_col, edit_row, base_col, base_row, move_col, move_row, mode)¶
- Parameters:
sv (
Gnm.SheetView
) –Gnm.SheetView
whose selection is append to.edit_col (
int
) –edit_row (
int
) – cell to mark as the new editGnm.cursor
.base_col (
int
) –base_row (
int
) – stationary corner of the newly selected range.move_col (
int
) –move_row (
int
) – moving corner of the newly selected range.mode (
Gnm.SelectionMode
) –
Prepends a range to the selection list and sets the edit position.
- Gnm.sv_selection_add_pos(sv, col, row, mode)¶
- Parameters:
sv (
Gnm.SheetView
) –col (
int
) –row (
int
) –mode (
Gnm.SelectionMode
) –
- Gnm.sv_selection_add_range(sv, range)¶
- Parameters:
sv (
Gnm.SheetView
) –range (
Gnm.Range
) –
- Gnm.sv_selection_apply(sv, func, allow_intersection, *user_data)¶
- Parameters:
sv (
Gnm.SheetView
) –Gnm.SheetView
func (
Gnm.SelectionApplyFunc
) – The function to apply.allow_intersection (
bool
) – Call the routine for the non-intersecting subregions.user_data (
object
orNone
) – A parameter to pass to each invocation of func.
Applies the specified function for all ranges in the selection. Optionally select whether to use the high level potentially over lapped ranges, rather than the smaller system created non-intersection regions.
- Gnm.sv_selection_col_type(sv, col)¶
- Parameters:
sv (
Gnm.SheetView
) –col (
int
) –
- Returns:
How much of column col is selected in sv.
- Return type:
- Gnm.sv_selection_extend_to(sv, col, row)¶
- Parameters:
sv (
Gnm.SheetView
) – the sheetcol (
int
) – column that gets covered (negative indicates all cols)row (
int
) –Gnm.row
that gets covered (negative indicates all rows)
This extends the selection to cover
Gnm.col
,Gnm.row
and updates the status areas.
- Gnm.sv_selection_foreach(sv, handler, *user_data)¶
- Parameters:
sv (
Gnm.SheetView
) – The whose selection is being iterated.handler (
Gnm.SelectionFunc
) – A function to call for each selected range.
- Return type:
Iterate through the ranges in a selection. NOTE : The function assumes that the callback routine does NOT change the selection list. This can be changed in the future if it is a requirement.
- Gnm.sv_selection_free(sv)¶
- Parameters:
sv (
Gnm.SheetView
) –Gnm.SheetView
Releases the selection associated with sv
WARNING: This does not set a new selection and leaves the view in an INVALID STATE.
- Gnm.sv_selection_reset(sv)¶
- Parameters:
sv (
Gnm.SheetView
) – The sheet view
Releases the selection associated with sv , and forces a redraw of the previously selected regions and headers.
WARNING: This does not set a new selection and leaves the view in an INVALID STATE.
- Gnm.sv_selection_row_type(sv, row)¶
- Parameters:
sv (
Gnm.SheetView
) –row (
int
) –
- Returns:
How much of column col is selected in sv.
- Return type:
- Gnm.sv_selection_set(sv, edit, base_col, base_row, move_col, move_row)¶
- Parameters:
sv (
Gnm.SheetView
) –edit (
Gnm.CellPos
) –base_col (
int
) –base_row (
int
) –move_col (
int
) –move_row (
int
) –
- Gnm.sv_selection_simplified_free(sv)¶
- Parameters:
sv (
Gnm.SheetView
) –Gnm.SheetView
Releases the simplified selection associated with sv
- Gnm.sv_selection_simplify(sv)¶
- Parameters:
sv (
Gnm.SheetView
) –
- Gnm.sv_selection_to_plot(sv, plot)¶
- Parameters:
sv (
Gnm.SheetView
) –plot (
GOffice.GraphPlot
) –
- Gnm.sv_selection_walk_step(sv, forward, horizontal)¶
- Parameters:
sv (
Gnm.SheetView
) –Gnm.SheetView
forward (
bool
) –horizontal (
bool
) –
Move the edit_pos of sv 1 step according to forward and horizontal. The behavior depends several factors
How many ranges are selected
The shape of the selected ranges
Previous movements (A sequence of tabs followed by an enter can jump to the 1st
Gnm.col
).
- Gnm.sv_sheet(sv)¶
- Parameters:
sv (
Gnm.SheetView
) –Gnm.SheetView
- Returns:
the sheet.
- Return type:
- Gnm.sv_wbv(sv)¶
- Parameters:
sv (
Gnm.SheetView
) –Gnm.SheetView
- Returns:
the
GOffice.workbook
view.- Return type:
- Gnm.taylor_log1p(x, k)¶
- Gnm.textbuffer_get_text(buf)¶
- Parameters:
buf (
Gtk.TextBuffer
) –- Return type:
- Gnm.textview_get_text(text_view)¶
- Parameters:
text_view (
Gtk.TextView
) –- Return type:
- Gnm.textview_set_text(text_view, txt)¶
- Parameters:
text_view (
Gtk.TextView
) –txt (
str
) –
- Gnm.theme_is_dark(widget)¶
- Parameters:
widget (
Gtk.Widget
) –- Return type:
- Gnm.tool_consolidate_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.tool_load_selection(state, allow_multiple)¶
- Parameters:
state (
Gnm.GenericToolState
) –allow_multiple (
bool
) –
load the current selection in the output and input entries show the dialog and focus the input_entry
- Gnm.tool_random_cor_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.tool_random_engine(gcc, dao, specs, selector, result)¶
- Parameters:
gcc (
GOffice.CmdContext
) –dao (
Gnm.data_analysis_output_t
) –selector (
Gnm.analysis_tool_engine_t
) –
- Return type:
- Gnm.translate_underline_from_pango(pul)¶
- Parameters:
pul (
Pango.Underline
) –- Return type:
- Gnm.translate_underline_to_pango(ul)¶
- Parameters:
ul (
Gnm.Underline
) –- Return type:
- Gnm.undo_cell_pos_name(sheet, pos)¶
- Parameters:
sheet (
Gnm.Sheet
) –pos (
Gnm.CellPos
) –
- Return type:
Returns the range name depending on the preference setting.
- Gnm.undo_range_list_name(sheet, ranges)¶
- Gnm.undo_range_name(sheet, r)¶
-
Returns the range name depending on the preference setting.
- Gnm.validation_eval(wbc, mstyle, sheet, pos)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –mstyle (
Gnm.Style
) –sheet (
Gnm.Sheet
) –pos (
Gnm.CellPos
) –
- Return type:
(
Gnm.ValidationStatus
, showed_dialog:bool
)
Checks the validation in mstyle, if any. Set showed_dialog to
True
if a dialog was showed as a result.
- Gnm.validation_eval_range(wbc, sheet, pos, r, showed_dialog)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sheet (
Gnm.Sheet
) –pos (
Gnm.CellPos
) –r (
Gnm.Range
) –showed_dialog (
bool
) –
- Return type:
- Gnm.value_cmp(ptr_a, ptr_b)¶
-
qsort style comparison function for ascending order
- Gnm.value_cmp_reverse(ptr_a, ptr_b)¶
-
qsort style comparison function for descending order.
- Gnm.value_error_name(err, translated)¶
- Parameters:
err (
Gnm.StdError
) –Gnm.StdError
- Returns:
the name of err, possibly localized.
- Return type:
- Gnm.value_error_set_pos(err, pos)¶
- Parameters:
err (
Gnm.ValueErr
) –pos (
Gnm.EvalPos
) –
- Returns:
err as a
Gnm.Value
.- Return type:
Change the position of a ValueError.
- Gnm.wb_control_claim_selection(wbc)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –- Return type:
- Gnm.wb_control_cur_sheet(wbc)¶
- Parameters:
- Returns:
the current sheet.
- Return type:
- Gnm.wb_control_cur_sheet_view(wbc)¶
- Parameters:
- Returns:
the current sheet view.
- Return type:
- Gnm.wb_control_edit_line_set(wbc, text)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –text (
str
) –
- Gnm.wb_control_get_doc(wbc)¶
- Parameters:
- Returns:
the
GOffice.workbook
set as aGOffice.Doc
.- Return type:
- Gnm.wb_control_get_workbook(wbc)¶
- Parameters:
- Returns:
the
GOffice.workbook
.- Return type:
- Gnm.wb_control_init_state(wbc)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –
- Gnm.wb_control_jump(wbc, sheet, r)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sheet (
Gnm.Sheet
) –r (
Gnm.RangeRef
) –
- Return type:
- Parameters:
wbc (
Gnm.WorkbookControl
) –flags (
int
) –
- Parameters:
wbc (
Gnm.WorkbookControl
) –to (
Gnm.wb_control_navigator_t
) –
- Gnm.wb_control_parse_and_jump(wbc, text)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –text (
str
) –
- Return type:
- Gnm.wb_control_paste_from_selection(wbc, pt)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –pt (
Gnm.PasteTarget
) –
- Gnm.wb_control_selection_descr_set(wbc, text)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –text (
str
) –
- Gnm.wb_control_set_view(wbc, optional_view, optional_wb)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –optional_view (
Gnm.WorkbookView
) –optional_wb (
Gnm.Workbook
) –
- Gnm.wb_control_sheet_add(wbc, sv)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sv (
Gnm.SheetView
) –
- Gnm.wb_control_sheet_focus(wbc, sheet)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sheet (
Gnm.Sheet
) –
- Gnm.wb_control_sheet_remove(wbc, sheet)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –sheet (
Gnm.Sheet
) –
- Gnm.wb_control_sheet_remove_all(wbc)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –
- Gnm.wb_control_style_feedback(wbc, changes)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –changes (
Gnm.Style
) –
- Gnm.wb_control_undo_redo_labels(wbc, undo, redo)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –undo (
str
) –redo (
str
) –
- Gnm.wb_control_undo_redo_pop(wbc, is_undo)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –is_undo (
bool
) –
- Gnm.wb_control_undo_redo_push(wbc, is_undo, text, key)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –is_undo (
bool
) –text (
str
) –
- Gnm.wb_control_undo_redo_truncate(wbc, n, is_undo)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –n (
int
) –is_undo (
bool
) –
- Gnm.wb_control_update_action_sensitivity(wbc)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –
- Gnm.wb_control_validation_msg(wbc, v, title, msg)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –v (
Gnm.ValidationStyle
) –title (
str
) –msg (
str
) –
- Return type:
1 : ignore invalid and accept result 0 : discard invalid and finish editing -1 : continue editing
- Gnm.wb_control_view(wbc)¶
- Parameters:
- Returns:
the
GOffice.workbook
view.- Return type:
- Gnm.wb_view_attach_control(wbv, wbc)¶
- Parameters:
wbv (
Gnm.WorkbookView
) –wbc (
Gnm.WorkbookControl
) –
- Gnm.wb_view_auto_expr_recalc(wbv)¶
- Parameters:
wbv (
Gnm.WorkbookView
) –
- Gnm.wb_view_cur_sheet(wbv)¶
- Parameters:
wbv (
Gnm.WorkbookView
) –Gnm.WorkbookView
- Returns:
the current sheet.
- Return type:
- Gnm.wb_view_cur_sheet_view(wbv)¶
- Parameters:
wbv (
Gnm.WorkbookView
) –Gnm.WorkbookView
- Returns:
the current sheet view.
- Return type:
- Gnm.wb_view_detach_control(wbc)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –
- Gnm.wb_view_detach_from_workbook(wbv)¶
- Parameters:
wbv (
Gnm.WorkbookView
) –
- Gnm.wb_view_edit_line_set(wbv, wbc)¶
- Parameters:
wbv (
Gnm.WorkbookView
) – The viewwbc (
Gnm.WorkbookControl
orNone
) – AGnm.WorkbookControl
Load the edit line with the
GOffice.value
of the cell in sheet's edit_pos.Calculate what to display on the edit line then display it either in the control wbc, or if that is
None
, in all controls.
- Gnm.wb_view_get_doc(wbv)¶
- Parameters:
wbv (
Gnm.WorkbookView
) –Gnm.WorkbookView
- Returns:
the
Gnm.Workbook
associated with wbv cast to aGOffice.Doc
- Return type:
- Gnm.wb_view_get_index_in_wb(wbv)¶
- Parameters:
wbv (
Gnm.WorkbookView
) –Gnm.WorkbookView
- Return type:
Returns 0 based index of wbv within
GOffice.workbook
, or -1 if there is noGOffice.workbook
.
- Gnm.wb_view_get_workbook(wbv)¶
- Parameters:
wbv (
Gnm.WorkbookView
) –Gnm.WorkbookView
- Returns:
the
Gnm.Workbook
associated with wbv- Return type:
- Gnm.wb_view_is_protected(wbv, check_sheet)¶
- Parameters:
wbv (
Gnm.WorkbookView
) –check_sheet (
bool
) –
- Return type:
- Parameters:
wbv (
Gnm.WorkbookView
) –
- Gnm.wb_view_preferred_size(wbv, w_pixels, h_pixels)¶
- Parameters:
wbv (
Gnm.WorkbookView
) –w_pixels (
int
) –h_pixels (
int
) –
- Gnm.wb_view_selection_desc(wbv, use_pos, wbc)¶
- Parameters:
wbv (
Gnm.WorkbookView
) – The viewuse_pos (
bool
) –wbc (
Gnm.WorkbookControl
orNone
) – AGnm.WorkbookControl
Load the edit line with the
GOffice.value
of the cell in sheet’s edit_pos.Calculate what to display on the edit line then display it either in the control wbc, or if that is
None
, in all controls.
- Gnm.wb_view_set_attribute(wbv, name, value)¶
- Parameters:
wbv (
Gnm.WorkbookView
) –name (
str
) –value (
str
) –
- Gnm.wb_view_sheet_add(wbv, new_sheet)¶
- Parameters:
wbv (
Gnm.WorkbookView
) –new_sheet (
Gnm.Sheet
) –
- Gnm.wb_view_sheet_focus(wbv, sheet)¶
- Parameters:
wbv (
Gnm.WorkbookView
) –sheet (
Gnm.Sheet
) –
- Gnm.wb_view_style_feedback(wbv)¶
- Parameters:
wbv (
Gnm.WorkbookView
) –
- Gnm.wbcg_append_sheet(ignored, wbcg)¶
- Parameters:
ignored (
Gtk.Widget
) –wbcg (
Gnm.WBCGtk
) –
- Gnm.wbcg_auto_complete_destroy(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.wbcg_clone_sheet(ignored, wbcg)¶
- Parameters:
ignored (
Gtk.Widget
) –wbcg (
Gnm.WBCGtk
) –
- Gnm.wbcg_copy_toolbar_visibility(new_wbcg, wbcg)¶
- Parameters:
new_wbcg (
Gnm.WBCGtk
) –wbcg (
Gnm.WBCGtk
) –
- Gnm.wbcg_cur_scg(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –Gnm.WBCGtk
- Returns:
the current
Gnm.SheetControlGUI
.- Return type:
- Gnm.wbcg_cur_sheet(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –Gnm.WBCGtk
- Returns:
the current
Gnm.Sheet
.- Return type:
- Gnm.wbcg_edit_add_markup(wbcg, attr)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –Gnm.WBCGtk
attr (
Pango.Attribute
) –Pango.Attribute
Absorbs the ref to attr.
- Gnm.wbcg_edit_finish(wbcg, result)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –Gnm.WBCGtk
result (
Gnm.WBCEditResult
) – what should we do with the content
- Returns:
True
if editing completed successfully, or we were no editing.- showed_dialog:
indicates whether a dialog was displayed.
- Return type:
- Gnm.wbcg_edit_get_display_text(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –- Return type:
- Gnm.wbcg_edit_get_markup(wbcg, full)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –Gnm.WBCGtk
full (
bool
) –
- Returns:
a potentially
None
Pango.AttrList
of the current markup while editing. The list belongs to wbcg and should not be freed.- Return type:
- Gnm.wbcg_edit_start(wbcg, blankp, cursorp)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) – TheGOffice.workbook
to be edited.blankp (
bool
) – If true, erase current cell contents first. If false, leave the contents alone.cursorp (
bool
) – If true, create an editingGnm.cursor
in the current sheet. (If false, the text will be editing in the edit box above the sheet, but this is not handled by this function.)
- Returns:
True
if we did indeed start editing. ReturnsFalse
if the cell-to-be-edited was locked.- Return type:
Initiate editing of a cell in the sheet. Note that we have two modes of editing: 1) in-cell editing when you just start typing, and 2) above sheet editing when you hit F2.
- Gnm.wbcg_entry_has_logical(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –Gnm.WBCGtk
- Returns:
True
ifGnm.wbcg_set_entry
has redirected the edit_entry.- Return type:
- Gnm.wbcg_find_action(wbcg, name)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) – theGOffice.workbook
control guiname (
str
) – name of action
- Returns:
The action with the given name
- Return type:
- Gnm.wbcg_find_for_workbook(wb, candidate, pref_screen, pref_display)¶
- Parameters:
wb (
Gnm.Workbook
) –Gnm.Workbook
candidate (
Gnm.WBCGtk
) – a candidateGnm.WBCGtk
pref_screen (
Gdk.Screen
) – the preferred screen.pref_display (
Gdk.Display
) – the preferred display.
- Returns:
the found
Gnm.WBCGtk
orNone
.- Return type:
- Gnm.wbcg_focus_cur_scg(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) – TheGOffice.workbook
control to operate on.- Returns:
the sheet.
- Return type:
A utility routine to safely ensure that the keyboard focus is attached to the item-grid. This is required when a user edits a combo-box or and entry-line which grab focus.
It is called for zoom,
Gnm.font
name/size, and accept/cancel for the editline.
- Gnm.wbcg_focus_current_cell_indicator(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –
- Gnm.wbcg_font_action_set_font_desc(act, desc)¶
- Parameters:
act (
Gtk.Action
) –desc (
Pango.FontDescription
) –
- Gnm.wbcg_get_entry(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –Gnm.WBCGtk
- Returns:
the
Gtk.Entry
associated with the currentGnm.ExprEntry
- Return type:
- Gnm.wbcg_get_entry_logical(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –Gnm.WBCGtk
- Returns:
the logical (allowing redirection via
Gnm.wbcg_set_entry
for gurus)Gnm.ExprEntry
- Return type:
- Gnm.wbcg_get_entry_underlying(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –Gnm.WBCGtk
- Returns:
the
Gtk.Entry
associated with the logicalGnm.ExprEntry
.- Return type:
- Gnm.wbcg_get_font_desc(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –- Return type:
- Gnm.wbcg_get_n_scg(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –- Return type:
- Gnm.wbcg_get_nth_scg(wbcg, i)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –Gnm.WBCGtk
i (
int
) –
- Returns:
the scg associated with the i-th tab in wbcg's notebook. NOTE : i != scg->sv->sheet->index_in_wb
- Return type:
- Gnm.wbcg_insert_object(wbcg, so)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –Gnm.WBCGtk
*so (
Gnm.SheetObject
) – The object the needs to be placed
Takes a newly created
Gnm.SheetObject
that has not yet been realized and prepares to place it on the sheet.NOTE : Absorbs a reference to the object.
- Gnm.wbcg_insert_object_clear(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –Gnm.WBCGtk
If we are preparing to insert a new object, unref the object, and restore a normal state to the scgs that was changed in
Gnm.wbcg_insert_object
(e.g., visibility of cursors)
- Gnm.wbcg_insert_sheet(ignored, wbcg)¶
- Parameters:
ignored (
Gtk.Widget
) –wbcg (
Gnm.WBCGtk
) –
- Gnm.wbcg_is_editing(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –- Return type:
- Gnm.wbcg_rangesel_possible(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) – theGOffice.workbook
control gui- Return type:
Returns true if the
Gnm.cursor
keys should be used to select a cell range (if theGnm.cursor
is in a spot in the expression where it makes sense to have a cell reference), false if not.
- Gnm.wbcg_set_end_mode(wbcg, flag)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –flag (
bool
) –
- Gnm.wbcg_set_entry(wbc, new_entry)¶
- Parameters:
wbc (
Gnm.WBCGtk
) –new_entry (
Gnm.ExprEntry
) –
- Gnm.wbcg_set_status_text(wbcg, text)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –text (
str
) –
- Gnm.wbcg_set_transient(wbcg, window)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –window (
Gtk.Window
) –
- Gnm.wbcg_toggle_visibility(wbcg, action)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –action (
Gtk.ToggleAction
) –
- Gnm.wbcg_toplevel(wbcg)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –Gnm.WBCGtk
- Returns:
the toplevel
Gtk.Window
.- Return type:
- Gnm.widget_measure_string(w, s)¶
- Parameters:
w (
Gtk.Widget
) –s (
str
) –
- Return type:
- Gnm.widget_set_cursor(w, ct)¶
- Parameters:
w (
Gtk.Widget
) –ct (
Gdk.Cursor
) –
- Gnm.widget_set_cursor_type(w, ct)¶
- Parameters:
w (
Gtk.Widget
) –ct (
Gdk.CursorType
) –
- Gnm.x_claim_clipboard(display)¶
- Parameters:
display (
Gdk.Display
) –- Return type:
- Gnm.x_disown_clipboard()¶
- Gnm.x_request_clipboard(wbcg, pt)¶
- Parameters:
wbcg (
Gnm.WBCGtk
) –pt (
Gnm.PasteTarget
) –
- Gnm.x_store_clipboard_if_needed(wb)¶
- Parameters:
wb (
Gnm.Workbook
) –
- Gnm.xml_attr_bool(attrs, name, res)¶
- Parameters:
attrs (
libxml2.Char
) –name (
str
) –res (
bool
) –
- Return type:
- Gnm.xml_attr_double(attrs, name, res)¶
- Parameters:
attrs (
libxml2.Char
) –name (
str
) –res (
float
) –
- Return type:
- Gnm.xml_attr_int(attrs, name, res)¶
- Parameters:
attrs (
libxml2.Char
) –name (
str
) –res (
int
) –
- Return type:
- Gnm.xml_cellregion_read(wbc, io_context, sheet, buffer, length)¶
- Parameters:
wbc (
Gnm.WorkbookControl
) –io_context (
GOffice.IOContext
) –sheet (
Gnm.Sheet
) –buffer (
str
) –length (
int
) –
- Return type:
- Gnm.xml_in_cur_obj(xin)¶
- Parameters:
- Returns:
the current sheet object.
- Return type:
- Gnm.xml_in_cur_sheet(xin)¶
- Gnm.xml_in_doc_dispose_on_exit(pdoc)¶
- Parameters:
pdoc (
Gsf.XMLInDoc
) –
- Gnm.xml_io_conventions()¶
- Return type:
- Gnm.xml_out_add_gocolor(o, id, c)¶
- Parameters:
o (
Gsf.XMLOut
) –id (
str
) –c (
int
) –
- Gnm.xml_out_end_element_check(xout, id)¶
- Parameters:
xout (
Gsf.XMLOut
) –Gsf.XMLOut
sinkid (
str
) – expected tag being closed
Closes an xml tag, expected it to be id. If it is not, tags will continue to be closed until the expected one is found in the hope that getting back to sync will make the result less corrupted.
- Gnm.xml_prep_style_parser(xin, attrs, handler, user)¶
- Parameters:
xin (
Gsf.XMLIn
) –attrs (
libxml2.Char
) –handler (
Gnm.XmlStyleHandler
) –
- Gnm.xml_sax_read_init()¶
- Gnm.xml_sax_read_shutdown()¶
- Gnm.xml_sax_write_init()¶
- Gnm.xml_sax_write_shutdown()¶
- Gnm.yearfrac(from_, to, basis)¶
- Parameters:
from (
GLib.Date
) –to (
GLib.Date
) –basis (
GOffice.BasisType
) –
- Return type: