Module: Gnm

Defined in:
lib/gnm/loader.rb,
lib/gnm.rb

Overview

Copyright (C) 2016-2021 Ruby-GNOME Project Team

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Defined Under Namespace

Modules: CellFlags, CellIterFlags, CmdObjectRaiseSelector, ColRowSelectionType, CollectFlags, ConsolidateMode, DependentFlags, DialogDestroyOptions, ExprEntryFlags, ExprEvalFlags, ExprOp, ExprParseFlags, FTFreqDirection, FileOpenStyle, FileSaveAsStyle, FilterOp, FormatDialogPosition_t, FormatImportFlags, FuncFlags, FuncHelpType, FuncImplStatus, FuncTestStatus, FuncType, GoalSeekStatus, HAlign, ItemCursorStyle, PageBreakType, PaneSlideFlags, ParseErrorID, PasteFlags, PrintCommentPlacementType, PrintErrorsType, PrintHFRenderType, PrintRange, SOAnchorMode, SOResizeMode, SearchReplaceError, SearchReplaceLocus, SearchReplaceQuery, SearchReplaceScope, SelectionMode, SheetClearFlags, SheetObjectExportable, SheetObjectFlags, SheetObjectImageable, SheetObjectViewContainer, SheetSlicerLayout, SheetType, SheetViewMode, SheetVisibility, SolverConstraintType, SolverModelType, SolverProblemType, SolverResultQuality, SolverStatus, SpanCalcFlags, StdError, StfDialogPage, StfFormatMode, StfParseType_t, StfTransliterateMode, StfTrimType_t, StyleBorderLocation, StyleBorderOrientation, StyleBorderType, StyleCondOp, StyleElement, TextDir, Underline, UpdateType, VAlign, ValDiff, ValidationOp, ValidationStatus, ValidationStyle, ValidationType, ValueType, WBCEditResult, XMLVersion, analysis_histogram_bin_type_t, analysis_tool_engine_t, analysis_tools_error_code_t, chart_freq_t, chart_t, data_analysis_output_type_t, exponential_smoothing_type_t, fill_series_date_unit_t, fill_series_type_t, group_by_t, moving_average_type_t, normality_test_type_t, random_distribution_t, random_gen_cor_type_t, signtest_type, sim_errmask_t, so_styled_t, ttest_type, wb_control_navigator_t Classes: App, CComboView, CellCombo, CellRendererExprEntry, CellRendererText, CellRendererToggle, CmdContextStderr, Command, Comment, Complete, CompleteSheet, Dao, DashedCanvasLine, DataCacheSource, Dependent, Error, ExprEntry, FilterCombo, FilterComboView, FontButton, Func, GODataMatrix, GODataScalar, GODataVector, GraphWindow, HLink, HLinkCurWB, HLinkEMail, HLinkExternal, HLinkURL, InputMsg, ItemBar, ItemCursor, ItemEdit, ItemGrid, IterSolver, Loader, Notebook, NotebookButton, Pane, PluginLoaderModule, PluginServiceFunctionGroup, PluginServiceSolver, PluginServiceUI, PreviewGrid, RadioButton, SOAnchorModeChooser, SOFilled, SOLine, SOPath, SOPolygon, SOWidgetView, Scenario, SearchReplace, Sheet, SheetControl, SheetControlGUI, SheetObject, SheetObjectComponent, SheetObjectGraph, SheetObjectImage, SheetObjectView, SheetObjectWidget, SheetSel, SheetSlicer, SheetSlicerCombo, SheetSlicerComboView, SheetView, SheetWidgetAdjustment, SheetWidgetButton, SheetWidgetCheckbox, SheetWidgetCombo, SheetWidgetFrame, SheetWidgetList, SheetWidgetRadioButton, SheetWidgetScrollbar, SheetWidgetSlider, SheetWidgetSpinbutton, SheetWidgetToggleButton, SimpleCanvas, Solver, SolverFactory, SolverIterator, SolverIteratorCompound, SolverParameters, SolverResult, SolverSensitivity, StfExport, StyleConditions, SubSolver, TextView, UndoColrowRestoreStateGroup, UndoColrowSetSizes, UndoFilterSetCondition, ValidationCombo, ValidationComboView, WBCGtk, Workbook, WorkbookControl, WorkbookSel, WorkbookView

Constant Summary collapse

COLROW_SEGMENT_SIZE =
128
COL_MARGIN =
2
DEFAULT_COLS =
256
DEFAULT_FONT =
Sans
DEFAULT_ROWS =
65536
DEFAULT_SIZE =
10.000000
EXPR_TOP_MAGIC =
66
FORMAT_E =
LE
FORMAT_G =
LG
FORMAT_e =
Le
FORMAT_f =
Lf
FORMAT_g =
Lg
sect-data-modify
anova-single-factor-tool
anova-two-factor-tool
sect-data-entry
sect-data-modify
sect-data-modify
sect-data-entry
sect-files-autosave
sect-data-comment
sect-data-format
sect-data-format
sect-data-modify
chi-square-tool
sect-worksheets-colrow
correlation-tool
covariance-tool
sect-data-generate
sect-data-modify
sect-data-slicer-config
sect-data-table
sect-workbooks-names
sect-data-table
sect-data-delete
descriptive-statistics-tool
smoothing-tool-dialog
sect-data-entry
sect-data-entry
fourier-analysis-tool
frequency-tool
sect-data-entry
ftest-two-sample-for-variances-tool
sect-advanced-analysis-goalseek
menu-edit-select.png
sect-worksheets-viewing
histogram-tool
sect-data-link
sect-data-insert
kaplan-meier-tool
t-test
chapter-workbooks
moving-average-tool
normality-tool
one-mean-tool
sect-workbooks-names-paste
Edit-Menu
sect-configuring-plugins
sect-configuration-preferences
principal-component-tool
sect-printing-setup
sect-printing-setup
sect-printing-setup
sect-dataentryadv
sect-dataentryadv
rank-and-percentile-tool
regression-tool
sect-worksheets-colrow
sampling-tool
sect-advanced-analysis-scenarios
sect-advanced-analysis-scenarios
sect-data-modify
sect-data-modify
sect-worksheets-managing
one-median-tool
two-medians-tool
sect-advanced-analysis-simulation
sect-advanced-analysis-solver
sect-graphics-drawings
sect-graphics-drawings
sect-graphics-drawings
sect-graphics-drawings
sect-graphics-drawings
sect-graphics-drawings
sect-graphics-drawings
sect-workbooks-docsummary
sect-data-generate
sect-worksheets-viewing
two-median-wilcoxon-mann-whitney-test-tool
sect-workbooks
sect-worksheets-viewing
MAX_COLS =
16384
MAX_ROWS =
16777216
MIN_COLS =
128
MIN_ROWS =
128
MS_ALL =
163839
MS_GURU_MENU_ITEMS =
480
M_PI_2gnum =
0
PANE_MAX_X =
1600000
PANE_MAX_Y =
1536000000
PASTE_OPER_MASK =
480
PATTERNS_MAX =
25
PLUGIN_SUBDIR =
plugins
GnumericPrintIgnorePageBreaks
GnumericPrintRange
GnumericPrintFromSheet
GnumericPrintToSheet
RESPONSE_DISCARD_ALL =
-1001
RESPONSE_SAVE_ALL =
-1000
ROW_MARGIN =
0
SCANF_g =
Lg
SCG_NUM_PANES =
4
SHUFFLE_AREA =
2
SHUFFLE_COLS =
0
SHUFFLE_ROWS =
1
STF_LINE_DISPLAY_LIMIT =
500
STF_LINE_LENGTH_LIMIT =
1000
STOCK_LABEL_CONTEXT =
Stock label
UNICODE_DIVISION_SLASH_C =
8725
UNICODE_EURO_SIGN_C =
8364
UNICODE_GREATER_THAN_OR_EQUAL_TO_C =
8805
UNICODE_LESS_THAN_OR_EQUAL_TO_C =
8804
UNICODE_LOGICAL_AND_C =
8743
UNICODE_LOGICAL_NOT_C =
172
UNICODE_LOGICAL_OR_C =
8744
UNICODE_MINUS_SIGN_C =
8722
UNICODE_NOT_EQUAL_TO_C =
8800
UNICODE_ZERO_WIDTH_SPACE_C =
0
UNICODE_ZERO_WIDTH_SPACE_C_UTF8_LENGTH =
3
VALUE_INTEGER =
30
LOG_DOMAIN =
"Gnumeric"

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.const_missing(name) ⇒ Object



29
30
31
32
33
34
35
36
# File 'lib/gnm.rb', line 29

def const_missing(name)
  init
  if const_defined?(name)
    const_get(name)
  else
    super
  end
end

.initObject



38
39
40
41
42
43
44
45
46
47
48
49
50
# File 'lib/gnm.rb', line 38

def init
  class << self
    remove_method(:init)
    remove_method(:const_missing)
  end
  GOffice.init if GOffice.respond_to?(:init)
  loader = Loader.new(self)
  loader.load("Gnm")
  init
  class << self
    remove_method(:init)
  end
end

Instance Method Details

#1_0_rangeref_as_string(out, ref) ⇒ nil

Simplified variant of rangeref_as_string that old versions of gnumeric can read. It drops support for full col/row references. We can remap them on import.

This function also ignores R1C1 settings.

Parameters:

  • out (Gnm::ConventionsOut)

    Gnm::ConventionsOut

  • ref (Gnm::RangeRef)

    Gnm::RangeRef

Returns:

  • (nil)

#acot(x) ⇒ Gnm::gnm_float

Returns The inverse co-tangent of the given number.

Parameters:

  • x (Gnm::gnm_float)

    a number

Returns:

  • (Gnm::gnm_float)

    The inverse co-tangent of the given number.

#acoth(x) ⇒ Gnm::gnm_float

Returns The inverse hyperbolic co-tangent of the given number.

Parameters:

  • x (Gnm::gnm_float)

    a number

Returns:

  • (Gnm::gnm_float)

    The inverse hyperbolic co-tangent of the given number.

#action_group_add_action(group, act) ⇒ nil

Parameters:

  • group (Gtk::ActionGroup)
  • act (Gtk::Action)

Returns:

  • (nil)

#action_group_add_actions(group, actions, n, user) ⇒ nil

Parameters:

  • group (Gtk::ActionGroup)
  • actions (Gnm::ActionEntry)
  • n (Integer)
  • user (GObject)

Returns:

  • (nil)

#advanced_filter(wbc, dao, database, criteria, unique_only_flag) ⇒ Integer

Parameters:

  • wbc (Gnm::WorkbookControl)
  • dao (Gnm::data_analysis_output_t)
  • database (Gnm::Value)
  • criteria (Gnm::Value)
  • unique_only_flag (Boolean)

Returns:

  • (Integer)

#agm(a, b) ⇒ Gnm::gnm_float

Returns The arithmetic-geometric mean of a and b.

Parameters:

  • a (Gnm::gnm_float)

    a number

  • b (Gnm::gnm_float)

    a number

Returns:

  • (Gnm::gnm_float)

    The arithmetic-geometric mean of a and b.

#analysis_tool_advanced_filter_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_anova_single_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_anova_two_factor_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_auto_expression_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_calc_length(info) ⇒ Integer

Parameters:

  • info (Gnm::analysis_tools_data_generic_t)

Returns:

  • (Integer)

#analysis_tool_chi_squared_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_correlation_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_covariance_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_descriptive_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_exponential_smoothing_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_fourier_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_frequency_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_ftest_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_generic_b_clean(specs) ⇒ Boolean

Parameters:

  • specs (GObject)

Returns:

  • (Boolean)

#analysis_tool_generic_clean(specs) ⇒ Boolean

Parameters:

  • specs (GObject)

Returns:

  • (Boolean)

#analysis_tool_get_function(name, dao) ⇒ Gnm::Func

The usage count of the function is incremented.

Parameters:

  • name (String)

    name of function

  • dao (Gnm::data_analysis_output_t)

Returns:

  • (Gnm::Func)

    the function named name or a placeholder.

#analysis_tool_histogram_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_kaplan_meier_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_moving_average_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_normality_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_one_mean_test_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_principal_components_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_ranking_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_regression_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_sampling_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_sign_test_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_sign_test_two_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_signed_rank_test_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_signed_rank_test_two_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_table(dao, info, title, functionname, full_table) ⇒ Boolean

Parameters:

  • dao (Gnm::data_analysis_output_t)
  • info (Gnm::analysis_tools_data_generic_t)
  • title (String)
  • functionname (String)
  • full_table (Boolean)

Returns:

  • (Boolean)

#analysis_tool_ttest_eqvar_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_ttest_neqvar_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_ttest_paired_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_wilcoxon_mann_whitney_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tool_ztest_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#analysis_tools_write_label(val, dao, info, x, y, i) ⇒ nil

Parameters:

  • val (Gnm::Value)
  • dao (Gnm::data_analysis_output_t)
  • info (Gnm::analysis_tools_data_generic_t)
  • x (Integer)
  • y (Integer)
  • i (Integer)

Returns:

  • (nil)

#analysis_tools_write_label_ftest(val, dao, x, y, labels, i) ⇒ nil

Parameters:

  • val (Gnm::Value)
  • dao (Gnm::data_analysis_output_t)
  • x (Integer)
  • y (Integer)
  • labels (Boolean)
  • i (Integer)

Returns:

  • (nil)

#annual_year_basis(value_date, basis, date_conv) ⇒ Integer

Parameters:

  • value_date (Gnm::Value)
  • basis (GOffice::BasisType)
  • date_conv (GOffice::DateConventions)

Returns:

  • (Integer)

#argv0String

Returns:

  • (String)

#auto_style_format_suggest(texpr, epos) ⇒ GOffice::Format

Suggest a format for texpr.

Parameters:

  • texpr (Gnm::ExprTop)

    A Gnm::ExprTop

  • epos (Gnm::EvalPos)

    A Gnm::EvalPos

Returns:

  • (GOffice::Format)

    Suggested format.

#autocorrect_tool(input) ⇒ String

Parameters:

  • input (String)

Returns:

  • (String)

#autofill_fill(sheet, default_increment, base_col, base_row, w, h, end_col, end_row) ⇒ nil

An internal routine to autofill a region. It does NOT queue a recalc, flag a status update, or regen spans.

Parameters:

  • sheet (Gnm::Sheet)
  • default_increment (Boolean)
  • base_col (Integer)
  • base_row (Integer)
  • w (Integer)
  • h (Integer)
  • end_col (Integer)
  • end_row (Integer)

Returns:

  • (nil)

#autofill_hint(sheet, default_increment, base_col, base_row, w, h, end_col, end_row) ⇒ GLib::String

Parameters:

  • sheet (Gnm::Sheet)
  • default_increment (Boolean)
  • base_col (Integer)
  • base_row (Integer)
  • w (Integer)
  • h (Integer)
  • end_col (Integer)
  • end_row (Integer)

Returns:

  • (GLib::String)

#autofill_initnil

Returns:

  • (nil)

#autofill_shutdownnil

Returns:

  • (nil)

#bessel_i(x, alpha) ⇒ Gnm::gnm_float

Parameters:

  • x (Gnm::gnm_float)
  • alpha (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#bessel_j(x, alpha) ⇒ Gnm::gnm_float

Parameters:

  • x (Gnm::gnm_float)
  • alpha (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#bessel_k(x, alpha) ⇒ Gnm::gnm_float

Parameters:

  • x (Gnm::gnm_float)
  • alpha (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#bessel_y(x, alpha) ⇒ Gnm::gnm_float

Parameters:

  • x (Gnm::gnm_float)
  • alpha (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#beta(a, b) ⇒ Gnm::gnm_float

Returns the Beta function evaluated at a and b.

Parameters:

  • a (Gnm::gnm_float)

    a number

  • b (Gnm::gnm_float)

    a number

Returns:

  • (Gnm::gnm_float)

    the Beta function evaluated at a and b.

#border_shutdownnil

Returns:

  • (nil)

#canvas_get_position(canvas, x, y, px, py) ⇒ nil

Parameters:

  • canvas (GOffice::Canvas)
  • x (Integer)
  • y (Integer)
  • px (Integer)
  • py (Integer)

Returns:

  • (nil)

#canvas_get_screen_position(canvas, x, y, ix, iy) ⇒ nil

Parameters:

  • canvas (GOffice::Canvas)
  • x (Float)
  • y (Float)
  • ix (Integer)
  • iy (Integer)

Returns:

  • (nil)

#cell_coord_name(col, row) ⇒ String

Returns a string representation of the cell at (col,row).

Parameters:

  • col (Integer)

    column number

  • row (Integer)

    row number

Returns:

  • (String)

    a string representation of the cell at (col,row)

#cell_set_array(sheet, r, texpr) ⇒ Boolean

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. NOTE : This adds a reference to the expression.

Does not regenerate spans, dimensions or autosize cols/rows.

DOES CHECK for array partitioning.

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:

  • (Boolean)

    true if the operation succeeded.

#cell_set_array_formula(sheet, cola, rowa, colb, rowb, texpr) ⇒ nil

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.

NOTE : Does not add a reference to the expression. It takes over the caller's reference.

Does not regenerate spans, dimensions or autosize cols/rows.

DOES NOT CHECK for array partitioning.

Parameters:

  • sheet (Gnm::Sheet)

    The sheet to set the expr in.

  • cola (Integer)

    The left column in the destination region.

  • rowa (Integer)

    The top row in the destination region.

  • colb (Integer)

    The right column in the destination region.

  • rowb (Integer)

    The bottom row in the destination region.

  • texpr (Gnm::ExprTop)

    an expression (the inner expression, not a corner or element)

Returns:

  • (nil)

#cell_set_array_formula_undo(sr, texpr) ⇒ GOffice::Undo

Returns the newly allocated #GOUndo.

Parameters:

  • sr (Gnm::SheetRange)
  • texpr (Gnm::ExprTop)

Returns:

  • (GOffice::Undo)

    the newly allocated #GOUndo.

#cell_set_comment(sheet, pos, author, text, markup) ⇒ Gnm::Comment

Returns the newly allocated Gnm::Comment.

Parameters:

  • sheet (Gnm::Sheet)

    #Sheet.

  • pos (Gnm::CellPos)

    the position.

  • author (String)

    comment author.

  • text (String)

    comment text.

  • markup (Pango::AttrList)

    comment markup.

Returns:

#cellpos_as_string(pos) ⇒ String

Returns a string representation of the cell at pos.

Parameters:

  • pos (Gnm::CellPos)

    A Gnm::CellPos

Returns:

  • (String)

    a string representation of the cell at pos

#cellpos_equal(a, b) ⇒ Integer

Parameters:

  • a (Gnm::CellPos)
  • b (Gnm::CellPos)

Returns:

  • (Integer)

#cellpos_hash(key) ⇒ Integer

Parameters:

  • key (Gnm::CellPos)

Returns:

  • (Integer)

#cellpos_init_cellref(cp, cr, pos, base_sheet) ⇒ nil

Parameters:

  • cp (Gnm::CellPos)
  • cr (Gnm::CellRef)
  • pos (Gnm::CellPos)
  • base_sheet (Gnm::Sheet)

Returns:

  • (nil)

#cellpos_init_cellref_ss(res, cell_ref, pos, ss) ⇒ nil

Parameters:

  • res (Gnm::CellPos)
  • cell_ref (Gnm::CellRef)
  • pos (Gnm::CellPos)
  • ss (Gnm::SheetSize)

Returns:

  • (nil)

#cellpos_parse(cell_str, ss, res, strict) ⇒ String

failure. (In the strict case, that would be a pointer to the \0 or nil.)

Parameters:

  • cell_str (String)

    a string representation of a cell name.

  • ss (Gnm::SheetSize)

    Gnm::SheetSize

  • res (Gnm::CellPos)

    result

  • strict (Boolean)

    if this is true, then parsing stops at possible errors, otherwise an attempt is made to return cell names with trailing garbage.

Returns:

  • (String)

    pointer to following char on success, nil on

#cellref_as_string(out, cell_ref, no_sheetname) ⇒ nil

Emits a string containing representation of ref as evaluated at pp. no_sheetname can be used to suppress the addition of the sheetname for non-local references.

Parameters:

  • out (Gnm::ConventionsOut)

    Gnm::ConventionsOut

  • cell_ref (Gnm::CellRef)
  • no_sheetname (Boolean)

    If true, suppress sheet name

Returns:

  • (nil)

#cellref_parse(out, ss, in, pos) ⇒ String

Converts the string representation of a Gnm::CellRef into an internal representation. cellref.

Parameters:

  • out (Gnm::CellRef)

    destination GnmCellRef

  • ss (Gnm::SheetSize)

    size of the sheet where parsing is being done

  • in (String)

    reference description text, no leading whitespace allowed.

  • pos (Gnm::CellPos)

    position parsing is being done at

Returns:

  • (String)

    a pointer to the character following the

#cellregion_cmd_size(cr) ⇒ Integer

Parameters:

  • cr (Gnm::CellRegion)

Returns:

  • (Integer)

#cellregion_invalidate_sheet(cr, sheet) ⇒ nil

Invalidate references from cell content, objects or style to sheet.

Parameters:

  • cr (Gnm::CellRegion)

    Gnm::CellRegion

  • sheet (Gnm::Sheet)

    #Sheet

Returns:

  • (nil)

#cellregion_ref(cr) ⇒ Gnm::CellRegion

Parameters:

  • cr (Gnm::CellRegion)

Returns:

  • (Gnm::CellRegion)

#cellregion_to_string(cr, only_visible, date_conv) ⇒ GLib::String

Parameters:

  • cr (Gnm::CellRegion)
  • only_visible (Boolean)
  • date_conv (GOffice::DateConventions)

Returns:

  • (GLib::String)

#cellregion_to_xml(cr) ⇒ Gsf::OutputMemory

Returns nil on error.

Parameters:

  • cr (Gnm::CellRegion)

    the content to store.

Returns:

  • (Gsf::OutputMemory)

    nil on error

#cellregion_unref(cr) ⇒ nil

Parameters:

  • cr (Gnm::CellRegion)

Returns:

  • (nil)

#check_for_plugins_missing(ids, parent) ⇒ Boolean

Parameters:

  • ids (String)
  • parent (Gtk::Window)

Returns:

  • (Boolean)

#clipboard_copy_obj(sheet, objects) ⇒ Gnm::CellRegion

Returns a cell region with copies of objects in list. Caller is responsible for cellregion_unref-ing the result.

Parameters:

Returns:

  • (Gnm::CellRegion)

#clipboard_copy_range(sheet, r) ⇒ Gnm::CellRegion

Entry point to the clipboard copy code

Parameters:

Returns:

  • (Gnm::CellRegion)

#clipboard_copy_range_undo(sheet, r) ⇒ GOffice::Undo

of the given range.

Parameters:

  • sheet (Gnm::Sheet)

    #Sheet

  • r (Gnm::Range)

    Gnm::Range

Returns:

  • (GOffice::Undo)

    A #GOUndo object that will restore the contents

#clipboard_copy_ranges_undo(sheet, ranges) ⇒ GOffice::Undo

of the given range.

Parameters:

  • sheet (Gnm::Sheet)

    #Sheet

  • ranges (GLib::SList<Gnm::Range>)

    list of ranges

Returns:

  • (GOffice::Undo)

    A #GOUndo object that will restore the contents

#clipboard_initnil

Returns:

  • (nil)

#clipboard_paste_region(cr, pt, cc) ⇒ Boolean

Pastes the supplied GnmCellRegion (cr) into the supplied GnmPasteTarget (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.

Parameters:

  • cr (Gnm::CellRegion)

    The GnmCellRegion to paste.

  • pt (Gnm::PasteTarget)

    Where to paste the values.

  • cc (GOffice::CmdContext)

    The context for error handling.

Returns:

  • (Boolean)

    true if there was a problem.

#clipboard_shutdownnil

Returns:

  • (nil)

#cmd_analysis_tool(wbc, sheet, dao, specs, engine, always_take_ownership) ⇒ Boolean

Note: this takes ownership of specs and dao if the command succeeds.

Parameters:

  • wbc (Gnm::WorkbookControl)
  • sheet (Gnm::Sheet)
  • dao (Gnm::data_analysis_output_t)
  • specs (GObject)
  • engine (Gnm::analysis_tool_engine)
  • always_take_ownership (Boolean)

Returns:

  • (Boolean)

    true if there was a problem, false otherwise.

#cmd_area_set_array_expr(wbc, sv, new_texpr) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_area_set_text(wbc, sv, text, markup) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_autofill(wbc, sheet, default_increment, base_col, base_row, w, h, end_col, end_row, inverse_autofill) ⇒ Boolean

Parameters:

  • wbc (Gnm::WorkbookControl)
  • sheet (Gnm::Sheet)
  • default_increment (Boolean)
  • base_col (Integer)
  • base_row (Integer)
  • w (Integer)
  • h (Integer)
  • end_col (Integer)
  • end_row (Integer)
  • inverse_autofill (Boolean)

Returns:

  • (Boolean)

#cmd_autofilter_add_remove(wbc) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_autofilter_set_condition(wbc, filter, i, cond) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_autofit_selection(wbc, sv, sheet, fit_width, selectionlist) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_cell_range_is_locked_effective(sheet, range, wbc, cmd_name) ⇒ Boolean

checks whether the cells are effectively locked

static gboolean cmd_cell_range_is_locked_effective

Do not use this function unless the sheet is part of the workbook with the given wbc (otherwise the results may be strange)

Parameters:

  • sheet (Gnm::Sheet)

    #Sheet

  • range (Gnm::Range)

    Gnm::Range

  • wbc (Gnm::WorkbookControl)

    Workbook::Control

  • cmd_name (String)

    the command name.

Returns:

  • (Boolean)

    true if there was a problem, false otherwise.

#cmd_change_meta_data(wbc, changes, removed) ⇒ Boolean

Returns true if there was a problem, false otherwise.

Parameters:

  • wbc (Gnm::WorkbookControl)

    Workbook::Control

  • changes (GLib::SList<Gsf::DocMetaData>)

    the changed metadata.

  • removed (GLib::SList<Gsf::DocMetaData>)

    the removed metadata.

Returns:

  • (Boolean)

    true if there was a problem, false otherwise.

#cmd_colrow_std_size(wbc, sheet, is_cols, new_default) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_context_error_calc(cc, msg) ⇒ nil

Parameters:

  • cc (GOffice::CmdContext)
  • msg (String)

Returns:

  • (nil)

#cmd_context_error_splits_array(cc, cmd, array) ⇒ nil

Parameters:

  • cc (GOffice::CmdContext)
  • cmd (String)
  • array (Gnm::Range)

Returns:

  • (nil)

#cmd_context_error_splits_merge(cc, merge) ⇒ nil

Parameters:

  • cc (GOffice::CmdContext)
  • merge (Gnm::Range)

Returns:

  • (nil)

#cmd_copyrel(wbc, dx, dy, name) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_create_data_table(wbc, sheet, r, col_input, row_input) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_data_shuffle(wbc, sc, sheet) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_define_name(wbc, name, pp, texpr, descriptor) ⇒ Boolean

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.

Parameters:

  • wbc (Gnm::WorkbookControl)
  • name (String)
  • pp (Gnm::ParsePos)
  • texpr (Gnm::ExprTop)

    Gnm::ExprTop

  • descriptor (String)

    optional descriptor.

Returns:

  • (Boolean)

    true if there was a problem, false otherwise.

#cmd_delete_cols(wbc, sheet, start_col, count) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_delete_rows(wbc, sheet, start_row, count) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_generic(wbc, text, undo, redo) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_generic_with_size(wbc, text, size, undo, redo) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_global_outline_change(wbc, is_cols, depth) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_goal_seek(wbc, cell, ov, nv) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_insert_cols(wbc, sheet, start_col, count) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_insert_rows(wbc, sheet, start_row, count) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_merge_cells(wbc, sheet, selection, center) ⇒ Boolean

Returns true if there was a problem, false otherwise.

Parameters:

Returns:

  • (Boolean)

    true if there was a problem, false otherwise.

#cmd_merge_data(wbc, sheet, merge_zone, merge_fields, merge_data) ⇒ Boolean

Returns true if there was a problem, false otherwise.

Parameters:

  • wbc (Gnm::WorkbookControl)

    Workbook::Control

  • sheet (Gnm::Sheet)

    #Sheet

  • merge_zone (Gnm::Value)

    Gnm::Value

  • merge_fields (GLib::SList<Gnm::Range>)
  • merge_data (GLib::SList<Gnm::Range>)

Returns:

  • (Boolean)

    true if there was a problem, false otherwise.

#cmd_object_raise(wbc, so, dir) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_objects_delete(wbc, objects, name) ⇒ Boolean

delete.

Parameters:

Returns:

  • (Boolean)

    true if there was a problem, false otherwise.

#cmd_objects_move(wbc, objects, anchors, objects_created, name) ⇒ Boolean

Returns true if there was a problem, false otherwise.

Parameters:

  • wbc (Gnm::WorkbookControl)

    Workbook::Control

  • objects (GLib::SList<Gnm::SheetObject>)

    the objects to move.

  • anchors (GLib::SList<Gnm::SheetObjectAnchor>)

    the anchors for the objects.

  • objects_created (Boolean)
  • name (String)

Returns:

  • (Boolean)

    true if there was a problem, false otherwise.

#cmd_page_break_toggle(wbc, sheet, is_vert) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_page_breaks_clear(wbc, sheet) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_paste(wbc, pt) ⇒ nil

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.

Parameters:

Returns:

  • (nil)

#cmd_paste_copy(wbc, pt, content) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_paste_cut(wbc, info, move_selection, cmd_descriptor) ⇒ Boolean

Parameters:

  • wbc (Gnm::WorkbookControl)
  • info (Gnm::ExprRelocateInfo)
  • move_selection (Boolean)
  • cmd_descriptor (String)

Returns:

  • (Boolean)

#cmd_paste_to_selection(wbc, dest_sv, paste_flags) ⇒ nil

Using the current selection as a target Full undo support.

Parameters:

Returns:

  • (nil)

#cmd_print_setup(wbc, sheet, pi) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_remove_name(wbc, nexpr) ⇒ Boolean

Returns TRUE on error

Parameters:

Returns:

  • (Boolean)

#cmd_rename_sheet(wbc, sheet, new_name) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_reorganize_sheets(wbc, old_state, undo_sheet) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_rescope_name(wbc, nexpr, scope) ⇒ Boolean

Returns true if there was a problem, false otherwise.

Parameters:

Returns:

  • (Boolean)

    true if there was a problem, false otherwise.

#cmd_resize_colrow(wbc, sheet, is_col, selection, new_size) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_resize_sheets(wbc, sheets, cols, rows) ⇒ Boolean

Returns true if there was a problem, false otherwise.

Parameters:

  • wbc (Gnm::WorkbookControl)

    Workbook::Control

  • sheets (GLib::SList<Gnm::Sheet>)

    the sheets to resize.

  • cols (Integer)

    new columns number.

  • rows (Integer)

    new rows number.

Returns:

  • (Boolean)

    true if there was a problem, false otherwise.

#cmd_scenario_add(wbc, s, sheet) ⇒ Boolean

Returns true if there was a problem, false otherwise.

Parameters:

Returns:

  • (Boolean)

    true if there was a problem, false otherwise.

#cmd_scenario_mngr(wbc, sc, undo) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_search_replace(wbc, sr) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_selection_autoformat(wbc, ft) ⇒ Boolean

Returns true if there was a problem, false otherwise.

Parameters:

Returns:

  • (Boolean)

    true if there was a problem, false otherwise.

#cmd_selection_clear(wbc, clear_flags) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_selection_colrow_hide(wbc, is_cols, visible) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_selection_format(wbc, style, borders, opt_translated_name) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_selection_format_toggle_font_style(wbc, style, t) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_selection_group(wbc, is_cols, group) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

Returns true if there was a problem, false otherwise.

Parameters:

  • wbc (Gnm::WorkbookControl)

    the workbook control.

  • style (Gnm::Style)

    style to apply to the selection

  • opt_translated_name (String)

    An optional name to use in place of 'Hyperlink Cells'

  • opt_content (String)

    optional content for otherwise empty cells.

Returns:

  • (Boolean)

    true if there was a problem, false otherwise.

#cmd_selection_is_locked_effective(sheet, selection, wbc, cmd_name) ⇒ Boolean

checks whether the selection is effectively locked static gboolean cmd_selection_is_locked_effective

Do not use this function unless the sheet is part of the workbook with the given wbcg (otherwise the results may be strange)

Parameters:

Returns:

  • (Boolean)

    true if there was a problem, false otherwise.

#cmd_selection_outline_change(wbc, is_cols, index, depth) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_set_comment(wbc, sheet, pos, new_text, attr, new_author) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_set_text(wbc, sheet, pos, new_text, markup, autocorrect) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_shift_cols(wbc, sheet, start_col, end_col, row, count) ⇒ nil

Takes the cells in the region (start_col,row):(end_col,MAX_ROW) and copies them count units (possibly negative) downwards.

Parameters:

  • wbc (Gnm::WorkbookControl)

    The error context.

  • sheet (Gnm::Sheet)

    the sheet

  • start_col (Integer)

    first column

  • end_col (Integer)

    end column

  • row (Integer)

    row marking the start of the shift

  • count (Integer)

    numbers of rows to shift. a negative numbers will delete count rows, positive number will insert count rows.

Returns:

  • (nil)

#cmd_shift_rows(wbc, sheet, col, start_row, end_row, count) ⇒ nil

Takes the cells in the region (col,start_row):(MAX_COL,end_row) and copies them count units (possibly negative) to the right. sheet the sheet col column marking the start of the shift start_row first row end_row end row count numbers of columns to shift. negative numbers will delete count columns, positive number will insert count columns.

Parameters:

Returns:

  • (nil)

#cmd_slicer_refresh(wbc) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_so_component_config(wbc, so, n_obj, o_obj) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_so_graph_config(wbc, sog, n_graph, o_graph) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_so_set_adjustment(wbc, so, lnk, horizontal, lower, upper, step, page, undo_label) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_so_set_button(wbc, so, lnk, old_label, new_label) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_so_set_checkbox(wbc, so, lnk, old_label, new_label) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_so_set_frame_label(wbc, so, old_label, new_label) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

Parameters:

Returns:

  • (Boolean)

#cmd_so_set_radio_button(wbc, so, lnk, old_label, new_label, old_value, new_value) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_so_set_value(wbc, text, pref, new_val, sheet) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_sort(wbc, data) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_tabulate(wbc, data) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_text_to_columns(wbc, src, src_sheet, target, target_sheet, content) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_toggle_rtl(wbc, sheet) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#cmd_trunc_descriptor(src, truncated) ⇒ GLib::String

Parameters:

  • src (GLib::String)
  • truncated (Boolean)

Returns:

  • (GLib::String)

#cmd_unmerge_cells(wbc, sheet, selection) ⇒ Boolean

Returns true if there was a problem, false otherwise.

Parameters:

Returns:

  • (Boolean)

    true if there was a problem, false otherwise.

#cmd_zoom(wbc, sheets, factor) ⇒ Boolean

Returns true if there was a problem, false otherwise.

Parameters:

Returns:

  • (Boolean)

    true if there was a problem, false otherwise.

#col_name(col) ⇒ String

Returns A string representation of col.

Parameters:

  • col (Integer)

    column number

Returns:

  • (String)

    A string representation of col

#col_parse(str, ss, res, relative) ⇒ String

Parameters:

  • str (String)
  • ss (Gnm::SheetSize)
  • res (Integer)
  • relative (Integer)

Returns:

  • (String)

#collect_float_pairs(v0, v1, ep, flags, xs0, xs1, n, constp) ⇒ Gnm::Value

If n is not positive upon return, no data has been allocated. If n is negative upon return, the two ranges had different sizes.

Note: introspection cannot handle this functions parameter mix. the vectors returned in xs0 and xs1. If present and true, the resulting data vectors in xs0 and xs1 are not owned by the caller. If not-present or false, the callers owns and must free the result.

Parameters:

  • v0 (Gnm::Value)

    value describing first data range

  • v1 (Gnm::Value)

    value describing second data range

  • ep (Gnm::EvalPos)

    evaluation position

  • flags (Gnm::CollectFlags)

    flags describing how to handle value types

  • xs0 (Array<Gnm::gnm_float>)

    return location for first data vector

  • xs1 (Array<Gnm::gnm_float>)

    return location for second data vector

  • n (Integer)

    return location for number of data points

  • constp (Boolean)

    Return location for a flag describing who own

Returns:

  • (Gnm::Value)

    Error value.

#collect_floats(argc, argv, ep, flags, n, error, info, constp) ⇒ Gnm::gnm_float

exprlist: List of expressions to evaluate. cr: Current location (for resolving relative cells). flags: COLLECT_IGNORE_STRINGS: silently ignore strings. COLLECT_COERCE_STRINGS: coerce string into numbers COLLECT_ZERO_STRINGS: count strings as 0. (Alternative: return #VALUE!.) COLLECT_IGNORE_BOOLS: silently ignore bools. COLLECT_ZEROONE_BOOLS: count FALSE as 0, TRUE as 1. (Alternative: return #VALUE!.) COLLECT_IGNORE_SUBTOTAL : ignore expressions that include the function SUBTOTAL directly and ignore any content in filtered rows. n: Output parameter for number of floats. Evaluate a list of expressions and return the result as an array of gnm_float.

Parameters:

  • argc (Integer)
  • argv (Gnm::ExprConstPtr)
  • ep (Gnm::EvalPos)
  • flags (Gnm::CollectFlags)
  • n (Integer)
  • error (Gnm::Value)
  • info (GLib::SList<GObject>)
  • constp (Boolean)

Returns:

  • (Gnm::gnm_float)

    NULL in case of strict and a blank. A copy of the error in the case of strict and an error. Non-NULL in case of success. Then n will be set.

#collect_floats_value(val, ep, flags, n, error) ⇒ Gnm::gnm_float

Parameters:

  • val (Gnm::Value)
  • ep (Gnm::EvalPos)
  • flags (Gnm::CollectFlags)
  • n (Integer)
  • error (Gnm::Value)

Returns:

  • (Gnm::gnm_float)

#collect_floats_value_with_info(val, ep, flags, n, info, error) ⇒ Gnm::gnm_float

Like collect_floats_value, but keeps info on missing values

Parameters:

  • val (Gnm::Value)

    Gnm::Value

  • ep (Gnm::EvalPos)

    Gnm::EvalPos

  • flags (Gnm::CollectFlags)

    Collect::Flags

  • n (Integer)
  • info (GLib::SList<Integer>)
  • error (Gnm::Value)

Returns:

  • (Gnm::gnm_float)

#color_initnil

Returns:

  • (nil)

#color_shutdownnil

Returns:

  • (nil)

#colrow_autofit(sheet, r, is_cols, ignore_strings, min_current, min_default, indices, sizes) ⇒ nil

Parameters:

  • sheet (Gnm::Sheet)
  • r (Gnm::Range)
  • is_cols (Boolean)
  • ignore_strings (Boolean)
  • min_current (Boolean)
  • min_default (Boolean)
  • indices (Gnm::ColRowIndexList)
  • sizes (Gnm::ColRowStateList)

Returns:

  • (nil)

#colrow_autofit_col(sheet, r) ⇒ nil

Parameters:

  • sheet (Gnm::Sheet)

    the #Sheet to change

  • r (Gnm::Range)

    the range to consider

Returns:

  • (nil)

#colrow_autofit_row(sheet, r) ⇒ nil

Parameters:

  • sheet (Gnm::Sheet)

    the #Sheet to change

  • r (Gnm::Range)

    the range to consider

Returns:

  • (nil)

#colrow_compute_pixel_scale(sheet, horizontal) ⇒ Float

Parameters:

Returns:

  • (Float)

#colrow_compute_pixels_from_pts(cri, sheet, horizontal, scale) ⇒ nil

Parameters:

  • cri (Gnm::ColRowInfo)
  • sheet (Gnm::Sheet)
  • horizontal (Boolean)
  • scale (Float)

Returns:

  • (nil)

#colrow_compute_pts_from_pixels(cri, sheet, horizontal, scale) ⇒ nil

Parameters:

  • cri (Gnm::ColRowInfo)
  • sheet (Gnm::Sheet)
  • horizontal (Boolean)
  • scale (Float)

Returns:

  • (nil)

#colrow_find_outline_bound(sheet, is_cols, index, depth, inc) ⇒ Integer

find the next/prev col/row at the designated depth starting from the supplied index.

Parameters:

  • sheet (Gnm::Sheet)
  • is_cols (Boolean)
  • index (Integer)
  • depth (Integer)
  • inc (Boolean)

Returns:

  • (Integer)

#colrow_free(cri) ⇒ nil

Parameters:

  • cri (Gnm::ColRowInfo)

Returns:

  • (nil)

#colrow_get_global_outline(sheet, is_cols, depth, show, hide) ⇒ nil

Collect the sets of visibility changes required to change the visibility of all outlined columns/rows such that those depth less then depth are visible.

Parameters:

  • sheet (Gnm::Sheet)
  • is_cols (Boolean)

    true for columns, false for rows.

  • depth (Integer)
  • show (Gnm::ColRowVisList)

    columns/rows that need to be shown

  • hide (Gnm::ColRowVisList)

    columns/rows that need to be hidden

Returns:

  • (nil)

#colrow_get_index_list(first, last, list) ⇒ Gnm::ColRowIndexList

Build an ordered list of pairs doing intelligent merging of overlapping regions.

Parameters:

  • first (Integer)
  • last (Integer)
  • list (Gnm::ColRowIndexList)

Returns:

  • (Gnm::ColRowIndexList)

    list.

#colrow_get_outline_toggle(sheet, is_cols, visible, first, last) ⇒ Gnm::ColRowVisList

Parameters:

  • sheet (Gnm::Sheet)

    #Sheet

  • is_cols (Boolean)

    true for columns, false for rows.

  • visible (Boolean)
  • first (Integer)
  • last (Integer)

Returns:

  • (Gnm::ColRowVisList)

#colrow_get_sizes(sheet, is_cols, src, new_size) ⇒ Gnm::ColRowStateGroup

Parameters:

  • sheet (Gnm::Sheet)

    #Sheet

  • is_cols (Boolean)

    true for columns, false for rows.

  • src (Gnm::ColRowIndexList)
  • new_size (Integer)

Returns:

  • (Gnm::ColRowStateGroup)

#colrow_get_states(sheet, is_cols, first, last) ⇒ Gnm::ColRowStateList

Parameters:

  • sheet (Gnm::Sheet)

    #Sheet

  • is_cols (Boolean)

    true for columns, false for rows.

  • first (Integer)

    first column or row.

  • last (Integer)

    last column or row.

Returns:

  • (Gnm::ColRowStateList)

#colrow_get_visibility_toggle(sv, is_cols, visible) ⇒ Gnm::ColRowVisList

Searches the selection list and generates a list of index,count pairs of row/col ranges that need to be hidden or unhidden.

Parameters:

  • sv (Gnm::SheetView)

    The sheet view whose selection we are interested in.

  • is_cols (Boolean)

    true for columns, false for rows.

  • visible (Boolean)

    Should we unhide or hide the cols/rows.

Returns:

  • (Gnm::ColRowVisList)

    the list.

#colrow_index_list_copy(list) ⇒ Gnm::ColRowIndexList

Parameters:

  • list (Gnm::ColRowIndexList)

    Col::RowIndexList

Returns:

  • (Gnm::ColRowIndexList)

#colrow_index_list_to_string(list, is_cols, is_single) ⇒ GLib::String

Parameters:

  • list (Gnm::ColRowIndexList)
  • is_cols (Boolean)
  • is_single (Boolean)

Returns:

  • (GLib::String)

#colrow_restore_state_group(sheet, is_cols, selection, state_groups) ⇒ nil

Parameters:

  • sheet (Gnm::Sheet)

    #Sheet

  • is_cols (Boolean)

    true for columns, false for rows.

  • selection (Gnm::ColRowIndexList)
  • state_groups (Gnm::ColRowStateGroup)

Returns:

  • (nil)

#colrow_set_sizes(sheet, is_cols, src, new_size, from, to) ⇒ Gnm::ColRowStateGroup

Parameters:

  • sheet (Gnm::Sheet)

    #Sheet

  • is_cols (Boolean)

    true for columns, false for rows.

  • src (Gnm::ColRowIndexList)
  • new_size (Integer)
  • from (Integer)
  • to (Integer)

Returns:

  • (Gnm::ColRowStateGroup)

#colrow_set_states(sheet, is_cols, first, states) ⇒ nil

This is a low level routine it does not redraw or reposition objects

Parameters:

  • sheet (Gnm::Sheet)

    #Sheet

  • is_cols (Boolean)

    true for columns, false for rows.

  • first (Integer)

    first column or row

  • states (Gnm::ColRowStateList)

    saved state to restore.

Returns:

  • (nil)

#colrow_set_visibility(sheet, is_cols, visible, first, last) ⇒ nil

Change the visibility of the selected range of contiguous cols/rows. NOTE : only changes the collapsed state for the LAST+1 element.

Parameters:

  • sheet (Gnm::Sheet)

    the #Sheet

  • is_cols (Boolean)

    true for columns, false for rows.

  • visible (Boolean)

    Make things visible or invisible.

  • first (Integer)

    The index of the first row/col (inclusive)

  • last (Integer)

    The index of the last row/col (inclusive)

Returns:

  • (nil)

#colrow_set_visibility_list(sheet, is_cols, visible, list) ⇒ nil

This is the high level command that is wrapped by undo and redo. It should not be called by other commands.

Parameters:

  • sheet (Gnm::Sheet)

    The #Sheet to change

  • is_cols (Boolean)

    true for columns, false for rows.

  • visible (Boolean)

    Should we unhide or hide the cols/rows.

  • list (Gnm::ColRowVisList)

Returns:

  • (nil)

#colrow_state_group_destroy(set) ⇒ Gnm::ColRowStateGroup

Returns nil.

Parameters:

  • set (Gnm::ColRowStateGroup)

    the group to destroy.

Returns:

  • (Gnm::ColRowStateGroup)

    nil.

#colrow_state_list_destroy(list) ⇒ Gnm::ColRowStateList

Returns nil.

Parameters:

  • list (Gnm::ColRowStateList)

    the list to destroy.

Returns:

  • (Gnm::ColRowStateList)

    nil.

#colrow_state_list_foreach(list, sheet, is_cols, base, callback, user_data) ⇒ nil

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.

Parameters:

  • list (Gnm::ColRowStateList)

    The Col::RowStateList to iterate.

  • sheet (Gnm::Sheet)

    Origin #Sheet.

  • is_cols (Boolean)

    true for columns, false for rows.

  • base (Integer)

    index of first column or row.

  • callback (Gnm::ColRowHandler)

    A callback function which should return true to stop the iteration.

  • user_data (GObject)

    A baggage pointer.

Returns:

  • (nil)

#colrow_vis_list_length(list) ⇒ Integer

Parameters:

  • list (Gnm::ColRowVisList)

Returns:

  • (Integer)

#cols_name(start_col, end_col) ⇒ String

start_col to end_col.

Parameters:

  • start_col (Integer)

    column number

  • end_col (Integer)

    column number

Returns:

  • (String)

    A string representation of the columns from

#combin(n, k) ⇒ Gnm::gnm_float

Parameters:

  • n (Gnm::gnm_float)
  • k (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#complex_fact(z, exp2) ⇒ GOffice::Complex

Returns the factorial function evaluated at z.

Parameters:

  • z (GOffice::Complex)

    a complex number

  • exp2 (Integer)

    Return location for power of 2.

Returns:

  • (GOffice::Complex)

    the factorial function evaluated at z.

#complex_from_string(dst, src, imunit) ⇒ Integer

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".

Parameters:

  • dst (GOffice::Complex)

    return location

  • src (String)

    string to parse

  • imunit (String)

    return location of imaginary unit.

Returns:

  • (Integer)

    zero on success, -1 otherwise.

#complex_gamma(z, exp2) ⇒ GOffice::Complex

Returns the Gamma function evaluated at z.

Parameters:

  • z (GOffice::Complex)

    a complex number

  • exp2 (Integer)

    Return location for power of 2.

Returns:

  • (GOffice::Complex)

    the Gamma function evaluated at z.

#complex_igamma(a, z, lower, regularized) ⇒ GOffice::Complex

a and z.

Parameters:

  • a (GOffice::Complex)

    a complex number

  • z (GOffice::Complex)

    a complex number

  • lower (Boolean)

    determines if upper or lower incomplete gamma is desired.

  • regularized (Boolean)

    determines if the result should be normalized by Gamma(a).

Returns:

  • (GOffice::Complex)

    the incomplete gamma function evaluated at

#complex_invalid_p(src) ⇒ Integer

Parameters:

  • src (GOffice::Complex)

Returns:

  • (Integer)

#complex_to_string(src, imunit) ⇒ String

Parameters:

  • src (GOffice::Complex)
  • imunit (Gnm::gchar)

Returns:

  • (String)

#conf_get_autocorrect_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_autocorrect_first_letterBoolean

Returns:

  • (Boolean)

#conf_get_autocorrect_first_letter_listGLib::SList<String>

Returns:

  • (GLib::SList<String>)

#conf_get_autocorrect_first_letter_list_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_autocorrect_first_letter_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_autocorrect_init_capsBoolean

Returns:

  • (Boolean)

#conf_get_autocorrect_init_caps_listGLib::SList<String>

Returns:

  • (GLib::SList<String>)

#conf_get_autocorrect_init_caps_list_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_autocorrect_init_caps_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_autocorrect_names_of_daysBoolean

Returns:

  • (Boolean)

#conf_get_autocorrect_names_of_days_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_autocorrect_replaceBoolean

Returns:

  • (Boolean)

#conf_get_autocorrect_replace_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_autoformat_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_autoformat_extra_dirsGLib::SList<String>

Returns:

  • (GLib::SList<String>)

#conf_get_autoformat_extra_dirs_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_autoformat_sys_dirString

Returns:

  • (String)

#conf_get_autoformat_sys_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_autoformat_usr_dirString

Returns:

  • (String)

#conf_get_autoformat_usr_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_defaultfont_boldBoolean

Returns:

  • (Boolean)

#conf_get_core_defaultfont_bold_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_defaultfont_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_defaultfont_italicBoolean

Returns:

  • (Boolean)

#conf_get_core_defaultfont_italic_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_defaultfont_nameString

Returns:

  • (String)

#conf_get_core_defaultfont_name_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_defaultfont_sizeFloat

Returns:

  • (Float)

#conf_get_core_defaultfont_size_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_file_save_def_overwriteBoolean

Returns:

  • (Boolean)

#conf_get_core_file_save_def_overwrite_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_file_save_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_file_save_extension_check_disabledGLib::SList<String>

Returns:

  • (GLib::SList<String>)

#conf_get_core_file_save_extension_check_disabled_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_file_save_single_sheetBoolean

Returns:

  • (Boolean)

#conf_get_core_file_save_single_sheet_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_gui_cells_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_gui_cells_extension_markersBoolean

Returns:

  • (Boolean)

#conf_get_core_gui_cells_extension_markers_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_gui_cells_function_markersBoolean

Returns:

  • (Boolean)

#conf_get_core_gui_cells_function_markers_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_gui_editing_autocompleteBoolean

Returns:

  • (Boolean)

#conf_get_core_gui_editing_autocomplete_min_charsInteger

Returns:

  • (Integer)

#conf_get_core_gui_editing_autocomplete_min_chars_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_gui_editing_autocomplete_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_gui_editing_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_gui_editing_enter_moves_dirGOffice::Direction

Returns:

  • (GOffice::Direction)

#conf_get_core_gui_editing_enter_moves_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_gui_editing_function_argument_tooltipsBoolean

Returns:

  • (Boolean)

#conf_get_core_gui_editing_function_argument_tooltips_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_gui_editing_function_name_tooltipsBoolean

Returns:

  • (Boolean)

#conf_get_core_gui_editing_function_name_tooltips_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_gui_editing_recalclagInteger

Returns:

  • (Integer)

#conf_get_core_gui_editing_recalclag_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_gui_editing_transitionkeysBoolean

Returns:

  • (Boolean)

#conf_get_core_gui_editing_transitionkeys_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_gui_screen_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_gui_screen_horizontaldpiFloat

Returns:

  • (Float)

#conf_get_core_gui_screen_horizontaldpi_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_gui_screen_verticaldpiFloat

Returns:

  • (Float)

#conf_get_core_gui_screen_verticaldpi_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_gui_toolbars_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_gui_toolbars_format_positionGtk::PositionType

Returns:

  • (Gtk::PositionType)

#conf_get_core_gui_toolbars_format_position_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_gui_toolbars_format_visibleBoolean

Returns:

  • (Boolean)

#conf_get_core_gui_toolbars_format_visible_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_gui_toolbars_object_positionGtk::PositionType

Returns:

  • (Gtk::PositionType)

#conf_get_core_gui_toolbars_object_position_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_gui_toolbars_object_visibleBoolean

Returns:

  • (Boolean)

#conf_get_core_gui_toolbars_object_visible_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_gui_toolbars_standard_positionGtk::PositionType

Returns:

  • (Gtk::PositionType)

#conf_get_core_gui_toolbars_standard_position_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_gui_toolbars_standard_visibleBoolean

Returns:

  • (Boolean)

#conf_get_core_gui_toolbars_standard_visible_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_gui_window_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_gui_window_xFloat

Returns:

  • (Float)

#conf_get_core_gui_window_x_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_gui_window_yFloat

Returns:

  • (Float)

#conf_get_core_gui_window_y_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_gui_window_zoomFloat

Returns:

  • (Float)

#conf_get_core_gui_window_zoom_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_sort_default_ascendingBoolean

Returns:

  • (Boolean)

#conf_get_core_sort_default_ascending_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_sort_default_by_caseBoolean

Returns:

  • (Boolean)

#conf_get_core_sort_default_by_case_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_sort_default_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_sort_default_retain_formatsBoolean

Returns:

  • (Boolean)

#conf_get_core_sort_default_retain_formats_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_sort_dialog_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_sort_dialog_max_initial_clausesInteger

Returns:

  • (Integer)

#conf_get_core_sort_dialog_max_initial_clauses_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_workbook_autosave_timeInteger

Returns:

  • (Integer)

#conf_get_core_workbook_autosave_time_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_workbook_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_workbook_n_colsInteger

Returns:

  • (Integer)

#conf_get_core_workbook_n_cols_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_workbook_n_rowsInteger

Returns:

  • (Integer)

#conf_get_core_workbook_n_rows_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_workbook_n_sheetInteger

Returns:

  • (Integer)

#conf_get_core_workbook_n_sheet_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_xml_compression_levelInteger

Returns:

  • (Integer)

#conf_get_core_xml_compression_level_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_core_xml_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_cut_and_paste_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_cut_and_paste_prefer_clipboardBoolean

Returns:

  • (Boolean)

#conf_get_cut_and_paste_prefer_clipboard_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_detachable_toolbarsBoolean

Returns:

  • (Boolean)

#conf_get_dialogs_rs_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_dialogs_rs_unfocusedBoolean

Returns:

  • (Boolean)

#conf_get_dialogs_rs_unfocused_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_functionselector_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_functionselector_num_of_recentInteger

Returns:

  • (Integer)

#conf_get_functionselector_num_of_recent_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_functionselector_recentfunctionsGLib::SList<String>

Returns:

  • (GLib::SList<String>)

#conf_get_functionselector_recentfunctions_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_long_desc(node) ⇒ String

Returns a description of node.

Parameters:

  • node (GOffice::ConfNode)

    GOConf::Node

Returns:

  • (String)

    a description of node.

#conf_get_page_setupGtk::PageSetup

Returns the default Gtk::PageSetup.

Returns:

  • (Gtk::PageSetup)

    the default Gtk::PageSetup.

#conf_get_plugin_glpk_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_plugin_glpk_glpsol_pathString

Returns:

  • (String)

#conf_get_plugin_glpk_glpsol_path_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_plugin_latex_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_plugin_latex_use_utf8Boolean

Returns:

  • (Boolean)

#conf_get_plugin_latex_use_utf8_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_plugin_lpsolve_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_plugin_lpsolve_lpsolve_pathString

Returns:

  • (String)

#conf_get_plugin_lpsolve_lpsolve_path_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_plugins_activate_newpluginsBoolean

Returns:

  • (Boolean)

#conf_get_plugins_activate_newplugins_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_plugins_activeGLib::SList<String>

Returns:

  • (GLib::SList<String>)

#conf_get_plugins_active_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_plugins_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_plugins_extra_dirsGLib::SList<String>

Returns:

  • (GLib::SList<String>)

#conf_get_plugins_extra_dirs_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_plugins_file_statesGLib::SList<String>

Returns:

  • (GLib::SList<String>)

#conf_get_plugins_file_states_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_plugins_knownGLib::SList<String>

Returns:

  • (GLib::SList<String>)

#conf_get_plugins_known_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_print_settingsGtk::PrintSettings

Returns the default Gtk::PrintSettings.

Returns:

  • (Gtk::PrintSettings)

    the default Gtk::PrintSettings.

#conf_get_printer_decoration_fontGnm::Style

footers.

Returns:

  • (Gnm::Style)

    a style appropriate font for headers and

#conf_get_printsetup_across_then_downBoolean

Returns:

  • (Boolean)

#conf_get_printsetup_across_then_down_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_all_sheetsBoolean

Returns:

  • (Boolean)

#conf_get_printsetup_all_sheets_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_center_horizontallyBoolean

Returns:

  • (Boolean)

#conf_get_printsetup_center_horizontally_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_center_verticallyBoolean

Returns:

  • (Boolean)

#conf_get_printsetup_center_vertically_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

Returns:

  • (GLib::SList<String>)

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_gtk_settingGLib::SList<String>

Returns:

  • (GLib::SList<String>)

#conf_get_printsetup_gtk_setting_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_headerGLib::SList<String>

Returns:

  • (GLib::SList<String>)

#conf_get_printsetup_header_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_hf_font_boldBoolean

Returns:

  • (Boolean)

#conf_get_printsetup_hf_font_bold_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_hf_font_italicBoolean

Returns:

  • (Boolean)

#conf_get_printsetup_hf_font_italic_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_hf_font_nameString

Returns:

  • (String)

#conf_get_printsetup_hf_font_name_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_hf_font_sizeFloat

Returns:

  • (Float)

#conf_get_printsetup_hf_font_size_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_hf_leftGLib::SList<String>

Returns:

  • (GLib::SList<String>)

#conf_get_printsetup_hf_left_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_hf_middleGLib::SList<String>

Returns:

  • (GLib::SList<String>)

#conf_get_printsetup_hf_middle_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_hf_rightGLib::SList<String>

Returns:

  • (GLib::SList<String>)

#conf_get_printsetup_hf_right_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_margin_bottomFloat

Returns:

  • (Float)

#conf_get_printsetup_margin_bottom_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_margin_gtk_bottomFloat

Returns:

  • (Float)

#conf_get_printsetup_margin_gtk_bottom_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_margin_gtk_leftFloat

Returns:

  • (Float)

#conf_get_printsetup_margin_gtk_left_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_margin_gtk_rightFloat

Returns:

  • (Float)

#conf_get_printsetup_margin_gtk_right_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_margin_gtk_topFloat

Returns:

  • (Float)

#conf_get_printsetup_margin_gtk_top_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_margin_topFloat

Returns:

  • (Float)

#conf_get_printsetup_margin_top_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_paperString

Returns:

  • (String)

#conf_get_printsetup_paper_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_paper_orientationInteger

Returns:

  • (Integer)

#conf_get_printsetup_paper_orientation_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_preferred_unitGtk::Unit

Returns:

  • (Gtk::Unit)

#conf_get_printsetup_preferred_unit_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_print_black_n_whiteBoolean

Returns:

  • (Boolean)

#conf_get_printsetup_print_black_n_white_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_print_even_if_only_stylesBoolean

Returns:

  • (Boolean)

#conf_get_printsetup_print_even_if_only_styles_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_print_grid_linesBoolean

Returns:

  • (Boolean)

#conf_get_printsetup_print_grid_lines_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_print_titlesBoolean

Returns:

  • (Boolean)

#conf_get_printsetup_print_titles_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_repeat_leftString

Returns:

  • (String)

#conf_get_printsetup_repeat_left_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_repeat_topString

Returns:

  • (String)

#conf_get_printsetup_repeat_top_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_scale_heightInteger

Returns:

  • (Integer)

#conf_get_printsetup_scale_height_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_scale_percentageBoolean

Returns:

  • (Boolean)

#conf_get_printsetup_scale_percentage_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_scale_percentage_valueFloat

Returns:

  • (Float)

#conf_get_printsetup_scale_percentage_value_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_printsetup_scale_widthInteger

Returns:

  • (Integer)

#conf_get_printsetup_scale_width_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_rootGOffice::ConfNode

Returns the root config node.

Returns:

  • (GOffice::ConfNode)

    the root config node.

#conf_get_searchreplace_change_cell_expressionsBoolean

Returns:

  • (Boolean)

#conf_get_searchreplace_change_cell_expressions_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_searchreplace_change_cell_otherBoolean

Returns:

  • (Boolean)

#conf_get_searchreplace_change_cell_other_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_searchreplace_change_cell_stringsBoolean

Returns:

  • (Boolean)

#conf_get_searchreplace_change_cell_strings_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_searchreplace_change_commentsBoolean

Returns:

  • (Boolean)

#conf_get_searchreplace_change_comments_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_searchreplace_columnmajorBoolean

Returns:

  • (Boolean)

#conf_get_searchreplace_columnmajor_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_searchreplace_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_searchreplace_error_behaviourInteger

Returns:

  • (Integer)

#conf_get_searchreplace_error_behaviour_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_searchreplace_ignore_caseBoolean

Returns:

  • (Boolean)

#conf_get_searchreplace_ignore_case_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_searchreplace_keep_stringsBoolean

Returns:

  • (Boolean)

#conf_get_searchreplace_keep_strings_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_searchreplace_preserve_caseBoolean

Returns:

  • (Boolean)

#conf_get_searchreplace_preserve_case_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_searchreplace_queryBoolean

Returns:

  • (Boolean)

#conf_get_searchreplace_query_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_searchreplace_regexInteger

Returns:

  • (Integer)

#conf_get_searchreplace_regex_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_searchreplace_scopeInteger

Returns:

  • (Integer)

#conf_get_searchreplace_scope_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_searchreplace_search_resultsBoolean

Returns:

  • (Boolean)

#conf_get_searchreplace_search_results_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_searchreplace_whole_words_onlyBoolean

Returns:

  • (Boolean)

#conf_get_searchreplace_whole_words_only_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_short_desc(node) ⇒ String

Returns a brief description of node.

Parameters:

  • node (GOffice::ConfNode)

    GOConf::Node

Returns:

  • (String)

    a brief description of node.

#conf_get_stf_export_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_stf_export_encodingString

Returns:

  • (String)

#conf_get_stf_export_encoding_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_stf_export_formatGnm::StfFormatMode

Returns:

#conf_get_stf_export_format_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_stf_export_localeString

Returns:

  • (String)

#conf_get_stf_export_locale_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_stf_export_quotingGsf::OutputCsvQuotingMode

Returns:

  • (Gsf::OutputCsvQuotingMode)

#conf_get_stf_export_quoting_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_stf_export_separatorString

Returns:

  • (String)

#conf_get_stf_export_separator_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_stf_export_stringindicatorString

Returns:

  • (String)

#conf_get_stf_export_stringindicator_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_stf_export_terminatorString

Returns:

  • (String)

#conf_get_stf_export_terminator_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_stf_export_transliterationBoolean

Returns:

  • (Boolean)

#conf_get_stf_export_transliteration_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_toolbar_position(name) ⇒ Gtk::PositionType

Parameters:

  • name (String)

Returns:

  • (Gtk::PositionType)

#conf_get_toolbar_styleGtk::ToolbarStyle

Returns:

  • (Gtk::ToolbarStyle)

#conf_get_toolbar_style_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_toolbar_visible(name) ⇒ Boolean

Parameters:

  • name (String)

Returns:

  • (Boolean)

#conf_get_undo_dir_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_undo_max_descriptor_widthInteger

Returns:

  • (Integer)

#conf_get_undo_max_descriptor_width_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_undo_maxnumInteger

Returns:

  • (Integer)

#conf_get_undo_maxnum_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_undo_show_sheet_nameBoolean

Returns:

  • (Boolean)

#conf_get_undo_show_sheet_name_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_get_undo_sizeInteger

Returns:

  • (Integer)

#conf_get_undo_size_nodeGOffice::ConfNode

Returns A GOConf::Node.

Returns:

  • (GOffice::ConfNode)

    A GOConf::Node

#conf_initnil

Returns:

  • (nil)

#conf_set_autocorrect_first_letter(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_autocorrect_first_letter_list(x) ⇒ nil

Parameters:

  • x (GLib::SList<String>)

    list of strings

Returns:

  • (nil)

#conf_set_autocorrect_init_caps(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_autocorrect_init_caps_list(x) ⇒ nil

Parameters:

  • x (GLib::SList<String>)

    list of strings

Returns:

  • (nil)

#conf_set_autocorrect_names_of_days(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_autocorrect_replace(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_autoformat_extra_dirs(x) ⇒ nil

Parameters:

  • x (GLib::SList<String>)

    list of strings

Returns:

  • (nil)

#conf_set_autoformat_sys_dir(x) ⇒ nil

Parameters:

  • x (String)

Returns:

  • (nil)

#conf_set_autoformat_usr_dir(x) ⇒ nil

Parameters:

  • x (String)

Returns:

  • (nil)

#conf_set_core_defaultfont_bold(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_core_defaultfont_italic(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_core_defaultfont_name(x) ⇒ nil

Parameters:

  • x (String)

Returns:

  • (nil)

#conf_set_core_defaultfont_size(x) ⇒ nil

Parameters:

  • x (Float)

Returns:

  • (nil)

#conf_set_core_file_save_def_overwrite(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_core_file_save_extension_check_disabled(x) ⇒ nil

Parameters:

  • x (GLib::SList<String>)

    list of strings

Returns:

  • (nil)

#conf_set_core_file_save_single_sheet(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_core_gui_cells_extension_markers(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_core_gui_cells_function_markers(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_core_gui_editing_autocomplete(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_core_gui_editing_autocomplete_min_chars(x) ⇒ nil

Parameters:

  • x (Integer)

Returns:

  • (nil)

#conf_set_core_gui_editing_enter_moves_dir(x) ⇒ nil

Parameters:

  • x (GOffice::Direction)

Returns:

  • (nil)

#conf_set_core_gui_editing_function_argument_tooltips(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_core_gui_editing_function_name_tooltips(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_core_gui_editing_recalclag(x) ⇒ nil

Parameters:

  • x (Integer)

Returns:

  • (nil)

#conf_set_core_gui_editing_transitionkeys(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_core_gui_screen_horizontaldpi(x) ⇒ nil

Parameters:

  • x (Float)

Returns:

  • (nil)

#conf_set_core_gui_screen_verticaldpi(x) ⇒ nil

Parameters:

  • x (Float)

Returns:

  • (nil)

#conf_set_core_gui_toolbars_format_position(x) ⇒ nil

Parameters:

  • x (Gtk::PositionType)

Returns:

  • (nil)

#conf_set_core_gui_toolbars_format_visible(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_core_gui_toolbars_object_position(x) ⇒ nil

Parameters:

  • x (Gtk::PositionType)

Returns:

  • (nil)

#conf_set_core_gui_toolbars_object_visible(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_core_gui_toolbars_standard_position(x) ⇒ nil

Parameters:

  • x (Gtk::PositionType)

Returns:

  • (nil)

#conf_set_core_gui_toolbars_standard_visible(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_core_gui_window_x(x) ⇒ nil

Parameters:

  • x (Float)

Returns:

  • (nil)

#conf_set_core_gui_window_y(x) ⇒ nil

Parameters:

  • x (Float)

Returns:

  • (nil)

#conf_set_core_gui_window_zoom(x) ⇒ nil

Parameters:

  • x (Float)

Returns:

  • (nil)

#conf_set_core_sort_default_ascending(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_core_sort_default_by_case(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_core_sort_default_retain_formats(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_core_sort_dialog_max_initial_clauses(x) ⇒ nil

Parameters:

  • x (Integer)

Returns:

  • (nil)

#conf_set_core_workbook_autosave_time(x) ⇒ nil

Parameters:

  • x (Integer)

Returns:

  • (nil)

#conf_set_core_workbook_n_cols(x) ⇒ nil

Parameters:

  • x (Integer)

Returns:

  • (nil)

#conf_set_core_workbook_n_rows(x) ⇒ nil

Parameters:

  • x (Integer)

Returns:

  • (nil)

#conf_set_core_workbook_n_sheet(x) ⇒ nil

Parameters:

  • x (Integer)

Returns:

  • (nil)

#conf_set_core_xml_compression_level(x) ⇒ nil

Parameters:

  • x (Integer)

Returns:

  • (nil)

#conf_set_cut_and_paste_prefer_clipboard(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_dialogs_rs_unfocused(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_functionselector_num_of_recent(x) ⇒ nil

Parameters:

  • x (Integer)

Returns:

  • (nil)

#conf_set_functionselector_recentfunctions(x) ⇒ nil

Parameters:

  • x (GLib::SList<String>)

    list of strings

Returns:

  • (nil)

#conf_set_page_setup(setup) ⇒ nil

Parameters:

  • setup (Gtk::PageSetup)

Returns:

  • (nil)

#conf_set_persistence(persist) ⇒ nil

If persist is true, then changes from this point on will not be saved.

Parameters:

  • persist (Boolean)

    whether to save changes

Returns:

  • (nil)

#conf_set_plugin_glpk_glpsol_path(x) ⇒ nil

Parameters:

  • x (String)

Returns:

  • (nil)

#conf_set_plugin_latex_use_utf8(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_plugin_lpsolve_lpsolve_path(x) ⇒ nil

Parameters:

  • x (String)

Returns:

  • (nil)

#conf_set_plugins_activate_newplugins(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_plugins_active(x) ⇒ nil

Parameters:

  • x (GLib::SList<String>)

    list of strings

Returns:

  • (nil)

#conf_set_plugins_extra_dirs(x) ⇒ nil

Parameters:

  • x (GLib::SList<String>)

    list of strings

Returns:

  • (nil)

#conf_set_plugins_file_states(x) ⇒ nil

Parameters:

  • x (GLib::SList<String>)

    list of strings

Returns:

  • (nil)

#conf_set_plugins_known(x) ⇒ nil

Parameters:

  • x (GLib::SList<String>)

    list of strings

Returns:

  • (nil)

#conf_set_print_settings(settings) ⇒ nil

Parameters:

  • settings (Gtk::PrintSettings)

Returns:

  • (nil)

#conf_set_printsetup_across_then_down(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_printsetup_all_sheets(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_printsetup_center_horizontally(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_printsetup_center_vertically(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

Parameters:

  • x (GLib::SList<String>)

    list of strings

Returns:

  • (nil)

#conf_set_printsetup_gtk_setting(x) ⇒ nil

Parameters:

  • x (GLib::SList<String>)

    list of strings

Returns:

  • (nil)

#conf_set_printsetup_header(x) ⇒ nil

Parameters:

  • x (GLib::SList<String>)

    list of strings

Returns:

  • (nil)

#conf_set_printsetup_hf_font_bold(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_printsetup_hf_font_italic(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_printsetup_hf_font_name(x) ⇒ nil

Parameters:

  • x (String)

Returns:

  • (nil)

#conf_set_printsetup_hf_font_size(x) ⇒ nil

Parameters:

  • x (Float)

Returns:

  • (nil)

#conf_set_printsetup_hf_left(x) ⇒ nil

Parameters:

  • x (GLib::SList<String>)

    list of strings

Returns:

  • (nil)

#conf_set_printsetup_hf_middle(x) ⇒ nil

Parameters:

  • x (GLib::SList<String>)

    list of strings

Returns:

  • (nil)

#conf_set_printsetup_hf_right(x) ⇒ nil

Parameters:

  • x (GLib::SList<String>)

    list of strings

Returns:

  • (nil)

#conf_set_printsetup_margin_bottom(x) ⇒ nil

Parameters:

  • x (Float)

Returns:

  • (nil)

#conf_set_printsetup_margin_gtk_bottom(x) ⇒ nil

Parameters:

  • x (Float)

Returns:

  • (nil)

#conf_set_printsetup_margin_gtk_left(x) ⇒ nil

Parameters:

  • x (Float)

Returns:

  • (nil)

#conf_set_printsetup_margin_gtk_right(x) ⇒ nil

Parameters:

  • x (Float)

Returns:

  • (nil)

#conf_set_printsetup_margin_gtk_top(x) ⇒ nil

Parameters:

  • x (Float)

Returns:

  • (nil)

#conf_set_printsetup_margin_top(x) ⇒ nil

Parameters:

  • x (Float)

Returns:

  • (nil)

#conf_set_printsetup_paper(x) ⇒ nil

Parameters:

  • x (String)

Returns:

  • (nil)

#conf_set_printsetup_paper_orientation(x) ⇒ nil

Parameters:

  • x (Integer)

Returns:

  • (nil)

#conf_set_printsetup_preferred_unit(x) ⇒ nil

Parameters:

  • x (Gtk::Unit)

Returns:

  • (nil)

#conf_set_printsetup_print_black_n_white(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_printsetup_print_even_if_only_styles(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_printsetup_print_grid_lines(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_printsetup_print_titles(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_printsetup_repeat_left(x) ⇒ nil

Parameters:

  • x (String)

Returns:

  • (nil)

#conf_set_printsetup_repeat_top(x) ⇒ nil

Parameters:

  • x (String)

Returns:

  • (nil)

#conf_set_printsetup_scale_height(x) ⇒ nil

Parameters:

  • x (Integer)

Returns:

  • (nil)

#conf_set_printsetup_scale_percentage(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_printsetup_scale_percentage_value(x) ⇒ nil

Parameters:

  • x (Float)

Returns:

  • (nil)

#conf_set_printsetup_scale_width(x) ⇒ nil

Parameters:

  • x (Integer)

Returns:

  • (nil)

#conf_set_searchreplace_change_cell_expressions(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_searchreplace_change_cell_other(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_searchreplace_change_cell_strings(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_searchreplace_change_comments(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_searchreplace_columnmajor(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_searchreplace_error_behaviour(x) ⇒ nil

Parameters:

  • x (Integer)

Returns:

  • (nil)

#conf_set_searchreplace_ignore_case(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_searchreplace_keep_strings(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_searchreplace_preserve_case(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_searchreplace_query(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_searchreplace_regex(x) ⇒ nil

Parameters:

  • x (Integer)

Returns:

  • (nil)

#conf_set_searchreplace_scope(x) ⇒ nil

Parameters:

  • x (Integer)

Returns:

  • (nil)

#conf_set_searchreplace_search_results(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_searchreplace_whole_words_only(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_stf_export_encoding(x) ⇒ nil

Parameters:

  • x (String)

Returns:

  • (nil)

#conf_set_stf_export_format(x) ⇒ nil

Parameters:

Returns:

  • (nil)

#conf_set_stf_export_locale(x) ⇒ nil

Parameters:

  • x (String)

Returns:

  • (nil)

#conf_set_stf_export_quoting(x) ⇒ nil

Parameters:

  • x (Gsf::OutputCsvQuotingMode)

Returns:

  • (nil)

#conf_set_stf_export_separator(x) ⇒ nil

Parameters:

  • x (String)

Returns:

  • (nil)

#conf_set_stf_export_stringindicator(x) ⇒ nil

Parameters:

  • x (String)

Returns:

  • (nil)

#conf_set_stf_export_terminator(x) ⇒ nil

Parameters:

  • x (String)

Returns:

  • (nil)

#conf_set_stf_export_transliteration(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_toolbar_position(name, x) ⇒ nil

Parameters:

  • name (String)
  • x (Gtk::PositionType)

Returns:

  • (nil)

#conf_set_toolbar_style(x) ⇒ nil

Parameters:

  • x (Gtk::ToolbarStyle)

Returns:

  • (nil)

#conf_set_toolbar_visible(name, x) ⇒ nil

Parameters:

  • name (String)
  • x (Boolean)

Returns:

  • (nil)

#conf_set_undo_max_descriptor_width(x) ⇒ nil

Parameters:

  • x (Integer)

Returns:

  • (nil)

#conf_set_undo_maxnum(x) ⇒ nil

Parameters:

  • x (Integer)

Returns:

  • (nil)

#conf_set_undo_show_sheet_name(x) ⇒ nil

Parameters:

  • x (Boolean)

Returns:

  • (nil)

#conf_set_undo_size(x) ⇒ nil

Parameters:

  • x (Integer)

Returns:

  • (nil)

#conf_shutdownnil

Returns:

  • (nil)

#convert_to_tooltip(ref_widget, widget) ⇒ Gtk::Widget

Returns widget.

Parameters:

  • ref_widget (Gtk::Widget)
  • widget (Gtk::Widget)

Returns:

  • (Gtk::Widget)

    widget

#cot(x) ⇒ Gnm::gnm_float

Returns The co-tangent of the given angle.

Parameters:

  • x (Gnm::gnm_float)

    an angle in radians

Returns:

  • (Gnm::gnm_float)

    The co-tangent of the given angle.

#coth(x) ⇒ Gnm::gnm_float

Returns The hyperbolic co-tangent of the given number.

Parameters:

  • x (Gnm::gnm_float)

    a number.

Returns:

  • (Gnm::gnm_float)

    The hyperbolic co-tangent of the given number.

#cpp(src, vars) ⇒ String

Parameters:

  • src (String)
  • vars (GLib::HashTable<GObject>)

Returns:

  • (String)

#create_popup_menu(elements, handler, user_data, notify, display_filter, sensitive_filter, event) ⇒ nil

Parameters:

  • elements (Gnm::PopupMenuElement)
  • handler (Gnm::PopupMenuHandler)
  • user_data (GObject)

    user data to pass to handler.

  • notify (GLib::DestroyNotify)

    destroy notification for user_data

  • display_filter (Integer)
  • sensitive_filter (Integer)
  • event (Gdk::Event)

Returns:

  • (nil)

#create_tooltip(ref_widget) ⇒ Gtk::Widget

Returns the newly allocated Gtk::Widget.

Parameters:

  • ref_widget (Gtk::Widget)

Returns:

  • (Gtk::Widget)

    the newly allocated Gtk::Widget.

#css_debug_color(name, color) ⇒ nil

Parameters:

  • name (String)
  • color (Gdk::RGBA)

Returns:

  • (nil)

#css_debug_int(name, i) ⇒ nil

Parameters:

  • name (String)
  • i (Integer)

Returns:

  • (nil)

#data_shuffling(wbc, dao, sheet, input, shuffling_type) ⇒ Gnm::data_shuffling_t

Parameters:

Returns:

  • (Gnm::data_shuffling_t)

#data_shuffling_free(st) ⇒ nil

Parameters:

  • st (Gnm::data_shuffling_t)

Returns:

  • (nil)

#data_shuffling_redo(st) ⇒ nil

Parameters:

  • st (Gnm::data_shuffling_t)

Returns:

  • (nil)

#date_add_days(d, n) ⇒ nil

Parameters:

  • d (GLib::Date)
  • n (Integer)

Returns:

  • (nil)

#date_add_months(d, n) ⇒ nil

Parameters:

  • d (GLib::Date)
  • n (Integer)

Returns:

  • (nil)

#date_add_years(d, n) ⇒ nil

Parameters:

  • d (GLib::Date)
  • n (Integer)

Returns:

  • (nil)

#datetime_allow_negativeBoolean

Returns:

  • (Boolean)

#datetime_value_to_g(res, v, conv) ⇒ Boolean

Parameters:

  • res (GLib::Date)
  • v (Gnm::Value)
  • conv (GOffice::DateConventions)

Returns:

  • (Boolean)

#datetime_value_to_seconds(v, conv) ⇒ Integer

Parameters:

  • v (Gnm::Value)
  • conv (GOffice::DateConventions)

Returns:

  • (Integer)

#datetime_value_to_serial(v, conv) ⇒ Integer

Parameters:

  • v (Gnm::Value)
  • conv (GOffice::DateConventions)

Returns:

  • (Integer)

#datetime_value_to_serial_raw(v, conv) ⇒ Gnm::gnm_float

Parameters:

  • v (Gnm::Value)
  • conv (GOffice::DateConventions)

Returns:

  • (Gnm::gnm_float)

#dbeta(x, a, b, give_log) ⇒ Gnm::gnm_float

Returns density of the beta distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • a (Gnm::gnm_float)

    the first shape parameter of the distribution

  • b (Gnm::gnm_float)

    the second scale parameter of the distribution

  • give_log (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    density of the beta distribution.

#dbinom(x, n, psuc, give_log) ⇒ Gnm::gnm_float

Returns density of the binomial distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • n (Gnm::gnm_float)

    the number of trials

  • psuc (Gnm::gnm_float)

    the probability of success in each trial

  • give_log (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    density of the binomial distribution.

#dcauchy(x, location, scale, give_log) ⇒ Gnm::gnm_float

Parameters:

  • x (Gnm::gnm_float)
  • location (Gnm::gnm_float)
  • scale (Gnm::gnm_float)
  • give_log (Boolean)

Returns:

  • (Gnm::gnm_float)

#dchisq(x, df, give_log) ⇒ Gnm::gnm_float

Returns density of the 𝜒² distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • df (Gnm::gnm_float)

    the number of degrees of freedom of the distribution

  • give_log (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    density of the 𝜒² distribution.

#debug_flag(flag) ⇒ Boolean

Parameters:

  • flag (String)

Returns:

  • (Boolean)

#dep_container_new(sheet) ⇒ Gnm::DepContainer

Parameters:

Returns:

  • (Gnm::DepContainer)

#dependent_managed_get_expr(dep) ⇒ Gnm::ExprTop

Parameters:

  • dep (Gnm::DepManaged)

Returns:

  • (Gnm::ExprTop)

#dependent_managed_init(dep, sheet) ⇒ nil

Parameters:

Returns:

  • (nil)

#dependent_managed_set_expr(dep, texpr) ⇒ nil

Parameters:

  • dep (Gnm::DepManaged)
  • texpr (Gnm::ExprTop)

Returns:

  • (nil)

#dependent_managed_set_sheet(dep, sheet) ⇒ nil

Parameters:

Returns:

  • (nil)

#dependent_type_register(klass) ⇒ Integer

Parameters:

  • klass (Gnm::DependentClass)

Returns:

  • (Integer)

#dependent_types_initnil

Returns:

  • (nil)

#dependent_types_shutdownnil

Returns:

  • (nil)

#dependents_dump(wb) ⇒ nil

Parameters:

Returns:

  • (nil)

#dependents_invalidate_sheet(sheet, destroy) ⇒ nil

Parameters:

Returns:

  • (nil)

link a list of dependents. (The list used to get freed, but is not freed anymore.)

Parameters:

Returns:

  • (nil)

#dependents_relocate(info) ⇒ GOffice::Undo

Fixes references to or from a region that is going to be moved. the region.

Parameters:

  • info (Gnm::ExprRelocateInfo)

    the descriptor record for what is being moved where.

Returns:

  • (GOffice::Undo)

    a list of the locations and expressions that were changed outside of

#dependents_revive_sheet(sheet) ⇒ nil

Parameters:

Returns:

  • (nil)

#dependents_workbook_destroy(wb) ⇒ nil

Parameters:

Returns:

  • (nil)

#dexp(x, scale, give_log) ⇒ Gnm::gnm_float

Returns density of the exponential distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • scale (Gnm::gnm_float)

    the scale parameter of the distribution

  • give_log (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    density of the exponential distribution.

#df(x, n1, n2, give_log) ⇒ Gnm::gnm_float

Returns density of the F distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • n1 (Gnm::gnm_float)

    the first number of degrees of freedom of the distribution

  • n2 (Gnm::gnm_float)

    the first number of degrees of freedom of the distribution

  • give_log (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    density of the F distribution.

#dgamma(x, shape, scale, give_log) ⇒ Gnm::gnm_float

Returns density of the gamma distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • shape (Gnm::gnm_float)

    the shape parameter of the distribution

  • scale (Gnm::gnm_float)

    the scale parameter of the distribution

  • give_log (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    density of the gamma distribution.

#dgeom(x, psuc, give_log) ⇒ Gnm::gnm_float

Returns density of the geometric distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • psuc (Gnm::gnm_float)

    the probability of success in each trial

  • give_log (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    density of the geometric distribution.

#dhyper(x, r, b, n, give_log) ⇒ Gnm::gnm_float

Returns density of the hypergeometric distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • r (Gnm::gnm_float)

    the number of red balls

  • b (Gnm::gnm_float)

    the number of black balls

  • n (Gnm::gnm_float)

    the number of balls drawn

  • give_log (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    density of the hypergeometric distribution.

#dialog_about(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_advanced_filter(wbcg) ⇒ nil

Show the dialog (guru).

Parameters:

Returns:

  • (nil)

#dialog_anova_single_factor_tool(wbcg, sheet) ⇒ Integer

Parameters:

Returns:

  • (Integer)

#dialog_anova_two_factor_tool(wbcg, sheet) ⇒ Integer

Show the dialog (guru).

Parameters:

Returns:

  • (Integer)

#dialog_auto_filter(wbcg, f, i, is_expr, cur) ⇒ nil

Parameters:

  • wbcg (Gnm::WBCGtk)
  • f (Gnm::Filter)
  • i (Integer)
  • is_expr (Boolean)
  • cur (Gnm::FilterCondition)

Returns:

  • (nil)

#dialog_autoformat(wbcg) ⇒ nil

This function will show the AutoFormatTemplate dialog and apply the template the user chooses to the current selection in the active sheet of the workbook if the user desires.

Parameters:

  • wbcg (Gnm::WBCGtk)

    the control that invoked this dialog

Returns:

  • (nil)

#dialog_autosave(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_autosave_prompt(wbcg) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#dialog_average_tool(wbcg, sheet) ⇒ Integer

Show the dialog (guru).

Parameters:

Returns:

  • (Integer)

#dialog_cell_comment(wbcg, sheet, pos) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_cell_format(wbcg, pageno, pages) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_cell_format_cond(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_cell_format_select_style(wbcg, pages, w, style, closure) ⇒ Gtk::Dialog

Returns a Gtk::Dialog.

Parameters:

  • wbcg (Gnm::WBCGtk)
  • pages (Integer)
  • w (Gtk::Window)
  • style (Gnm::Style)
  • closure (GObject)

Returns:

  • (Gtk::Dialog)

    a Gtk::Dialog.

#dialog_cell_format_style_added(closure, style) ⇒ nil

Parameters:

  • closure (GObject)
  • style (Gnm::Style)

Returns:

  • (nil)

#dialog_cell_sort(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_chi_square_tool(wbcg, sheet, independence) ⇒ Integer

Parameters:

Returns:

  • (Integer)

#dialog_col_row(wbcg, operation, callback, data) ⇒ nil

Parameters:

  • wbcg (Gnm::WBCGtk)
  • operation (String)
  • callback (Gnm::ColRowCallback_t)
  • data (GObject)

Returns:

  • (nil)

#dialog_col_width(wbcg, set_default) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_consolidate(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_correlation_tool(wbcg, sheet) ⇒ Integer

Show the dialog (guru).

Parameters:

Returns:

  • (Integer)

#dialog_covariance_tool(wbcg, sheet) ⇒ Integer

Show the dialog (guru).

Parameters:

Returns:

  • (Integer)

#dialog_data_slicer(wbcg, create) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_data_table(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_define_names(wbcg) ⇒ nil

Create and show the define names dialog.

Parameters:

Returns:

  • (nil)

#dialog_delete_cells(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_descriptive_stat_tool(wbcg, sheet) ⇒ Integer

Show the dialog (guru).

Parameters:

Returns:

  • (Integer)

#dialog_doc_metadata_new(wbcg, page) ⇒ nil

Creates a new instance of the dialog.

Parameters:

Returns:

  • (nil)

#dialog_exp_smoothing_tool(wbcg, sheet) ⇒ Integer

Show the dialog (guru).

Parameters:

Returns:

  • (Integer)

#dialog_fill_series(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_formula_guru(wbcg, func) ⇒ nil

Pop up a function selector then a formula guru.

Parameters:

Returns:

  • (nil)

#dialog_fourier_tool(wbcg, sheet) ⇒ Integer

Show the dialog (guru).

Parameters:

Returns:

  • (Integer)

#dialog_frequency_tool(wbcg, sheet) ⇒ Integer

Show the dialog (guru).

Parameters:

Returns:

  • (Integer)

#dialog_ftest_tool(wbcg, sheet) ⇒ Integer

Show the dialog (guru).

Parameters:

Returns:

  • (Integer)

#dialog_function_select(wbcg, key) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_function_select_help(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_function_select_paste(wbcg, from, to) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_get_password(parent, filename) ⇒ String

Parameters:

  • parent (Gtk::Window)
  • filename (String)

Returns:

  • (String)

#dialog_goal_seek(wbcg, sheet) ⇒ nil

Create the dialog (guru).

Parameters:

Returns:

  • (nil)

#dialog_goto_cell(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_histogram_tool(wbcg, sheet) ⇒ Integer

Show the dialog (guru).

Parameters:

Returns:

  • (Integer)

Parameters:

Returns:

  • (nil)

#dialog_insert_cells(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_kaplan_meier_tool(wbcg, sheet) ⇒ Integer

Show the dialog (guru).

Parameters:

Returns:

  • (Integer)

#dialog_merge(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_new_view(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_normality_tool(wbcg, sheet) ⇒ Integer

Show the dialog (guru).

Parameters:

Returns:

  • (Integer)

#dialog_one_mean_test_tool(wbcg, sheet) ⇒ Integer

Parameters:

Returns:

  • (Integer)

#dialog_paste_names(wbcg) ⇒ nil

Create and show the define names dialog.

Parameters:

Returns:

  • (nil)

#dialog_paste_special(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_plugin_manager(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_preferences(wbcg, page) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_principal_components_tool(wbcg, sheet) ⇒ Integer

Show the dialog (guru).

Parameters:

Returns:

  • (Integer)

#dialog_printer_setup(wbcg, sheet) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_quit(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_raise_if_exists(wbcg, key) ⇒ Gtk::Dialog

Raise the dialog identified by key if it is registered on the wbcg.

Parameters:

  • wbcg (Gnm::WBCGtk)

    A WBCGtk

  • key (String)

    A key to identify the dialog

Returns:

  • (Gtk::Dialog)

    existing dialog

#dialog_random_cor_tool(wbcg, sheet) ⇒ Integer

Show the dialog (guru).

Parameters:

Returns:

  • (Integer)

#dialog_random_tool(wbcg, sheet) ⇒ Integer

Show the dialog (guru).

Parameters:

Returns:

  • (Integer)

#dialog_ranking_tool(wbcg, sheet) ⇒ Integer

Show the dialog (guru).

Parameters:

Returns:

  • (Integer)

#dialog_recent_used(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_regression_tool(wbcg, sheet) ⇒ Integer

Show the dialog (guru).

Parameters:

Returns:

  • (Integer)

#dialog_row_height(wbcg, set_default) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_sampling_tool(wbcg, sheet) ⇒ Integer

Show the dialog (guru).

Parameters:

Returns:

  • (Integer)

#dialog_scenario_add(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_scenarios(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_search(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_search_replace(wbcg, cb) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_search_replace_query(wbcg, sr, location, old_text, new_text) ⇒ Integer

Parameters:

Returns:

  • (Integer)

#dialog_setup_destroy_handlers(dialog, wbcg, what) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_sheet_compare(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_sheet_order(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_sheet_rename(wbcg, sheet) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_sheet_resize(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_shuffle(wbcg) ⇒ nil

Show the dialog (guru).

Parameters:

Returns:

  • (nil)

#dialog_sign_test_tool(wbcg, sheet, type) ⇒ Integer

Parameters:

Returns:

  • (Integer)

#dialog_sign_test_two_tool(wbcg, sheet, type) ⇒ Integer

Parameters:

Returns:

  • (Integer)

#dialog_simulation(wbcg, sheet) ⇒ nil

Show the dialog (guru).

Parameters:

Returns:

  • (nil)

#dialog_so_list(wbcg, so) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_so_size(wbcg, so) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_so_styled(wbcg, so, default_style, title, extent) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_solver(wbcg, sheet) ⇒ nil

Create the dialog (guru).

Parameters:

Returns:

  • (nil)

#dialog_tabulate(wbcg, sheet) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_tool_init(state, wbcg, sheet, help_file, gui_name, dialog_name, error_str, key, ok_function, close_function, sensitivity_cb, flags) ⇒ Boolean

Create the dialog (guru).

Parameters:

  • state (Gnm::GenericToolState)
  • wbcg (Gnm::WBCGtk)
  • sheet (Gnm::Sheet)
  • help_file (String)
  • gui_name (String)
  • dialog_name (String)
  • error_str (String)
  • key (String)
  • ok_function (GObject::Callback)
  • close_function (GObject::Callback)
  • sensitivity_cb (GObject::Callback)
  • flags (Gnm::ExprEntryFlags)

Returns:

  • (Boolean)

#dialog_tool_init_outputs(state, sensitivity_cb) ⇒ nil

Setup the standard output information

Parameters:

  • state (Gnm::GenericToolState)
  • sensitivity_cb (GObject::Callback)

Returns:

  • (nil)

#dialog_tool_preset_to_range(state) ⇒ nil

Parameters:

  • state (Gnm::GenericToolState)

Returns:

  • (nil)

#dialog_ttest_tool(wbcg, sheet, test) ⇒ Integer

Show the dialog (guru).

Parameters:

Returns:

  • (Integer)

#dialog_wilcoxon_m_w_tool(wbcg, sheet) ⇒ Integer

Parameters:

Returns:

  • (Integer)

#dialog_workbook_attr(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#dialog_zoom(wbcg, sheet) ⇒ nil

Parameters:

Returns:

  • (nil)

#diff_sheets(actions, user, old_sheet, new_sheet) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#diff_workbooks(actions, user, old_wb, new_wb) ⇒ Integer

Parameters:

Returns:

  • (Integer)

#digamma(x) ⇒ Gnm::gnm_float

Returns the digamma function evaluated at x.

Parameters:

  • x (Gnm::gnm_float)

    a number

Returns:

  • (Gnm::gnm_float)

    the digamma function evaluated at x.

#discpfuncinverter(p, shape, lower_tail, log_p, xlow, xhigh, x0, pfunc) ⇒ Gnm::gnm_float

Discrete pfuncs only. (Specifically: only integer x are allowed).

Parameters:

  • p (Gnm::gnm_float)
  • shape (Gnm::gnm_float)
  • lower_tail (Boolean)
  • log_p (Boolean)
  • xlow (Gnm::gnm_float)
  • xhigh (Gnm::gnm_float)
  • x0 (Gnm::gnm_float)
  • pfunc (Gnm::PFunc)

Returns:

  • (Gnm::gnm_float)

#dlnorm(x, logmean, logsd, give_log) ⇒ Gnm::gnm_float

Returns density of the log-normal distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • logmean (Gnm::gnm_float)

    mean of the underlying normal distribution

  • logsd (Gnm::gnm_float)

    standard deviation of the underlying normal distribution

  • give_log (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    density of the log-normal distribution.

#dnbinom(x, n, psuc, give_log) ⇒ Gnm::gnm_float

Returns density of the negative binomial distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • n (Gnm::gnm_float)

    the number of trials

  • psuc (Gnm::gnm_float)

    the probability of success in each trial

  • give_log (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    density of the negative binomial distribution.

#dnorm(x, mu, sigma, give_log) ⇒ Gnm::gnm_float

Returns density of the normal distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • mu (Gnm::gnm_float)

    mean of the distribution

  • sigma (Gnm::gnm_float)

    standard deviation of the distribution

  • give_log (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    density of the normal distribution.

#do_tabulation(wbc, data) ⇒ GLib::SList<Integer>

Parameters:

Returns:

  • (GLib::SList<Integer>)

#dpois(x, lambda, give_log) ⇒ Gnm::gnm_float

Returns density of the Poisson distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • lambda (Gnm::gnm_float)

    the mean of the distribution

  • give_log (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    density of the Poisson distribution.

#drayleigh(x, scale, give_log) ⇒ Gnm::gnm_float

Returns density of the Rayleigh distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • scale (Gnm::gnm_float)

    scale parameter

  • give_log (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    density of the Rayleigh distribution.

#dt(x, n, give_log) ⇒ Gnm::gnm_float

Returns density of the Student t distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • n (Gnm::gnm_float)

    the number of degrees of freedom of the distribution

  • give_log (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    density of the Student t distribution.

#dweibull(x, shape, scale, give_log) ⇒ Gnm::gnm_float

Returns density of the Weibull distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • shape (Gnm::gnm_float)

    the shape parameter of the distribution

  • scale (Gnm::gnm_float)

    the scale parameter of the distribution

  • give_log (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    density of the Weibull distribution.

#editable_enters(window, editable) ⇒ nil

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.

Parameters:

  • window (Gtk::Window)

    dialog to affect.

  • editable (Gtk::Widget)

    Editable to affect.

Returns:

  • (nil)

#entry_to_float_with_format(entry, the_float, update, format) ⇒ Boolean

Parameters:

  • entry (Gtk::Entry)
  • the_float (Gnm::gnm_float)
  • update (Boolean)
  • format (GOffice::Format)

Returns:

  • (Boolean)

#entry_to_float_with_format_default(entry, the_float, update, format, num) ⇒ Boolean

Parameters:

  • entry (Gtk::Entry)
  • the_float (Gnm::gnm_float)
  • update (Boolean)
  • format (GOffice::Format)
  • num (Gnm::gnm_float)

Returns:

  • (Boolean)

#entry_to_int(entry, the_int, update) ⇒ Boolean

Retrieve an int from an entry field parsing all reasonable formats

Parameters:

  • entry (Gtk::Entry)
  • the_int (Integer)
  • update (Boolean)

Returns:

  • (Boolean)

#error_arrayGLib::Quark

Returns:

  • (GLib::Quark)

#error_calcGLib::Quark

Returns:

  • (GLib::Quark)

#error_in_entry(state, entry, err_str) ⇒ nil

Show an error dialog and select corresponding entry

Parameters:

  • state (Gnm::GenericToolState)
  • entry (Gtk::Widget)
  • err_str (String)

Returns:

  • (nil)

#eval_info_get_arg_count(ei) ⇒ Integer

Parameters:

  • ei (Gnm::FuncEvalInfo)

Returns:

  • (Integer)

#eval_info_get_func(ei) ⇒ Gnm::Func

Returns the called function.

Parameters:

  • ei (Gnm::FuncEvalInfo)

    Gnm::FuncEvalInfo

Returns:

#excel_search_impl(needle, haystack, skip) ⇒ Integer

characters.

The is the implementation of Excel's SEARCH function. However, note that skip and return value are zero-based.

Parameters:

  • needle (String)

    the pattern to search for, see gnm_regcomp_XL.

  • haystack (String)

    the string to search in.

  • skip (Integer)

    zero-based search start point in characters.

Returns:

  • (Integer)

    -1 for a non-match, or zero-based location in

#expmx2h(x) ⇒ Gnm::gnm_float

naive formula.

Parameters:

  • x (Gnm::gnm_float)

    a number

Returns:

  • (Gnm::gnm_float)

    The result of exp(-0.5*x*x) with higher accuracy than the

#expr_cell_deriv(y, x) ⇒ Gnm::ExprTop

respect to cell x.

Parameters:

  • y (Gnm::Cell)

    Result cell

  • x (Gnm::Cell)

    Variable cell

Returns:

  • (Gnm::ExprTop)

    The derivative of cell y with

#expr_cell_deriv_value(y, x) ⇒ Gnm::gnm_float

current value of x. Returns NaN on error.

Parameters:

  • y (Gnm::Cell)

    Result cell

  • x (Gnm::Cell)

    Variable cell

Returns:

  • (Gnm::gnm_float)

    The derivative of cell y with respect to cell x at the

#expr_char_start_p(c) ⇒ String

Can the supplied string be an expression ? It does not guarantee that it is, however, it is possible. If it is possible it strips off any header characters that are not relevant.

NOTE : things like -1,234 will match

Parameters:

  • c (String)

    string

Returns:

  • (String)

#expr_conv_quote(convs, str) ⇒ GLib::String

quoting is necessary, a literal copy of str will be returned.

Parameters:

  • convs (Gnm::Conventions)

    Gnm::Conventions

  • str (String)

    string to quote

Returns:

  • (GLib::String)

    A quoted string according to convs. If no

#expr_deriv_shutdown_nil

Returns:

  • (nil)

#expr_init_nil

Returns:

  • (nil)

#expr_lex_all(str, pp, flags, convs) ⇒ Gnm::LexerItem

Parameters:

Returns:

  • (Gnm::LexerItem)

#expr_list_as_string(argc, argv, out) ⇒ nil

Parameters:

  • argc (Integer)
  • argv (Gnm::ExprConstPtr)
  • out (Gnm::ConventionsOut)

Returns:

  • (nil)

#expr_list_copy(list) ⇒ Gnm::ExprList

expressions in it.

Parameters:

  • list (Gnm::ExprList)

    list of expressions

Returns:

  • (Gnm::ExprList)

    a copy of the list and all the

#expr_list_unref(list) ⇒ nil

This frees list and all the expressions in it.

Parameters:

  • list (Gnm::ExprList)

    expression list

Returns:

  • (nil)

#expr_name_add(pp, name, texpr, error_msg, link_to_container, stub) ⇒ Gnm::NamedExpr

Absorbs the reference to texpr. If error_msg is non NULL it may hold a pointer to a translated descriptive string. NOTE : caller is responsible for freeing the error message.

The reference semantics of the new expression are

  1. new names with link_to_container TRUE are referenced by the container. The caller DOES NOT OWN a reference to the result, and needs to add their own.
  2. if link_to_container is false the caller DOES OWN a reference, and can free the result by unrefing the name.

Parameters:

  • pp (Gnm::ParsePos)
  • name (String)
  • texpr (Gnm::ExprTop)

    if texpr == NULL then create a placeholder with value #NAME?

  • error_msg (String)
  • link_to_container (Boolean)
  • stub (Gnm::NamedExpr)

Returns:

  • (Gnm::NamedExpr)

#expr_name_add_dep(nexpr, dep) ⇒ nil

Parameters:

Returns:

  • (nil)

#expr_name_as_string(nexpr, pp, fmt) ⇒ String

Returns The rendering of nexpr given convention fmt.

Parameters:

  • nexpr (Gnm::NamedExpr)

    A Gnm::NamedExpr

  • pp (Gnm::ParsePos)

    Position where name was defined.

  • fmt (Gnm::Conventions)

    Gnm::Conventions describing how to render nexpr

Returns:

  • (String)

    The rendering of nexpr given convention fmt.

#expr_name_check_for_loop(name, texpr) ⇒ Boolean

name reference.

NOTE: if we already have a circular reference beforehand, we will come to serious grief.

Parameters:

  • name (String)

    tentative name

  • texpr (Gnm::ExprTop)

    tentative expression

Returns:

  • (Boolean)

    true if defining the tentative name would cause a circular

#expr_name_cmp_by_name(a, b) ⇒ Integer

Parameters:

  • a (Gnm::NamedExpr)
  • b (Gnm::NamedExpr)

Returns:

  • (Integer)

#expr_name_downgrade_to_placeholder(nexpr) ⇒ nil

Takes a real non-placeholder name and converts it to being a placeholder. unrefing its expression

Parameters:

  • nexpr (Gnm::NamedExpr)

Returns:

  • (nil)

#expr_name_eval(nexpr, pos, flags) ⇒ Gnm::Value

Returns The resulting value.

Parameters:

  • nexpr (Gnm::NamedExpr)

    A Gnm::NamedExpr

  • pos (Gnm::EvalPos)

    Position where evaluation takes place

  • flags (Gnm::ExprEvalFlags)

    Gnm::ExprEvalFlags flags describing context.

Returns:

  • (Gnm::Value)

    The resulting value.

#expr_name_in_use(nexpr) ⇒ Boolean

approximation only, as we only look at the workbook in which the name is defined.

Parameters:

  • nexpr (Gnm::NamedExpr)

    A named expression.

Returns:

  • (Boolean)

    TRUE, if the named expression appears to be in use. This is an

#expr_name_is_active(nexpr) ⇒ Boolean

Parameters:

  • nexpr (Gnm::NamedExpr)

Returns:

  • (Boolean)

#expr_name_is_placeholder(ne) ⇒ Boolean

Returns true if ne is a placeholder for an unknown name.

Parameters:

  • ne (Gnm::NamedExpr)

Returns:

  • (Boolean)

    true if ne is a placeholder for an unknown name

#expr_name_lookup(pos, name) ⇒ Gnm::NamedExpr

given by pos; nil if no such Gnm::NamedExpr exists.

Parameters:

  • pos (Gnm::ParsePos)

    Gnm::ParsePos identifying a #Sheet or a #Workbook.

  • name (String)

    name of Gnm::NamedExpr to look up.

Returns:

  • (Gnm::NamedExpr)

    Gnm::NamedExpr named name in the scope

#expr_name_name(nexpr) ⇒ String

Parameters:

  • nexpr (Gnm::NamedExpr)

Returns:

  • (String)

#expr_name_new(name) ⇒ Gnm::NamedExpr

Creates a new name without linking it into any container.

Parameters:

  • name (String)

Returns:

  • (Gnm::NamedExpr)

#expr_name_perm_add(sheet, name, texpr, is_editable) ⇒ nil

This is a wrapper around expr_name_add to set this as permanent name.

Parameters:

  • sheet (Gnm::Sheet)
  • name (String)

    name

  • texpr (Gnm::ExprTop)

    string to be the value of the name

  • is_editable (Boolean)

    whether this is a predefined action

Returns:

  • (nil)

#expr_name_ref(nexpr) ⇒ Gnm::NamedExpr

Parameters:

  • nexpr (Gnm::NamedExpr)

Returns:

  • (Gnm::NamedExpr)

#expr_name_remove(nexpr) ⇒ nil

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!

Parameters:

  • nexpr (Gnm::NamedExpr)

Returns:

  • (nil)

#expr_name_remove_dep(nexpr, dep) ⇒ nil

Parameters:

Returns:

  • (nil)

#expr_name_set_expr(nexpr, texpr) ⇒ nil

Set the content of nexpr to texpr.

Parameters:

  • nexpr (Gnm::NamedExpr)

    Gnm::NamedExpr to change

  • texpr (Gnm::ExprTop)

    the new contents

Returns:

  • (nil)

#expr_name_set_expr_undo_new(nexpr) ⇒ GOffice::Undo

Parameters:

  • nexpr (Gnm::NamedExpr)

    Gnm::NamedExpr

Returns:

  • (GOffice::Undo)

#expr_name_set_is_placeholder(nexpr, is_placeholder) ⇒ nil

Parameters:

  • nexpr (Gnm::NamedExpr)
  • is_placeholder (Boolean)

Returns:

  • (nil)

#expr_name_set_name(nexpr, new_name) ⇒ Boolean

Returns TRUE on error.

Parameters:

  • nexpr (Gnm::NamedExpr)

    the named expression

  • new_name (String)

    the new name of the expression

Returns:

  • (Boolean)

    TRUE on error.

#expr_name_set_pos(nexpr, pp) ⇒ String

Returns a translated error string which the caller must free if something goes wrong.

Parameters:

  • nexpr (Gnm::NamedExpr)

    the named expression

  • pp (Gnm::ParsePos)

    the new position

Returns:

  • (String)

#expr_name_unref(nexpr) ⇒ nil

Parameters:

  • nexpr (Gnm::NamedExpr)

Returns:

  • (nil)

#expr_name_validate(name) ⇒ Boolean

returns true if the given name is valid, false otherwise.

Parameters:

  • name (String)

    tentative name

Returns:

  • (Boolean)

#expr_parse_str(str, pp, flags, convs, error) ⇒ Gnm::ExprTop

Parameters:

  • str (String)
  • pp (Gnm::ParsePos)
  • flags (Gnm::ExprParseFlags)
  • convs (Gnm::Conventions)
  • error (Gnm::ParseError)

Returns:

  • (Gnm::ExprTop)

#expr_shutdown_nil

Returns:

  • (nil)

#fact(x) ⇒ Gnm::gnm_float

Returns the factorial of x, which must not be a negative integer.

Parameters:

  • x (Gnm::gnm_float)

    number

Returns:

  • (Gnm::gnm_float)

    the factorial of x, which must not be a negative integer.

#factx(x, exp2) ⇒ Gnm::gnm_float

Parameters:

  • x (Gnm::gnm_float)
  • exp2 (Integer)

Returns:

  • (Gnm::gnm_float)

#file_saver_common_export_option(fs, wb, key, value) ⇒ Boolean

Parameters:

  • fs (GOffice::FileSaver)
  • wb (Gnm::Workbook)
  • key (String)
  • value (String)

Returns:

  • (Boolean)

#file_saver_get_sheet(fs, wbv) ⇒ Gnm::Sheet

For a single-sheet saver, this function determines what sheet to save.

Parameters:

  • fs (GOffice::FileSaver)

    GOFile::Saver

  • wbv (Gnm::WorkbookView)

    Workbook::View

Returns:

#file_saver_get_sheets(fs, wbv, default_all) ⇒ Array<Gnm::Sheet>

This function determines what sheets to save. this function will return nil if no sheets were explicitly selected. Note: the return value should be unreffed, not freed.

Parameters:

  • fs (GOffice::FileSaver)

    GOFile::Saver

  • wbv (Gnm::WorkbookView)

    Workbook::View

  • default_all (Boolean)

    If true, all sheets will be selected by default; if false,

Returns:

#fill_series_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#filter_show_all(wbc) ⇒ nil

Parameters:

Returns:

  • (nil)

#find_column_of_field(ep, database, field) ⇒ Integer

Parameters:

  • ep (Gnm::EvalPos)
  • database (Gnm::Value)
  • field (Gnm::Value)

Returns:

  • (Integer)

#find_rows_that_match(sheet, first_col, first_row, last_col, last_row, criterias, unique_only) ⇒ GLib::SList<Integer>

Finds the rows from the given database that match the criteria.

Parameters:

  • sheet (Gnm::Sheet)

    #Sheet

  • first_col (Integer)

    first column.

  • first_row (Integer)

    first row.

  • last_col (Integer)

    last column.

  • last_row (Integer)

    last row.

  • criterias (GLib::SList<Gnm::DBCriteria>)

    the criteria to use.

  • unique_only (Boolean)

Returns:

  • (GLib::SList<Integer>)

    the list of matching rows.

#float_equal(a, b) ⇒ Integer

Parameters:

  • a (Gnm::gnm_float)
  • b (Gnm::gnm_float)

Returns:

  • (Integer)

#float_hash(d) ⇒ Integer

Parameters:

  • d (Gnm::gnm_float)

Returns:

  • (Integer)

#float_range_function(argc, argv, ei, func, flags, func_error) ⇒ Gnm::Value

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. of values from argv.

Parameters:

  • argc (Integer)

    number of arguments

  • argv (Array<Gnm::ExprConstPtr>)

    function arguments

  • ei (Gnm::FuncEvalInfo)

    Gnm::FuncEvalInfo describing evaluation context

  • func (Gnm::float_range_function_t)

    implementation function

  • flags (Gnm::CollectFlags)

    Collect::Flags flags describing the collection and interpretation

  • func_error (Gnm::StdError)

    A Gnm::StdError to use to func indicates an error.

Returns:

  • (Gnm::Value)

    Function result or error value.

#float_range_function2(val0, val1, ei, func, flags, func_error) ⇒ Gnm::Value

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. of values from val0 and val1.

Parameters:

  • val0 (Gnm::Value)

    First range

  • val1 (Gnm::Value)

    Second range

  • ei (Gnm::FuncEvalInfo)

    Gnm::FuncEvalInfo describing evaluation context

  • func (Gnm::float_range_function2_t)

    implementation function

  • flags (Gnm::CollectFlags)

    Collect::Flags flags describing the collection and interpretation

  • func_error (Gnm::StdError)

    A Gnm::StdError to use to func indicates an error.

Returns:

  • (Gnm::Value)

    Function result or error value.

#float_range_function2d(val0, val1, ei, func, flags, func_error, data) ⇒ Gnm::Value

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. of values from val0 and val1.

Parameters:

  • val0 (Gnm::Value)

    First range

  • val1 (Gnm::Value)

    Second range

  • ei (Gnm::FuncEvalInfo)

    Gnm::FuncEvalInfo describing evaluation context

  • func (Gnm::float_range_function2d_t)

    implementation function

  • flags (Gnm::CollectFlags)

    Collect::Flags flags describing the collection and interpretation

  • func_error (Gnm::StdError)

    A Gnm::StdError to use to func indicates an error.

  • data (GObject)

    user data for func

Returns:

  • (Gnm::Value)

    Function result or error value.

#float_to_entry(entry, the_float) ⇒ nil

Parameters:

  • entry (Gtk::Entry)
  • the_float (Gnm::gnm_float)

Returns:

  • (nil)

#focus_on_entry(entry) ⇒ nil

Parameters:

  • entry (Gtk::Entry)

Returns:

  • (nil)

#font_equal(v, v2) ⇒ Integer

Parameters:

  • v (GObject)
  • v2 (GObject)

Returns:

  • (Integer)

#font_hash(v) ⇒ Integer

Parameters:

  • v (GObject)

Returns:

  • (Integer)

#font_initnil

Returns:

  • (nil)

#font_override_codepage(font_name) ⇒ Integer

Returns a codepage for the named Win32 font, or -1 if no such codepage is known.

Parameters:

  • font_name (String)

    The win32 font name

Returns:

  • (Integer)

#font_shutdownnil

Release all resources allocated by gnm_font_init.

Returns:

  • (nil)

#format_for_date_editing(cell) ⇒ GOffice::Format

Parameters:

  • cell (Gnm::Cell)

Returns:

  • (GOffice::Format)

#format_frob_slashes(s) ⇒ String

Parameters:

  • s (String)

Returns:

  • (String)

#format_has_hour(fmt, value) ⇒ Boolean

Parameters:

  • fmt (GOffice::Format)
  • value (Gnm::Value)

Returns:

  • (Boolean)

#format_import(fmt, flags) ⇒ GOffice::Format

Parameters:

Returns:

  • (GOffice::Format)

#format_is_date_for_value(fmt, value) ⇒ Integer

Parameters:

  • fmt (GOffice::Format)
  • value (Gnm::Value)

Returns:

  • (Integer)

#format_is_time_for_value(fmt, value) ⇒ Integer

Parameters:

  • fmt (GOffice::Format)
  • value (Gnm::Value)

Returns:

  • (Integer)

#format_layout(result, metrics, format, value, col_width, date_conv, unicode_minus) ⇒ GOffice::FormatNumberError

Parameters:

  • result (Pango::Layout)
  • metrics (GOffice::FontMetrics)
  • format (GOffice::Format)
  • value (Gnm::Value)
  • col_width (Integer)
  • date_conv (GOffice::DateConventions)
  • unicode_minus (Boolean)

Returns:

  • (GOffice::FormatNumberError)

#format_match(text, cur_fmt, date_conv) ⇒ Gnm::Value

Attempts to parse the supplied string to see if it matches a known value format. The caller is responsible for releasing the resulting value.

Parameters:

  • text (String)

    The text to parse

  • cur_fmt (GOffice::Format)

    The current format for the value

  • date_conv (GOffice::DateConventions)

    optional date convention

Returns:

  • (Gnm::Value)

#format_match_datetime(text, date_conv, month_before_day, add_format, presume_date) ⇒ Gnm::Value

Parameters:

  • text (String)
  • date_conv (GOffice::DateConventions)
  • month_before_day (Boolean)
  • add_format (Boolean)
  • presume_date (Boolean)

Returns:

  • (Gnm::Value)

#format_match_decimal_number_with_locale(text, family, curr, thousand, decimal) ⇒ Gnm::Value

Parameters:

  • text (String)
  • family (GOffice::FormatFamily)
  • curr (GLib::String)
  • thousand (GLib::String)
  • decimal (GLib::String)

Returns:

  • (Gnm::Value)

#format_match_number(text, cur_fmt, date_conv) ⇒ Gnm::Value

Attempts to parse the supplied string to see if it matches a known 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 resulting value. Will ONLY return numbers.

Parameters:

  • text (String)

    The text to parse

  • cur_fmt (GOffice::Format)

    The current format for the value

  • date_conv (GOffice::DateConventions)

    optional date convention

Returns:

  • (Gnm::Value)

#format_match_simple(text) ⇒ Gnm::Value

Attempt to match the supplied string as a simple value.

WARNING WARNING WARNING : This routine should NEVER be changed to match VALUE_STRING that will break the parsers handling of named expressions.

Parameters:

  • text (String)

    A String to match against.

Returns:

  • (Gnm::Value)

#format_month_before_day(fmt, value) ⇒ Integer

Parameters:

  • fmt (GOffice::Format)
  • value (Gnm::Value)

Returns:

  • (Integer)

#format_sel_newGtk::Widget

Returns a new format selector.

Returns:

  • (Gtk::Widget)

    a new format selector

#format_sel_set_value(nfs, value) ⇒ nil

Parameters:

  • nfs (GOffice::FormatSel)
  • value (Gnm::Value)

Returns:

  • (nil)

#format_specialize(fmt, value) ⇒ GOffice::Format

Parameters:

  • fmt (GOffice::Format)
  • value (Gnm::Value)

Returns:

  • (GOffice::Format)

#format_value(format, value, col_width, date_conv) ⇒ String

Parameters:

  • format (GOffice::Format)
  • value (Gnm::Value)
  • col_width (Integer)
  • date_conv (GOffice::DateConventions)

Returns:

  • (String)

#format_value_gstring(str, format, value, col_width, date_conv) ⇒ GOffice::FormatNumberError

Parameters:

  • str (GLib::String)

    append the result here.

  • format (GOffice::Format)

    #GOFormat.

  • value (Gnm::Value)

    Gnm::Value to convert

  • col_width (Integer)

    maximum width in characters, -1 for unlimited

  • date_conv (GOffice::DateConventions)

    GODate::Conventions.

Returns:

  • (GOffice::FormatNumberError)

#format_value_layout(layout, format, value, col_width, date_conv) ⇒ GOffice::FormatNumberError

Parameters:

  • layout (Pango::Layout)

    A PangoLayout

  • format (GOffice::Format)

    #GOFormat.

  • value (Gnm::Value)

    Gnm::Value to convert

  • col_width (Integer)

    optional limit on width, -1 for unlimited

  • date_conv (GOffice::DateConventions)

    GODate::Conventions.

Returns:

  • (GOffice::FormatNumberError)

#free_criterias(criterias) ⇒ nil

freed. Frees the allocated memory.

Parameters:

  • criterias (GLib::SList<Gnm::Criteria>)

    the criteria to be

Returns:

  • (nil)

#ft_category_group_cmp(a, b) ⇒ Integer

Parameters:

  • a (GObject)
  • b (GObject)

Returns:

  • (Integer)

#ft_category_group_list_free(category_groups) ⇒ nil

Parameters:

  • category_groups (GLib::List<Gnm::FTCategoryGroup>)

    the list to free.

Returns:

  • (nil)

#ft_category_group_list_getGLib::List<Gnm::FTCategoryGroup>

the list of Gnm::FTCategoryGroup which should be freed using gnm_ft_category_group_list_free().

Returns:

  • (GLib::List<Gnm::FTCategoryGroup>)

#ft_compare_name(a, b) ⇒ Integer

Parameters:

  • a (GObject)

    First GnmFT

  • b (GObject)

    Second GnmFT

Returns:

  • (Integer)

#func_group_fetch(name, translation) ⇒ Gnm::FuncGroup

Parameters:

  • name (String)
  • translation (String)

Returns:

  • (Gnm::FuncGroup)

#func_group_get_nth(n) ⇒ Gnm::FuncGroup

Parameters:

  • n (Integer)

Returns:

  • (Gnm::FuncGroup)

#function_call_with_exprs(ei) ⇒ Gnm::Value

Do the guts of calling a function.

Returns the result.

Parameters:

  • ei (Gnm::FuncEvalInfo)

    EvalInfo containing valid fn_def!

Returns:

  • (Gnm::Value)

#function_call_with_values(ep, name, argc, values) ⇒ Gnm::Value

Parameters:

  • ep (Gnm::EvalPos)
  • name (String)
  • argc (Integer)
  • values (Gnm::Value)

Returns:

  • (Gnm::Value)

#function_def_call_with_values(ep, fn, argc, values) ⇒ Gnm::Value

Parameters:

  • ep (Gnm::EvalPos)
  • fn (Gnm::Func)
  • argc (Integer)
  • values (Gnm::Value)

Returns:

  • (Gnm::Value)

#function_iterate_argument_values(ep, callback, callback_closure, argc, argv, strict, iter_flags) ⇒ Gnm::Value

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 GnmValue found on the list (this means that ranges get properly expanded).

Parameters:

  • ep (Gnm::EvalPos)

    The position in a workbook at which to evaluate

  • callback (Gnm::FunctionIterateCB)

    The routine to be invoked for every value computed

  • callback_closure (GObject)

    Closure for the callback.

  • argc (Integer)
  • argv (Gnm::ExprConstPtr)
  • strict (Boolean)

    If TRUE, the function is considered "strict". This means that if an error value occurs as an argument, the iteration will stop and that error will be returned. If FALSE, an error will be passed on to the callback (as a GnmValue * of type VALUE_ERROR).

  • iter_flags (Gnm::CellIterFlags)

Returns:

  • (Gnm::Value)

    NULL : if no errors were reported. GnmValue * : if an error was found during strict evaluation VALUE_TERMINATE : if the callback requested termination of the iteration.

#gamma(x) ⇒ Gnm::gnm_float

non-integer x.

Parameters:

  • x (Gnm::gnm_float)

    a number

Returns:

  • (Gnm::gnm_float)

    the Gamma function evaluated at x for positive or

#gammax(x, exp2) ⇒ Gnm::gnm_float

Parameters:

  • x (Gnm::gnm_float)
  • exp2 (Integer)

Returns:

  • (Gnm::gnm_float)

Parameters:

  • widget (Gtk::Widget)
  • res (Gdk::RGBA)

Returns:

  • (nil)

#get_pango_attributes_from_buffer(buffer) ⇒ Pango::AttrList

Parameters:

  • buffer (Gtk::TextBuffer)

Returns:

  • (Pango::AttrList)

#global_range_contained(sheet, a, b) ⇒ Boolean

Returns true if a is contained in b. We do not handle 3d ranges.

Parameters:

  • sheet (Gnm::Sheet)

    The calling context #Sheet for references without sheet.

  • a (Gnm::Value)

    A Gnm::Value representing a range

  • b (Gnm::Value)

    A Gnm::Value representing a range

Returns:

  • (Boolean)

    true if a is contained in b. We do not handle 3d ranges

#global_range_list_foreach(gr_list, ep, flags, handler, closure) ⇒ Gnm::Value

Parameters:

  • gr_list (GLib::SList<Gnm::Range>)

    list of ranges.

  • ep (Gnm::EvalPos)
  • flags (Gnm::CellIterFlags)
  • handler (Gnm::CellIterFunc)
  • closure (GObject)

    user data.

Returns:

  • (Gnm::Value)

#global_range_list_parse(sheet, str) ⇒ GLib::SList<Gnm::Value>

Parses a list of ranges, relative to the sheet and returns a list with the results.

Parameters:

  • sheet (Gnm::Sheet)

    Sheet where the range specification is relatively parsed to

  • str (String)

    a range or list of ranges to parse (ex: "A1", "A1:B1,C2,Sheet2!D2:D4")

Returns:

  • (GLib::SList<Gnm::Value>)

    a #GSList of Gnm::Value.

#global_range_name(sheet, r) ⇒ String

Parameters:

Returns:

  • (String)

#go_data_foreach_dep(dat, so, func, user) ⇒ nil

Parameters:

  • dat (GOffice::Data)

    #GOData

  • so (Gnm::SheetObject)

    Sheet::Object

  • func (Gnm::SheetObjectForeachDepFunc)
  • user (GObject)

    user data.

Returns:

  • (nil)

#go_data_get_expr(dat) ⇒ Gnm::ExprTop

Parameters:

  • dat (GOffice::Data)

Returns:

  • (Gnm::ExprTop)

#go_data_get_sheet(dat) ⇒ Gnm::Sheet

Returns the sheet.

Parameters:

  • dat (GOffice::Data)

    #GOData

Returns:

#go_data_set_sheet(dat, sheet) ⇒ nil

Parameters:

Returns:

  • (nil)

#go_error_info_dialog_create(error) ⇒ Gtk::Widget

SHOULD BE IN GOFFICE

Parameters:

  • error (GOffice::ErrorInfo)

Returns:

  • (Gtk::Widget)

    the newly allocated dialog.

#go_error_info_dialog_show(parent, error) ⇒ nil

Parameters:

  • parent (Gtk::Window)
  • error (GOffice::ErrorInfo)

Returns:

  • (nil)

#go_error_info_list_dialog_show(parent, errs) ⇒ nil

Parameters:

  • parent (Gtk::Window)
  • errs (GLib::SList<GOffice::ErrorInfo>)

Returns:

  • (nil)

#goal_seek_bisection(f, data, user_data) ⇒ Gnm::GoalSeekStatus

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).

Parameters:

  • f (Gnm::GoalSeekFunction)

    object function

  • data (Gnm::GoalSeekData)

    Gnm::GoalSeekData state.

  • user_data (GObject)

    user data for f.

Returns:

#goal_seek_cell(data, celldata) ⇒ Gnm::GoalSeekStatus

Parameters:

  • data (Gnm::GoalSeekData)
  • celldata (Gnm::GoalSeekCellData)

Returns:

#goal_seek_eval_cell(x, y, data) ⇒ Gnm::GoalSeekStatus

Returns An status indicating whether evaluation went ok.

Parameters:

  • x (Gnm::gnm_float)

    x-value for which to evaluate

  • y (Gnm::gnm_float)

    location to store result

  • data (GObject)

    user data

Returns:

#goal_seek_initialize(data) ⇒ nil

Parameters:

  • data (Gnm::GoalSeekData)

Returns:

  • (nil)

#goal_seek_newton(f, df, data, user_data, x0) ⇒ Gnm::GoalSeekStatus

Seek a goal (root) using Newton's iterative method.

The supplied function must (should) be continuously differentiable in the supplied interval. If df is nil, 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.)

Parameters:

  • f (Gnm::GoalSeekFunction)

    object function

  • df (Gnm::GoalSeekFunction)

    object function derivative

  • data (Gnm::GoalSeekData)

    Gnm::GoalSeekData state

  • user_data (GObject)

    user data for f and df

  • x0 (Gnm::gnm_float)

    root guess

Returns:

#goal_seek_point(f, data, user_data, x0) ⇒ Gnm::GoalSeekStatus

Seek a goal using a single point.

Parameters:

  • f (Gnm::GoalSeekFunction)

    object function

  • data (Gnm::GoalSeekData)

    Gnm::GoalSeekData state

  • user_data (GObject)

    user data for f

  • x0 (Gnm::gnm_float)

    root guess

Returns:

#goal_seek_trawl_normally(f, data, user_data, mu, sigma, points) ⇒ Gnm::GoalSeekStatus

Parameters:

  • f (Gnm::GoalSeekFunction)

    object function

  • data (Gnm::GoalSeekData)

    Gnm::GoalSeekData state

  • user_data (GObject)

    user data for f

  • mu (Gnm::gnm_float)

    search mean

  • sigma (Gnm::gnm_float)

    search standard deviation

  • points (Integer)

    number of points to try.

Returns:

#goal_seek_trawl_uniformly(f, data, user_data, xmin, xmax, points) ⇒ Gnm::GoalSeekStatus

Parameters:

  • f (Gnm::GoalSeekFunction)

    object function

  • data (Gnm::GoalSeekData)

    Gnm::GoalSeekData state

  • user_data (GObject)

    user data for f

  • xmin (Gnm::gnm_float)

    lower search bound

  • xmax (Gnm::gnm_float)

    upper search bound

  • points (Integer)

    number of points to try.

Returns:

#gtk_builder_load(uifile, domain, cc) ⇒ Gtk::Builder

Simple utility to open ui files

Parameters:

  • uifile (String)
  • domain (String)
  • cc (GOffice::CmdContext)

    GOCmd::Context

Returns:

  • (Gtk::Builder)

    the newly allocated Gtk::Builder.

#gtk_print_cell_range(context, sheet, range, base_x, base_y, pinfo) ⇒ nil

Parameters:

  • context (cairo::Context)
  • sheet (Gnm::Sheet)
  • range (Gnm::Range)
  • base_x (Float)
  • base_y (Float)
  • pinfo (Gnm::PrintInformation)

Returns:

  • (nil)

#gtk_radio_group_get_selected(radio_group) ⇒ Integer

Returns the index of the selected radio button starting from list end.

Parameters:

  • radio_group (GLib::SList<Gtk::RadioButton>)

    list of radio buttons.

Returns:

  • (Integer)

    the index of the selected radio button starting from list end.

#gui_clipboard_initnil

Returns:

  • (nil)

#gui_clipboard_shutdownnil

Returns:

  • (nil)

#gui_clipboard_test(fmt) ⇒ GLib::Bytes

Parameters:

  • fmt (String)

Returns:

  • (GLib::Bytes)

#gui_file_export_repeat(wbcg) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#gui_file_open(wbcg, type, default_format) ⇒ nil

Parameters:

Returns:

  • (nil)

#gui_file_read(wbcg, file_name, optional_format, optional_encoding) ⇒ Gnm::WorkbookView

Returns the new Workbook::View for the file read.

Parameters:

  • wbcg (Gnm::WBCGtk)
  • file_name (String)
  • optional_format (GOffice::FileOpener)
  • optional_encoding (String)

Returns:

#gui_file_save(wbcg, wbv) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#gui_file_save_as(wbcg, wbv, type, default_format) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#gui_file_template(wbcg, uri) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#gui_group_value(gui, group) ⇒ Integer

Parameters:

  • gui (GObject)
  • group (String)

Returns:

  • (Integer)

#gui_wb_view_show(wbcg, wbv) ⇒ nil

Parameters:

Returns:

  • (nil)

#gutils_initnil

Returns:

  • (nil)

#gutils_shutdownnil

Returns:

  • (nil)

#hash_table_foreach_ordered(h, callback, order, user) ⇒ nil

Like g_hash_table_foreach, but with an ordering imposed.

Parameters:

  • h (GLib::HashTable<GObject>)

    Hash table

  • callback (GLib::HFunc)

    #GHFunc

  • order (Gnm::HashTableOrder)

    Ordering function

  • user (GObject)

    user data for callback and order

Returns:

  • (nil)

#history_item_label(uri, accel_number) ⇒ String

Parameters:

  • uri (String)
  • accel_number (Integer)

Returns:

  • (String)

#if2(ei, argc, argv, flags) ⇒ Gnm::Value

Parameters:

  • ei (Gnm::FuncEvalInfo)
  • argc (Integer)
  • argv (Gnm::ExprConstPtr)
  • flags (Gnm::ExprEvalFlags)

Returns:

  • (Gnm::Value)

#ifs_func(data, crits, vals, fun, err, ep, flags) ⇒ Gnm::Value

This implements a Gnumeric sheet database function of the "*IFS" type This function collects the arguments and uses fun to do the actual computation. of values from data.

Parameters:

  • data (Array<Gnm::Value>)
  • crits (Array<Gnm::Criteria>)

    criteria

  • vals (Gnm::Value)
  • fun (Gnm::float_range_function_t)

    function to evaluate on filtered data

  • err (Gnm::StdError)

    error value in case fun fails.

  • ep (Gnm::EvalPos)

    evaluation position

  • flags (Gnm::CollectFlags)

    Collect::Flags flags describing the collection and interpretation

Returns:

  • (Gnm::Value)

    Function result or error value.

#ilog(x, b) ⇒ Gnm::gnm_float

Parameters:

  • x (Gnm::gnm_float)
  • b (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#initnil

Returns:

  • (nil)

#init_help_button(w, lnk) ⇒ nil

Parameters:

  • w (Gtk::Widget)
  • lnk (String)

Returns:

  • (nil)

#insert_meta_date(doc, name) ⇒ nil

Parameters:

  • doc (GOffice::Doc)
  • name (String)

Returns:

  • (nil)

#int_to_entry(entry, the_int) ⇒ nil

Parameters:

  • entry (Gtk::Entry)
  • the_int (Integer)

Returns:

  • (nil)

#keyed_dialog(wbcg, dialog, key) ⇒ nil

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.

Parameters:

  • wbcg (Gnm::WBCGtk)

    A WBCGtk

  • dialog (Gtk::Window)

    A transient window

  • key (String)

    A key to identify the dialog

Returns:

  • (nil)

#lambert_w(x, k) ⇒ Gnm::gnm_float

for the primary branch and -1 for the alternate.

Parameters:

  • x (Gnm::gnm_float)

    a number

  • k (Integer)

    branch, either 0 or -1

Returns:

  • (Gnm::gnm_float)

    The Lambert W function at x. k is a branch number: 0

#lbeta(a, b) ⇒ Gnm::gnm_float

Parameters:

  • a (Gnm::gnm_float)
  • b (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#lbeta3(a, b, sign) ⇒ Gnm::gnm_float

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.

Parameters:

  • a (Gnm::gnm_float)

    a number

  • b (Gnm::gnm_float)

    a number

  • sign (Integer)

    the sign

Returns:

  • (Gnm::gnm_float)

    the logarithm of the absolute value of the Beta function

#lgamma1p(a) ⇒ Gnm::gnm_float

Parameters:

  • a (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#linear_solve(A, b, x) ⇒ GOffice::RegressionResult

Parameters:

  • A (Gnm::Matrix)
  • b (Gnm::gnm_float)
  • x (Gnm::gnm_float)

Returns:

  • (GOffice::RegressionResult)

#linear_solve_multiple(A, B) ⇒ GOffice::RegressionResult

Parameters:

  • A (Gnm::Matrix)
  • B (Gnm::Matrix)

Returns:

  • (GOffice::RegressionResult)

#linear_solve_posdef(A, b, x) ⇒ GOffice::RegressionResult

Parameters:

  • A (Gnm::Matrix)
  • b (Gnm::gnm_float)
  • x (Gnm::gnm_float)

Returns:

  • (GOffice::RegressionResult)

#link_button_and_entry(button, entry) ⇒ nil

Parameters:

  • button (Gtk::Widget)
  • entry (Gtk::Widget)

Returns:

  • (nil)

#load_pango_attributes_into_buffer(markup, buffer, str) ⇒ nil

Parameters:

  • markup (Pango::AttrList)
  • buffer (Gtk::TextBuffer)
  • str (String)

Returns:

  • (nil)

#locale_dirString

Returns:

  • (String)

#log1pmx(x) ⇒ Gnm::gnm_float

especially for small values of x.

Parameters:

  • x (Gnm::gnm_float)

    a number

Returns:

  • (Gnm::gnm_float)

    log(1+x)-x with less rounding error than the naive formula,

#logcf(x, i, d) ⇒ Gnm::gnm_float

Parameters:

  • x (Gnm::gnm_float)
  • i (Gnm::gnm_float)
  • d (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#logspace_add(logx, logy) ⇒ Gnm::gnm_float

Parameters:

  • logx (Gnm::gnm_float)
  • logy (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#logspace_sub(logx, logy) ⇒ Gnm::gnm_float

Parameters:

  • logx (Gnm::gnm_float)
  • logy (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#make_cellref(dx, dy) ⇒ Gnm::Expr

Parameters:

  • dx (Integer)
  • dy (Integer)

Returns:

  • (Gnm::Expr)

#make_rangeref(dx0, dy0, dx1, dy1) ⇒ Gnm::Expr

Parameters:

  • dx0 (Integer)
  • dy0 (Integer)
  • dx1 (Integer)
  • dy1 (Integer)

Returns:

  • (Gnm::Expr)

#mathfunc_initnil

Returns:

  • (nil)

#matrix_from_value(v, perr, ep) ⇒ Gnm::Matrix

Returns A new Gnm::Matrix, nil on error.

Parameters:

  • v (Gnm::Value)

    Gnm::Value

  • perr (Gnm::Value)

    Gnm::Value with error value

  • ep (Gnm::EvalPos)

    Evaluation location

Returns:

  • (Gnm::Matrix)

    A new Gnm::Matrix, nil on error.

#message_dialog_create(parent, flags, type, primary_message, secondary_message) ⇒ Gtk::Widget

A convenience function to build HIG compliant message dialogs.

parent : transient parent, or nil for none. flags type : type of dialog primary_message : message displayed in bold secondary_message : message displayed below

Parameters:

  • parent (Gtk::Window)
  • flags (Gtk::DialogFlags)
  • type (Gtk::MessageType)
  • primary_message (String)
  • secondary_message (String)

Returns:

  • (Gtk::Widget)

    a GtkDialog, without buttons.

#object_get_bool(o, name) ⇒ Boolean

Returns the value of o's boolean property name.

Parameters:

  • o (GObject)

    #GObject

  • name (String)

    property name

Returns:

  • (Boolean)

    the value of o's boolean property name.

#object_has_readable_prop(obj, property, typ, pres) ⇒ Boolean

of type typ.

Parameters:

  • obj (GObject)

    #GObject

  • property (String)

    property name

  • typ (GLib::Type)

    property's type or %G_TYPE_NONE. (Exact type, not is-a.)

  • pres (GObject)

    location to store property value.

Returns:

  • (Boolean)

    true if obj has a readable property named property

#option_groupGLib::OptionGroup

Returns a GOption::Group for the commandline arguments recognized by libspreadsheet. You should add this group to your GOption::Context with g_option_context_add_group(), if you are using g_option_context_parse() to parse your commandline arguments.

Returns a GOption::Group for the commandline arguments recognized by libspreadsheet

Returns:

  • (GLib::OptionGroup)

#owent(h, a) ⇒ Gnm::gnm_float

Parameters:

  • h (Gnm::gnm_float)
  • a (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#page_break_type_from_str(str) ⇒ Gnm::PageBreakType

Parameters:

  • str (String)

Returns:

#page_setup_get_paper(page_setup) ⇒ String

Parameters:

  • page_setup (Gtk::PageSetup)

Returns:

  • (String)

#page_setup_set_paper(page_setup, paper) ⇒ Boolean

Parameters:

  • page_setup (Gtk::PageSetup)
  • paper (String)

Returns:

  • (Boolean)

#pango_attr_list_equal(l1, l2) ⇒ Boolean

Parameters:

  • l1 (Pango::AttrList)
  • l2 (Pango::AttrList)

Returns:

  • (Boolean)

#pango_context_getPango::Context

Simple wrapper to handle windowless operation

Returns:

  • (Pango::Context)

#parse_criteria(crit_val, date_conv, anchor_end) ⇒ Gnm::Criteria

">=value" "<=value" "<>value" "<value" ">value" "=value" "pattern"

Parameters:

  • crit_val (Gnm::Value)

    Gnm::Value

  • date_conv (GOffice::DateConventions)

    GODate::Conventions

  • anchor_end (Boolean)

Returns:

  • (Gnm::Criteria)

    GnmCriteria which caller must free.

#parse_database_criteria(ep, database, criteria) ⇒ GLib::SList<Gnm::DBCriteria>

Parses the criteria cell range.

Parameters:

  • ep (Gnm::EvalPos)

    Gnm::EvalPos

  • database (Gnm::Value)

    Gnm::Value

  • criteria (Gnm::Value)

    Gnm::Value

Returns:

  • (GLib::SList<Gnm::DBCriteria>)

#parse_output(state, dao) ⇒ Gnm::data_analysis_output_t

fill dao with information from the standard output section of a dialog

Parameters:

  • state (Gnm::GenericToolState)
  • dao (Gnm::data_analysis_output_t)

Returns:

  • (Gnm::data_analysis_output_t)

#parse_text_value_or_expr(pos, text, val, texpr) ⇒ nil

Utility routine to parse a string and convert it into an expression or value.

If there is a parse failure for an expression an error GnmValue with the syntax error is returned in val.

Parameters:

  • pos (Gnm::ParsePos)

    If the string looks like an expression parse it at this location.

  • text (String)

    The text to be parsed.

  • val (Gnm::Value)

    Returns a Gnm::Value if the text was a value, otherwise nil.

  • texpr (Gnm::ExprTop)

    Returns a Gnm::ExprTop if the text was an expression, otherwise nil.

Returns:

  • (nil)

#parse_util_initnil

Returns:

  • (nil)

#parse_util_shutdownnil

Returns:

  • (nil)

#parsepos_as_string(pp) ⇒ String

Parameters:

  • pp (Gnm::ParsePos)

Returns:

  • (String)

#pattern_background_set(mstyle, cr, is_selected, ctxt) ⇒ Boolean

Set up a cairo context to paint the background of a cell.

Parameters:

  • mstyle (Gnm::Style)
  • cr (cairo::Context)
  • is_selected (Boolean)
  • ctxt (Gtk::StyleContext)

Returns:

  • (Boolean)

    true if there is a background to paint.

#pbeta(x, a, b, lower_tail, log_p) ⇒ Gnm::gnm_float

Returns cumulative density of the beta distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • a (Gnm::gnm_float)

    the first shape parameter of the distribution

  • b (Gnm::gnm_float)

    the second scale parameter of the distribution

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    cumulative density of the beta distribution.

#pbinom(x, n, psuc, lower_tail, log_p) ⇒ Gnm::gnm_float

Returns cumulative density of the binomial distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • n (Gnm::gnm_float)

    the number of trials

  • psuc (Gnm::gnm_float)

    the probability of success in each trial

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    cumulative density of the binomial distribution.

#pbinom2(x0, x1, n, p) ⇒ Gnm::gnm_float

Parameters:

  • x0 (Gnm::gnm_float)
  • x1 (Gnm::gnm_float)
  • n (Gnm::gnm_float)
  • p (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#pcauchy(x, location, scale, lower_tail, log_p) ⇒ Gnm::gnm_float

Parameters:

  • x (Gnm::gnm_float)
  • location (Gnm::gnm_float)
  • scale (Gnm::gnm_float)
  • lower_tail (Boolean)
  • log_p (Boolean)

Returns:

  • (Gnm::gnm_float)

#pchisq(x, df, lower_tail, log_p) ⇒ Gnm::gnm_float

Returns cumulative density of the 𝜒² distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • df (Gnm::gnm_float)

    the number of degrees of freedom of the distribution

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    cumulative density of the 𝜒² distribution.

#permut(n, k) ⇒ Gnm::gnm_float

Parameters:

  • n (Gnm::gnm_float)
  • k (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#pexp(x, scale, lower_tail, log_p) ⇒ Gnm::gnm_float

Returns cumulative density of the exponential distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • scale (Gnm::gnm_float)

    the scale parameter of the distribution

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    cumulative density of the exponential distribution.

#pf(x, n1, n2, lower_tail, log_p) ⇒ Gnm::gnm_float

Returns cumulative density of the F distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • n1 (Gnm::gnm_float)

    the first number of degrees of freedom of the distribution

  • n2 (Gnm::gnm_float)

    the first number of degrees of freedom of the distribution

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    cumulative density of the F distribution.

#pfuncinverter(p, shape, lower_tail, log_p, xlow, xhigh, x0, pfunc, dpfunc_dx) ⇒ Gnm::gnm_float

Parameters:

  • p (Gnm::gnm_float)
  • shape (Gnm::gnm_float)
  • lower_tail (Boolean)
  • log_p (Boolean)
  • xlow (Gnm::gnm_float)
  • xhigh (Gnm::gnm_float)
  • x0 (Gnm::gnm_float)
  • pfunc (Gnm::PFunc)
  • dpfunc_dx (Gnm::DPFunc)

Returns:

  • (Gnm::gnm_float)

#pgamma(x, shape, scale, lower_tail, log_p) ⇒ Gnm::gnm_float

Returns cumulative density of the gamma distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • shape (Gnm::gnm_float)

    the shape parameter of the distribution

  • scale (Gnm::gnm_float)

    the scale parameter of the distribution

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    cumulative density of the gamma distribution.

#pgeom(x, psuc, lower_tail, log_p) ⇒ Gnm::gnm_float

Returns cumulative density of the geometric distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • psuc (Gnm::gnm_float)

    the probability of success in each trial

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    cumulative density of the geometric distribution.

#phyper(x, r, b, n, lower_tail, log_p) ⇒ Gnm::gnm_float

Returns cumulative density of the hypergeometric distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • r (Gnm::gnm_float)

    the number of red balls

  • b (Gnm::gnm_float)

    the number of black balls

  • n (Gnm::gnm_float)

    the number of balls drawn

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    cumulative density of the hypergeometric distribution.

#plnorm(x, logmean, logsd, lower_tail, log_p) ⇒ Gnm::gnm_float

Returns cumulative density of the log-normal distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • logmean (Gnm::gnm_float)

    mean of the underlying normal distribution

  • logsd (Gnm::gnm_float)

    standard deviation of the underlying normal distribution

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    cumulative density of the log-normal distribution.

#plugins_init(c) ⇒ nil

Parameters:

  • c (GOffice::CmdContext)

Returns:

  • (nil)

#plugins_service_initnil

Returns:

  • (nil)

#pnbinom(x, n, psuc, lower_tail, log_p) ⇒ Gnm::gnm_float

Returns cumulative density of the negative binomial distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • n (Gnm::gnm_float)

    the number of trials

  • psuc (Gnm::gnm_float)

    the probability of success in each trial

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    cumulative density of the negative binomial distribution.

#pnorm(x, mu, sigma, lower_tail, log_p) ⇒ Gnm::gnm_float

Returns cumulative density of the normal distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • mu (Gnm::gnm_float)

    mean of the distribution

  • sigma (Gnm::gnm_float)

    standard deviation of the distribution

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    cumulative density of the normal distribution.

#pnorm2(x1, x2) ⇒ Gnm::gnm_float

Parameters:

  • x1 (Gnm::gnm_float)
  • x2 (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#pochhammer(x, n) ⇒ Gnm::gnm_float

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.

Parameters:

  • x (Gnm::gnm_float)

    a real number

  • n (Gnm::gnm_float)

    a real number, often an integer

Returns:

  • (Gnm::gnm_float)

    Pochhammer's symbol (x)_n.

#pop_C_locale(locale) ⇒ nil

Frees the result of gnm_push_C_locale and restores the original locale.

Parameters:

  • locale (Gnm::Locale)

    Gnm::Locale

Returns:

  • (nil)

Bring up a popup and if event is non-nil ensure that the popup is on the right screen.

Parameters:

  • menu (Gtk::Menu)

    Gtk::Menu

  • event (Gdk::Event)

    Gdk::Event

Returns:

  • (nil)

#position_tooltip(tip, px, py, horizontal) ⇒ nil

Parameters:

  • tip (Gtk::Widget)
  • px (Integer)
  • py (Integer)
  • horizontal (Boolean)

Returns:

  • (nil)

#pow1p(x, y) ⇒ Gnm::gnm_float

naive formula.

Parameters:

  • x (Gnm::gnm_float)

    a number

  • y (Gnm::gnm_float)

    a number

Returns:

  • (Gnm::gnm_float)

    The result of (1+x)^y with less rounding error than the

#pow1pm1(x, y) ⇒ Gnm::gnm_float

naive formula.

Parameters:

  • x (Gnm::gnm_float)

    a number

  • y (Gnm::gnm_float)

    a number

Returns:

  • (Gnm::gnm_float)

    The result of (1+x)^y-1 with less rounding error than the

#ppois(x, lambda, lower_tail, log_p) ⇒ Gnm::gnm_float

Returns cumulative density of the Poisson distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • lambda (Gnm::gnm_float)

    the mean of the distribution

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    cumulative density of the Poisson distribution.

#prayleigh(x, scale, lower_tail, log_p) ⇒ Gnm::gnm_float

Returns cumulative density of the Rayleigh distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • scale (Gnm::gnm_float)

    scale parameter

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    cumulative density of the Rayleigh distribution.

#pre_parse_init(argc, argv) ⇒ Array<String>

Initialization to be done before cmd line arguments are handled. Needs to be called first, before any other initialization.

Parameters:

  • argc (Integer)
  • argv (String)

Returns:

  • (Array<String>)

    the arguments in UTF-8 encoding.

#pre_parse_shutdownnil

Returns:

  • (nil)

#prepare_input_range(input_range, group_by) ⇒ nil

Parameters:

Returns:

  • (nil)

Parameters:

Returns:

  • (String)

Parameters:

  • pi (Gnm::PrintInformation)

Returns:

  • (Gnm::PrintInformation)

Parameters:

  • pi (Gnm::PrintInformation)

Returns:

  • (nil)

Parameters:

  • pi (Gnm::PrintInformation)

    Gnm::PrintInformation

  • top (Float)

    top margin.

  • bottom (Float)

    bottom margin.

  • left (Float)

    left margin.

  • right (Float)

    right margin.

  • edge_to_below_header (Float)

    margin.

  • edge_to_above_footer (Float)

    margin.

Returns:

  • (nil)

Returns the page setup.

Parameters:

  • pi (Gnm::PrintInformation)

    Gnm::PrintInformation

Returns:

  • (Gtk::PageSetup)

    the page setup.

Parameters:

  • pi (Gnm::PrintInformation)

Returns:

  • (String)

Returns the name of the selected paper type.

Parameters:

  • pi (Gnm::PrintInformation)

    Gnm::PrintInformation

Returns:

  • (String)

    the name of the selected paper type

Parameters:

  • pi (Gnm::PrintInformation)
  • unit (Gtk::Unit)

Returns:

  • (Float)

Parameters:

  • pi (Gnm::PrintInformation)

Returns:

  • (Gtk::PageOrientation)

Parameters:

  • pi (Gnm::PrintInformation)

Returns:

  • (Gtk::PaperSize)

Parameters:

  • pi (Gnm::PrintInformation)
  • unit (Gtk::Unit)

Returns:

  • (Float)

Parameters:

  • pi (Gnm::PrintInformation)

Returns:

Returns The uri used for print-to-file.

Parameters:

  • pi (Gnm::PrintInformation)

    GnmPrintInformation

Returns:

  • (String)

    The uri used for print-to-file.

Parameters:

  • pi (Gnm::PrintInformation)

Returns:

  • (Boolean)

NOTE: This reads from a globally stored configuration. If a configuration is stored along with a sheet then that will override these global defaults.

Parameters:

  • pi (Gnm::PrintInformation)

    Gnm::PrintInformation

Returns:

  • (nil)

Parameters:

  • pi (Gnm::PrintInformation)

Returns:

  • (nil)

Parameters:

  • pi (Gnm::PrintInformation)

    Gnm::PrintInformation

  • breaks (Gnm::PageBreaks)

    Gnm::PageBreaks

Returns:

  • (nil)

Parameters:

  • pi (Gnm::PrintInformation)
  • e_f (Float)

Returns:

  • (nil)

Parameters:

  • pi (Gnm::PrintInformation)
  • e_h (Float)

Returns:

  • (nil)

Parameters:

  • pi (Gnm::PrintInformation)
  • settings (Gtk::PrintSettings)

Returns:

  • (nil)

Parameters:

  • pi (Gnm::PrintInformation)
  • footer (Float)

Returns:

  • (nil)

Parameters:

  • pi (Gnm::PrintInformation)
  • header (Float)

Returns:

  • (nil)

Parameters:

  • pi (Gnm::PrintInformation)
  • left (Float)

Returns:

  • (nil)

Parameters:

  • pi (Gnm::PrintInformation)
  • right (Float)

Returns:

  • (nil)

Parameters:

  • pi (Gnm::PrintInformation)
  • header (Float)
  • footer (Float)
  • left (Float)
  • right (Float)

Returns:

  • (nil)

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.

  2. Why not copy the page_setup in here and make the arg const ?

Parameters:

  • pi (Gnm::PrintInformation)

    Gnm::PrintInformation

  • page_setup (Gtk::PageSetup)

    Gtk::PageSetup

Returns:

  • (nil)

Parameters:

  • pi (Gnm::PrintInformation)
  • paper (String)

Returns:

  • (Boolean)

Parameters:

  • pi (Gnm::PrintInformation)
  • orientation (Gtk::PageOrientation)

Returns:

  • (nil)

Parameters:

Returns:

  • (nil)

Parameters:

  • pi (Gnm::PrintInformation)
  • settings (Gtk::PrintSettings)
  • default_uri (String)

Returns:

  • (nil)

Parameters:

  • pi (Gnm::PrintInformation)
  • uri (String)

Returns:

  • (nil)

Returns:

  • (nil)

Parameters:

Returns:

  • (Boolean)

Parameters:

Returns:

  • (nil)

Parameters:

  • cr (cairo::Context)
  • sheet (Gnm::Sheet)
  • range (Gnm::Range)
  • base_x (Float)
  • base_y (Float)

Returns:

  • (nil)

Returns:

  • (nil)

Parameters:

Returns:

  • (nil)

#pt(x, n, lower_tail, log_p) ⇒ Gnm::gnm_float

Returns cumulative density of the Student t distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • n (Gnm::gnm_float)

    the number of degrees of freedom of the distribution

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    cumulative density of the Student t distribution.

#ptukey(x, nmeans, df, nranges, lower_tail, log_p) ⇒ Gnm::gnm_float

Parameters:

  • x (Gnm::gnm_float)
  • nmeans (Gnm::gnm_float)
  • df (Gnm::gnm_float)
  • nranges (Gnm::gnm_float)
  • lower_tail (Boolean)
  • log_p (Boolean)

Returns:

  • (Gnm::gnm_float)

#push_C_localeGnm::Locale

Returns the current locale, and sets the locale and the value-format engine's locale to 'C'. The caller must call gnm_pop_C_locale to free the result and restore the previous locale.

Returns:

  • (Gnm::Locale)

#pweibull(x, shape, scale, lower_tail, log_p) ⇒ Gnm::gnm_float

Returns cumulative density of the Weibull distribution.

Parameters:

  • x (Gnm::gnm_float)

    observation

  • shape (Gnm::gnm_float)

    the shape parameter of the distribution

  • scale (Gnm::gnm_float)

    the scale parameter of the distribution

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    cumulative density of the Weibull distribution.

#qbeta(p, a, b, lower_tail, log_p) ⇒ Gnm::gnm_float

beta distribution.

Parameters:

  • p (Gnm::gnm_float)

    probability

  • a (Gnm::gnm_float)

    the first shape parameter of the distribution

  • b (Gnm::gnm_float)

    the second scale parameter of the distribution

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, p is given as log probability

Returns:

  • (Gnm::gnm_float)

    the observation with cumulative probability p for the

#qbinom(p, n, psuc, lower_tail, log_p) ⇒ Gnm::gnm_float

binomial distribution.

Parameters:

  • p (Gnm::gnm_float)

    probability

  • n (Gnm::gnm_float)

    the number of trials

  • psuc (Gnm::gnm_float)

    the probability of success in each trial

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, p is given as log probability

Returns:

  • (Gnm::gnm_float)

    the observation with cumulative probability p for the

#qcauchy(p, location, scale, lower_tail, log_p) ⇒ Gnm::gnm_float

Cauchy distribution.

Parameters:

  • p (Gnm::gnm_float)

    probability

  • location (Gnm::gnm_float)

    center of distribution

  • scale (Gnm::gnm_float)

    scale parameter of the distribution

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, p is given as log probability

Returns:

  • (Gnm::gnm_float)

    the observation with cumulative probability p for the

#qchisq(p, df, lower_tail, log_p) ⇒ Gnm::gnm_float

𝜒² distribution.

Parameters:

  • p (Gnm::gnm_float)

    probability

  • df (Gnm::gnm_float)

    the number of degrees of freedom of the distribution

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, p is given as log probability

Returns:

  • (Gnm::gnm_float)

    the observation with cumulative probability p for the

#qexp(p, scale, lower_tail, log_p) ⇒ Gnm::gnm_float

exponential distribution.

Parameters:

  • p (Gnm::gnm_float)

    probability

  • scale (Gnm::gnm_float)

    the scale parameter of the distribution

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, p is given as log probability

Returns:

  • (Gnm::gnm_float)

    the observation with cumulative probability p for the

#qf(p, n1, n2, lower_tail, log_p) ⇒ Gnm::gnm_float

F distribution.

Parameters:

  • p (Gnm::gnm_float)

    probability

  • n1 (Gnm::gnm_float)

    the first number of degrees of freedom of the distribution

  • n2 (Gnm::gnm_float)

    the first number of degrees of freedom of the distribution

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, p is given as log probability

Returns:

  • (Gnm::gnm_float)

    the observation with cumulative probability p for the

#qfactf(x, mant, exp2) ⇒ Integer

Parameters:

  • x (Gnm::gnm_float)
  • mant (GOffice::Quad)
  • exp2 (Integer)

Returns:

  • (Integer)

#qgamma(p, shape, scale, lower_tail, log_p) ⇒ Gnm::gnm_float

gamma distribution.

Parameters:

  • p (Gnm::gnm_float)

    probability

  • shape (Gnm::gnm_float)

    the shape parameter of the distribution

  • scale (Gnm::gnm_float)

    the scale parameter of the distribution

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, p is given as log probability

Returns:

  • (Gnm::gnm_float)

    the observation with cumulative probability p for the

#qgeom(p, psuc, lower_tail, log_p) ⇒ Gnm::gnm_float

geometric distribution.

Parameters:

  • p (Gnm::gnm_float)

    probability

  • psuc (Gnm::gnm_float)

    the probability of success in each trial

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, p is given as log probability

Returns:

  • (Gnm::gnm_float)

    the observation with cumulative probability p for the

#qhyper(p, r, b, n, lower_tail, log_p) ⇒ Gnm::gnm_float

hypergeometric distribution.

Parameters:

  • p (Gnm::gnm_float)

    probability

  • r (Gnm::gnm_float)

    the number of red balls

  • b (Gnm::gnm_float)

    the number of black balls

  • n (Gnm::gnm_float)

    the number of balls drawn

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, p is given as log probability

Returns:

  • (Gnm::gnm_float)

    the observation with cumulative probability p for the

#qlnorm(p, logmean, logsd, lower_tail, log_p) ⇒ Gnm::gnm_float

log-normal distribution.

Parameters:

  • p (Gnm::gnm_float)

    probability

  • logmean (Gnm::gnm_float)

    mean of the underlying normal distribution

  • logsd (Gnm::gnm_float)

    standard deviation of the underlying normal distribution

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, p is given as log probability

Returns:

  • (Gnm::gnm_float)

    the observation with cumulative probability p for the

#qnbinom(p, n, psuc, lower_tail, log_p) ⇒ Gnm::gnm_float

negative binomial distribution.

Parameters:

  • p (Gnm::gnm_float)

    probability

  • n (Gnm::gnm_float)

    the number of trials

  • psuc (Gnm::gnm_float)

    the probability of success in each trial

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, p is given as log probability

Returns:

  • (Gnm::gnm_float)

    the observation with cumulative probability p for the

#qnorm(p, mu, sigma, lower_tail, log_p) ⇒ Gnm::gnm_float

normal distribution.

Parameters:

  • p (Gnm::gnm_float)

    probability

  • mu (Gnm::gnm_float)

    mean of the distribution

  • sigma (Gnm::gnm_float)

    standard deviation of the distribution

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, p is given as log probability

Returns:

  • (Gnm::gnm_float)

    the observation with cumulative probability p for the

#qpois(p, lambda, lower_tail, log_p) ⇒ Gnm::gnm_float

Poisson distribution.

Parameters:

  • p (Gnm::gnm_float)

    probability

  • lambda (Gnm::gnm_float)

    the mean of the distribution

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, p is given as log probability

Returns:

  • (Gnm::gnm_float)

    the observation with cumulative probability p for the

#qrayleigh(p, scale, lower_tail, log_p) ⇒ Gnm::gnm_float

Rayleigh distribution.

Parameters:

  • p (Gnm::gnm_float)

    probability

  • scale (Gnm::gnm_float)

    scale parameter

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, log of the result will be returned instead

Returns:

  • (Gnm::gnm_float)

    the observation with cumulative probability p for the

#qt(p, n, lower_tail, log_p) ⇒ Gnm::gnm_float

Student t distribution.

Parameters:

  • p (Gnm::gnm_float)

    probability

  • n (Gnm::gnm_float)

    the number of degrees of freedom of the distribution

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, p is given as log probability

Returns:

  • (Gnm::gnm_float)

    the observation with cumulative probability p for the

#qtukey(p, nmeans, df, nranges, lower_tail, log_p) ⇒ Gnm::gnm_float

Parameters:

  • p (Gnm::gnm_float)
  • nmeans (Gnm::gnm_float)
  • df (Gnm::gnm_float)
  • nranges (Gnm::gnm_float)
  • lower_tail (Boolean)
  • log_p (Boolean)

Returns:

  • (Gnm::gnm_float)

#qweibull(p, shape, scale, lower_tail, log_p) ⇒ Gnm::gnm_float

Weibull distribution.

Parameters:

  • p (Gnm::gnm_float)

    probability

  • shape (Gnm::gnm_float)

    the shape parameter of the distribution

  • scale (Gnm::gnm_float)

    the scale parameter of the distribution

  • lower_tail (Boolean)

    if true, the lower tail of the distribution is considered.

  • log_p (Boolean)

    if true, p is given as log probability

Returns:

  • (Gnm::gnm_float)

    the observation with cumulative probability p for the

#random_01Gnm::gnm_float

Returns:

  • (Gnm::gnm_float)

#random_bernoulli(p) ⇒ Gnm::gnm_float

Parameters:

  • p (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_beta(a, b) ⇒ Gnm::gnm_float

Parameters:

  • a (Gnm::gnm_float)
  • b (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_binomial(p, trials) ⇒ Gnm::gnm_float

Parameters:

  • p (Gnm::gnm_float)
  • trials (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_cauchy(a) ⇒ Gnm::gnm_float

Parameters:

  • a (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_chisq(nu) ⇒ Gnm::gnm_float

Parameters:

  • nu (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_exponential(b) ⇒ Gnm::gnm_float

Parameters:

  • b (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_exppow(a, b) ⇒ Gnm::gnm_float

Parameters:

  • a (Gnm::gnm_float)
  • b (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_exppow_pdf(x, a, b) ⇒ Gnm::gnm_float

Parameters:

  • x (Gnm::gnm_float)
  • a (Gnm::gnm_float)
  • b (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_fdist(nu1, nu2) ⇒ Gnm::gnm_float

Parameters:

  • nu1 (Gnm::gnm_float)
  • nu2 (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_gamma(a, b) ⇒ Gnm::gnm_float

Parameters:

  • a (Gnm::gnm_float)
  • b (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_gaussian_tail(a, sigma) ⇒ Gnm::gnm_float

Parameters:

  • a (Gnm::gnm_float)
  • sigma (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_geometric(p) ⇒ Gnm::gnm_float

Parameters:

  • p (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_gumbel1(a, b) ⇒ Gnm::gnm_float

Parameters:

  • a (Gnm::gnm_float)
  • b (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_gumbel2(a, b) ⇒ Gnm::gnm_float

Parameters:

  • a (Gnm::gnm_float)
  • b (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_hypergeometric(n1, n2, t) ⇒ Gnm::gnm_float

Parameters:

  • n1 (Gnm::gnm_float)
  • n2 (Gnm::gnm_float)
  • t (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_landauGnm::gnm_float

Returns:

  • (Gnm::gnm_float)

#random_laplace(a) ⇒ Gnm::gnm_float

Parameters:

  • a (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_laplace_pdf(x, a) ⇒ Gnm::gnm_float

Parameters:

  • x (Gnm::gnm_float)
  • a (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_levy(c, alpha) ⇒ Gnm::gnm_float

Parameters:

  • c (Gnm::gnm_float)
  • alpha (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_levy_skew(c, alpha, beta) ⇒ Gnm::gnm_float

Parameters:

  • c (Gnm::gnm_float)
  • alpha (Gnm::gnm_float)
  • beta (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_logarithmic(p) ⇒ Gnm::gnm_float

Parameters:

  • p (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_logistic(a) ⇒ Gnm::gnm_float

Parameters:

  • a (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_lognormal(zeta, sigma) ⇒ Gnm::gnm_float

Parameters:

  • zeta (Gnm::gnm_float)
  • sigma (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_negbinom(p, f) ⇒ Gnm::gnm_float

Parameters:

  • p (Gnm::gnm_float)
  • f (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_normalGnm::gnm_float

Returns a N(0,1) distributed random number.

Returns:

  • (Gnm::gnm_float)

    a N(0,1) distributed random number.

#random_pareto(a, b) ⇒ Gnm::gnm_float

Parameters:

  • a (Gnm::gnm_float)
  • b (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_poisson(lambda) ⇒ Gnm::gnm_float

Parameters:

  • lambda (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_rayleigh(sigma) ⇒ Gnm::gnm_float

Parameters:

  • sigma (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_rayleigh_tail(a, sigma) ⇒ Gnm::gnm_float

Parameters:

  • a (Gnm::gnm_float)
  • sigma (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_skew_normal(a) ⇒ Gnm::gnm_float

Parameters:

  • a (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_skew_tdist(nu, a) ⇒ Gnm::gnm_float

Parameters:

  • nu (Gnm::gnm_float)
  • a (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_tdist(nu) ⇒ Gnm::gnm_float

Parameters:

  • nu (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#random_uniform_int(n) ⇒ Integer

Returns a uniformly distributed random non-negative integer less than n.

Parameters:

  • n (Integer)

    one more than the maximum number in range.

Returns:

  • (Integer)

    a uniformly distributed random non-negative integer less than n.

#random_weibull(a, b) ⇒ Gnm::gnm_float

Parameters:

  • a (Gnm::gnm_float)
  • b (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#range_adtest(xs, n, p, statistics) ⇒ Integer

Parameters:

  • xs (Gnm::gnm_float)
  • n (Integer)
  • p (Gnm::gnm_float)
  • statistics (Gnm::gnm_float)

Returns:

  • (Integer)

#range_avedev(xs, n, res) ⇒ Integer

Parameters:

  • xs (Gnm::gnm_float)
  • n (Integer)
  • res (Gnm::gnm_float)

Returns:

  • (Integer)

#range_concatenate(data, res, user) ⇒ Integer

Returns non-zero on error.

Parameters:

  • data (Array<String>)
  • res (String)
  • user (GObject)

Returns:

  • (Integer)

    non-zero on error.

#range_correl_pop(xs, ys, n, res) ⇒ Integer

Parameters:

  • xs (Gnm::gnm_float)
  • ys (Gnm::gnm_float)
  • n (Integer)
  • res (Gnm::gnm_float)

Returns:

  • (Integer)

#range_count(xs, n, res) ⇒ Integer

Parameters:

  • xs (Gnm::gnm_float)
  • n (Integer)
  • res (Gnm::gnm_float)

Returns:

  • (Integer)

#range_covar_est(xs, ys, n, res) ⇒ Integer

Parameters:

  • xs (Gnm::gnm_float)
  • ys (Gnm::gnm_float)
  • n (Integer)
  • res (Gnm::gnm_float)

Returns:

  • (Integer)

#range_covar_pop(xs, ys, n, res) ⇒ Integer

Parameters:

  • xs (Gnm::gnm_float)
  • ys (Gnm::gnm_float)
  • n (Integer)
  • res (Gnm::gnm_float)

Returns:

  • (Integer)

#range_geometric_mean(xs, n, res) ⇒ Integer

Parameters:

  • xs (Gnm::gnm_float)
  • n (Integer)
  • res (Gnm::gnm_float)

Returns:

  • (Integer)

#range_harmonic_mean(xs, n, res) ⇒ Integer

Parameters:

  • xs (Gnm::gnm_float)
  • n (Integer)
  • res (Gnm::gnm_float)

Returns:

  • (Integer)

#range_hypot(xs, n, res) ⇒ Integer

Parameters:

  • xs (Gnm::gnm_float)
  • n (Integer)
  • res (Gnm::gnm_float)

Returns:

  • (Integer)

#range_kurtosis_m3_est(xs, n, res) ⇒ Integer

Parameters:

  • xs (Gnm::gnm_float)
  • n (Integer)
  • res (Gnm::gnm_float)

Returns:

  • (Integer)

#range_kurtosis_m3_pop(xs, n, res) ⇒ Integer

Parameters:

  • xs (Gnm::gnm_float)
  • n (Integer)
  • res (Gnm::gnm_float)

Returns:

  • (Integer)

#range_list_destroy(ranges) ⇒ nil

Destroys a list of ranges returned from parse_cell_range_list. Note: the element type here is GnmValue, not GnmRange. to destroy.

Parameters:

  • ranges (GLib::SList<Gnm::Value>)

    a list of value ranges

Returns:

  • (nil)

#range_mode(xs, n, res) ⇒ Integer

Parameters:

  • xs (Gnm::gnm_float)
  • n (Integer)
  • res (Gnm::gnm_float)

Returns:

  • (Integer)

#range_multinomial(xs, n, res) ⇒ Integer

Parameters:

  • xs (Gnm::gnm_float)
  • n (Integer)
  • res (Gnm::gnm_float)

Returns:

  • (Integer)

#range_product(xs, n, res) ⇒ Integer

Parameters:

  • xs (Gnm::gnm_float)
  • n (Integer)
  • res (Gnm::gnm_float)

Returns:

  • (Integer)

#range_rsq_pop(xs, ys, n, res) ⇒ Integer

Parameters:

  • xs (Gnm::gnm_float)
  • ys (Gnm::gnm_float)
  • n (Integer)
  • res (Gnm::gnm_float)

Returns:

  • (Integer)

#range_simplify(arr) ⇒ nil

Simplifies the array of ranges by merging small ranges into larger ones.

Parameters:

  • arr (Array<Gnm::Range>)

    array of ranges to simplify

Returns:

  • (nil)

#range_skew_est(xs, n, res) ⇒ Integer

Parameters:

  • xs (Gnm::gnm_float)
  • n (Integer)
  • res (Gnm::gnm_float)

Returns:

  • (Integer)

#range_skew_pop(xs, n, res) ⇒ Integer

Parameters:

  • xs (Gnm::gnm_float)
  • n (Integer)
  • res (Gnm::gnm_float)

Returns:

  • (Integer)

#range_stddev_est(xs, n, res) ⇒ Integer

Parameters:

  • xs (Gnm::gnm_float)
  • n (Integer)
  • res (Gnm::gnm_float)

Returns:

  • (Integer)

#range_stddev_pop(xs, n, res) ⇒ Integer

Parameters:

  • xs (Gnm::gnm_float)
  • n (Integer)
  • res (Gnm::gnm_float)

Returns:

  • (Integer)

#range_var_est(xs, n, res) ⇒ Integer

Parameters:

  • xs (Gnm::gnm_float)
  • n (Integer)
  • res (Gnm::gnm_float)

Returns:

  • (Integer)

#range_var_pop(xs, n, res) ⇒ Integer

Parameters:

  • xs (Gnm::gnm_float)
  • n (Integer)
  • res (Gnm::gnm_float)

Returns:

  • (Integer)

#rangeref_as_string(out, ref) ⇒ nil

Parameters:

  • out (Gnm::ConventionsOut)

    Gnm::ConventionsOut

  • ref (Gnm::RangeRef)

    Gnm::RangeRef

Returns:

  • (nil)

#rangeref_parse(res, start, pp, convs) ⇒ String

If the result != start then res is valid.

Parameters:

  • res (Gnm::RangeRef)

    Gnm::RangeRef

  • start (String)

    the start of the string to parse

  • pp (Gnm::ParsePos)

    the location to parse relative to

  • convs (Gnm::Conventions)

    Gnm::Conventions

Returns:

  • (String)

    a pointer to the first invalid character.

#reduce_pi(x, e, k) ⇒ Gnm::gnm_float

This function performs range reduction for trigonometric functions. number j and |xr| <= Pi/2^(e+1). The lower e+1 bits of j will be returned in k.

Parameters:

  • x (Gnm::gnm_float)

    number of reduce

  • e (Integer)

    scale between -1 and 8, inclusive.

  • k (Integer)

    location to return lower e+1 bits of reduction count

Returns:

  • (Gnm::gnm_float)

    a value, xr, such that x = xr + j * Pi/2^e for some integer

#regcomp_XL(preg, pattern, cflags, anchor_start, anchor_end) ⇒ Integer

Parameters:

  • preg (GOffice::Regexp)
  • pattern (String)
  • cflags (Integer)
  • anchor_start (Boolean)
  • anchor_end (Boolean)

Returns:

  • (Integer)

#rendered_value_initnil

Returns:

  • (nil)

#rendered_value_new(cell, context, allow_variable_width, zoom) ⇒ Gnm::RenderedValue

Formats the value of the cell according to its style.

Parameters:

  • cell (Gnm::Cell)

    The cell

  • context (Pango::Context)

    A Pango::Context for text measurement.

  • allow_variable_width (Boolean)

    Allow format to depend on column width.

  • zoom (Float)

    zoom factor.

Returns:

  • (Gnm::RenderedValue)

    a new GnmRenderedValue

#rendered_value_shutdownnil

Returns:

  • (nil)

#restore_window_geometry(dialog, key) ⇒ nil

Parameters:

  • dialog (Gtk::Window)
  • key (String)

Returns:

  • (nil)

#row_calc_spans(ri, row, sheet) ⇒ nil

Parameters:

  • ri (Gnm::ColRowInfo)
  • row (Integer)
  • sheet (Gnm::Sheet)

Returns:

  • (nil)

#row_destroy_span(ri) ⇒ nil

Parameters:

  • ri (Gnm::ColRowInfo)

Returns:

  • (nil)

#row_name(row) ⇒ String

Returns A string representation of row.

Parameters:

  • row (Integer)

    row number

Returns:

  • (String)

    A string representation of row

#row_parse(str, ss, res, relative) ⇒ String

Parameters:

  • str (String)
  • ss (Gnm::SheetSize)
  • res (Integer)
  • relative (Integer)

Returns:

  • (String)

#row_span_get(ri, col) ⇒ Gnm::CellSpanInfo

Parameters:

  • ri (Gnm::ColRowInfo)
  • col (Integer)

Returns:

  • (Gnm::CellSpanInfo)

#rows_height_update(sheet, range, shrink) ⇒ nil

Use this function having changed the font size to auto-resize the row heights to make the text fit nicely.

Parameters:

  • sheet (Gnm::Sheet)

    The sheet,

  • range (Gnm::Range)

    The range whose rows should be resized.

  • shrink (Boolean)

    If set to false, rows will never shrink!

Returns:

  • (nil)

#rows_name(start_row, end_row) ⇒ String

start_row to end_row.

Parameters:

  • start_row (Integer)

    row number

  • end_row (Integer)

    row number

Returns:

  • (String)

    A string representation of the rows from

#rvc_free(rvc) ⇒ nil

Parameters:

  • rvc (Gnm::RenderedValueCollection)

Returns:

  • (nil)

#rvc_new(context, size) ⇒ Gnm::RenderedValueCollection

Returns a new GnmRenderedValueCollection.

Parameters:

  • context (Pango::Context)

    The context

  • size (Integer)

Returns:

  • (Gnm::RenderedValueCollection)

    a new GnmRenderedValueCollection

#rvc_query(rvc, cell) ⇒ Gnm::RenderedValue

Returns the rendered value for cell.

Parameters:

  • rvc (Gnm::RenderedValueCollection)

    The rendered value collection

  • cell (Gnm::Cell)

    Gnm::Cell

Returns:

  • (Gnm::RenderedValue)

    the rendered value for cell.

#rvc_remove(rvc, cell) ⇒ nil

Parameters:

  • rvc (Gnm::RenderedValueCollection)
  • cell (Gnm::Cell)

Returns:

  • (nil)

#rvc_store(rvc, cell, rv) ⇒ nil

Parameters:

  • rvc (Gnm::RenderedValueCollection)
  • cell (Gnm::Cell)
  • rv (Gnm::RenderedValue)

Returns:

  • (nil)

#sc_ant(sc) ⇒ nil

Parameters:

Returns:

  • (nil)

#sc_cursor_bound(sc, r) ⇒ nil

Parameters:

Returns:

  • (nil)

#sc_freeze_object_view(sc, freeze) ⇒ nil

Parameters:

Returns:

  • (nil)

#sc_make_cell_visible(sc, col, row, couple_panes) ⇒ nil

Parameters:

Returns:

  • (nil)

#sc_mode_edit(sc) ⇒ nil

Parameters:

Returns:

  • (nil)

#sc_object_create_view(sc, so) ⇒ nil

Parameters:

Returns:

  • (nil)

#sc_recompute_visible_region(sc, full_recompute) ⇒ nil

Parameters:

Returns:

  • (nil)

#sc_redraw_all(sc, headers) ⇒ nil

Parameters:

Returns:

  • (nil)

#sc_redraw_headers(sc, col, row, r) ⇒ nil

Parameters:

Returns:

  • (nil)

#sc_redraw_range(sc, r) ⇒ nil

Parameters:

Returns:

  • (nil)

#sc_resize(sc, force_scroll) ⇒ nil

Parameters:

Returns:

  • (nil)

#sc_scale_changed(sc) ⇒ nil

Parameters:

Returns:

  • (nil)

#sc_scrollbar_config(sc) ⇒ nil

Parameters:

Returns:

  • (nil)

#sc_set_panes(sc) ⇒ nil

Parameters:

Returns:

  • (nil)

#sc_set_top_left(sc, col, row) ⇒ nil

Parameters:

Returns:

  • (nil)

#sc_sheet(sc) ⇒ Gnm::Sheet

Returns the sheet.

Parameters:

Returns:

#sc_show_im_tooltip(sc, im, pos) ⇒ nil

Parameters:

Returns:

  • (nil)

#sc_unant(sc) ⇒ nil

Parameters:

Returns:

  • (nil)

#sc_view(sc) ⇒ Gnm::SheetView

Returns the sheet view.

Parameters:

Returns:

#sc_wbc(sc) ⇒ Gnm::WorkbookControl

Returns the workbook control.

Parameters:

Returns:

#scg_adjust_preferences(scg) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_colrow_distance_get(scg, is_cols, from, to) ⇒ Integer

Parameters:

Returns:

  • (Integer)

#scg_colrow_select(scg, is_cols, index, modifiers) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#scg_colrow_size_set(scg, is_cols, index, new_size_pixels) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_comment_display(scg, cc, x, y) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_comment_select(scg, cc, x, y) ⇒ nil

Prepare cc for display.

Parameters:

Returns:

  • (nil)

#scg_comment_unselect(scg, cc) ⇒ nil

If cc is the current cell comment being edited/displayed shutdown the display mechanism.

Parameters:

Returns:

  • (nil)

#scg_context_menu(scg, event, is_col, is_row) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_cursor_extend(scg, n, jump_to_bound, horiz) ⇒ nil

Parameters:

  • scg (Gnm::SheetControlGUI)

    The scg

  • n (Integer)

    Units to extend the selection

  • jump_to_bound (Boolean)

    Move to transitions between cells and blanks, or move in single steps.

  • horiz (Boolean)

    extend vertically or horizontally.

Returns:

  • (nil)

#scg_cursor_move(scg, dir, jump_to_bound, horiz) ⇒ nil

Moves the cursor count rows

Parameters:

  • scg (Gnm::SheetControlGUI)

    The scg

  • dir (Integer)

    Number of units to move the cursor

  • jump_to_bound (Boolean)

    skip from the start to the end of ranges of filled or unfilled cells.

  • horiz (Boolean)

    is the movement horizontal or vertical

Returns:

  • (nil)

#scg_cursor_visible(scg, is_visible) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_delete_sheet_if_possible(scg) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_drag_data_get(scg, selection_data) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_drag_data_received(scg, source_widget, x, y, selection_data) ⇒ nil

Parameters:

  • scg (Gnm::SheetControlGUI)
  • source_widget (Gtk::Widget)
  • x (Float)
  • y (Float)
  • selection_data (Gtk::SelectionData)

Returns:

  • (nil)

#scg_edit_start(scg) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_edit_stop(scg) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_make_cell_visible(scg, col, row, force_scroll, couple_panes) ⇒ nil

Ensure that cell (col, row) is visible. Sheet is scrolled if cell is outside viewport.

Parameters:

  • scg (Gnm::SheetControlGUI)

    The gui control

  • col (Integer)
  • row (Integer)
  • force_scroll (Boolean)

    Completely recalibrate the offsets to the new position

  • couple_panes (Boolean)

    Scroll scroll dynamic panes back to bounds if target is in frozen segment.

Returns:

  • (nil)

#scg_mode_edit(scg) ⇒ nil

Put sheet into the standard state 'edit mode'. This shuts down any object editing and frees any objects that are created but not realized.

Parameters:

Returns:

  • (nil)

#scg_object_anchor_to_coords(scg, anchor, coords) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_object_coords_to_anchor(scg, coords, in_out) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_object_select(scg, so) ⇒ nil

Adds so to the set of selected objects and prepares it for user editing. Adds a reference to ref if it is selected.

Parameters:

Returns:

  • (nil)

#scg_object_select_next(scg, reverse) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_object_unselect(scg, so) ⇒ nil

unselect the supplied object, and drop out of edit mode if this is the last one. If so == NULL unselect all objects.

Parameters:

Returns:

  • (nil)

#scg_objects_drag(scg, gcanvas, primary, dx, dy, drag_type, symmetric, snap_to_grid, is_mouse_move) ⇒ nil

Move the control points and drag views of the currently selected objects to a new position. This movement is only made in scg not in the actual objects.

Parameters:

  • scg (Gnm::SheetControlGUI)

    Sheet::ControlGUI

  • gcanvas (Gnm::Pane)
  • primary (Gnm::SheetObject)

    Sheet::Object (optionally NULL)

  • dx (Float)
  • dy (Float)
  • drag_type (Integer)
  • symmetric (Boolean)
  • snap_to_grid (Boolean)
  • is_mouse_move (Boolean)

Returns:

  • (nil)

#scg_objects_drag_commit(scg, drag_type, created_objects, pundo, predo, undo_title) ⇒ nil

Parameters:

  • scg (Gnm::SheetControlGUI)
  • drag_type (Integer)
  • created_objects (Boolean)
  • pundo (GOffice::Undo)
  • predo (GOffice::Undo)
  • undo_title (String)

Returns:

  • (nil)

#scg_objects_nudge(scg, gcanvas, drag_type, dx, dy, symmetric, snap_to_grid) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_pane(scg, pane) ⇒ Gnm::Pane

Returns the pane.

Parameters:

Returns:

#scg_paste_image(scg, where, data, len) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_queue_movement(scg, handler, n, jump, horiz) ⇒ nil

Do motion compression when possible to avoid redrawing an area that will disappear when we scroll again.

Parameters:

  • scg (Gnm::SheetControlGUI)
  • handler (Gnm::SCGUIMoveFunc)

    The movement handler

  • n (Integer)

    how far

  • jump (Boolean)

    TRUE jump to bound

  • horiz (Boolean)

    TRUE move by cols

Returns:

  • (nil)

#scg_rangesel_bound(scg, base_col, base_row, move_col, move_row) ⇒ nil

Parameters:

  • scg (Gnm::SheetControlGUI)
  • base_col (Integer)
  • base_row (Integer)
  • move_col (Integer)
  • move_row (Integer)

Returns:

  • (nil)

#scg_rangesel_extend(scg, n, jump_to_bound, horiz) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_rangesel_extend_to(scg, col, row) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_rangesel_move(scg, dir, jump_to_bound, horiz) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_rangesel_start(scg, base_col, base_row, move_col, move_row) ⇒ nil

Parameters:

  • scg (Gnm::SheetControlGUI)
  • base_col (Integer)
  • base_row (Integer)
  • move_col (Integer)
  • move_row (Integer)

Returns:

  • (nil)

#scg_rangesel_stop(scg, clear_str) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_reload_item_edits(scg) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_select_all(scg) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_set_display_cursor(scg) ⇒ nil

Set the displayed cursor type.

Parameters:

Returns:

  • (nil)

#scg_set_left_col(scg, new_first_col) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_set_top_row(scg, new_first_row) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_sheet(scg) ⇒ Gnm::Sheet

Returns the sheet.

Parameters:

Returns:

#scg_size_guide_motion(scg, vert, guide_pos) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_size_guide_start(scg, vert, colrow, is_colrow_resize) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_size_guide_stop(scg) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_special_cursor_bound_set(scg, r) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#scg_special_cursor_start(scg, style, button) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_special_cursor_stop(scg) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_take_focus(scg) ⇒ nil

Parameters:

Returns:

  • (nil)

#scg_view(scg) ⇒ Gnm::SheetView

Returns the sheet view.

Parameters:

Returns:

#scg_wbc(scg) ⇒ Gnm::WorkbookControl

Returns the workbook control.

Parameters:

Returns:

#scg_wbcg(scg) ⇒ Gnm::WBCGtk

Returns the #WBCGtk.

Parameters:

Returns:

#search_collect_cells(sr) ⇒ Array<Gnm::EvalPos>

Collect a list of all cells subject to search.

Parameters:

Returns:

  • (Array<Gnm::EvalPos>)

    the newly created array.

#search_collect_cells_free(cells) ⇒ nil

Parameters:

  • cells (Array<Gnm::EvalPos>)

Returns:

  • (nil)

#search_filter_matching(sr, cells) ⇒ Array<Gnm::SearchFilterResult>

Returns matches.

Parameters:

  • sr (Gnm::SearchReplace)

    The search spec.

  • cells (Array<Gnm::EvalPos>)

    Cell positions to filter, presumably a result of gnm_search_collect_cells.

Returns:

  • (Array<Gnm::SearchFilterResult>)

    matches

#search_filter_matching_free(matches) ⇒ nil

Parameters:

  • matches (Array<Gnm::SearchFilterResult>)

    matches

Returns:

  • (nil)

#search_normalize(txt) ⇒ String

Parameters:

  • txt (String)

Returns:

  • (String)

#selection_first_range(sv, cc, cmd_name) ⇒ Gnm::Range

displays an error if there is more than one range.

Parameters:

  • sv (Gnm::SheetView)

    The Sheet::View whose selection we are testing.

  • cc (GOffice::CmdContext)

    The command context to report errors to

  • cmd_name (String)

    A string naming the operation requiring a single range.

Returns:

  • (Gnm::Range)

    the first range, if a control is supplied it

#selection_get_ranges(sv, allow_intersection) ⇒ GLib::SList<Gnm::Range>

Caller is responsible for free the list and the content.

Parameters:

  • sv (Gnm::SheetView)

    Sheet::View

  • allow_intersection (Boolean)

    Divide the selection into nonoverlapping subranges.

Returns:

  • (GLib::SList<Gnm::Range>)

#selection_to_string(sv, include_sheet_name_prefix) ⇒ String

Parameters:

Returns:

  • (String)

#session_init(argv0) ⇒ nil

Parameters:

  • argv0 (String)

Returns:

  • (nil)

#set_cell_text_col(dao, col, row, text) ⇒ nil

Parameters:

  • dao (Gnm::data_analysis_output_t)
  • col (Integer)
  • row (Integer)
  • text (String)

Returns:

  • (nil)

#set_cell_text_row(dao, col, row, text) ⇒ nil

Parameters:

  • dao (Gnm::data_analysis_output_t)
  • col (Integer)
  • row (Integer)
  • text (String)

Returns:

  • (nil)

#set_uifilename(name, actions, nb) ⇒ nil

Parameters:

  • name (String)
  • actions (Gnm::ActionEntry)
  • nb (Integer)

Returns:

  • (nil)

#sheet_range_set_text(pos, r, str) ⇒ nil

Does NOT check for array division. Does NOT redraw Does NOT generate spans.

Parameters:

  • pos (Gnm::ParsePos)

    The position from which to parse an expression.

  • r (Gnm::Range)

    The range to fill

  • str (String)

    The text to be parsed and assigned.

Returns:

  • (nil)

#shortest_rep_in_filesBoolean

Returns:

  • (Boolean)

#shutdownnil

Returns:

  • (nil)

#simulation_tool(wbc, dao, sim) ⇒ String

Parameters:

Returns:

  • (String)

#simulation_tool_destroy(sim) ⇒ nil

Parameters:

  • sim (Gnm::simulation_t)

Returns:

  • (nil)

#slist_sort_merge(list_1, list_2) ⇒ GLib::SList<Integer>

gnm_slist_sort_merge merges two lists of unsigned integers. unsigned integers with no duplicates.

Parameters:

  • list_1 (GLib::SList<Integer>)

    a sorted list of

  • list_2 (GLib::SList<Integer>)

    another one

Returns:

  • (GLib::SList<Integer>)

    the mergedlist.

#sort_contents(data, cc) ⇒ Integer

Parameters:

  • data (Gnm::SortData)
  • cc (GOffice::CmdContext)

Returns:

  • (Integer)

#sort_permute_invert(perm, length) ⇒ Integer

Parameters:

  • perm (Integer)
  • length (Integer)

Returns:

  • (Integer)

#sort_position(data, perm, cc) ⇒ nil

Parameters:

  • data (Gnm::SortData)
  • perm (Integer)
  • cc (GOffice::CmdContext)

Returns:

  • (nil)

#stf_dialog(wbcg, opt_encoding, fixed_encoding, opt_locale, fixed_locale, source, data, data_len) ⇒ Gnm::DialogStfResult_t

This will start the import. (NOTE: you have to free the DialogStfResult_t that this function returns yourself)

Parameters:

  • wbcg (Gnm::WBCGtk)
  • opt_encoding (String)
  • fixed_encoding (Boolean)
  • opt_locale (String)
  • fixed_locale (Boolean)
  • source (String)

    name of the file we are importing (or data) in UTF-8

  • data (String)

    the data itself

  • data_len (Integer)

Returns:

  • (Gnm::DialogStfResult_t)

    A DialogStfResult_t struct on success, NULL otherwise.

#stf_dialog_csv_page_cleanup(pagedata) ⇒ nil

Will cleanup csv page run-time data

Parameters:

  • pagedata (Gnm::StfDialogData)

    mother struct

Returns:

  • (nil)

#stf_dialog_csv_page_init(gui, pagedata) ⇒ nil

Parameters:

  • gui (Gtk::Builder)
  • pagedata (Gnm::StfDialogData)

Returns:

  • (nil)

#stf_dialog_csv_page_prepare(pagedata) ⇒ nil

Will prepare the csv page

Parameters:

  • pagedata (Gnm::StfDialogData)

    mother struct

Returns:

  • (nil)

#stf_dialog_fixed_page_cleanup(pagedata) ⇒ nil

Will cleanup fixed page run-time data

Parameters:

  • pagedata (Gnm::StfDialogData)

    mother struct

Returns:

  • (nil)

#stf_dialog_fixed_page_init(gui, pagedata) ⇒ nil

Parameters:

  • gui (Gtk::Builder)
  • pagedata (Gnm::StfDialogData)

Returns:

  • (nil)

#stf_dialog_fixed_page_prepare(pagedata) ⇒ nil

Will prepare the fixed page

Parameters:

  • pagedata (Gnm::StfDialogData)

    mother struct

Returns:

  • (nil)

#stf_dialog_format_page_cleanup(pagedata) ⇒ nil

Parameters:

  • pagedata (Gnm::StfDialogData)

Returns:

  • (nil)

#stf_dialog_format_page_init(gui, pagedata) ⇒ nil

Parameters:

  • gui (Gtk::Builder)
  • pagedata (Gnm::StfDialogData)

Returns:

  • (nil)

#stf_dialog_format_page_prepare(pagedata) ⇒ nil

This will prepare the widgets on the format page before the page gets displayed

Parameters:

  • pagedata (Gnm::StfDialogData)

    mother struct

Returns:

  • (nil)

#stf_dialog_main_page_cleanup(pagedata) ⇒ nil

Parameters:

  • pagedata (Gnm::StfDialogData)

Returns:

  • (nil)

#stf_dialog_main_page_init(gui, pagedata) ⇒ nil

Parameters:

  • gui (Gtk::Builder)
  • pagedata (Gnm::StfDialogData)

Returns:

  • (nil)

#stf_dialog_main_page_prepare(pagedata) ⇒ nil

This will prepare the widgets on the format page before the page gets displayed

Parameters:

  • pagedata (Gnm::StfDialogData)

    mother struct

Returns:

  • (nil)

#stf_dialog_result_attach_formats_to_cr(dialogresult, cr) ⇒ nil

Attach the formats of the dialogresult to the given cell region.

Parameters:

  • dialogresult (Gnm::DialogStfResult_t)

    a dialogresult struct

  • cr (Gnm::CellRegion)

    a cell region

Returns:

  • (nil)

#stf_dialog_result_free(dialogresult) ⇒ nil

This routine will properly free the members of dialogresult and dialogresult itself

Parameters:

  • dialogresult (Gnm::DialogStfResult_t)

    a dialogresult struct

Returns:

  • (nil)

#stf_export(export_options) ⇒ Boolean

Exports the sheets given in stfe

Parameters:

Returns:

  • (Boolean)

    TRUE on success, FALSE otherwise

#stf_file_saver_create(id) ⇒ GOffice::FileSaver

Returns the newly allocated GOFile::Saver.

Parameters:

  • id (String)

Returns:

  • (GOffice::FileSaver)

    the newly allocated GOFile::Saver.

#stf_get_stfe(obj) ⇒ Gnm::StfExport

If none is found, a new one is created and attached to obj.

Parameters:

  • obj (GObject::Object)

    #GObject with a Gnm::StfExport attached as data.

Returns:

#stf_initnil

Returns:

  • (nil)

#stf_parse_find_line(parseoptions, data, line) ⇒ String

Parameters:

  • parseoptions (Gnm::StfParseOptions_t)
  • data (String)
  • line (Integer)

Returns:

  • (String)

#stf_parse_general(parseoptions, lines_chunk, data, data_end) ⇒ Array<GObject>

GPtrArray of strings.

The caller must free this entire structure, for example by calling stf_parse_general_free.

Parameters:

  • parseoptions (Gnm::StfParseOptions_t)
  • lines_chunk (GLib::StringChunk)
  • data (String)
  • data_end (String)

Returns:

  • (Array<GObject>)

    a GPtrArray of lines, where each line is itself a

#stf_parse_general_free(lines) ⇒ nil

Parameters:

  • lines (Array<GObject>)

Returns:

  • (nil)

#stf_parse_lines(parseoptions, lines_chunk, data, maxlines, with_lineno) ⇒ Array<GObject>

GPtrArray of strings.

The caller must free this entire structure, for example by calling stf_parse_general_free.

Parameters:

  • parseoptions (Gnm::StfParseOptions_t)

    Stf::ParseOptions_t

  • lines_chunk (GLib::StringChunk)
  • data (String)
  • maxlines (Integer)
  • with_lineno (Boolean)

Returns:

  • (Array<GObject>)

    a GPtrArray of lines, where each line is itself a

#stf_parse_options_guess(data) ⇒ Gnm::StfParseOptions_t

Returns the guessed options.

Parameters:

  • data (String)

    the input data.

Returns:

  • (Gnm::StfParseOptions_t)

    the guessed options.

#stf_parse_options_guess_csv(data) ⇒ Gnm::StfParseOptions_t

Returns the guessed options.

Parameters:

  • data (String)

    the CSV input data.

Returns:

  • (Gnm::StfParseOptions_t)

    the guessed options.

#stf_parse_region(parseoptions, data, data_end, wb) ⇒ Gnm::CellRegion

Parameters:

  • parseoptions (Gnm::StfParseOptions_t)
  • data (String)
  • data_end (String)
  • wb (Gnm::Workbook)

Returns:

  • (Gnm::CellRegion)

#stf_parse_sheet(parseoptions, data, data_end, sheet, start_col, start_row) ⇒ Boolean

Parameters:

  • parseoptions (Gnm::StfParseOptions_t)
  • data (String)
  • data_end (String)
  • sheet (Gnm::Sheet)
  • start_col (Integer)
  • start_row (Integer)

Returns:

  • (Boolean)

#stf_preview_colformats_add(renderdata, format) ⇒ nil

This will add an entry to the renderdata->colformats array. The widths of the columns will be set to at least have the width of the format.

Parameters:

  • renderdata (Gnm::RenderData_t)

    a struct containing rendering information

  • format (GOffice::Format)

    the format of the column

Returns:

  • (nil)

#stf_preview_colformats_clear(renderdata) ⇒ nil

This will clear the renderdata->colformats array which contains the format of each column.

Parameters:

  • renderdata (Gnm::RenderData_t)

    a struct containing rendering information

Returns:

  • (nil)

#stf_preview_find_column(renderdata, x, pcol, dx) ⇒ nil

Parameters:

  • renderdata (Gnm::RenderData_t)
  • x (Integer)
  • pcol (Integer)
  • dx (Integer)

Returns:

  • (nil)

#stf_preview_free(data) ⇒ nil

This will free the renderdata

Parameters:

  • data (Gnm::RenderData_t)

    a renderdata struct

Returns:

  • (nil)

#stf_preview_get_cell_renderer(renderdata, col) ⇒ Gtk::CellRenderer

Parameters:

  • renderdata (Gnm::RenderData_t)
  • col (Integer)

Returns:

  • (Gtk::CellRenderer)

#stf_preview_get_column(renderdata, col) ⇒ Gtk::TreeViewColumn

Parameters:

  • renderdata (Gnm::RenderData_t)
  • col (Integer)

Returns:

  • (Gtk::TreeViewColumn)

#stf_preview_new(data_container, date_conv) ⇒ Gnm::RenderData_t

Returns a new renderdata struct.

Parameters:

  • data_container (Gtk::Widget)

    a container in which to put a treeview.

  • date_conv (GOffice::DateConventions)

Returns:

  • (Gnm::RenderData_t)

    a new renderdata struct

#stf_preview_set_lines(data, lines_chunk, lines) ⇒ nil

Parameters:

  • data (Gnm::RenderData_t)
  • lines_chunk (GLib::StringChunk)
  • lines (Array<GObject>)

Returns:

  • (nil)

#stf_shutdownnil

Returns:

  • (nil)

#stf_text_to_columns(wbc, cc) ⇒ nil

Main routine, handles importing a file including all dialog mumbo-jumbo

Parameters:

Returns:

  • (nil)

#stirlerr(n) ⇒ Gnm::gnm_float

Parameters:

  • n (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#string_add_number(buf, d) ⇒ nil

Parameters:

  • buf (GLib::String)
  • d (Gnm::gnm_float)

Returns:

  • (nil)

#string_range_function(argc, argv, ei, func, user, flags, func_error) ⇒ Gnm::Value

This implements a Gnumeric sheet function that operates on a list of strings. This function collects the arguments and uses func to do the actual computation. of values from argv.

Parameters:

  • argc (Integer)

    number of arguments

  • argv (Array<Gnm::ExprConstPtr>)

    function arguments

  • ei (Gnm::FuncEvalInfo)

    Gnm::FuncEvalInfo describing evaluation context

  • func (Gnm::string_range_function_t)

    implementation function

  • user (GObject)
  • flags (Gnm::CollectFlags)

    Collect::Flags flags describing the collection and interpretation

  • func_error (Gnm::StdError)

    A Gnm::StdError to use to func indicates an error.

Returns:

  • (Gnm::Value)

    Function result or error value.

#strip_missing(data, n, missing) ⇒ nil

This removes the data elements from data whose indices are given by missing. n is the number of elements and it updated upon return. order.

Parameters:

  • data (Array<Gnm::gnm_float>)

    Array

  • n (Integer)

    Number of elements in data.

  • missing (GLib::SList<Integer>)

    indices of elements to remove in increasing

Returns:

  • (nil)

#style_border_fetch(line_type, color, orientation) ⇒ Gnm::Border

Returns A Gnm::Border.

Parameters:

Returns:

  • (Gnm::Border)

    A Gnm::Border

#style_border_get_orientation(type) ⇒ Gnm::StyleBorderOrientation

#style_border_get_width(line_type) ⇒ Integer

Parameters:

Returns:

  • (Integer)

#style_border_noneGnm::Border

Returns A Gnm::Border with no borders.

Returns:

  • (Gnm::Border)

    A Gnm::Border with no borders.

#style_border_none_set_color(color) ⇒ nil

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 by style_color_grid (). - otherwise, the auto pattern color is used for the grid.

Parameters:

  • color (Gnm::Color)

    Gnm::Color

Returns:

  • (nil)

#style_border_ref(border) ⇒ Gnm::Border

Returns a reference to border.

Parameters:

  • border (Gnm::Border)

    Gnm::Border

Returns:

  • (Gnm::Border)

    a reference to border

#style_border_set_dash(i, context) ⇒ nil

Parameters:

Returns:

  • (nil)

#style_border_unref(border) ⇒ nil

Parameters:

  • border (Gnm::Border)

    Gnm::Border

Returns:

  • (nil)

#style_border_visible_in_blank(border) ⇒ Boolean

Parameters:

  • border (Gnm::Border)

Returns:

  • (Boolean)

#style_borders_row_draw(prev_vert, sr, cr, x, y1, y2, colwidths, draw_vertical, dir) ⇒ nil

TODO : This is not the final resting place for this. It will move into the gui layer eventually.

Parameters:

  • prev_vert (Gnm::Border)
  • sr (Gnm::StyleRow)
  • cr (cairo::Context)
  • x (Integer)
  • y1 (Integer)
  • y2 (Integer)
  • colwidths (Integer)
  • draw_vertical (Boolean)
  • dir (Integer)

Returns:

  • (nil)

#style_borders_row_print_gtk(prev_vert, sr, context, x, y1, y2, sheet, draw_vertical, dir) ⇒ nil

Parameters:

  • prev_vert (Gnm::Border)
  • sr (Gnm::StyleRow)
  • context (cairo::Context)
  • x (Float)
  • y1 (Float)
  • y2 (Float)
  • sheet (Gnm::Sheet)
  • draw_vertical (Boolean)
  • dir (Integer)

Returns:

  • (nil)

#style_color_auto_backGnm::Color

Always white, as far as we know.

Returns:

  • (Gnm::Color)

#style_color_auto_fontGnm::Color

Always black, as far as we know.

Returns:

  • (Gnm::Color)

#style_color_auto_patternGnm::Color

Normally black, but follows grid color if so told.

Returns:

  • (Gnm::Color)

#style_color_blackGnm::Color

Returns:

  • (Gnm::Color)

#style_color_equal(a, b) ⇒ Integer

Parameters:

  • a (Gnm::Color)
  • b (Gnm::Color)

Returns:

  • (Integer)

#style_color_grid(context) ⇒ Gnm::Color

Parameters:

  • context (Gtk::StyleContext)

Returns:

  • (Gnm::Color)

#style_color_ref(sc) ⇒ Gnm::Color

Parameters:

  • sc (Gnm::Color)

Returns:

  • (Gnm::Color)

#style_color_unref(sc) ⇒ nil

Parameters:

  • sc (Gnm::Color)

Returns:

  • (nil)

#style_color_whiteGnm::Color

Returns:

  • (Gnm::Color)

#style_context_get_color(context, state, color) ⇒ nil

Parameters:

  • context (Gtk::StyleContext)
  • state (Gtk::StateFlags)
  • color (Gdk::RGBA)

Returns:

  • (nil)

#style_hash(style) ⇒ Integer

Parameters:

  • style (GObject)

Returns:

  • (Integer)

#style_hash_XL(style) ⇒ Integer

Parameters:

  • style (GObject)

Returns:

  • (Integer)

#style_initnil

Returns:

  • (nil)

#style_list_free(l) ⇒ nil

Free up the resources in the style list. This includes unreferencing the styles.

Parameters:

  • l (Gnm::StyleList)

    the list to free

Returns:

  • (nil)

#style_list_get_style(l, col, row) ⇒ Gnm::Style

Attempts to find the style associated with the pos offset within the 0,0 based style list. The resulting style does not have its reference count bumped.

Parameters:

  • l (Gnm::StyleList)

    A style list.

  • col (Integer)
  • row (Integer)

Returns:

  • (Gnm::Style)

#style_row_init(prev_vert, sr, next_sr, start_col, end_col, mem, hide_grid) ⇒ nil

A small utility routine to initialize the grid drawing GnmStyleRow data structure.

Parameters:

  • prev_vert (Gnm::Border)
  • sr (Gnm::StyleRow)
  • next_sr (Gnm::StyleRow)
  • start_col (Integer)
  • end_col (Integer)
  • mem (GObject)
  • hide_grid (Boolean)

Returns:

  • (nil)

#style_shutdownnil

Returns:

  • (nil)

#sv_is_colrow_selected(sv, colrow, is_col) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#sv_is_full_colrow_selected(sv, is_cols, index) ⇒ Boolean

are fully selected and the selection contains the specified col.

Parameters:

  • sv (Gnm::SheetView)
  • is_cols (Boolean)

    true for columns, false for rows.

  • index (Integer)

    index of column or row, -1 for any.

Returns:

  • (Boolean)

    true if all of the selected cols/rows in the selection

#sv_is_full_range_selected(sv, r) ⇒ Boolean

Returns true if all of r is contained by the selection in sv.

Parameters:

Returns:

  • (Boolean)

    true if all of r is contained by the selection in sv.

#sv_is_pos_selected(sv, col, row) ⇒ Boolean

Returns true if the supplied position is selected in view sv.

Parameters:

Returns:

  • (Boolean)

    true if the supplied position is selected in view sv.

#sv_is_range_selected(sv, r) ⇒ Boolean

Returns true If r overlaps with any part of the selection in sv.

Parameters:

Returns:

  • (Boolean)

    true If r overlaps with any part of the selection in sv.

#sv_is_singleton_selected(sv) ⇒ Gnm::CellPos

See if the 1st selected region is a singleton. a singleton

Parameters:

Returns:

  • (Gnm::CellPos)

    A Gnm::CellPos if the selection is

#sv_select_cur_array(sv) ⇒ nil

If the editpos is part of an array clear the selection and select the array.

Parameters:

Returns:

  • (nil)

#sv_select_cur_col(sv) ⇒ nil

Selects an entire column

Parameters:

Returns:

  • (nil)

#sv_select_cur_depends(sv) ⇒ nil

Select all cells that depend on the expression in the current cell.

Parameters:

Returns:

  • (nil)

#sv_select_cur_inputs(sv) ⇒ nil

Select all cells that are direct potential inputs to the current cell.

Parameters:

Returns:

  • (nil)

#sv_select_cur_row(sv) ⇒ nil

Selects an entire row

Parameters:

Returns:

  • (nil)

#sv_selection_add_full(sv, edit_col, edit_row, base_col, base_row, move_col, move_row, mode) ⇒ nil

Prepends a range to the selection list and sets the edit position.

Parameters:

  • sv (Gnm::SheetView)

    Sheet::View whose selection is append to.

  • edit_col (Integer)
  • edit_row (Integer)

    cell to mark as the new edit cursor.

  • base_col (Integer)
  • base_row (Integer)

    stationary corner of the newly selected range.

  • move_col (Integer)
  • move_row (Integer)

    moving corner of the newly selected range.

  • mode (Gnm::SelectionMode)

Returns:

  • (nil)

#sv_selection_add_pos(sv, col, row, mode) ⇒ nil

Parameters:

Returns:

  • (nil)

#sv_selection_add_range(sv, range) ⇒ nil

Parameters:

Returns:

  • (nil)

#sv_selection_apply(sv, func, allow_intersection, user_data) ⇒ nil

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.

Parameters:

  • sv (Gnm::SheetView)

    Sheet::View

  • func (Gnm::SelectionApplyFunc)

    The function to apply.

  • allow_intersection (Boolean)

    Call the routine for the non-intersecting subregions.

  • user_data (GObject)

    A parameter to pass to each invocation of func.

Returns:

  • (nil)

#sv_selection_col_type(sv, col) ⇒ Gnm::ColRowSelectionType

Returns How much of column col is selected in sv.

Parameters:

Returns:

#sv_selection_extend_to(sv, col, row) ⇒ nil

This extends the selection to cover col, row and updates the status areas.

Parameters:

  • sv (Gnm::SheetView)

    the sheet

  • col (Integer)

    column that gets covered (negative indicates all cols)

  • row (Integer)

    row that gets covered (negative indicates all rows)

Returns:

  • (nil)

#sv_selection_foreach(sv, handler, user_data) ⇒ Boolean

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.

Parameters:

  • sv (Gnm::SheetView)

    The whose selection is being iterated.

  • handler (Gnm::SelectionFunc)

    A function to call for each selected range.

  • user_data (GObject)

Returns:

  • (Boolean)

#sv_selection_free(sv) ⇒ nil

Releases the selection associated with sv

WARNING: This does not set a new selection and leaves the view in an INVALID STATE.

Parameters:

Returns:

  • (nil)

#sv_selection_reset(sv) ⇒ nil

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.

Parameters:

Returns:

  • (nil)

#sv_selection_row_type(sv, row) ⇒ Gnm::ColRowSelectionType

Returns How much of column col is selected in sv.

Parameters:

Returns:

#sv_selection_set(sv, edit, base_col, base_row, move_col, move_row) ⇒ nil

Parameters:

  • sv (Gnm::SheetView)
  • edit (Gnm::CellPos)
  • base_col (Integer)
  • base_row (Integer)
  • move_col (Integer)
  • move_row (Integer)

Returns:

  • (nil)

#sv_selection_simplified_free(sv) ⇒ nil

Releases the simplified selection associated with sv

Parameters:

Returns:

  • (nil)

#sv_selection_simplify(sv) ⇒ nil

Parameters:

Returns:

  • (nil)

#sv_selection_to_plot(sv, plot) ⇒ nil

Parameters:

Returns:

  • (nil)

#sv_selection_walk_step(sv, forward, horizontal) ⇒ nil

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 col).

Parameters:

  • sv (Gnm::SheetView)

    Sheet::View

  • forward (Boolean)
  • horizontal (Boolean)

Returns:

  • (nil)

#sv_sheet(sv) ⇒ Gnm::Sheet

Returns the sheet.

Parameters:

Returns:

#sv_wbv(sv) ⇒ Gnm::WorkbookView

Returns the workbook view.

Parameters:

Returns:

#swap_log_tail(lp) ⇒ Gnm::gnm_float

Parameters:

  • lp (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#sys_data_dirString

Returns:

  • (String)

#sys_extern_plugin_dirString

Returns:

  • (String)

#sys_lib_dirString

Returns:

  • (String)

#textbuffer_get_text(buf) ⇒ String

Parameters:

  • buf (Gtk::TextBuffer)

Returns:

  • (String)

#textview_get_text(text_view) ⇒ String

Parameters:

  • text_view (Gtk::TextView)

Returns:

  • (String)

#textview_set_text(text_view, txt) ⇒ nil

Parameters:

  • text_view (Gtk::TextView)
  • txt (String)

Returns:

  • (nil)

#theme_is_dark(widget) ⇒ Boolean

Parameters:

  • widget (Gtk::Widget)

Returns:

  • (Boolean)

#tool_consolidate_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#tool_load_selection(state, allow_multiple) ⇒ nil

load the current selection in the output and input entries show the dialog and focus the input_entry

Parameters:

  • state (Gnm::GenericToolState)
  • allow_multiple (Boolean)

Returns:

  • (nil)

#tool_random_cor_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#tool_random_engine(gcc, dao, specs, selector, result) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#tool_setup_update(state, name, cb, closure) ⇒ Gtk::Widget

Parameters:

  • state (Gnm::GenericToolState)
  • name (String)
  • cb (GObject::Callback)
  • closure (GObject)

Returns:

  • (Gtk::Widget)

#translate_underline_from_pango(pul) ⇒ Gnm::Underline

Parameters:

  • pul (Pango::Underline)

Returns:

#translate_underline_to_pango(ul) ⇒ Pango::Underline

Parameters:

Returns:

  • (Pango::Underline)

#trunc(x) ⇒ Gnm::gnm_float

Parameters:

  • x (Gnm::gnm_float)

Returns:

  • (Gnm::gnm_float)

#undo_cell_pos_name(sheet, pos) ⇒ String

Returns the range name depending on the preference setting.

Parameters:

Returns:

  • (String)

#undo_range_list_name(sheet, ranges) ⇒ String

(The result will be something like: "A1:C3, D4:E5"). The string will be truncated to max_descriptor_width.

Parameters:

  • sheet (Gnm::Sheet)
  • ranges (GLib::SList<Gnm::Range>)

    list of ranges

Returns:

  • (String)

    the range list name depending on the preference setting.

#undo_range_name(sheet, r) ⇒ String

Returns the range name depending on the preference setting.

Parameters:

Returns:

  • (String)

#unit_name_to_unit(name) ⇒ Gtk::Unit

Parameters:

  • name (String)

Returns:

  • (Gtk::Unit)

#unit_to_unit_name(unit) ⇒ String

Parameters:

  • unit (Gtk::Unit)

Returns:

  • (String)

#usr_dir(versioned) ⇒ String

Parameters:

  • versioned (Boolean)

Returns:

  • (String)

#utf8_strto(s, end) ⇒ Gnm::gnm_float

Parameters:

  • s (String)
  • end (String)

Returns:

  • (Gnm::gnm_float)

#utf8_strtol(s, end) ⇒ Gnm::glong

Parameters:

  • s (String)
  • end (String)

Returns:

  • (Gnm::glong)

#validation_eval(wbc, mstyle, sheet, pos, showed_dialog) ⇒ Gnm::ValidationStatus

Checks the validation in mstyle, if any. Set showed_dialog to true if a dialog was showed as a result.

Parameters:

Returns:

#validation_eval_range(wbc, sheet, pos, r, showed_dialog) ⇒ Gnm::ValidationStatus

Parameters:

Returns:

#value_cmp(ptr_a, ptr_b) ⇒ Integer

qsort style comparison function for ascending order

Parameters:

  • ptr_a (GObject)
  • ptr_b (GObject)

Returns:

  • (Integer)

#value_cmp_reverse(ptr_a, ptr_b) ⇒ Integer

qsort style comparison function for descending order.

Parameters:

  • ptr_a (GObject)
  • ptr_b (GObject)

Returns:

  • (Integer)

#value_error_name(err, translated) ⇒ String

Returns the name of err, possibly localized.

Parameters:

  • err (Gnm::StdError)

    Gnm::StdError

  • translated (Boolean)

    If true, use localized name.

Returns:

  • (String)

    the name of err, possibly localized.

#value_error_set_pos(err, pos) ⇒ Gnm::Value

Change the position of a ValueError.

Parameters:

  • err (Gnm::ValueErr)
  • pos (Gnm::EvalPos)

Returns:

  • (Gnm::Value)

    err as a Gnm::Value.

#value_initnil

Returns:

  • (nil)

#value_shutdownnil

Returns:

  • (nil)

#wb_control_claim_selection(wbc) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#wb_control_cur_sheet(wbc) ⇒ Gnm::Sheet

Returns the current sheet.

Parameters:

Returns:

#wb_control_cur_sheet_view(wbc) ⇒ Gnm::SheetView

Returns the current sheet view.

Parameters:

Returns:

#wb_control_edit_line_set(wbc, text) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_control_get_doc(wbc) ⇒ GOffice::Doc

Returns the workbook set as a #GODoc.

Parameters:

Returns:

  • (GOffice::Doc)

    the workbook set as a #GODoc.

#wb_control_get_workbook(wbc) ⇒ Gnm::Workbook

Returns the workbook.

Parameters:

Returns:

#wb_control_init_state(wbc) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_control_jump(wbc, sheet, r) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#wb_control_menu_state_update(wbc, flags) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_control_navigate_to_cell(wbc, to) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_control_parse_and_jump(wbc, text) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#wb_control_paste_from_selection(wbc, pt) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_control_selection_descr_set(wbc, text) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_control_set_view(wbc, optional_view, optional_wb) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_control_sheet_add(wbc, sv) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_control_sheet_focus(wbc, sheet) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_control_sheet_remove(wbc, sheet) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_control_sheet_remove_all(wbc) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_control_style_feedback(wbc, changes) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_control_undo_redo_labels(wbc, undo, redo) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_control_undo_redo_pop(wbc, is_undo) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_control_undo_redo_push(wbc, is_undo, text, key) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_control_undo_redo_truncate(wbc, n, is_undo) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_control_update_action_sensitivity(wbc) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_control_validation_msg(wbc, v, title, msg) ⇒ Integer

1 : ignore invalid and accept result 0 : discard invalid and finish editing -1 : continue editing

Parameters:

Returns:

  • (Integer)

#wb_control_view(wbc) ⇒ Gnm::WorkbookView

Returns the workbook view.

Parameters:

Returns:

#wb_view_attach_control(wbv, wbc) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_view_auto_expr_recalc(wbv) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_view_cur_sheet(wbv) ⇒ Gnm::Sheet

Returns the current sheet.

Parameters:

Returns:

#wb_view_cur_sheet_view(wbv) ⇒ Gnm::SheetView

Returns the current sheet view.

Parameters:

Returns:

#wb_view_detach_control(wbc) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_view_detach_from_workbook(wbv) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_view_edit_line_set(wbv, wbc) ⇒ nil

Load the edit line with the 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 nil, in all controls.

Parameters:

Returns:

  • (nil)

#wb_view_get_doc(wbv) ⇒ GOffice::Doc

Returns the #Workbook associated with wbv cast to a #GODoc.

Parameters:

Returns:

  • (GOffice::Doc)

    the #Workbook associated with wbv cast to a #GODoc

#wb_view_get_index_in_wb(wbv) ⇒ Integer

Returns 0 based index of wbv within workbook, or -1 if there is no workbook.

Parameters:

Returns:

  • (Integer)

#wb_view_get_workbook(wbv) ⇒ Gnm::Workbook

Returns the #Workbook associated with wbv.

Parameters:

Returns:

#wb_view_is_protected(wbv, check_sheet) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#wb_view_menus_update(wbv) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_view_preferred_size(wbv, w_pixels, h_pixels) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_view_selection_desc(wbv, use_pos, wbc) ⇒ nil

Load the edit line with the 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 nil, in all controls.

Parameters:

Returns:

  • (nil)

#wb_view_set_attribute(wbv, name, value) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_view_sheet_add(wbv, new_sheet) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_view_sheet_focus(wbv, sheet) ⇒ nil

Parameters:

Returns:

  • (nil)

#wb_view_style_feedback(wbv) ⇒ nil

Parameters:

Returns:

  • (nil)

#wbcg_append_sheet(ignored, wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#wbcg_auto_complete_destroy(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#wbcg_clone_sheet(ignored, wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#wbcg_copy_toolbar_visibility(new_wbcg, wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#wbcg_cur_scg(wbcg) ⇒ Gnm::SheetControlGUI

Returns the current Sheet::ControlGUI.

Parameters:

Returns:

#wbcg_cur_sheet(wbcg) ⇒ Gnm::Sheet

Returns the current #Sheet.

Parameters:

Returns:

#wbcg_edit_add_markup(wbcg, attr) ⇒ nil

Absorbs the ref to attr.

Parameters:

  • wbcg (Gnm::WBCGtk)

    #WBCGtk

  • attr (Pango::Attribute)

    Pango::Attribute

Returns:

  • (nil)

#wbcg_edit_finish(wbcg, result, showed_dialog) ⇒ Boolean

Returns true if editing completed successfully, or we were no editing.

Parameters:

  • wbcg (Gnm::WBCGtk)

    #WBCGtk

  • result (Gnm::WBCEditResult)

    what should we do with the content

  • showed_dialog (Boolean)

    indicates whether a dialog was displayed.

Returns:

  • (Boolean)

    true if editing completed successfully, or we were no editing.

#wbcg_edit_get_display_text(wbcg) ⇒ String

Parameters:

Returns:

  • (String)

#wbcg_edit_get_markup(wbcg, full) ⇒ Pango::AttrList

editing. The list belongs to wbcg and should not be freed.

Parameters:

Returns:

  • (Pango::AttrList)

    a potentially NULL PangoAttrList of the current markup while

#wbcg_edit_start(wbcg, blankp, cursorp) ⇒ Boolean

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. cell-to-be-edited was locked.

Parameters:

  • wbcg (Gnm::WBCGtk)

    The workbook to be edited.

  • blankp (Boolean)

    If true, erase current cell contents first. If false, leave the contents alone.

  • cursorp (Boolean)

    If true, create an editing 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:

  • (Boolean)

    true if we did indeed start editing. Returns false if the

#wbcg_entry_has_logical(wbcg) ⇒ Boolean

Returns true if wbcg_set_entry has redirected the edit_entry.

Parameters:

Returns:

  • (Boolean)

    true if wbcg_set_entry has redirected the edit_entry.

#wbcg_find_action(wbcg, name) ⇒ Gtk::Action

Returns The action with the given name.

Parameters:

  • wbcg (Gnm::WBCGtk)

    the workbook control gui

  • name (String)

    name of action

Returns:

  • (Gtk::Action)

    The action with the given name

#wbcg_find_for_workbook(wb, candidate, pref_screen, pref_display) ⇒ Gnm::WBCGtk

Returns the found #WBCGtk or nil.

Parameters:

  • wb (Gnm::Workbook)

    #Workbook

  • candidate (Gnm::WBCGtk)

    a candidate #WBCGtk

  • pref_screen (Gdk::Screen)

    the preferred screen.

  • pref_display (Gdk::Display)

    the preferred display.

Returns:

#wbcg_focus_cur_scg(wbcg) ⇒ Gnm::Sheet

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, font name/size, and accept/cancel for the editline.

Parameters:

  • wbcg (Gnm::WBCGtk)

    The workbook control to operate on.

Returns:

#wbcg_focus_current_cell_indicator(wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#wbcg_font_action_set_font_desc(act, desc) ⇒ nil

Parameters:

  • act (Gtk::Action)
  • desc (Pango::FontDescription)

Returns:

  • (nil)

#wbcg_get_entry(wbcg) ⇒ Gtk::Entry

Returns the Gtk::Entry associated with the current GnmExprEntry.

Parameters:

Returns:

  • (Gtk::Entry)

    the Gtk::Entry associated with the current GnmExprEntry

#wbcg_get_entry_logical(wbcg) ⇒ Gnm::ExprEntry

wbcg_set_entry for gurus) Gnm::ExprEntry

Parameters:

Returns:

#wbcg_get_entry_underlying(wbcg) ⇒ Gtk::Widget

Gnm::ExprEntry.

Parameters:

Returns:

  • (Gtk::Widget)

    the Gtk::Entry associated with the logical

#wbcg_get_font_desc(wbcg) ⇒ Pango::FontDescription

Parameters:

Returns:

  • (Pango::FontDescription)

#wbcg_get_n_scg(wbcg) ⇒ Integer

Parameters:

Returns:

  • (Integer)

#wbcg_get_nth_scg(wbcg, i) ⇒ Gnm::SheetControlGUI

wbcg's notebook. NOTE : i != scg->sv->sheet->index_in_wb

Parameters:

Returns:

#wbcg_insert_object(wbcg, so) ⇒ nil

Takes a newly created Sheet::Object that has not yet been realized and prepares to place it on the sheet.

NOTE : Absorbs a reference to the object.

Parameters:

Returns:

  • (nil)

#wbcg_insert_object_clear(wbcg) ⇒ nil

If we are preparing to insert a new object, unref the object, and restore a normal state to the scgs that was changed in wbcg_insert_object (e.g., visibility of cursors)

Parameters:

Returns:

  • (nil)

#wbcg_insert_sheet(ignored, wbcg) ⇒ nil

Parameters:

Returns:

  • (nil)

#wbcg_is_editing(wbcg) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#wbcg_rangesel_possible(wbcg) ⇒ Boolean

Returns true if the cursor keys should be used to select a cell range (if the cursor is in a spot in the expression where it makes sense to have a cell reference), false if not.

Parameters:

Returns:

  • (Boolean)

#wbcg_set_end_mode(wbcg, flag) ⇒ nil

Parameters:

Returns:

  • (nil)

#wbcg_set_entry(wbc, new_entry) ⇒ nil

Parameters:

Returns:

  • (nil)

#wbcg_set_status_text(wbcg, text) ⇒ nil

Parameters:

Returns:

  • (nil)

#wbcg_set_transient(wbcg, window) ⇒ nil

Parameters:

Returns:

  • (nil)

#wbcg_toggle_visibility(wbcg, action) ⇒ nil

Parameters:

Returns:

  • (nil)

#wbcg_toplevel(wbcg) ⇒ Gtk::Window

Returns the toplevel Gtk::Window.

Parameters:

Returns:

  • (Gtk::Window)

    the toplevel Gtk::Window.

#widget_measure_string(w, s) ⇒ Integer

Parameters:

  • w (Gtk::Widget)
  • s (String)

Returns:

  • (Integer)

#widget_set_cursor(w, ct) ⇒ nil

Parameters:

  • w (Gtk::Widget)
  • ct (Gdk::Cursor)

Returns:

  • (nil)

#widget_set_cursor_type(w, ct) ⇒ nil

Parameters:

  • w (Gtk::Widget)
  • ct (Gdk::CursorType)

Returns:

  • (nil)

#x_claim_clipboard(display) ⇒ Boolean

Parameters:

  • display (Gdk::Display)

Returns:

  • (Boolean)

#x_disown_clipboardnil

Returns:

  • (nil)

#x_request_clipboard(wbcg, pt) ⇒ nil

Parameters:

Returns:

  • (nil)

#x_store_clipboard_if_needed(wb) ⇒ nil

Parameters:

Returns:

  • (nil)

#xml_attr_bool(attrs, name, res) ⇒ Boolean

Parameters:

  • attrs (libxml2::Char)
  • name (String)
  • res (Boolean)

Returns:

  • (Boolean)

#xml_attr_double(attrs, name, res) ⇒ Boolean

Parameters:

  • attrs (libxml2::Char)
  • name (String)
  • res (Float)

Returns:

  • (Boolean)

#xml_attr_int(attrs, name, res) ⇒ Boolean

Parameters:

  • attrs (libxml2::Char)
  • name (String)
  • res (Integer)

Returns:

  • (Boolean)

#xml_cellregion_read(wbc, io_context, sheet, buffer, length) ⇒ Gnm::CellRegion

Parameters:

Returns:

  • (Gnm::CellRegion)

#xml_in_cur_obj(xin) ⇒ Gnm::SheetObject

Returns the current sheet object.

Parameters:

  • xin (Gsf::XMLIn)

    Gsf::XMLIn

Returns:

#xml_in_cur_sheet(xin) ⇒ Gnm::Sheet

Returns the current sheet.

Parameters:

  • xin (Gsf::XMLIn)

    Gsf::XMLIn

Returns:

#xml_in_doc_dispose_on_exit(pdoc) ⇒ nil

Parameters:

  • pdoc (Gsf::XMLInDoc)

Returns:

  • (nil)

#xml_io_conventionsGnm::Conventions

Returns:

  • (Gnm::Conventions)

#xml_out_add_gocolor(o, id, c) ⇒ nil

Parameters:

  • o (Gsf::XMLOut)
  • id (String)
  • c (GOffice::Color)

Returns:

  • (nil)

#xml_out_end_element_check(xout, id) ⇒ nil

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.

Parameters:

  • xout (Gsf::XMLOut)

    Gsf::XMLOut sink

  • id (String)

    expected tag being closed

Returns:

  • (nil)

#xml_prep_style_parser(xin, attrs, handler, user) ⇒ nil

Parameters:

  • xin (Gsf::XMLIn)
  • attrs (libxml2::Char)
  • handler (Gnm::XmlStyleHandler)
  • user (GObject)

    user data.

Returns:

  • (nil)

#xml_sax_read_initnil

Returns:

  • (nil)

#xml_sax_read_shutdownnil

Returns:

  • (nil)

#xml_sax_write_initnil

Returns:

  • (nil)

#xml_sax_write_shutdownnil

Returns:

  • (nil)

#yearfrac(from, to, basis) ⇒ Gnm::gnm_float

Parameters:

  • from (GLib::Date)
  • to (GLib::Date)
  • basis (GOffice::BasisType)

Returns:

  • (Gnm::gnm_float)