From: Elliot Smith Date: Wed, 15 Dec 2010 13:31:12 +0000 (+0000) Subject: cookbook: Proofing for "box layout" recipe X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=894c0527dffc4d0c01ef87880d33b02fcfab923e;p=profile%2Fivi%2Fclutter.git cookbook: Proofing for "box layout" recipe General improvements to readability, formatting, fixing typos etc. --- diff --git a/doc/cookbook/layouts.xml b/doc/cookbook/layouts.xml index 1df5499..406a4c5 100644 --- a/doc/cookbook/layouts.xml +++ b/doc/cookbook/layouts.xml @@ -843,7 +843,7 @@ clutter_actor_raise_top (text); full example. It demonstrates how to lay out three rectangles in a vertical column. A different approach is used to set the x-fill - property on each rectangle, so that they fill the horizontal space in + property on each rectangle, so each fills the horizontal space in the layout (each rectangle is 100 pixels wide, while the box they are inside is 200 pixels wide). @@ -936,15 +936,16 @@ clutter_container_add_actor (CLUTTER_CONTAINER (stage), box); ClutterBoxLayout is not a reflowing layout: that is, if the layout's container changes size, the actors inside - aren't automatically repositioned to fill the available area. - If you want that behaviour, use ClutterFlowLayout - instead. + aren't automatically repositioned to occupy or find new positions + in its available area. If you want that behaviour, use + ClutterFlowLayout instead. - If you want the container to be resizable, but still want - access to the actors inside it if they go outside its clip area, - you can provide another way to get to them. For example, you - could put the container inside a scrollable area, so the - container's actors can be scrolled to if they go out of sight. + If you want the container to be resizable, but find that + resizing the container obscures its child actors, you could put + the container inside a scrollable area. Then the container's actors + can be scrolled to if they go out of sight. + This recipe explains + how to make a container scrollable.
Layout properties @@ -963,15 +964,18 @@ clutter_container_add_actor (CLUTTER_CONTAINER (stage), box); The main issue you may face when applying these properties is understanding how they interact. As this is harder to describe than to show, you can run the - third example - below to toggle and tweak the various properties. + example + below to toggle and tweak various properties and see + how they affect the layout's appearance. - The second example sets child properties (fill, alignment, - expand) on all children of the layout when those properties are - changed. If you want to see the effect of setting these to - different values for each child, you - will have to experiment yourself. + The "toggle and tweak" + example sets + child properties (fill, alignment, expand) on all children + of the layout when those properties are changed. If you want + to see the effect of setting these to different values for + each child, you will have to experiment + yourself.
@@ -1019,10 +1023,11 @@ clutter_container_add_actor (CLUTTER_CONTAINER (stage), box); Sets the number of pixels to place between actors in the layout. - Note that if you increase spacing too much, actors - may go outside the edges of the layout's container (if - the container has a fixed size). + + Note that if you increase spacing too much, actors + may go outside the edges of the layout's container (if + the container has a fixed size). @@ -1035,11 +1040,11 @@ clutter_container_add_actor (CLUTTER_CONTAINER (stage), box); prepend actors to the row or column; the default is FALSE, meaning that actors are appended to the row or column when added. - - Changing this property on a layout which already has - actors in it will reverse the order of those actors, as - well as changing how new actors are added to the layout. + + Changing this property on a layout which already has + actors in it will reverse the order of those actors, as + well as changing how new actors are added to the layout. @@ -1067,11 +1072,11 @@ clutter_container_add_actor (CLUTTER_CONTAINER (stage), box); set whether an actor will fill its allocated horizontal or vertical space (respectively) within the layout. Setting these properties only has an effect where an actor is smaller - (on the fill axis or axes) than the layout's container. + (on the appropriate fill axes) than the layout's container. - Note that the actor's size is not actually changed + Note that the actor's actual size is not changed if it is set to fill: the reported width and height are - not affected. + unaffected. @@ -1142,9 +1147,9 @@ clutter_container_add_actor (CLUTTER_CONTAINER (stage), box); introduction for more about easing and duration properties). - The third example - uses animation for layout changes, and can give you some idea - of what to expect in your own animated layouts. + The "toggle and tweak" + example uses animation for layout changes, and can give + you some idea of what to expect in your own animated layouts.
@@ -1172,8 +1177,8 @@ clutter_container_add_actor (CLUTTER_CONTAINER (stage), box); - A demonstrator for some of <type>ClutterBoxLayout's</type> - properties + A demonstrator for "toggling and tweaking" a + <type>ClutterBoxLayout's</type> properties a code sample should be here... but isn't