Class: Gnm::Dao

Inherits:

Gtk::Box

• Object
• Gtk::Box
• Gnm::Dao

Defined in:

(unknown)

Class Method Summary

• .adjust(dao, cols, rows) ⇒ nil

  shrinks the dao to the given cols/rows (or enlarges it if dao was a singleton).

• .append_date(buf) ⇒ nil
• .autofit_columns(dao) ⇒ nil

  fits all columns to their content.

• .autofit_rows(dao) ⇒ nil
• .autofit_these_columns(dao, from_col, to_col) ⇒ nil

  Fits the specified columns to their content.

• .autofit_these_rows(dao, from_row, to_row) ⇒ nil
• .cell_is_visible(dao, col, row) ⇒ Boolean
• .command_descriptor(dao, format, result) ⇒ String

  Uses format to provide a string to be used as command descriptor for undo/redo.

• .find_name(sheet, col, row) ⇒ String
• .format_output(dao, cmd) ⇒ Boolean

  Formats the output range according to the settings.

• .free(dao) ⇒ nil
• .get_cellref(dao, x, y) ⇒ Gnm::Expr
• .get_colrow_state_list(dao, is_cols) ⇒ Gnm::ColRowStateList
• .get_rangeref(dao, ax, ay, bx, by) ⇒ Gnm::Expr
• .go_data_vector(dao, ax, ay, bx, by) ⇒ GOffice::Data
• .init(dao, type) ⇒ Gnm::data_analysis_output_t

  Initialize dao to given type.

• .init_new_sheet(dao) ⇒ Gnm::data_analysis_output_t
• .load_from_value(dao, output_range) ⇒ Gnm::data_analysis_output_t
• .prepare_output(wbc, dao, name) ⇒ nil

  prepares the output by creating a new sheet or workbook as appropriate.

• .put_formulas(dao) ⇒ Boolean
• .redraw_respan(dao) ⇒ nil
• .set_align(dao, col1, row1, col2, row2, align_h, align_v) ⇒ nil

  set the given horizontal and vertical alignment to a cell range.

• .set_array_expr(dao, col, row, cols, rows, expr) ⇒ nil
• .set_bold(dao, col1, row1, col2, row2) ⇒ nil

  sets the given cell range to bold.

• .set_border(dao, col1, row1, col2, row2, elem, border, color, orientation) ⇒ nil
• .set_cell(dao, col, row, text) ⇒ nil

  set cell to a string.

• .set_cell_array_expr(dao, col, row, expr) ⇒ nil

  Sets a singleton array expression.

• .set_cell_comment(dao, col, row, comment) ⇒ nil

  set a cell comment.

• .set_cell_expr(dao, col, row, expr) ⇒ nil

  Sets a singleton array expression.

• .set_cell_float(dao, col, row, v) ⇒ nil
• .set_cell_float_na(dao, col, row, v, is_valid) ⇒ nil

  set cell to a gnm_float or NA as appropriate.

• .set_cell_int(dao, col, row, v) ⇒ nil
• .set_cell_na(dao, col, row) ⇒ nil

  set cell to NA.

• .set_cell_printf(dao, col, row, fmt, array) ⇒ nil

  create format string and set cell.

• .set_cell_value(dao, col, row, v) ⇒ nil

  set cell to a value.

• .set_colors(dao, col1, row1, col2, row2, fore, back) ⇒ nil

  set the given cell range to given background and text colors.

• .set_colrow_state_list(dao, is_cols, list) ⇒ nil
• .set_date(dao, col1, row1, col2, row2) ⇒ nil

  set the given cell range to date format.

• .set_format(dao, col1, row1, col2, row2, format) ⇒ nil

  set the given cell range to given format.

• .set_italic(dao, col1, row1, col2, row2) ⇒ nil

  sets the given cell range to italic.

• .set_merge(dao, col1, row1, col2, row2) ⇒ nil
• .set_omit_so(dao, omit) ⇒ nil
• .set_percent(dao, col1, row1, col2, row2) ⇒ nil

  set the given cell range to percent format.

• .set_sheet_object(dao, col, row, so) ⇒ nil
• .surrender_so(dao) ⇒ GLib::SList<GObject::Object>
• .write_header(dao, toolname, title, sheet) ⇒ nil

  Writes the titles of a report.

Instance Method Summary

• #focus_output_range ⇒ nil
• #get_data(dao) ⇒ Boolean
• #initialize(wbcg, inplace_str) ⇒ Gtk::Widget constructor
• #inplace=(inplace_str) ⇒ nil
• #is_finite ⇒ Boolean
• #is_ready ⇒ Boolean
• #load_range(range) ⇒ nil
• #set_put(show_put, put_formulas) ⇒ nil

Constructor Details

#initialize(wbcg, inplace_str) ⇒ Gtk::Widget

Parameters:

• wbcg (Gnm::WBCGtk)
• inplace_str (String)

Class Method Details

.adjust(dao, cols, rows) ⇒ nil

shrinks the dao to the given cols/rows (or enlarges it if dao was a singleton)

Parameters:

• dao (Gnm::data_analysis_output_t)
• cols (Integer)
• rows (Integer)

Returns:

• (nil)

.append_date(buf) ⇒ nil

Parameters:

• buf (GLib::String)

Returns:

• (nil)

.autofit_columns(dao) ⇒ nil

fits all columns to their content

Parameters:

• dao (Gnm::data_analysis_output_t)

Returns:

• (nil)

.autofit_rows(dao) ⇒ nil

Parameters:

• dao (Gnm::data_analysis_output_t)

Returns:

• (nil)

.autofit_these_columns(dao, from_col, to_col) ⇒ nil

Fits the specified columns to their content

Parameters:

• dao (Gnm::data_analysis_output_t)
• from_col (Integer)
• to_col (Integer)

Returns:

• (nil)

.autofit_these_rows(dao, from_row, to_row) ⇒ nil

Parameters:

• dao (Gnm::data_analysis_output_t)
• from_row (Integer)
• to_row (Integer)

Returns:

• (nil)

.cell_is_visible(dao, col, row) ⇒ Boolean

Parameters:

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

Returns:

• (Boolean)

.command_descriptor(dao, format, result) ⇒ String

Uses format to provide a string to be used as command descriptor for undo/redo

Parameters:

• dao (Gnm::data_analysis_output_t)
• format (String)
• result (GObject)

Returns:

• (String)

.find_name(sheet, col, row) ⇒ String

Parameters:

• sheet (Gnm::Sheet)
• col (Integer)
• row (Integer)

Returns:

• (String)

.format_output(dao, cmd) ⇒ Boolean

Formats the output range according to the settings

Parameters:

• dao (Gnm::data_analysis_output_t)
• cmd (String)

Returns:

• (Boolean)

.free(dao) ⇒ nil

Parameters:

• dao (Gnm::data_analysis_output_t)

Returns:

• (nil)

.get_cellref(dao, x, y) ⇒ Gnm::Expr

Parameters:

• dao (Gnm::data_analysis_output_t)
• x (Integer)
• y (Integer)

Returns:

• (Gnm::Expr)

.get_colrow_state_list(dao, is_cols) ⇒ Gnm::ColRowStateList

Parameters:

• dao (Gnm::data_analysis_output_t)
• is_cols (Boolean) —

  true for columns, false for rows.

Returns:

• (Gnm::ColRowStateList)

.get_rangeref(dao, ax, ay, bx, by) ⇒ Gnm::Expr

Parameters:

• dao (Gnm::data_analysis_output_t)
• ax (Integer)
• ay (Integer)
• bx (Integer)
• by (Integer)

Returns:

• (Gnm::Expr)

.go_data_vector(dao, ax, ay, bx, by) ⇒ GOffice::Data

Parameters:

• dao (Gnm::data_analysis_output_t)
• ax (Integer)
• ay (Integer)
• bx (Integer)
• by (Integer)

Returns:

• (GOffice::Data)

.init(dao, type) ⇒ Gnm::data_analysis_output_t

Initialize dao to given type.

Parameters:

• dao (Gnm::data_analysis_output_t)
• type (Gnm::data_analysis_output_type_t)

Returns:

• (Gnm::data_analysis_output_t)

.init_new_sheet(dao) ⇒ Gnm::data_analysis_output_t

Parameters:

• dao (Gnm::data_analysis_output_t)

Returns:

• (Gnm::data_analysis_output_t)

.load_from_value(dao, output_range) ⇒ Gnm::data_analysis_output_t

Parameters:

• dao (Gnm::data_analysis_output_t)
• output_range (Gnm::Value)

Returns:

• (Gnm::data_analysis_output_t)

.prepare_output(wbc, dao, name) ⇒ nil

prepares the output by creating a new sheet or workbook as appropriate

Parameters:

• wbc (Gnm::WorkbookControl)
• dao (Gnm::data_analysis_output_t)
• name (String)

Returns:

• (nil)

.put_formulas(dao) ⇒ Boolean

Parameters:

• dao (Gnm::data_analysis_output_t)

Returns:

• (Boolean)

.redraw_respan(dao) ⇒ nil

Parameters:

• dao (Gnm::data_analysis_output_t)

Returns:

• (nil)

.set_align(dao, col1, row1, col2, row2, align_h, align_v) ⇒ nil

set the given horizontal and vertical alignment to a cell range

Parameters:

• dao (Gnm::data_analysis_output_t)
• col1 (Integer)
• row1 (Integer)
• col2 (Integer)
• row2 (Integer)
• align_h (Gnm::HAlign)
• align_v (Gnm::VAlign)

Returns:

• (nil)

.set_array_expr(dao, col, row, cols, rows, expr) ⇒ nil

Parameters:

• dao (Gnm::data_analysis_output_t)
• col (Integer) —

  starting column

• row (Integer) —

  starting row

• cols (Integer) —

  number of columns

• rows (Integer) —

  number of rows

• expr (Gnm::Expr) —

  expression to set

Returns:

• (nil)

.set_bold(dao, col1, row1, col2, row2) ⇒ nil

sets the given cell range to bold

Parameters:

• dao (Gnm::data_analysis_output_t)
• col1 (Integer)
• row1 (Integer)
• col2 (Integer)
• row2 (Integer)

Returns:

• (nil)

.set_border(dao, col1, row1, col2, row2, elem, border, color, orientation) ⇒ nil

Parameters:

• dao (Gnm::data_analysis_output_t)
• col1 (Integer)
• row1 (Integer)
• col2 (Integer)
• row2 (Integer)
• elem (Gnm::StyleElement)
• border (Gnm::StyleBorderType)
• color (Gnm::Color)
• orientation (Gnm::StyleBorderOrientation)

Returns:

• (nil)

.set_cell(dao, col, row, text) ⇒ nil

set cell to a string

Parameters:

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

Returns:

• (nil)

.set_cell_array_expr(dao, col, row, expr) ⇒ nil

Sets a singleton array expression.

Parameters:

• dao (Gnm::data_analysis_output_t)
• col (Integer) —

  column

• row (Integer) —

  row

• expr (Gnm::Expr) —

  expression to set

Returns:

• (nil)

.set_cell_comment(dao, col, row, comment) ⇒ nil

set a cell comment

Parameters:

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

Returns:

• (nil)

.set_cell_expr(dao, col, row, expr) ⇒ nil

Sets a singleton array expression.

Parameters:

• dao (Gnm::data_analysis_output_t)
• col (Integer) —

  column

• row (Integer) —

  row

• expr (Gnm::Expr) —

  expression to set

Returns:

• (nil)

.set_cell_float(dao, col, row, v) ⇒ nil

Parameters:

• dao (Gnm::data_analysis_output_t)
• col (Integer)
• row (Integer)
• v (Gnm::gnm_float)

Returns:

• (nil)

.set_cell_float_na(dao, col, row, v, is_valid) ⇒ nil

set cell to a gnm_float or NA as appropriate

Parameters:

• dao (Gnm::data_analysis_output_t)
• col (Integer)
• row (Integer)
• v (Gnm::gnm_float)
• is_valid (Boolean)

Returns:

• (nil)

.set_cell_int(dao, col, row, v) ⇒ nil

Parameters:

• dao (Gnm::data_analysis_output_t)
• col (Integer)
• row (Integer)
• v (Integer)

Returns:

• (nil)

.set_cell_na(dao, col, row) ⇒ nil

set cell to NA

Parameters:

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

Returns:

• (nil)

.set_cell_printf(dao, col, row, fmt, array) ⇒ nil

create format string and set cell.

Parameters:

• dao (Gnm::data_analysis_output_t)
• col (Integer)
• row (Integer)
• fmt (String)
• array (Array)

Returns:

• (nil)

.set_cell_value(dao, col, row, v) ⇒ nil

set cell to a value

Note: the rows/cols specification for all dao_set_cell_... commands are relative to the location of the output

Parameters:

• dao (Gnm::data_analysis_output_t)
• col (Integer)
• row (Integer)
• v (Gnm::Value)

Returns:

• (nil)

.set_colors(dao, col1, row1, col2, row2, fore, back) ⇒ nil

set the given cell range to given background and text colors

Parameters:

• dao (Gnm::data_analysis_output_t)
• col1 (Integer)
• row1 (Integer)
• col2 (Integer)
• row2 (Integer)
• fore (Gnm::Color)
• back (Gnm::Color)

Returns:

• (nil)

.set_colrow_state_list(dao, is_cols, list) ⇒ nil

Parameters:

• dao (Gnm::data_analysis_output_t)
• is_cols (Boolean) —

  true for columns, false for rows.

• list (Gnm::ColRowStateList)

Returns:

• (nil)

.set_date(dao, col1, row1, col2, row2) ⇒ nil

set the given cell range to date format

Parameters:

• dao (Gnm::data_analysis_output_t)
• col1 (Integer)
• row1 (Integer)
• col2 (Integer)
• row2 (Integer)

Returns:

• (nil)

.set_format(dao, col1, row1, col2, row2, format) ⇒ nil

set the given cell range to given format

Parameters:

• dao (Gnm::data_analysis_output_t)
• col1 (Integer)
• row1 (Integer)
• col2 (Integer)
• row2 (Integer)
• format (String)

Returns:

• (nil)

.set_italic(dao, col1, row1, col2, row2) ⇒ nil

sets the given cell range to italic

Parameters:

• dao (Gnm::data_analysis_output_t)
• col1 (Integer)
• row1 (Integer)
• col2 (Integer)
• row2 (Integer)

Returns:

• (nil)

.set_merge(dao, col1, row1, col2, row2) ⇒ nil

Parameters:

• dao (Gnm::data_analysis_output_t)
• col1 (Integer)
• row1 (Integer)
• col2 (Integer)
• row2 (Integer)

Returns:

• (nil)

.set_omit_so(dao, omit) ⇒ nil

Parameters:

• dao (Gnm::data_analysis_output_t)
• omit (Boolean)

Returns:

• (nil)

.set_percent(dao, col1, row1, col2, row2) ⇒ nil

set the given cell range to percent format

Parameters:

• dao (Gnm::data_analysis_output_t)
• col1 (Integer)
• row1 (Integer)
• col2 (Integer)
• row2 (Integer)

Returns:

• (nil)

.set_sheet_object(dao, col, row, so) ⇒ nil

Parameters:

• dao (Gnm::data_analysis_output_t)
• col (Integer)
• row (Integer)
• so (Gnm::SheetObject)

Returns:

• (nil)

.surrender_so(dao) ⇒ GLib::SList<GObject::Object>

Parameters:

• dao (Gnm::data_analysis_output_t)

Returns:

• (GLib::SList<GObject::Object>)

.write_header(dao, toolname, title, sheet) ⇒ nil

Writes the titles of a report.

Parameters:

• dao (Gnm::data_analysis_output_t)
• toolname (String) —

  name of the tool, like Solver or Risk simulation

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

Returns:

• (nil)

Instance Method Details

#focus_output_range ⇒ nil

Returns:

• (nil)

#get_data(dao) ⇒ Boolean

Parameters:

• dao (Gnm::data_analysis_output_t)

Returns:

• (Boolean)

#inplace=(inplace_str) ⇒ nil

Parameters:

• inplace_str (String)

Returns:

• (nil)

#is_finite ⇒ Boolean

Returns:

• (Boolean)

#is_ready ⇒ Boolean

Returns:

• (Boolean)

#load_range(range) ⇒ nil

Parameters:

• range (Gnm::Range)

Returns:

• (nil)

#set_put(show_put, put_formulas) ⇒ nil

Parameters:

• show_put (Boolean)
• put_formulas (Boolean)

Returns:

• (nil)