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/e-text-model.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/e-text-model.h')
-rw-r--r-- | e-util/e-text-model.h | 155 |
1 files changed, 99 insertions, 56 deletions
diff --git a/e-util/e-text-model.h b/e-util/e-text-model.h index 3426c183e2..4b0914e97a 100644 --- a/e-util/e-text-model.h +++ b/e-util/e-text-model.h @@ -29,14 +29,26 @@ #include <glib-object.h> -G_BEGIN_DECLS +/* Standard GObject macros */ +#define E_TYPE_TEXT_MODEL \ + (e_text_model_get_type ()) +#define E_TEXT_MODEL(obj) \ + (G_TYPE_CHECK_INSTANCE_CAST \ + ((obj), E_TYPE_TEXT_MODEL, ETextModel)) +#define E_TEXT_MODEL_CLASS(cls) \ + (G_TYPE_CHECK_CLASS_CAST \ + ((cls), E_TYPE_TEXT_MODEL, ETextModelClass)) +#define E_IS_TEXT_MODEL(obj) \ + (G_TYPE_CHECK_INSTANCE_TYPE \ + ((obj), E_TYPE_TEXT_MODEL)) +#define E_IS_TEXT_MODEL_CLASS(cls) \ + (G_TYPE_CHECK_CLASS_TYPE \ + ((cls), E_TYPE_TEXT_MODEL)) +#define E_TEXT_MODEL_GET_CLASS(obj) \ + (G_TYPE_INSTANCE_GET_CLASS \ + ((obj), E_TYPE_TEXT_MODEL_TYPE, ETextModelClass)) -#define E_TYPE_TEXT_MODEL (e_text_model_get_type ()) -#define E_TEXT_MODEL(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), E_TYPE_TEXT_MODEL, ETextModel)) -#define E_TEXT_MODEL_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), E_TYPE_TEXT_MODEL, ETextModelClass)) -#define E_IS_TEXT_MODEL(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), E_TYPE_TEXT_MODEL)) -#define E_IS_TEXT_MODEL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), E_TYPE_TEXT_MODEL)) -#define E_TEXT_MODEL_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), E_TYPE_TEXT_MODEL_TYPE, ETextModelClass)) +G_BEGIN_DECLS typedef struct _ETextModel ETextModel; typedef struct _ETextModelClass ETextModelClass; @@ -46,7 +58,6 @@ typedef gint (*ETextModelReposFn) (gint, gpointer); struct _ETextModel { GObject item; - ETextModelPrivate *priv; }; @@ -54,59 +65,91 @@ struct _ETextModelClass { GObjectClass parent_class; /* Signal */ - void (* changed) (ETextModel *model); - void (* reposition) (ETextModel *model, ETextModelReposFn fn, gpointer repos_fn_data); - void (* object_activated) (ETextModel *model, gint obj_num); - void (* cancel_completion) (ETextModel *model); + void (*changed) (ETextModel *model); + void (*reposition) (ETextModel *model, + ETextModelReposFn fn, + gpointer repos_fn_data); + void (*object_activated) (ETextModel *model, + gint obj_num); + void (*cancel_completion) (ETextModel *model); /* Virtual methods */ - gint (* validate_pos) (ETextModel *model, gint pos); - - const gchar *(* get_text) (ETextModel *model); - gint (* get_text_len) (ETextModel *model); - void (* set_text) (ETextModel *model, const gchar *text); - void (* insert) (ETextModel *model, gint position, const gchar *text); - void (* insert_length) (ETextModel *model, gint position, const gchar *text, gint length); - void (* delete) (ETextModel *model, gint position, gint length); - - void (* objectify) (ETextModel *model); - gint (* obj_count) (ETextModel *model); - const gchar *(* get_nth_obj) (ETextModel *model, gint n, gint *len); - gint (* obj_at_offset) (ETextModel *model, gint offset); + gint (*validate_pos) (ETextModel *model, + gint pos); + + const gchar * (*get_text) (ETextModel *model); + gint (*get_text_len) (ETextModel *model); + void (*set_text) (ETextModel *model, + const gchar *text); + void (*insert) (ETextModel *model, + gint position, + const gchar *text); + void (*insert_length) (ETextModel *model, + gint position, + const gchar *text, + gint length); + void (*delete) (ETextModel *model, + gint position, + gint length); + + void (*objectify) (ETextModel *model); + gint (*obj_count) (ETextModel *model); + const gchar * (*get_nth_obj) (ETextModel *model, + gint n, + gint *len); + gint (*obj_at_offset) (ETextModel *model, + gint offset); }; -GType e_text_model_get_type (void); - -ETextModel *e_text_model_new (void); - -void e_text_model_changed (ETextModel *model); -void e_text_model_cancel_completion (ETextModel *model); - -void e_text_model_reposition (ETextModel *model, ETextModelReposFn fn, gpointer repos_data); -gint e_text_model_validate_position (ETextModel *model, gint pos); - -/* Functions for manipulating the underlying text. */ - -const gchar *e_text_model_get_text (ETextModel *model); -gint e_text_model_get_text_length (ETextModel *model); -void e_text_model_set_text (ETextModel *model, const gchar *text); -void e_text_model_insert (ETextModel *model, gint position, const gchar *text); -void e_text_model_insert_length (ETextModel *model, gint position, const gchar *text, gint length); -void e_text_model_prepend (ETextModel *model, const gchar *text); -void e_text_model_append (ETextModel *model, const gchar *text); -void e_text_model_delete (ETextModel *model, gint position, gint length); - -/* Functions for accessing embedded objects. */ - -gint e_text_model_object_count (ETextModel *model); -const gchar *e_text_model_get_nth_object (ETextModel *model, gint n, gint *len); -gchar *e_text_model_strdup_nth_object (ETextModel *model, gint n); -void e_text_model_get_nth_object_bounds (ETextModel *model, gint n, gint *start_pos, gint *end_pos); -gint e_text_model_get_object_at_offset (ETextModel *model, gint offset); -gint e_text_model_get_object_at_pointer (ETextModel *model, const gchar *c); -void e_text_model_activate_nth_object (ETextModel *model, gint n); +GType e_text_model_get_type (void) G_GNUC_CONST; +ETextModel * e_text_model_new (void); +void e_text_model_changed (ETextModel *model); +void e_text_model_cancel_completion (ETextModel *model); +void e_text_model_reposition (ETextModel *model, + ETextModelReposFn fn, + gpointer repos_data); +gint e_text_model_validate_position (ETextModel *model, + gint pos); +const gchar * e_text_model_get_text (ETextModel *model); +gint e_text_model_get_text_length (ETextModel *model); +void e_text_model_set_text (ETextModel *model, + const gchar *text); +void e_text_model_insert (ETextModel *model, + gint position, + const gchar *text); +void e_text_model_insert_length (ETextModel *model, + gint position, + const gchar *text, + gint length); +void e_text_model_prepend (ETextModel *model, + const gchar *text); +void e_text_model_append (ETextModel *model, + const gchar *text); +void e_text_model_delete (ETextModel *model, + gint position, + gint length); +gint e_text_model_object_count (ETextModel *model); +const gchar * e_text_model_get_nth_object (ETextModel *model, + gint n, + gint *len); +gchar * e_text_model_strdup_nth_object (ETextModel *model, + gint n); +void e_text_model_get_nth_object_bounds + (ETextModel *model, + gint n, + gint *start_pos, + gint *end_pos); +gint e_text_model_get_object_at_offset + (ETextModel *model, + gint offset); +gint e_text_model_get_object_at_pointer + (ETextModel *model, + const gchar *c); +void e_text_model_activate_nth_object + (ETextModel *model, + gint n); G_END_DECLS -#endif +#endif /* E_TEXT_MODEL_H */ |