Gnm.Validation

Fields

Name	Type	Access	Description
allow_blank	bool	r/w
deps	[Gnm.DepManaged]	r/w
msg	GOffice.String	r/w
op	Gnm.ValidationOp	r/w
ref_count	int	r/w
style	Gnm.ValidationStyle	r/w
title	GOffice.String	r/w
type	Gnm.ValidationType	r/w
use_dropdown	bool	r/w

Methods

class	eval (wbc, mstyle, sheet, pos)
class	eval_range (wbc, sheet, pos, r, showed_dialog)
class	new (style, type, op, sheet, title, msg, texpr0, texpr1, allow_blank, use_dropdown)
	dup_to (sheet)
	equal (b, relax_sheet)
	get_sheet ()
	is_ok ()
	ref ()
	set_expr (texpr, indx)
	unref ()

Details

class Gnm.Validation

classmethod eval(wbc, mstyle, sheet, pos)

Parameters:

• wbc (Gnm.WorkbookControl) –

• mstyle (Gnm.Style) –

• sheet (Gnm.Sheet) –

• pos (Gnm.CellPos) –

Return type:

(Gnm.ValidationStatus, showed_dialog: bool)

Checks the validation in mstyle, if any. Set showed_dialog to True if a dialog was showed as a result.

classmethod eval_range(wbc, sheet, pos, r, showed_dialog)

Parameters:

• wbc (Gnm.WorkbookControl) –

• sheet (Gnm.Sheet) –

• pos (Gnm.CellPos) –

• r (Gnm.Range) –

• showed_dialog (bool) –

Return type:

Gnm.ValidationStatus

classmethod new(style, type, op, sheet, title, msg, texpr0, texpr1, allow_blank, use_dropdown)

Parameters:

• style (Gnm.ValidationStyle) – #ValidationStyle

• type (Gnm.ValidationType) –

• op (Gnm.ValidationOp) – #ValidationOp

• sheet (Gnm.Sheet) – Gnm.Sheet

• title (str) – will be copied.

• msg (str) – will be copied.

• texpr0 (Gnm.ExprTop or None) – first expression

• texpr1 (Gnm.ExprTop or None) – second expression

• allow_blank (bool) –

• use_dropdown (bool) –

Returns:

a new GnmValidation object

Return type:

Gnm.Validation

Does _NOT_ require all necessary information to be set here. Gnm.Validation.set_expr can be used to change the expressions after creation, and Gnm.Validation.is_ok can be used to ensure that things are properly setup.

dup_to(sheet)

Parameters:

sheet (Gnm.Sheet) –

Return type:

Gnm.Validation

equal(b, relax_sheet)

Parameters:

• b (Gnm.Validation) –

• relax_sheet (bool) –

Return type:

bool

get_sheet()

Returns:

the sheet.

Return type:

Gnm.Sheet

is_ok()

Return type:

GLib.Error

ref()

Return type:

Gnm.Validation

set_expr(texpr, indx)

Parameters:

• texpr (Gnm.ExprTop) – Gnm.ExprTop

• indx (int) – 0 or 1

Assign an expression to a validation. Gnm.Validation.is_ok can be used to verify that self has all of the required information.

unref()