brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Document ClutterTextBuffer structures

Browse Source
This commit is contained in:
Emmanuele Bassi 2012-02-23 11:54:41 +00:00
parent 0099bbf7d9
commit 2b35b2a081
1 changed files with 26 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
clutter/clutter-text-buffer.h
View File

@ -44,20 +44,43 @@ typedef struct _ClutterTextBuffer ClutterTextBuffer;
typedef struct _ClutterTextBufferClass ClutterTextBufferClass; typedef struct _ClutterTextBufferClass ClutterTextBufferClass;
typedef struct _ClutterTextBufferPrivate ClutterTextBufferPrivate; typedef struct _ClutterTextBufferPrivate ClutterTextBufferPrivate;
/**
* ClutterTextBuffer:
*
* The <structname>ClutterTextBuffer</structname> structure contains private
* data and it should only be accessed using the provided API.
*
* Since: 1.10
*/
struct _ClutterTextBuffer struct _ClutterTextBuffer
{ {
/*< private >*/
GObject parent_instance; GObject parent_instance;
/*< private >*/
ClutterTextBufferPrivate *priv; ClutterTextBufferPrivate *priv;
}; };
/**
* ClutterTextBufferClass:
* @inserted_text: default handler for the #ClutterTextBuffer::inserted-text signal
* @deleted_text: default hanlder for the #ClutterTextBuffer::deleted-text signal
* @get_text: virtual function
* @get_length: virtual function
* @insert_text: virtual function
* @delete_text: virtual function
*
* The <structname>ClutterTextBufferClass</structname> structure contains
* only private data.
*
* Since: 1.10
*/
struct _ClutterTextBufferClass struct _ClutterTextBufferClass
{ {
/*< private >*/
GObjectClass parent_class; GObjectClass parent_class;
/*< public >*/
/* Signals */ /* Signals */
void (*inserted_text) (ClutterTextBuffer *buffer, void (*inserted_text) (ClutterTextBuffer *buffer,
guint position, guint position,
const gchar *chars, const gchar *chars,
@ -68,7 +91,6 @@ struct _ClutterTextBufferClass
guint n_chars); guint n_chars);
/* Virtual Methods */ /* Virtual Methods */
const gchar* (*get_text) (ClutterTextBuffer *buffer, const gchar* (*get_text) (ClutterTextBuffer *buffer,
gsize *n_bytes); gsize *n_bytes);
@ -83,6 +105,7 @@ struct _ClutterTextBufferClass
guint position, guint position,
guint n_chars); guint n_chars);
/*< private >*/
/* Padding for future expansion */ /* Padding for future expansion */
void (*_clutter_reserved1) (void); void (*_clutter_reserved1) (void);
void (*_clutter_reserved2) (void); void (*_clutter_reserved2) (void);