Class: GOffice::FileSaver

Inherits:

Object

• Object
• GOffice::FileSaver

Defined in:

(unknown)

Overview

File saver base class.

Class Method Summary

• .default ⇒ GOffice::FileSaver

  Finds file saver registered as default saver with the highest priority.

• .for_file_name(file_name) ⇒ GOffice::FileSaver

  Searches for file saver matching the given file_name, registered using go_file_saver_register.

• .for_id(id) ⇒ GOffice::FileSaver

  Searches for file saver with given id, registered using go_file_saver_register or register_file_opener_as_default.

• .for_mime_type(mime_type) ⇒ GOffice::FileSaver

  mime_type.

Instance Method Summary

• #description ⇒ String

  Description.

• #description=(description) ⇒ String
• #extension ⇒ String

  Extension.

• #extension=(extension) ⇒ String
• #format_level ⇒ GOffice::FileFormatLevel

  Format-level.

• #format_level=(format_level) ⇒ GOffice::FileFormatLevel
• #id ⇒ String

  Id.

• #id=(id) ⇒ String
• #initialize(id, extension, description, level, save_func) ⇒ GOffice::FileSaver constructor

  Creates new GOFile::Saver object.

• #interactive_only=(interactive_only) ⇒ Boolean
• #interactive_only? ⇒ Boolean

  Interactive-only.

• #mime_type ⇒ String

  Mime-type.

• #mime_type=(mime_type) ⇒ String
• #overwrite=(overwrite) ⇒ Boolean
• #overwrite? ⇒ Boolean

  Overwrite.

• #overwrite_files=(overwrite) ⇒ nil

  Changes behaviour of the saver when saving a file.

• #register ⇒ nil

  Adds fs saver to the list of available file savers, making it available for the user when selecting file format for save.

• #register_as_default(priority) ⇒ nil

  Adds fs saver to the list of available file savers, making it available for the user when selecting file format for save.

• #save(io_context, view, output) ⇒ nil

  Saves wbv and the workbook it is attached to into output stream.

• #save_scope ⇒ GOffice::FileSaveScope

  The save scope of fs.

• #save_scope=(scope) ⇒ nil
• #scope ⇒ GOffice::FileSaveScope

  Scope.

• #scope=(scope) ⇒ GOffice::FileSaveScope
• #set_export_options(doc, options) ⇒ Boolean
• #sheet_selection=(sheet_selection) ⇒ Boolean
• #sheet_selection? ⇒ Boolean

  Sheet-selection.

• #unregister ⇒ nil

  Removes fs saver from list of available file savers.

Constructor Details

#initialize(id, extension, description, level, save_func) ⇒ GOffice::FileSaver

Creates new GOFile::Saver object. Optional id will be used after registering it with go_file_saver_register or go_file_saver_register_as_default function.

Parameters:

• id (String) —

  ID of the saver

• extension (String) —

  Default extension of saved files

• description (String) —

  Description of supported file format

• level (GOffice::FileFormatLevel) —

  File format level

• save_func (GOffice::FileSaverSaveFunc) —

  Pointer to "save" function

Class Method Details

.default ⇒ GOffice::FileSaver

Finds file saver registered as default saver with the highest priority. Reference count for the saver is NOT incremented. default saver.

Returns:

• (GOffice::FileSaver) —

  GOFile::Saver for the highest priority

.for_file_name(file_name) ⇒ GOffice::FileSaver

Searches for file saver matching the given file_name, registered using go_file_saver_register.

Parameters:

• file_name (String) —

  name

Returns:

• (GOffice::FileSaver) —

  GOFile::Saver for file_name

.for_id(id) ⇒ GOffice::FileSaver

Searches for file saver with given id, registered using go_file_saver_register or register_file_opener_as_default.

Parameters:

• id (String) —

  File saver's ID

Returns:

• (GOffice::FileSaver) —

  GOFile::Saver with given id.

.for_mime_type(mime_type) ⇒ GOffice::FileSaver

mime_type.

Parameters:

• mime_type (String) —

  A mime type

Returns:

• (GOffice::FileSaver) —

  A GOFile::Saver object associated with

Instance Method Details

#description ⇒ String

Returns description.

Returns:

• (String) —

  description

#description=(description) ⇒ String

Parameters:

• description (String)

Returns:

• (String) —

  description

• (String) —

  description

#extension ⇒ String

Returns extension.

Returns:

• (String) —

  extension

#extension=(extension) ⇒ String

Parameters:

• extension (String)

Returns:

• (String) —

  extension

• (String) —

  extension

#format_level ⇒ GOffice::FileFormatLevel

Returns format-level.

Returns:

• (GOffice::FileFormatLevel) —

  format-level

#format_level=(format_level) ⇒ GOffice::FileFormatLevel

Parameters:

• format_level (GOffice::FileFormatLevel)

Returns:

• (GOffice::FileFormatLevel) —

  format-level

• (GOffice::FileFormatLevel) —

  format-level

#id ⇒ String

Returns id.

Returns:

• (String) —

  id

#id=(id) ⇒ String

Parameters:

• id (String)

Returns:

• (String) —

  id

• (String) —

  id

#interactive_only=(interactive_only) ⇒ Boolean

Parameters:

• interactive_only (Boolean)

Returns:

• (Boolean) —

  interactive-only

• (Boolean) —

  interactive-only

#interactive_only? ⇒ Boolean

Returns interactive-only.

Returns:

• (Boolean) —

  interactive-only

#mime_type ⇒ String

Returns mime-type.

Returns:

• (String) —

  mime-type

#mime_type=(mime_type) ⇒ String

Parameters:

• mime_type (String)

Returns:

• (String) —

  mime-type

• (String) —

  mime-type

#overwrite=(overwrite) ⇒ Boolean

Parameters:

• overwrite (Boolean)

Returns:

• (Boolean) —

  overwrite

• (Boolean) —

  overwrite

#overwrite? ⇒ Boolean

Returns overwrite.

Returns:

• (Boolean) —

  overwrite

#overwrite_files=(overwrite) ⇒ nil

Changes behaviour of the saver when saving a file. If overwrite is set to TRUE, existing file will be overwritten. Otherwise, the saver will report an error without saving anything.

Parameters:

• overwrite (Boolean) —

  A boolean value saying whether the saver should overwrite existing files.

Returns:

• (nil)

#register ⇒ nil

Adds fs saver to the list of available file savers, making it available for the user when selecting file format for save.

Returns:

• (nil)

#register_as_default(priority) ⇒ nil

Adds fs saver to the list of available file savers, making it available for the user when selecting file format for save. The saver is also marked as default saver with given priority. When Gnumeric needs default file saver, it chooses the one with the highest priority. Recommended range for priority is [0, 100].

Parameters:

• priority (Integer) —

  Saver's priority

Returns:

• (nil)

#save(io_context, view, output) ⇒ nil

Saves wbv and the workbook it is attached to into output stream. Results are reported using io_context object, use go_io_error_occurred to find out if operation was successful. It's possible that file_name is created and contain some data if operation fails, you should remove the file in that case.

Parameters:

• io_context (GOffice::IOContext) —

  Context for i/o operation

• view (GOffice::View) —

  Go::View

• output (Gsf::Output) —

  Output stream

Returns:

• (nil)

#save_scope ⇒ GOffice::FileSaveScope

Returns The save scope of fs.

Returns:

• (GOffice::FileSaveScope) —

  The save scope of fs.

#save_scope=(scope) ⇒ nil

Parameters:

• scope (GOffice::FileSaveScope)

Returns:

• (nil)

#scope ⇒ GOffice::FileSaveScope

Returns scope.

Returns:

• (GOffice::FileSaveScope) —

  scope

#scope=(scope) ⇒ GOffice::FileSaveScope

Parameters:

• scope (GOffice::FileSaveScope)

Returns:

• (GOffice::FileSaveScope) —

  scope

• (GOffice::FileSaveScope) —

  scope

#set_export_options(doc, options) ⇒ Boolean

Parameters:

• doc (GOffice::Doc)
• options (String)

Returns:

• (Boolean)

#sheet_selection=(sheet_selection) ⇒ Boolean

Parameters:

• sheet_selection (Boolean)

Returns:

• (Boolean) —

  sheet-selection

• (Boolean) —

  sheet-selection

#sheet_selection? ⇒ Boolean

Returns sheet-selection.

Returns:

• (Boolean) —

  sheet-selection

#unregister ⇒ nil

Removes fs saver from list of available file savers. Reference count for the saver is decremented inside the function.

Returns:

• (nil)