Top |
Functions
GOImage * | go_doc_add_image () |
void | go_doc_end_read () |
gint64 | go_doc_get_dirty_time () |
GOImage * | go_doc_get_image () |
GHashTable * | go_doc_get_images () |
GsfDocMetaData * | go_doc_get_meta_data () |
char const * | go_doc_get_uri () |
GOImage * | go_doc_image_fetch () |
void | go_doc_init_read () |
void | go_doc_init_write () |
gboolean | go_doc_is_dirty () |
gboolean | go_doc_is_pristine () |
void | go_doc_read () |
void | go_doc_save_image () |
void | go_doc_save_resource () |
void | go_doc_set_dirty () |
void | go_doc_set_dirty_time () |
void | go_doc_set_meta_data () |
void | go_doc_set_pristine () |
gboolean | go_doc_set_uri () |
void | go_doc_update_meta_data () |
void | go_doc_write () |
Properties
gboolean | dirty | Read / Write |
gint64 | dirty-time | Read / Write |
gboolean | pristine | Read / Write |
gchar * | uri | Read / Write |
Functions
go_doc_add_image ()
GOImage * go_doc_add_image (GODoc *doc
,char const *id
,GOImage *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.
go_doc_get_image ()
GOImage * go_doc_get_image (GODoc *doc
,char const *id
);
Returns
the GOImage is one exist with name id
. The caller does not own a
reference.
[transfer none]
go_doc_image_fetch ()
GOImage * go_doc_image_fetch (GODoc *doc
,char const *id
,GType type
);
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.
go_doc_is_pristine ()
gboolean
go_doc_is_pristine (GODoc const *doc
);
This checks to see if the doc has ever been used ( approximately )
go_doc_save_image ()
void go_doc_save_image (GODoc *doc
,char const *id
);
Saves the image with the document. Each image will be saved only once.
go_doc_save_resource ()
void go_doc_save_resource (GODoc *doc
,GOPersist const *gp
);
Saves the resource with the document. Each resource will be saved only once.
go_doc_set_dirty ()
void go_doc_set_dirty (GODoc *doc
,gboolean is_dirty
);
Changes the dirty state of doc
to is_dirty
and clears the pristine state
no matter what.
go_doc_set_dirty_time ()
void go_doc_set_dirty_time (GODoc *doc
,gint64 t
);
Changes the dirty time, i.e., the time the document was first marked dirty.
go_doc_set_meta_data ()
void go_doc_set_meta_data (GODoc *doc
,GsfDocMetaData *data
);
Adds a ref to data
.
go_doc_set_pristine ()
void go_doc_set_pristine (GODoc *doc
,gboolean pristine
);
Sets the indication of whether this document is unchanged since it was created. Note: if both "dirty" and "pristine" are being set, set "pristine" last.
go_doc_update_meta_data ()
void
go_doc_update_meta_data (GODoc *doc
);
Signal that doc
's metadata should be updated
- statistics (sheet count, word count)
- content (sheet names, bookmarks)
- reloading linked items
Property Details
The “dirty”
property
“dirty” gboolean
Whether the document has been changed.
Flags: Read / Write
Default value: FALSE
The “dirty-time”
property
“dirty-time” gint64
When the document was first changed.
Flags: Read / Write
Default value: 0
The “pristine”
property
“pristine” gboolean
Whether the document is unchanged since it was created.
Flags: Read / Write
Default value: FALSE
Signal Details
The “metadata-changed”
signal
void user_function (GODoc *godoc, gpointer user_data)
Parameters
godoc |
the object which received the signal. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
The “metadata-update”
signal
void user_function (GODoc *godoc, gpointer user_data)
Parameters
godoc |
the object which received the signal. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last