StoreSummary
Object Hierarchy:
Description:
[ CCode ( type_id = "camel_store_summary_get_type ()" ) ]
public class StoreSummary : Object
Content:
Creation methods:
Methods:
- public void add (owned StoreInfo info)
The info
record should have been generated by calling one
of the info_new_*() functions, as it will be free'd based on the summary class.
- public unowned StoreInfo? add_from_path (string path)
Build a new info record based on the name, and add it to the summary.
- public GenericArray<StoreInfo> array ()
Obtain a copy of the summary array.
- public void array_free (owned GenericArray<StoreInfo> array)
Free the folder summary array.
- public bool connect_folder_summary (string path, FolderSummary folder_summary)
Connects listeners for count changes on folder_summary
to
keep CamelStoreInfo.
- public int count ()
Get the number of summary items stored in this summary.
- public bool disconnect_folder_summary (FolderSummary folder_summary)
- public StoreInfo info_new ()
Allocate a new StoreInfo
, suitable for adding to this summary.
- public StoreInfo info_ref (StoreInfo info)
Add an extra reference to info
.
- public void info_unref (owned StoreInfo info)
Unref and potentially free info
, and all associated
memory.
- public int load ()
Load the summary off disk.
- public StoreInfo? path (string path)
Retrieve a summary item by path name.
- public void remove (StoreInfo info)
Remove a specific info
record from the summary.
- public void remove_path (string path)
Remove a specific info record from the summary, by path
.
- public int save ()
Writes the summary to disk.
- public void set_filename (string filename)
Set the filename where the summary will be loaded to/saved from.
- public void sort (CompareDataFunc compare_func)
Sorts the array of the folders using the compare_func
.
- public virtual void store_info_free (owned StoreInfo info)
- public virtual StoreInfo store_info_load (FileStream file)
- public virtual StoreInfo store_info_new (string path)
- public virtual int store_info_save (FileStream file, StoreInfo info)
- public virtual void store_info_set_value (StoreInfo info, int type, string value)
- public virtual int summary_header_load (FileStream file)
- public virtual int summary_header_save (FileStream file)
- public void touch ()
Mark the summary as changed, so that a save will force it to be
written back to disk.
Inherited Members:
All known members inherited from class GLib.Object
- @get
- @new
- @ref
- @set
- add_toggle_ref
- add_weak_pointer
- bind_property
- connect
- constructed
- disconnect
- dispose
- dup_data
- dup_qdata
- force_floating
- freeze_notify
- get_class
- get_data
- get_property
- get_qdata
- get_type
- getv
- interface_find_property
- interface_install_property
- interface_list_properties
- is_floating
- new_valist
- new_with_properties
- newv
- notify
- notify_property
- ref_count
- ref_sink
- remove_toggle_ref
- remove_weak_pointer
- replace_data
- replace_qdata
- set_data
- set_data_full
- set_property
- set_qdata
- set_qdata_full
- set_valist
- setv
- steal_data
- steal_qdata
- thaw_notify
- unref
- watch_closure
- weak_ref
- weak_unref