TnyFolderStoreChange

TnyFolderStoreChange — A type with the changes between two states of a folder store

Synopsis




#define             TNY_TYPE_FOLDER_STORE_CHANGE_CHANGED
                    TnyFolderStoreChange;
GType               tny_folder_store_change_changed_get_type
                                                        (void);
TnyFolderStoreChange* tny_folder_store_change_new       (TnyFolderStore *folderstore);
void                tny_folder_store_change_add_created_folder
                                                        (TnyFolderStoreChange *self,
                                                         TnyFolder *folder);
void                tny_folder_store_change_add_removed_folder
                                                        (TnyFolderStoreChange *self,
                                                         TnyFolder *folder);
void                tny_folder_store_change_get_created_folders
                                                        (TnyFolderStoreChange *self,
                                                         TnyList *folders);
void                tny_folder_store_change_get_removed_folders
                                                        (TnyFolderStoreChange *self,
                                                         TnyList *folders);
void                tny_folder_store_change_reset       (TnyFolderStoreChange *self);
TnyFolderStore*     tny_folder_store_change_get_folder_store
                                                        (TnyFolderStoreChange *self);
TnyFolderStoreChangeChanged tny_folder_store_change_get_changed
                                                        (TnyFolderStoreChange *self);

Object Hierarchy


  GObject
   +----TnyFolderStoreChange

Description

A type with the delta or changes between two states of a TnyFolderStore. The TnyFolderStoreObserver will receive instances of this type as information about what got changed.

Details

TNY_TYPE_FOLDER_STORE_CHANGE_CHANGED

#define TNY_TYPE_FOLDER_STORE_CHANGE_CHANGED (tny_folder_store_change_changed_get_type())


TnyFolderStoreChange

typedef struct _TnyFolderStoreChange TnyFolderStoreChange;

A delta of changes, used by TnyFolderStoreObserver

free-function: g_object_unref


tny_folder_store_change_changed_get_type ()

GType               tny_folder_store_change_changed_get_type
                                                        (void);

GType system helper function

Returns : a GType

tny_folder_store_change_new ()

TnyFolderStoreChange* tny_folder_store_change_new       (TnyFolderStore *folderstore);

Creates a changeset for folderstore

folderstore : a TnyFolderStore
Returns : (caller-owns): a new TnyFolderStoreChange instance

Since 1.0 audience: application-developer


tny_folder_store_change_add_created_folder ()

void                tny_folder_store_change_add_created_folder
                                                        (TnyFolderStoreChange *self,
                                                         TnyFolder *folder);

Add folder to the changeset of created folders. This is an internal function not intended for application developers to alter.

self : a TnyFolderStoreChange
folder : a TnyFolder to add to the changeset

Since 1.0 audience: tinymail-developer


tny_folder_store_change_add_removed_folder ()

void                tny_folder_store_change_add_removed_folder
                                                        (TnyFolderStoreChange *self,
                                                         TnyFolder *folder);

Add folder to the changeset of removed folders. This is an internal function not intended for application developers to alter.

self : a TnyFolderStoreChange
folder : a TnyFolder to add to the changeset

Since 1.0 audience: tinymail-developer


tny_folder_store_change_get_created_folders ()

void                tny_folder_store_change_get_created_folders
                                                        (TnyFolderStoreChange *self,
                                                         TnyList *folders);

Get the created folders in self.

self : a TnyFolderStoreChange
folders : a TnyList where the created folders will be prepended to

Since 1.0 audience: application-developer


tny_folder_store_change_get_removed_folders ()

void                tny_folder_store_change_get_removed_folders
                                                        (TnyFolderStoreChange *self,
                                                         TnyList *folders);

Get the removed folders in this changeset

self : a TnyFolderStoreChange
folders : a TnyList where the removed folders will be prepended to

Since 1.0 audience: application-developer


tny_folder_store_change_reset ()

void                tny_folder_store_change_reset       (TnyFolderStoreChange *self);

Reset the state of self. This is an internal function not intended for application developers to alter.

Since 1.0 audience: tinymail-developer


tny_folder_store_change_get_folder_store ()

TnyFolderStore*     tny_folder_store_change_get_folder_store
                                                        (TnyFolderStoreChange *self);

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

self : a TnyFolderStoreChange
Returns : (caller-owns): the TnyFolderStore related to this changeset

Since 1.0 audience: application-developer


tny_folder_store_change_get_changed ()

TnyFolderStoreChangeChanged tny_folder_store_change_get_changed
                                                        (TnyFolderStoreChange *self);

Get a flags field with all the changed things

self : a TnyFolderStoreChange
Returns : the changed items as a flags field

Since 1.0 audience: application-developer