SeahorseContext

SeahorseContext — This is where all the action in a Seahorse process comes together.

Synopsis


#include <libseahorse/seahorse-context.h>

                    SeahorseContextPrivate;
                    SeahorseContext;
void                (*SeahorseObjectFunc)               (struct _SeahorseObject *obj,
                                                         gpointer user_data);
#define             SCTX_APP                            ()
SeahorseContext*    seahorse_context_for_app            (void);
SeahorseContext*    seahorse_context_new                (guint flags);
void                seahorse_context_destroy            (SeahorseContext *sctx);
#define             seahorse_context_is_daemon          (ctx)
void                seahorse_context_add_source         (SeahorseContext *sctx,
                                                         SeahorseSource *sksrc);
void                seahorse_context_take_source        (SeahorseContext *sctx,
                                                         SeahorseSource *sksrc);
void                seahorse_context_remove_source      (SeahorseContext *sctx,
                                                         SeahorseSource *sksrc);
SeahorseSource*     seahorse_context_find_source        (SeahorseContext *sctx,
                                                         GQuark ktype,
                                                         SeahorseLocation location);
GSList*             seahorse_context_find_sources       (SeahorseContext *sctx,
                                                         GQuark ktype,
                                                         SeahorseLocation location);
SeahorseSource*     seahorse_context_remote_source      (SeahorseContext *sctx,
                                                         const gchar *uri);
void                seahorse_context_add_object         (SeahorseContext *sctx,
                                                         struct _SeahorseObject *sobj);
void                seahorse_context_take_object        (SeahorseContext *sctx,
                                                         struct _SeahorseObject *sobj);
guint               seahorse_context_get_count          (SeahorseContext *sctx);
struct _SeahorseObject* seahorse_context_get_object     (SeahorseContext *sctx,
                                                         SeahorseSource *sksrc,
                                                         GQuark id);
GList*              seahorse_context_get_objects        (SeahorseContext *sctx,
                                                         SeahorseSource *sksrc);
struct _SeahorseObject* seahorse_context_find_object    (SeahorseContext *sctx,
                                                         GQuark id,
                                                         SeahorseLocation location);
GList*              seahorse_context_find_objects       (SeahorseContext *sctx,
                                                         GQuark ktype,
                                                         SeahorseUsage usage,
                                                         SeahorseLocation location);
GList*              seahorse_context_find_objects_full  (SeahorseContext *self,
                                                         struct _SeahorseObjectPredicate *skpred);
void                seahorse_context_for_objects_full   (SeahorseContext *self,
                                                         struct _SeahorseObjectPredicate *skpred,
                                                         SeahorseObjectFunc func,
                                                         gpointer user_data);
void                seahorse_context_verify_objects     (SeahorseContext *self);
void                seahorse_context_remove_object      (SeahorseContext *sctx,
                                                         struct _SeahorseObject *sobj);
SeahorseServiceDiscovery * seahorse_context_get_discovery
                                                        (SeahorseContext *sctx);
struct _SeahorseObject * seahorse_context_get_default_key
                                                        (SeahorseContext *sctx);
void                seahorse_context_refresh_auto       (SeahorseContext *sctx);
SeahorseOperation*  seahorse_context_search_remote      (SeahorseContext *sctx,
                                                         const gchar *search);
SeahorseOperation*  seahorse_context_transfer_objects   (SeahorseContext *sctx,
                                                         GList *objs,
                                                         SeahorseSource *to);
SeahorseOperation*  seahorse_context_retrieve_objects   (SeahorseContext *sctx,
                                                         GQuark ktype,
                                                         GSList *ids,
                                                         SeahorseSource *to);
GList*              seahorse_context_discover_objects   (SeahorseContext *sctx,
                                                         GQuark ktype,
                                                         GSList *ids);
struct _SeahorseObject* seahorse_context_object_from_dbus
                                                        (SeahorseContext *sctx,
                                                         const gchar *dbusid);
gchar*              seahorse_context_object_to_dbus     (SeahorseContext *sctx,
                                                         struct _SeahorseObject *sobj);
gchar*              seahorse_context_id_to_dbus         (SeahorseContext *sctx,
                                                         GQuark id);
GQuark              (*SeahorseCanonizeFunc)             (const gchar *id);
GQuark              seahorse_context_canonize_id        (GQuark ktype,
                                                         const gchar *id);

Description

Details

SeahorseContextPrivate

typedef struct _SeahorseContextPrivate SeahorseContextPrivate;


SeahorseContext

typedef struct {
    GtkObject               parent;
    
    gboolean                is_daemon;
} SeahorseContext;

This is where all the action in a Seahorse process comes together.

- Usually there's only one SeahorseContext per process created by passing SEAHORSE_CONTEXT_APP to seahorse_context_new(), and accessed via the SCTX_APP macro. - Retains the list of all valid struct _SeahorseObject objects. - Has a collection of SeahorseSource objects which add objects to the SeahorseContext.

Signals: added: A object was added to the context. removed: A object was removed from the context. changed: A object changed. destroy: The context was destroyed.

GtkObject parent;

The parent GtkObject

gboolean is_daemon;

a gboolean indicating whether the context is being used in a program that is daemonized

SeahorseObjectFunc ()

void                (*SeahorseObjectFunc)               (struct _SeahorseObject *obj,
                                                         gpointer user_data);

obj :

user_data :


SCTX_APP()

#define             SCTX_APP()                          (seahorse_context_for_app ())


seahorse_context_for_app ()

SeahorseContext*    seahorse_context_for_app            (void);

Returns :

the application main context as SeahorseContext

seahorse_context_new ()

SeahorseContext*    seahorse_context_new                (guint flags);

flags :

Returns :


seahorse_context_destroy ()

void                seahorse_context_destroy            (SeahorseContext *sctx);

Emits the destroy signal for sctx.

sctx :

SeahorseContext to destroy

seahorse_context_is_daemon()

#define             seahorse_context_is_daemon(ctx)     ((ctx)->is_daemon)

ctx :


seahorse_context_add_source ()

void                seahorse_context_add_source         (SeahorseContext *sctx,
                                                         SeahorseSource *sksrc);

sctx :

sksrc :


seahorse_context_take_source ()

void                seahorse_context_take_source        (SeahorseContext *sctx,
                                                         SeahorseSource *sksrc);

sctx :

sksrc :


seahorse_context_remove_source ()

void                seahorse_context_remove_source      (SeahorseContext *sctx,
                                                         SeahorseSource *sksrc);

sctx :

sksrc :


seahorse_context_find_source ()

SeahorseSource*     seahorse_context_find_source        (SeahorseContext *sctx,
                                                         GQuark ktype,
                                                         SeahorseLocation location);

sctx :

ktype :

location :

Returns :


seahorse_context_find_sources ()

GSList*             seahorse_context_find_sources       (SeahorseContext *sctx,
                                                         GQuark ktype,
                                                         SeahorseLocation location);

sctx :

the context to work with

ktype :

the type of the key to match. Or SEAHORSE_TAG_INVALID

location :

the location to match. Or SEAHORSE_LOCATION_INVALID

Returns :

A list of seahorse sources matching ktype and location as GSList. Must be freed with g_slist_free

seahorse_context_remote_source ()

SeahorseSource*     seahorse_context_remote_source      (SeahorseContext *sctx,
                                                         const gchar *uri);

sctx :

uri :

Returns :


seahorse_context_add_object ()

void                seahorse_context_add_object         (SeahorseContext *sctx,
                                                         struct _SeahorseObject *sobj);

sctx :

sobj :


seahorse_context_take_object ()

void                seahorse_context_take_object        (SeahorseContext *sctx,
                                                         struct _SeahorseObject *sobj);

sctx :

sobj :


seahorse_context_get_count ()

guint               seahorse_context_get_count          (SeahorseContext *sctx);

sctx :

Returns :


seahorse_context_get_object ()

struct _SeahorseObject* seahorse_context_get_object     (SeahorseContext *sctx,
                                                         SeahorseSource *sksrc,
                                                         GQuark id);

sctx :

sksrc :

id :

Returns :


seahorse_context_get_objects ()

GList*              seahorse_context_get_objects        (SeahorseContext *sctx,
                                                         SeahorseSource *sksrc);

sctx :

sksrc :

Returns :


seahorse_context_find_object ()

struct _SeahorseObject* seahorse_context_find_object    (SeahorseContext *sctx,
                                                         GQuark id,
                                                         SeahorseLocation location);

sctx :

id :

location :

Returns :


seahorse_context_find_objects ()

GList*              seahorse_context_find_objects       (SeahorseContext *sctx,
                                                         GQuark ktype,
                                                         SeahorseUsage usage,
                                                         SeahorseLocation location);

sctx :

ktype :

usage :

location :

Returns :


seahorse_context_find_objects_full ()

GList*              seahorse_context_find_objects_full  (SeahorseContext *self,
                                                         struct _SeahorseObjectPredicate *skpred);

self :

skpred :

Returns :


seahorse_context_for_objects_full ()

void                seahorse_context_for_objects_full   (SeahorseContext *self,
                                                         struct _SeahorseObjectPredicate *skpred,
                                                         SeahorseObjectFunc func,
                                                         gpointer user_data);

self :

skpred :

func :

user_data :


seahorse_context_verify_objects ()

void                seahorse_context_verify_objects     (SeahorseContext *self);

self :


seahorse_context_remove_object ()

void                seahorse_context_remove_object      (SeahorseContext *sctx,
                                                         struct _SeahorseObject *sobj);

sctx :

sobj :


seahorse_context_get_discovery ()

SeahorseServiceDiscovery * seahorse_context_get_discovery
                                                        (SeahorseContext *sctx);

Warning

seahorse_context_get_discovery is deprecated and should not be used in newly-written code. No replacement

Gets the Service Discovery object for this context.

sctx :

SeahorseContext object

Returns :

The Service Discovery object.

seahorse_context_get_default_key ()

struct _SeahorseObject * seahorse_context_get_default_key
                                                        (SeahorseContext *sctx);

Warning

seahorse_context_get_default_key is deprecated and should not be used in newly-written code. No replacement

sctx :

Current SeahorseContext

Returns :

the secret key that's the default key

seahorse_context_refresh_auto ()

void                seahorse_context_refresh_auto       (SeahorseContext *sctx);

sctx :


seahorse_context_search_remote ()

SeahorseOperation*  seahorse_context_search_remote      (SeahorseContext *sctx,
                                                         const gchar *search);

sctx :

search :

Returns :


seahorse_context_transfer_objects ()

SeahorseOperation*  seahorse_context_transfer_objects   (SeahorseContext *sctx,
                                                         GList *objs,
                                                         SeahorseSource *to);

sctx :

objs :

to :

Returns :


seahorse_context_retrieve_objects ()

SeahorseOperation*  seahorse_context_retrieve_objects   (SeahorseContext *sctx,
                                                         GQuark ktype,
                                                         GSList *ids,
                                                         SeahorseSource *to);

sctx :

ktype :

ids :

to :

Returns :


seahorse_context_discover_objects ()

GList*              seahorse_context_discover_objects   (SeahorseContext *sctx,
                                                         GQuark ktype,
                                                         GSList *ids);

sctx :

ktype :

ids :

Returns :


seahorse_context_object_from_dbus ()

struct _SeahorseObject* seahorse_context_object_from_dbus
                                                        (SeahorseContext *sctx,
                                                         const gchar *dbusid);

sctx :

dbusid :

Returns :


seahorse_context_object_to_dbus ()

gchar*              seahorse_context_object_to_dbus     (SeahorseContext *sctx,
                                                         struct _SeahorseObject *sobj);

sctx :

sobj :

Returns :


seahorse_context_id_to_dbus ()

gchar*              seahorse_context_id_to_dbus         (SeahorseContext *sctx,
                                                         GQuark id);

sctx :

id :

Returns :


SeahorseCanonizeFunc ()

GQuark              (*SeahorseCanonizeFunc)             (const gchar *id);

id :

Returns :


seahorse_context_canonize_id ()

GQuark              seahorse_context_canonize_id        (GQuark ktype,
                                                         const gchar *id);

ktype :

id :

Returns :