Gnm.WorkbookView¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (wb)
class	`new_from_input` (input, uri, file_opener, io_context, encoding)
class	`new_from_uri` (uri, file_opener, io_context, encoding)
	`save` (cc)
	`save_as` (fs, uri, cc)
	`save_to_output` (fs, output, io_context)
	`save_to_uri` (fs, uri, io_context)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`auto-expr-descr`	`str`	r/w	Description of the automatically computed sheet function.
`auto-expr-eval-pos`	`Gnm.EvalPos`	w	The cell position to track.
`auto-expr-func`	`Gnm.Func`	r/w	The automatically computed sheet function.
`auto-expr-max-precision`	`bool`	r/w	Use maximum available precision for auto-expressions
`auto-expr-value`	`Gnm.Value`	r/w	The current `GOffice.value` of the auto-expression.
`do-auto-completion`	`bool`	r/w	Auto-complete text
`preferred-height`	`int`	r/w	Preferred height
`preferred-width`	`int`	r/w	Preferred width
`protected`	`bool`	r/w	Is view protected?
`show-extension-markers`	`bool`	r/w	Mark each cell that fails to show the complete content
`show-function-cell-markers`	`bool`	r/w	Mark each cell containing a formula
`show-horizontal-scrollbar`	`bool`	r/w	Show the horizontal scrollbar
`show-notebook-tabs`	`bool`	r/w	Show the notebook tabs for sheets
`show-vertical-scrollbar`	`bool`	r/w	Show the vertical scrollbar
`workbook`	`Gnm.Workbook`	r/w/co	`Gnm.Workbook`

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access
base	`GOffice.View`	r
current_sheet	`Gnm.Sheet`	r
current_sheet_view	`Gnm.SheetView`	r
current_style	`Gnm.Style`	r
do_auto_completion	`bool`	r
in_cell_combo	`Gnm.SheetObject`	r
is_protected	`bool`	r
preferred_height	`int`	r
preferred_width	`int`	r
selection_description	`str`	r
show_extension_markers	`bool`	r
show_function_cell_markers	`bool`	r
show_horizontal_scrollbar	`bool`	r
show_notebook_tabs	`bool`	r
show_vertical_scrollbar	`bool`	r
wb	`Gnm.Workbook`	r
wb_controls	[`Gnm.WorkbookControl`]	r

Class Details¶

class Gnm.WorkbookView(**kwargs)¶

Bases:: GOffice.View
Abstract:: No
Structure:: Gnm.WorkbookViewClass

classmethod new(wb)¶

Parameters:: wb (Gnm.Workbook or None) – Gnm.Workbook
Returns:: A new Gnm.WorkbookView for wb (or a fresh one if that is None).
Return type:: Gnm.WorkbookView

classmethod new_from_input(input, uri, file_opener, io_context, encoding)¶

Parameters:

input (Gsf.Input) – Gsf.Input to read data from.
uri (str or None) – URI
file_opener (GOffice.FileOpener or None) – GOffice.FileOpener
io_context (GOffice.IOContext or None) – Context to display errors.
encoding (str or None) – Encoding for file_opener that understand it

Returns:

the newly allocated Gnm.WorkbookView or None on error.

Return type:

Gnm.WorkbookView or None

Reads uri file using given file opener file_opener, or probes for a valid possibility if file_opener is None. Reports problems to io_context.

classmethod new_from_uri(uri, file_opener, io_context, encoding)¶

Parameters:

uri (str) – URI for file
file_opener (GOffice.FileOpener or None) – GOffice.FileOpener
io_context (GOffice.IOContext) – Context to display errors.
encoding (str or None) – Encoding for file_opener that understands it

Returns:

the newly allocated Gnm.WorkbookView or None on error.

Return type:

Gnm.WorkbookView or None

Reads uri file using given file opener file_opener, or probes for a valid possibility if file_opener is None. Reports problems to io_context.

save(cc)¶

Parameters:: cc (GOffice.CmdContext) – The GOffice.CmdContext that invoked the operation
Returns:: True if file was successfully saved and False otherwise.
Return type:: bool

Saves self and GOffice.workbook it’s attached to into file assigned to the GOffice.workbook using GOffice.workbook's file saver. If the GOffice.workbook has no file saver assigned to it, default file saver is used instead.

save_as(fs, uri, cc)¶

Parameters:

fs (GOffice.FileSaver) – GOffice.FileSaver object
uri (str) – URI to save as.
cc (GOffice.CmdContext) – The GOffice.CmdContext that invoked the operation

Returns:

True if file was successfully saved and False otherwise.

Return type:

bool

Saves self and GOffice.workbook it’s attached to into uri file using fs file saver. If the format sufficiently advanced make it the saver and update the uri.

save_to_output(fs, output, io_context)¶

Parameters:

fs (GOffice.FileSaver) – GOffice.FileSaver
output (Gsf.Output) – Gsf.Output
io_context (GOffice.IOContext) – GOffice.IOContext

NOTE : Temporary api until we get the new output framework.

save_to_uri(fs, uri, io_context)¶

Parameters:

fs (GOffice.FileSaver) – GOffice.FileSaver
uri (str) – destination URI
io_context (GOffice.IOContext) – GOffice.IOContext

Property Details¶

Gnm.WorkbookView.props.auto_expr_descr¶

Name:: auto-expr-descr
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Description of the automatically computed sheet function.

Gnm.WorkbookView.props.auto_expr_eval_pos¶

Name:: auto-expr-eval-pos
Type:: Gnm.EvalPos
Default Value:: None
Flags:: WRITABLE

The cell position to track.

Gnm.WorkbookView.props.auto_expr_func¶

Name:: auto-expr-func
Type:: Gnm.Func
Default Value:: None
Flags:: READABLE, WRITABLE

The automatically computed sheet function.

Gnm.WorkbookView.props.auto_expr_max_precision¶

Name:: auto-expr-max-precision
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Use maximum available precision for auto-expressions

Gnm.WorkbookView.props.auto_expr_value¶

Name:: auto-expr-value
Type:: Gnm.Value
Default Value:: None
Flags:: READABLE, WRITABLE

The current GOffice.value of the auto-expression.

Gnm.WorkbookView.props.do_auto_completion¶

Name:: do-auto-completion
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Auto-complete text

Gnm.WorkbookView.props.preferred_height¶

Name:: preferred-height
Type:: int
Default Value:: 768
Flags:: READABLE, WRITABLE

Preferred height

Gnm.WorkbookView.props.preferred_width¶

Name:: preferred-width
Type:: int
Default Value:: 1024
Flags:: READABLE, WRITABLE

Preferred width

Gnm.WorkbookView.props.protected¶

Name:: protected
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Is view protected?

Gnm.WorkbookView.props.show_extension_markers¶

Name:: show-extension-markers
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Mark each cell that fails to show the complete content

Gnm.WorkbookView.props.show_function_cell_markers¶

Name:: show-function-cell-markers
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Mark each cell containing a formula

Gnm.WorkbookView.props.show_horizontal_scrollbar¶

Name:: show-horizontal-scrollbar
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE

Show the horizontal scrollbar

Gnm.WorkbookView.props.show_notebook_tabs¶

Name:: show-notebook-tabs
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE

Show the notebook tabs for sheets

Gnm.WorkbookView.props.show_vertical_scrollbar¶

Name:: show-vertical-scrollbar
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE

Show the vertical scrollbar

Gnm.WorkbookView.props.workbook¶

Name:: workbook
Type:: Gnm.Workbook
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Gnm.Workbook