Gnm.Filter¶

Fields¶

Name	Type	Access	Description
fields	[`object`]	r/w
is_active	`bool`	r/w
r	`Gnm.Range`	r/w
ref_count	`int`	r/w
sheet	`Gnm.Sheet`	r/w

Methods¶

class	`new` (sheet, r, attach)
class	`show_all` (wbc)
	`attach` (sheet)
	`dup` (sheet)
	`get_condition` (i)
	`reapply` ()
	`ref` ()
	`remove` ()
	`set_condition` (i, cond, apply)
	`unref` ()

Details¶

class Gnm.Filter¶

classmethod new(sheet, r, attach)¶

Parameters:

sheet (Gnm.Sheet) – Gnm.Sheet for which to create the filter.
r (Gnm.Range) – Gnm.Range that the filter covers.
attach (bool) – whether to attach the filter.

Returns:

A new filter.

Return type:

classmethod show_all(wbc)¶

Parameters:: wbc (Gnm.WorkbookControl) –

attach(sheet)¶

Parameters:: sheet (Gnm.Sheet) –

dup(sheet)¶

Parameters:: sheet (Gnm.Sheet) – Gnm.Sheet
Return type:: Gnm.Filter

Duplicate self into sheet

get_condition(i)¶

Parameters:: i (int) – zero-based index
Returns:: the i'th condition of self
Return type:: Gnm.FilterCondition or None

reapply()¶: Reapplies self after changes.

ref()¶

Return type:: Gnm.Filter

remove()¶

set_condition(i, cond, apply)¶

Parameters:

i (int) –
cond (Gnm.FilterCondition or None) – Gnm.FilterCondition
apply (bool) –

Change the i-th condition of self to cond. If apply is True, self is used to set the visibility of the rows in self::sheet

Absorbs the reference to cond.

unref()¶