diff options
author | Matthew Barnes <mbarnes@redhat.com> | 2012-12-14 20:25:24 +0800 |
---|---|---|
committer | Matthew Barnes <mbarnes@redhat.com> | 2012-12-15 21:16:36 +0800 |
commit | 5e2efa2cd4ac7891fdf316dafd9ab249086e842a (patch) | |
tree | fe4b9c1ef8d783281789c4a378253aa41af35db3 /e-util/gal-view-instance.h | |
parent | 63cff95414fc76e6d58a274ffebe019cd6feb0a5 (diff) | |
download | gsoc2013-evolution-5e2efa2cd4ac7891fdf316dafd9ab249086e842a.tar gsoc2013-evolution-5e2efa2cd4ac7891fdf316dafd9ab249086e842a.tar.gz gsoc2013-evolution-5e2efa2cd4ac7891fdf316dafd9ab249086e842a.tar.bz2 gsoc2013-evolution-5e2efa2cd4ac7891fdf316dafd9ab249086e842a.tar.lz gsoc2013-evolution-5e2efa2cd4ac7891fdf316dafd9ab249086e842a.tar.xz gsoc2013-evolution-5e2efa2cd4ac7891fdf316dafd9ab249086e842a.tar.zst gsoc2013-evolution-5e2efa2cd4ac7891fdf316dafd9ab249086e842a.zip |
Finish adding symbols to libeutil API docs.
Diffstat (limited to 'e-util/gal-view-instance.h')
-rw-r--r-- | e-util/gal-view-instance.h | 107 |
1 files changed, 64 insertions, 43 deletions
diff --git a/e-util/gal-view-instance.h b/e-util/gal-view-instance.h index c5debd1c3a..33427d42e6 100644 --- a/e-util/gal-view-instance.h +++ b/e-util/gal-view-instance.h @@ -25,21 +25,37 @@ #error "Only <e-util/e-util.h> should be included directly." #endif -#ifndef _GAL_VIEW_INSTANCE_H_ -#define _GAL_VIEW_INSTANCE_H_ +#ifndef GAL_VIEW_INSTANCE_H +#define GAL_VIEW_INSTANCE_H #include <e-util/gal-view-collection.h> +/* Standard GObject macros */ +#define GAL_TYPE_VIEW_INSTANCE \ + (gal_view_instance_get_type ()) +#define GAL_VIEW_INSTANCE(obj) \ + (G_TYPE_CHECK_INSTANCE_CAST \ + ((obj), GAL_TYPE_VIEW_INSTANCE, GalViewInstance)) +#define GAL_VIEW_INSTANCE_CLASS(cls) \ + (G_TYPE_CHECK_CLASS_CAST \ + ((cls), GAL_TYPE_VIEW_INSTANCE, GalViewInstanceClass)) +#define GAL_IS_VIEW_INSTANCE(obj) \ + (G_TYPE_CHECK_INSTANCE_TYPE \ + ((obj), GAL_TYPE_VIEW_INSTANCE)) +#define GAL_IS_VIEW_INSTANCE_CLASS(cls) \ + (G_TYPE_CHECK_CLASS_TYPE \ + ((cls), GAL_TYPE_VIEW_INSTANCE)) +#define GAL_VIEW_INSTANCE_GET_CLASS(obj) \ + (G_TYPE_INSTANCE_GET_CLASS \ + ((obj), GAL_TYPE_VIEW_INSTANCE, GalViewInstanceClass)) + G_BEGIN_DECLS -#define GAL_VIEW_INSTANCE_TYPE (gal_view_instance_get_type ()) -#define GAL_VIEW_INSTANCE(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), GAL_VIEW_INSTANCE_TYPE, GalViewInstance)) -#define GAL_VIEW_INSTANCE_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), GAL_VIEW_INSTANCE_TYPE, GalViewInstanceClass)) -#define GAL_IS_VIEW_INSTANCE(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), GAL_VIEW_INSTANCE_TYPE)) -#define GAL_IS_VIEW_INSTANCE_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), GAL_VIEW_INSTANCE_TYPE)) +typedef struct _GalViewInstance GalViewInstance; +typedef struct _GalViewInstanceClass GalViewInstanceClass; -typedef struct { - GObject base; +struct _GalViewInstance { + GObject parent; GalViewCollection *collection; @@ -58,57 +74,62 @@ typedef struct { guint loaded : 1; gchar *default_view; -} GalViewInstance; +}; -typedef struct { +struct _GalViewInstanceClass { GObjectClass parent_class; - /* - * Signals - */ - void (*display_view) (GalViewInstance *instance, - GalView *view); - void (*changed) (GalViewInstance *instance); - void (*loaded) (GalViewInstance *instance); -} GalViewInstanceClass; + /* Signals */ + void (*display_view) (GalViewInstance *instance, + GalView *view); + void (*changed) (GalViewInstance *instance); + void (*loaded) (GalViewInstance *instance); +}; -/* Standard functions */ -GType gal_view_instance_get_type (void); +GType gal_view_instance_get_type (void) G_GNUC_CONST; -/* */ /*collection should be loaded when you call this. instance_id: Which instance of this type of object is this (for most of evo, this is the folder id.) */ -GalViewInstance *gal_view_instance_new (GalViewCollection *collection, - const gchar *instance_id); -GalViewInstance *gal_view_instance_construct (GalViewInstance *instance, - GalViewCollection *collection, - const gchar *instance_id); +GalViewInstance * + gal_view_instance_new (GalViewCollection *collection, + const gchar *instance_id); +GalViewInstance * + gal_view_instance_construct (GalViewInstance *instance, + GalViewCollection *collection, + const gchar *instance_id); /* Manipulate the current view. */ -gchar *gal_view_instance_get_current_view_id (GalViewInstance *instance); -void gal_view_instance_set_current_view_id (GalViewInstance *instance, - const gchar *view_id); -GalView *gal_view_instance_get_current_view (GalViewInstance *instance); +gchar * gal_view_instance_get_current_view_id + (GalViewInstance *instance); +void gal_view_instance_set_current_view_id + (GalViewInstance *instance, + const gchar *view_id); +GalView * gal_view_instance_get_current_view + (GalViewInstance *instance); /* Sets the current view to the given custom view. */ -void gal_view_instance_set_custom_view (GalViewInstance *instance, - GalView *view); +void gal_view_instance_set_custom_view + (GalViewInstance *instance, + GalView *view); /* Returns true if this instance has ever been used before. */ -gboolean gal_view_instance_exists (GalViewInstance *instance); +gboolean gal_view_instance_exists (GalViewInstance *instance); /* Manipulate the view collection */ -/* void gal_view_instance_set_as_default (GalViewInstance *instance); */ -void gal_view_instance_save_as (GalViewInstance *instance); +void gal_view_instance_save_as (GalViewInstance *instance); -/* This is idempotent. Once it's been called once, the rest of the calls are ignored. */ -void gal_view_instance_load (GalViewInstance *instance); +/* This is idempotent. Once it's been called + * once, the rest of the calls are ignored. */ +void gal_view_instance_load (GalViewInstance *instance); -/* These only mean anything before gal_view_instance_load is called the first time. */ -const gchar *gal_view_instance_get_default_view (GalViewInstance *instance); -void gal_view_instance_set_default_view (GalViewInstance *instance, - const gchar *id); +/* These only mean anything before gal_view_instance_load() + * is called the first time. */ +const gchar * gal_view_instance_get_default_view + (GalViewInstance *instance); +void gal_view_instance_set_default_view + (GalViewInstance *instance, + const gchar *id); G_END_DECLS -#endif /* _GAL_VIEW_INSTANCE_H_ */ +#endif /* GAL_VIEW_INSTANCE_H */ |