isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2025-08-01 14:15:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

2007-11-18 Emmanuele Bassi <ebassi@openedhand.com>

Browse Source 
* clutter/clutter-model.c: Add gtk-doc section for
	ClutterModelIter

	* clutter/clutter-script.h: Fix argument name.

	* clutter/x11/clutter-x11.h:
	* clutter/x11/clutter-event-x11.c:
	* clutter/x11/clutter-backend-x11.c: Document functions and
	types.
This commit is contained in:
Emmanuele Bassi
2007-11-18 15:41:47 +00:00
parent 7495848f14
commit fd0e52848b
9 changed files with 201 additions and 126 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
clutter/clutter-model.c
View File

@@ -1109,6 +1109,27 @@ clutter_model_set_filter (ClutterModel *model,
* ClutterModelIter Object
*/
/**
* SECTION:clutter-model-iter
* @short_description: Iterates through a model
*
* #ClutterModelIter is an object used for iterating through all the rows
* of a #ClutterModel. It allows setting and getting values on the row
* which is currently pointing at.
*
* A #ClutterModelIter represents a position between two elements
* of the sequence. For example, the iterator returned by
* clutter_model_get_first_iter() represents the gap immediately before
* the first row of the #ClutterModel, and the iterator returned by
* clutter_model_get_last_iter() represents the gap immediately after the
* last row.
*
* A #ClutterModelIter can only be created by a #ClutterModel and it is
* valid as long as the model does not change.
*
* #ClutterModelIter is available since Clutter 0.6
*/
G_DEFINE_TYPE (ClutterModelIter, clutter_model_iter, G_TYPE_OBJECT);
#define CLUTTER_MODEL_ITER_GET_PRIVATE(obj) \
@@ -1470,10 +1491,11 @@ _model_iter_is_last (ClutterModelIter *iter)
{
temp_iter->priv->seq_iter = begin;
if (_model_filter (model, temp_iter))
{
end = begin;
break;
}
{
end = begin;
break;
}
begin = g_sequence_iter_prev (begin);
}
/* This is because the 'end_iter' is always *after* the last valid iter.
@@ -1508,9 +1530,8 @@ _model_iter_next (ClutterModelIter *iter)
{
g_object_set (temp_iter, "iter", filter_next, NULL);
if (_model_filter (model, temp_iter))
{
break;
}
break;
filter_next = g_sequence_iter_next (filter_next);
}
@@ -1549,9 +1570,8 @@ _model_iter_prev (ClutterModelIter *iter)
{
g_object_set (temp_iter, "iter", filter_prev, NULL);
if (_model_filter (model, temp_iter))
{
break;
}
break;
filter_prev = g_sequence_iter_prev (filter_prev);
}
@@ -1608,6 +1628,7 @@ _model_iter_get_row (ClutterModelIter *iter)
{
if (iter_priv->seq_iter == temp_iter->priv->seq_iter)
break;
row++;
}
filter_next = g_sequence_iter_next (filter_next);
@@ -1699,7 +1720,9 @@ clutter_model_iter_set_valist (ClutterModelIter *iter,
if (column < 0 || column >= model_priv->n_columns)
{
g_warning ("%s: Invalid column number %d added to iter (remember to end you list of columns with a -1)", G_STRLOC, column);
g_warning ("%s: Invalid column number %d added to iter "
"(remember to end you list of columns with a -1)",
G_STRLOC, column);
break;
}
g_value_init (&value, model_priv->column_types[column]);
@@ -1820,7 +1843,9 @@ clutter_model_iter_get_valist (ClutterModelIter *iter,
if (column < 0 || column >= model_priv->n_columns)
{
g_warning ("%s: Invalid column number %d added to iter (remember to end you list of columns with a -1)", G_STRLOC, column);
g_warning ("%s: Invalid column number %d added to iter "
"(remember to end you list of columns with a -1)",
G_STRLOC, column);
break;
}

2
clutter/clutter-script.h
View File

@@ -134,7 +134,7 @@ void clutter_script_ensure_objects (ClutterScript *script);
GType clutter_script_get_type_from_name (ClutterScript *script,
const gchar *type_name);
G_CONST_RETURN gchar *clutter_get_script_id (GObject *object);
G_CONST_RETURN gchar *clutter_get_script_id (GObject *gobject);
void clutter_script_connect_signals (ClutterScript *script,
gpointer user_data);

60
clutter/x11/clutter-backend-x11.c
View File

@@ -331,9 +331,9 @@ error_handler(Display *xdpy,
/**
* clutter_x11_trap_x_errors:
*
* FIXME
* Traps every X error until clutter_x11_untrap_x_errors() is called.
*
* Since: 0.4
* Since: 0.6
*/
void
clutter_x11_trap_x_errors (void)
@@ -345,9 +345,9 @@ clutter_x11_trap_x_errors (void)
/**
* clutter_x11_untrap_x_errors:
*
* FIXME
* Removes the X error trap and returns the current status.
*
* Return value: FIXME
* Return value: the trapped error code, or 0 for success
*
* Since: 0.4
*/
@@ -362,11 +362,11 @@ clutter_x11_untrap_x_errors (void)
/**
* clutter_x11_get_default_display:
*
* FIXME
* Retrieves the pointer to the default display.
*
* Return value: FIXME
* Return value: the default display
*
* Since: 0.4
* Since: 0.6
*/
Display *
clutter_x11_get_default_display (void)
@@ -383,11 +383,11 @@ clutter_x11_get_default_display (void)
/**
* clutter_x11_get_default_screen:
*
* Gets the pointer to the default X Screen object.
* Gets the number of the default X Screen object.
*
* Return value: FIXME
* Return value: the number of the default screen
*
* Since: 0.4
* Since: 0.6
*/
int
clutter_x11_get_default_screen (void)
@@ -404,11 +404,11 @@ clutter_x11_get_default_screen (void)
/**
* clutter_x11_get_root_window:
*
* FIXME
* Retrieves the root window.
*
* Return value: FIXME
* Return value: the id of the root window
*
* Since: 0.4
* Since: 0.6
*/
Window
clutter_x11_get_root_window (void)
@@ -424,15 +424,16 @@ clutter_x11_get_root_window (void)
/**
* clutter_x11_add_filter:
*
* FIXME
* @func: a filter function
* @data: user data to be passed to the filter function, or %NULL
*
* Return value: FIXME
* Adds an event filter function.
*
* Since: 0.4
* Since: 0.6
*/
void
clutter_x11_add_filter (ClutterX11FilterFunc func, gpointer data)
clutter_x11_add_filter (ClutterX11FilterFunc func,
gpointer data)
{
ClutterX11EventFilter *filter;
@@ -444,27 +445,28 @@ clutter_x11_add_filter (ClutterX11FilterFunc func, gpointer data)
return;
}
filter = g_new0(ClutterX11EventFilter, 1);
filter = g_new0 (ClutterX11EventFilter, 1);
filter->func = func;
filter->data = data;
backend_singleton->event_filters
= g_slist_append (backend_singleton->event_filters, filter);
backend_singleton->event_filters =
g_slist_append (backend_singleton->event_filters, filter);
return;
}
/**
* clutter_x11_remove_filter:
*
* FIXME
* @func: a filter function
* @data: user data to be passed to the filter function, or %NULL
*
* Return value: FIXME
* Removes the given filter function.
*
* Since: 0.4
* Since: 0.6
*/
void
clutter_x11_remove_filter (ClutterX11FilterFunc func, gpointer data)
clutter_x11_remove_filter (ClutterX11FilterFunc func,
gpointer data)
{
GSList *tmp_list, *this;
ClutterX11EventFilter *filter;
@@ -475,14 +477,14 @@ clutter_x11_remove_filter (ClutterX11FilterFunc func, gpointer data)
while (tmp_list)
{
filter = (ClutterX11EventFilter *)tmp_list->data;
filter = tmp_list->data;
this = tmp_list;
tmp_list = tmp_list->next;
if (filter->func == func && filter->data == data)
{
backend_singleton->event_filters
= g_slist_remove_link (backend_singleton->event_filters, this);
backend_singleton->event_filters =
g_slist_remove_link (backend_singleton->event_filters, this);
g_slist_free_1 (this);
g_free (filter);

5
clutter/x11/clutter-event-x11.c
View File

@@ -357,9 +357,9 @@ event_translate (ClutterBackend *backend,
while (node)
{
filter = (ClutterX11EventFilter *)node->data;
filter = node->data;
switch (filter->func(xevent, event, filter->data))
switch (filter->func (xevent, event, filter->data))
{
case CLUTTER_X11_FILTER_CONTINUE:
break;
@@ -370,6 +370,7 @@ event_translate (ClutterBackend *backend,
default:
break;
}
node = node->next;
}
}

45
clutter/x11/clutter-x11.h
View File

@@ -45,17 +45,39 @@
G_BEGIN_DECLS
/**
* ClutterX11FilterReturn:
* @CLUTTER_X11_FILTER_CONTINUE: The event was not handled, continues the
* processing
* @CLUTTER_X11_FILTER_TRANSLATE: Native event translated into a Clutter
* event, stops the processing
* @CLUTTER_X11_FILTER_REMOVE: Remove the event, stops the processing
*
* Return values for the #ClutterX11FilterFunc function.
*
* Since: 0.6
*/
typedef enum {
CLUTTER_X11_FILTER_CONTINUE, /* Event not handled, continue processesing */
CLUTTER_X11_FILTER_TRANSLATE, /* Native event translated into a Clutter
event and stored in the "event" structure
that was passed in */
CLUTTER_X11_FILTER_REMOVE /* Terminate processing, removing event */
CLUTTER_X11_FILTER_CONTINUE,
CLUTTER_X11_FILTER_TRANSLATE,
CLUTTER_X11_FILTER_REMOVE
} ClutterX11FilterReturn;
/**
* ClutterX11FilterFunc:
* @xev: Native X11 event structure
* @cev: Clutter event structure
* @data: user data passed to the filter function
*
* Filter function for X11 native events.
*
* Return value: the result of the filtering
*
* Since: 0.6
*/
typedef ClutterX11FilterReturn (*ClutterX11FilterFunc) (XEvent *xev,
ClutterEvent *cev,
gpointer *data);
gpointer data);
void clutter_x11_trap_x_errors (void);
gint clutter_x11_untrap_x_errors (void);
@@ -64,16 +86,15 @@ Display *clutter_x11_get_default_display (void);
int clutter_x11_get_default_screen (void);
Window clutter_x11_get_root_window (void);
Window clutter_x11_get_stage_window (ClutterStage *stage);
XVisualInfo *clutter_x11_get_stage_visual (ClutterStage *stage);
Window clutter_x11_get_stage_window (ClutterStage *stage);
XVisualInfo *clutter_x11_get_stage_visual (ClutterStage *stage);
gboolean clutter_x11_set_stage_foreign (ClutterStage *stage,
Window xwindow);
void clutter_x11_add_filter (ClutterX11FilterFunc func, gpointer data);
void clutter_x11_add_filter (ClutterX11FilterFunc func,
gpointer data);
void clutter_x11_remove_filter (ClutterX11FilterFunc func,
gpointer data);
gpointer data);
G_END_DECLS