Gnm.StfExport¶

Subclasses:: None

Methods¶

Inherited:: Gsf.OutputCsv (2), Gsf.Output (18), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`can_transliterate` ()
class	`dialog` (wbcg, stfe, wb)
	`_` ()
	`options_sheet_list_add` (sheet)
	`options_sheet_list_clear` ()
	`options_sheet_list_get` ()

Virtual Methods¶

Inherited:: Gsf.Output (3), GObject.Object (7)

Properties¶

Inherited:: Gsf.OutputCsv (7), Gsf.Output (6)

Name	Type	Flags	Short Description
`charset`	`str`	r/w	The character encoding of the output.
`format`	`Gnm.StfFormatMode`	r/w	How should cells be formatted?
`locale`	`str`	r/w	The locale to use for number and date formatting.
`transliterate-mode`	`Gnm.StfTransliterateMode`	r/w	What to do with unrepresentable characters.

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Gnm.StfExport(**kwargs)¶

Bases:: Gsf.OutputCsv
Abstract:: No

classmethod can_transliterate()¶

Returns:: True iff //TRANSLIT is supported
Return type:: bool

classmethod dialog(wbcg, stfe, wb)¶

Parameters:

wbcg (Gnm.WBCGtk or None) – Gnm.WBCGtk
stfe (Gnm.StfExport) – An exporter to set up (and take defaults from)
wb (Gnm.Workbook) – The Gnm.Workbook to export

Returns:

True if cancelled.

Return type:

This will start the export assistant.

_()¶

Returns:: True on success, False otherwise
Return type:: bool

Exports the sheets given in stfe

options_sheet_list_add(sheet)¶

Parameters:: sheet (Gnm.Sheet) – a gnumeric sheet

Appends a sheet to the list of sheets to be exported

options_sheet_list_clear()¶: Clears the sheet list.

options_sheet_list_get()¶

Returns:: the list of Gnm.Sheet instances added to self using Gnm.StfExport.options_sheet_list_add().
Return type:: [Gnm.Sheet]

Property Details¶

Gnm.StfExport.props.charset¶

Name:: charset
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The character encoding of the output.

Gnm.StfExport.props.format¶

Name:: format
Type:: Gnm.StfFormatMode
Default Value:: Gnm.StfFormatMode.AUTOMATIC
Flags:: READABLE, WRITABLE

How should cells be formatted?

Gnm.StfExport.props.locale¶

Name:: locale
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The locale to use for number and date formatting.

Gnm.StfExport.props.transliterate_mode¶

Name:: transliterate-mode
Type:: Gnm.StfTransliterateMode
Default Value:: Gnm.StfTransliterateMode.ESCAPE
Flags:: READABLE, WRITABLE

What to do with unrepresentable characters.