TnyFolderStats

TnyFolderStats — A stats object about a folder

Synopsis




                    TnyFolderStats;
TnyFolderStats*     tny_folder_stats_new                (TnyFolder *folder);
guint               tny_folder_stats_get_unread_count   (TnyFolderStats *self);
guint               tny_folder_stats_get_all_count      (TnyFolderStats *self);
gsize               tny_folder_stats_get_local_size     (TnyFolderStats *self);
void                tny_folder_stats_set_local_size     (TnyFolderStats *self,
                                                         gsize local_size);
TnyFolder*          tny_folder_stats_get_folder         (TnyFolderStats *self);

Object Hierarchy


  GObject
   +----TnyFolderStats

Description

A object with some statistical information about a TnyFolder

Details

TnyFolderStats

typedef struct _TnyFolderStats TnyFolderStats;

Some statistics about a TnyFolder

free-function: g_object_unref


tny_folder_stats_new ()

TnyFolderStats*     tny_folder_stats_new                (TnyFolder *folder);

Creates a stats object for folder

folder : a TnyFolder
Returns : a new TnyFolderStats

Since 1.0 audience: application-developer


tny_folder_stats_get_unread_count ()

guint               tny_folder_stats_get_unread_count   (TnyFolderStats *self);

Get the amount of unread messages in self.

self : a TnyFolderStats
Returns : the amount of unread messages

Since 1.0 audience: application-developer


tny_folder_stats_get_all_count ()

guint               tny_folder_stats_get_all_count      (TnyFolderStats *self);

Get the amount of messages in self.

self : a TnyFolderStats
Returns : the amount of messages

Since 1.0 audience: application-developer


tny_folder_stats_get_local_size ()

gsize               tny_folder_stats_get_local_size     (TnyFolderStats *self);

Get the local disk space that self is consuming in its cache.

self : a TnyFolderStats
Returns : local size

Since 1.0 audience: application-developer


tny_folder_stats_set_local_size ()

void                tny_folder_stats_set_local_size     (TnyFolderStats *self,
                                                         gsize local_size);

Set the local disk space that self is consuming. This is an internal function not intended for application developers to alter.

self : a TnyFolderStats
local_size : the local size of the folder

Since 1.0 audience: tinymail-developer


tny_folder_stats_get_folder ()

TnyFolder*          tny_folder_stats_get_folder         (TnyFolderStats *self);

Get the folder of self. The return value of this method must be unreferenced after use

self : a TnyFolderStats
Returns : (caller-owns): the TnyFolder instance related to self

Since 1.0 audience: application-developer