Gnm.FT

Fields

Name	Type	Access	Description
alignment	bool	r/w
author	str	r/w
border	bool	r/w
category	Gnm.FTCategory	r/w
description	str	r/w
dimension	Gnm.Range	r
edges	object	r/w
filename	str	r/w
font	bool	r/w
invalidate_hash	bool	r
members	[object]	r/w
name	str	r/w
number	bool	r/w
patterns	bool	r/w
table	{object: object}	r

Methods

class	compare_name (a, b)
class	new_from_file (filename, context)
	apply_to_sheet_regions (sheet, regions)
	check_valid (regions, cc)
	clone ()
	free ()
	get_style (row, col)

Details

class Gnm.FT

classmethod compare_name(a, b)

Parameters:

• a (object or None) – First Gnm.FT

• b (object or None) – Second Gnm.FT

Return type:

int

classmethod new_from_file(filename, context)

Parameters:

• filename (str) – The filename to load from

• context (GOffice.CmdContext) –

Returns:

a new Gnm.FT (or None on error)

Return type:

Gnm.FT

Create a new Gnm.FT and load a template file into it.

apply_to_sheet_regions(sheet, regions)

Parameters:

• sheet (Gnm.Sheet) – the Target sheet

• regions ([Gnm.Range]) – Region list

Apply the template to all selected regions in sheet.

check_valid(regions, cc)

Parameters:

• regions ([Gnm.Range]) –

• cc (GOffice.CmdContext or None) – where to report errors

Returns:

True if ok, else False. Will report an error to cc if it is supplied.

Return type:

bool

check to see if the regions are able to contain the support template self.

clone()

Returns:

transfer full): a copy of self

Return type:

Gnm.FT

Make a copy of self.

free()

get_style(row, col)

Parameters:

• row (int) –

• col (int) –

Returns:

an Gnm.Style

Return type:

Gnm.Style

Returns the Gnm.Style associated with coordinates Gnm.row, Gnm.col. This routine uses the hash to do this. NOTE : You MAY NOT free the result of this operation, you may also NOT MODIFY the Gnm.Style returned. (make a copy first)