Class: GOffice::Doc

Inherits:

Object

• Object
• GOffice::Doc

Defined in:

(unknown)

Instance Method Summary

• #add_image(id, image) ⇒ GOffice::Image

  Adds image to the document if no such image already exists.

• #bump_state ⇒ nil

  Sets the current state of the document to a fresh id.

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

  Dirty.

• #dirty_time ⇒ Integer

  Dirty-time.

• #dirty_time=(dirty_time) ⇒ Integer
• #end_read ⇒ nil
• #get_image(id) ⇒ GOffice::Image

  reference.

• #image_fetch(id, type) ⇒ GOffice::Image

  Searches for a #GOImage with name id in the document image buffer and creates one if needed.

• #images ⇒ GLib::HashTable<GObject>

  The images registered inside the document.

• #init_read(input) ⇒ nil
• #init_write(output) ⇒ nil
• #is_dirty ⇒ Boolean

  TRUE if doc has been modified.

• #is_pristine ⇒ Boolean

  This checks to see if the doc has ever been used ( approximately ).

• #meta_data ⇒ Gsf::DocMetaData

  doc's metadata.

• #meta_data=(data) ⇒ nil

  Adds a ref to data.

• #modtime ⇒ GLib::DateTime

  Modtime.

• #modtime=(modtime) ⇒ GLib::DateTime
• #pristine=(pristine) ⇒ Boolean
• #pristine? ⇒ Boolean

  Pristine.

• #read(xin, attrs) ⇒ nil
• #save_image(id) ⇒ nil

  Saves the image with the document.

• #save_resource(gp) ⇒ nil

  Saves the resource with the document.

• #saved_state ⇒ Integer

  Saved-state.

• #saved_state=(saved_state) ⇒ Integer
• #state ⇒ Integer

  State.

• #state=(state) ⇒ Integer
• #update_meta_data ⇒ nil

  Signal that doc's metadata should be updated - statistics (sheet count, word count) - content (sheet names, bookmarks) - reloading linked items.

• #uri ⇒ String

  Uri.

• #uri=(uri) ⇒ String
• #write(output) ⇒ nil

Instance Method Details

#add_image(id, image) ⇒ GOffice::Image

Adds image to the document if no such image already exists. The name of the returned image might be different from id, even if given. an identical image for which the owner does not own a reference.

Parameters:

• id (String) —

  the image name or nil

• image (GOffice::Image) —

  a #GOImage

Returns:

• (GOffice::Image) —

  either image, in which case the document adds a reference on it, or

#bump_state ⇒ nil

Sets the current state of the document to a fresh id.

Returns:

• (nil)

#dirty=(dirty) ⇒ Boolean

Parameters:

• dirty (Boolean)

Returns:

• (Boolean) —

  dirty

• (Boolean) —

  dirty

#dirty? ⇒ Boolean

Returns dirty.

Returns:

• (Boolean) —

  dirty

#dirty_time ⇒ Integer

Returns dirty-time.

Returns:

• (Integer) —

  dirty-time

#dirty_time=(dirty_time) ⇒ Integer

Parameters:

• dirty_time (Integer)

Returns:

• (Integer) —

  dirty-time

• (Integer) —

  dirty-time

#end_read ⇒ nil

Returns:

• (nil)

#get_image(id) ⇒ GOffice::Image

reference.

Parameters:

• id (String) —

  the image name

Returns:

• (GOffice::Image) —

  the #GOImage is one exist with name id. The caller does not own a

#image_fetch(id, type) ⇒ GOffice::Image

Searches for a #GOImage with name id in the document image buffer and creates one if needed. The caller does not own a reference on the returned #GOImage. This function must be called after a call to go_doc_init_read(), otherwise it will emit a critical and return NULL.

Parameters:

• id (String) —

  the name for the new image.

• type (GLib::Type) —

  the type of the #GOImage to create if needed.

Returns:

• (GOffice::Image) —

  the found or created #GOImage.

#images ⇒ GLib::HashTable<GObject>

Returns the images registered inside the document.

Returns:

• (GLib::HashTable<GObject>) —

  the images registered inside the document

#init_read(input) ⇒ nil

Parameters:

• input (Gsf::Input)

Returns:

• (nil)

#init_write(output) ⇒ nil

Parameters:

• output (Gsf::XMLOut)

Returns:

• (nil)

#is_dirty ⇒ Boolean

Returns TRUE if doc has been modified.

Returns:

• (Boolean) —

  TRUE if doc has been modified.

#is_pristine ⇒ Boolean

This checks to see if the doc has ever been used ( approximately )

Returns:

• (Boolean) —

  true if we can discard this doc.

#meta_data ⇒ Gsf::DocMetaData

Returns doc's metadata.

Returns:

• (Gsf::DocMetaData) —

  doc's metadata

#meta_data=(data) ⇒ nil

Adds a ref to data.

Parameters:

• data (Gsf::DocMetaData) —

  Gsf::DocMetaData

Returns:

• (nil)

#modtime ⇒ GLib::DateTime

Returns modtime.

Returns:

• (GLib::DateTime) —

  modtime

#modtime=(modtime) ⇒ GLib::DateTime

Parameters:

• modtime (GLib::DateTime)

Returns:

• (GLib::DateTime) —

  modtime

• (GLib::DateTime) —

  modtime

#pristine=(pristine) ⇒ Boolean

Parameters:

• pristine (Boolean)

Returns:

• (Boolean) —

  pristine

• (Boolean) —

  pristine

#pristine? ⇒ Boolean

Returns pristine.

Returns:

• (Boolean) —

  pristine

#read(xin, attrs) ⇒ nil

Parameters:

• xin (Gsf::XMLIn)
• attrs (libxml2::Char)

Returns:

• (nil)

#save_image(id) ⇒ nil

Saves the image with the document. Each image will be saved only once.

Parameters:

• id (String) —

  the Id of the #GOImage to save

Returns:

• (nil)

#save_resource(gp) ⇒ nil

Saves the resource with the document. Each resource will be saved only once.

Parameters:

• gp (GOffice::Persist) —

  the #GOPersist to save

Returns:

• (nil)

#saved_state ⇒ Integer

Returns saved-state.

Returns:

• (Integer) —

  saved-state

#saved_state=(saved_state) ⇒ Integer

Parameters:

• saved_state (Integer)

Returns:

• (Integer) —

  saved-state

• (Integer) —

  saved-state

#state ⇒ Integer

Returns state.

Returns:

• (Integer) —

  state

#state=(state) ⇒ Integer

Parameters:

• state (Integer)

Returns:

• (Integer) —

  state

• (Integer) —

  state

#update_meta_data ⇒ nil

Signal that doc's metadata should be updated - statistics (sheet count, word count) - content (sheet names, bookmarks) - reloading linked items

Returns:

• (nil)

#uri ⇒ String

Returns uri.

Returns:

• (String) —

  uri

#uri=(uri) ⇒ String

Parameters:

• uri (String)

Returns:

• (String) —

  uri

• (String) —

  uri

#write(output) ⇒ nil

Parameters:

• output (Gsf::XMLOut)

Returns:

• (nil)