Gnm.Dao

Subclasses:

None

Methods

Inherited:

Gtk.Box (14), Gtk.Container (35), Gtk.Widget (278), GObject.Object (37), Gtk.Buildable (10), Gtk.Orientable (2)

Structs:

Gtk.ContainerClass (5), Gtk.WidgetClass (12), GObject.ObjectClass (5)

class	adjust (dao, cols, rows)
class	append_date (buf)
class	autofit_columns (dao)
class	autofit_rows (dao)
class	autofit_these_columns (dao, from_col, to_col)
class	autofit_these_rows (dao, from_row, to_row)
class	cell_is_visible (dao, col, row)
class	command_descriptor (dao, format, result)
class	find_name (sheet, col, row)
class	format_output (dao, cmd)
class	free (dao)
class	get_cellref (dao, x, y)
class	get_colrow_state_list (dao, is_cols)
class	get_rangeref (dao, ax, ay, bx, by)
class	go_data_vector (dao, ax, ay, bx, by)
class	new (wbcg, inplace_str)
class	prepare_output (wbc, dao, name)
class	put_formulas (dao)
class	redraw_respan (dao)
class	set_align (dao, col1, row1, col2, row2, align_h, align_v)
class	set_bold (dao, col1, row1, col2, row2)
class	set_border (dao, col1, row1, col2, row2, elem, border, color, orientation)
class	set_cell (dao, col, row, text)
class	set_cell_comment (dao, col, row, comment)
class	set_cell_float (dao, col, row, v)
class	set_cell_float_na (dao, col, row, v, is_valid)
class	set_cell_int (dao, col, row, v)
class	set_cell_na (dao, col, row)
class	set_cell_value (dao, col, row, v)
class	set_colors (dao, col1, row1, col2, row2, fore, back)
class	set_colrow_state_list (dao, is_cols, list)
class	set_date (dao, col1, row1, col2, row2)
class	set_format (dao, col1, row1, col2, row2, format)
class	set_italic (dao, col1, row1, col2, row2)
class	set_merge (dao, col1, row1, col2, row2)
class	set_omit_so (dao, omit)
class	set_percent (dao, col1, row1, col2, row2)
class	set_sheet_object (dao, col, row, so)
class	surrender_so (dao)
class	write_header (dao, toolname, title, sheet)
	focus_output_range ()
	get_data (dao)
	is_finite ()
	is_ready ()
	load_range (range)
	set_inplace (inplace_str)
	set_put (show_put, put_formulas)

Virtual Methods

Inherited:

Gtk.Container (10), Gtk.Widget (82), GObject.Object (7), Gtk.Buildable (10)

Properties

Inherited:

Gtk.Box (3), Gtk.Container (3), Gtk.Widget (39), Gtk.Orientable (1)

Child Properties

Inherited:

Gtk.Box (5)

Style Properties

Inherited:

Gtk.Widget (17)

Signals

Inherited:

Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Name	Short Description
activate
readiness-changed

Fields

Inherited:

Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Class Details

class Gnm.Dao(*args, **kwargs)

Bases:

Gtk.Box

Abstract:

No

classmethod adjust(dao, cols, rows)

Parameters:

• dao (Gnm.data_analysis_output_t)

• cols (int)

• rows (int)

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

classmethod append_date(buf)

Parameters:

buf (GLib.String)

classmethod autofit_columns(dao)

Parameters:

dao (Gnm.data_analysis_output_t)

fits all columns to their content

classmethod autofit_rows(dao)

Parameters:

dao (Gnm.data_analysis_output_t)

classmethod autofit_these_columns(dao, from_col, to_col)

Parameters:

• dao (Gnm.data_analysis_output_t)

• from_col (int)

• to_col (int)

Fits the specified columns to their content

classmethod autofit_these_rows(dao, from_row, to_row)

Parameters:

• dao (Gnm.data_analysis_output_t)

• from_row (int)

• to_row (int)

classmethod cell_is_visible(dao, col, row)

Parameters:

• dao (Gnm.data_analysis_output_t)

• col (int)

• row (int)

Return type:

bool

classmethod command_descriptor(dao, format, result)

Parameters:

• dao (Gnm.data_analysis_output_t)

• format (str)

• result (object or None)

Return type:

str

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

classmethod find_name(sheet, col, row)

Parameters:

• sheet (Gnm.Sheet)

• col (int)

• row (int)

Return type:

str

classmethod format_output(dao, cmd)

Parameters:

• dao (Gnm.data_analysis_output_t)

• cmd (str)

Return type:

bool

Formats the output range according to the settings

classmethod free(dao)

Parameters:

dao (Gnm.data_analysis_output_t)

classmethod get_cellref(dao, x, y)

Parameters:

• dao (Gnm.data_analysis_output_t)

• x (int)

• y (int)

Return type:

Gnm.Expr

classmethod get_colrow_state_list(dao, is_cols)

Parameters:

• dao (Gnm.data_analysis_output_t)

• is_cols (bool) – True for columns, False for rows.

Return type:

[object]

classmethod get_rangeref(dao, ax, ay, bx, by)

Parameters:

• dao (Gnm.data_analysis_output_t)

• ax (int)

• ay (int)

• bx (int)

• by (int)

Return type:

Gnm.Expr

classmethod go_data_vector(dao, ax, ay, bx, by)

Parameters:

• dao (Gnm.data_analysis_output_t)

• ax (int)

• ay (int)

• bx (int)

• by (int)

Return type:

GOffice.Data

classmethod new(wbcg, inplace_str)

Parameters:

• wbcg (Gnm.WBCGtk)

• inplace_str (str)

Return type:

Gtk.Widget

classmethod prepare_output(wbc, dao, name)

Parameters:

• wbc (Gnm.WorkbookControl)

• dao (Gnm.data_analysis_output_t)

• name (str)

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

classmethod put_formulas(dao)

Parameters:

dao (Gnm.data_analysis_output_t)

Return type:

bool

classmethod redraw_respan(dao)

Parameters:

dao (Gnm.data_analysis_output_t)

classmethod set_align(dao, col1, row1, col2, row2, align_h, align_v)

Parameters:

• dao (Gnm.data_analysis_output_t)

• col1 (int)

• row1 (int)

• col2 (int)

• row2 (int)

• align_h (Gnm.HAlign)

• align_v (Gnm.VAlign)

set the given horizontal and vertical alignment to a cell range

classmethod set_bold(dao, col1, row1, col2, row2)

Parameters:

• dao (Gnm.data_analysis_output_t)

• col1 (int)

• row1 (int)

• col2 (int)

• row2 (int)

sets the given cell range to bold

classmethod set_border(dao, col1, row1, col2, row2, elem, border, color, orientation)

Parameters:

• dao (Gnm.data_analysis_output_t)

• col1 (int)

• row1 (int)

• col2 (int)

• row2 (int)

• elem (Gnm.StyleElement)

• border (Gnm.StyleBorderType)

• color (Gnm.Color)

• orientation (Gnm.StyleBorderOrientation)

classmethod set_cell(dao, col, row, text)

Parameters:

• dao (Gnm.data_analysis_output_t)

• col (int)

• row (int)

• text (str)

set cell to a string

classmethod set_cell_comment(dao, col, row, comment)

Parameters:

• dao (Gnm.data_analysis_output_t)

• col (int)

• row (int)

• comment (str)

set a cell Gnm.comment

classmethod set_cell_float(dao, col, row, v)

Parameters:

• dao (Gnm.data_analysis_output_t)

• col (int)

• row (int)

• v (float)

classmethod set_cell_float_na(dao, col, row, v, is_valid)

Parameters:

• dao (Gnm.data_analysis_output_t)

• col (int)

• row (int)

• v (float)

• is_valid (bool)

set cell to a gnm_float or NA as appropriate

classmethod set_cell_int(dao, col, row, v)

Parameters:

• dao (Gnm.data_analysis_output_t)

• col (int)

• row (int)

• v (int)

classmethod set_cell_na(dao, col, row)

Parameters:

• dao (Gnm.data_analysis_output_t)

• col (int)

• row (int)

set cell to NA

classmethod set_cell_value(dao, col, row, v)

Parameters:

• dao (Gnm.data_analysis_output_t)

• col (int)

• row (int)

• v (Gnm.Value)

set cell to a GOffice.value

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

classmethod set_colors(dao, col1, row1, col2, row2, fore, back)

Parameters:

• dao (Gnm.data_analysis_output_t)

• col1 (int)

• row1 (int)

• col2 (int)

• row2 (int)

• fore (Gnm.Color)

• back (Gnm.Color)

set the given cell range to given background and text colors

classmethod set_colrow_state_list(dao, is_cols, list)

Parameters:

• dao (Gnm.data_analysis_output_t)

• is_cols (bool) – True for columns, False for rows.

• list ([object])

classmethod set_date(dao, col1, row1, col2, row2)

Parameters:

• dao (Gnm.data_analysis_output_t)

• col1 (int)

• row1 (int)

• col2 (int)

• row2 (int)

set the given cell range to date format

classmethod set_format(dao, col1, row1, col2, row2, format)

Parameters:

• dao (Gnm.data_analysis_output_t)

• col1 (int)

• row1 (int)

• col2 (int)

• row2 (int)

• format (str)

set the given cell range to given format

classmethod set_italic(dao, col1, row1, col2, row2)

Parameters:

• dao (Gnm.data_analysis_output_t)

• col1 (int)

• row1 (int)

• col2 (int)

• row2 (int)

sets the given cell range to italic

classmethod set_merge(dao, col1, row1, col2, row2)

Parameters:

• dao (Gnm.data_analysis_output_t)

• col1 (int)

• row1 (int)

• col2 (int)

• row2 (int)

classmethod set_omit_so(dao, omit)

Parameters:

• dao (Gnm.data_analysis_output_t)

• omit (bool)

classmethod set_percent(dao, col1, row1, col2, row2)

Parameters:

• dao (Gnm.data_analysis_output_t)

• col1 (int)

• row1 (int)

• col2 (int)

• row2 (int)

set the given cell range to percent format

classmethod set_sheet_object(dao, col, row, so)

Parameters:

• dao (Gnm.data_analysis_output_t)

• col (int)

• row (int)

• so (Gnm.SheetObject)

classmethod surrender_so(dao)

Parameters:

dao (Gnm.data_analysis_output_t)

Return type:

[GObject.Object]

classmethod write_header(dao, toolname, title, sheet)

Parameters:

• dao (Gnm.data_analysis_output_t)

• toolname (str) – name of the tool, like Solver or Risk simulation

• title (str)

• sheet (Gnm.Sheet)

Writes the titles of a report.

focus_output_range()

get_data(dao)

Parameters:

dao (Gnm.data_analysis_output_t)

Return type:

bool

is_finite()

Return type:

bool

is_ready()

Return type:

bool

load_range(range)

Parameters:

range (Gnm.Range)

set_inplace(inplace_str)

Parameters:

inplace_str (str)

set_put(show_put, put_formulas)

Parameters:

• show_put (bool)

• put_formulas (bool)

Signal Details

Gnm.Dao.signals.activate(dao)

Signal Name:

activate

Flags:

RUN_LAST, ACTION

Parameters:

dao (Gnm.Dao) – The object which received the signal

Gnm.Dao.signals.readiness_changed(dao)

Signal Name:

readiness-changed

Flags:

RUN_LAST

Parameters:

dao (Gnm.Dao) – The object which received the signal