brl/gnome-shell
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

st-box-layout: Document insertion apis

Browse Source 
This commit just adds some brief doc comments
to st_box_layout_insert_actor() and
st_box_layout_insert_before()

https://bugzilla.gnome.org/show_bug.cgi?id=657082
This commit is contained in:
Ray Strode 2011-08-19 13:41:08 -04:00
parent a13af7fbcc
commit 4e9e6e75d3
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/st/st-box-layout.c
View File

@ -1206,6 +1206,17 @@ st_box_layout_get_pack_start (StBoxLayout *box)
return box->priv->is_pack_start;
}
/**
* st_box_layout_insert_actor:
* @self: A #StBoxLayout
* @actor: A #ClutterActor
* @pos: position to insert actor
*
* Adds @actor to @self at position @pos. If @pos is
* negative or larger than the number of elements in the
* list then @actor is added after all the others previously
* added.
*/
void
st_box_layout_insert_actor (StBoxLayout *self,
ClutterActor *actor,
@ -1215,6 +1226,16 @@ st_box_layout_insert_actor (StBoxLayout *self,
st_container_move_child (ST_CONTAINER (self), actor, pos);
}
/**
* st_box_layout_insert_before:
* @self: A #StBoxLayout
* @actor: A #ClutterActor
* @sibling: A previously added #ClutterActor
*
* Adds @actor to @self at the position before @sibling.
* @sibling cannot be %NULL and must be already a child
* of @self.
*/
void
st_box_layout_insert_before (StBoxLayout *self,
ClutterActor *actor,