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

cookbook: Proofing for "box layout" recipe

Browse Source 
General improvements to readability, formatting, fixing
typos etc.
This commit is contained in:
Elliot Smith 2010-12-15 13:31:12 +00:00 committed by Emmanuele Bassi
parent accdd92110
commit 894c0527df
1 changed files with 36 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
doc/cookbook/layouts.xml
View File

@ -843,7 +843,7 @@ clutter_actor_raise_top (text);
<link linkend="layouts-box-example-1">full example</link>. It <link linkend="layouts-box-example-1">full example</link>. It
demonstrates how to lay out three rectangles in a vertical demonstrates how to lay out three rectangles in a vertical
column. A different approach is used to set the <varname>x-fill</varname> column. A different approach is used to set the <varname>x-fill</varname>
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 the layout (each rectangle is 100 pixels wide, while the
box they are inside is 200 pixels wide).</para> box they are inside is 200 pixels wide).</para>
@ -936,15 +936,16 @@ clutter_container_add_actor (CLUTTER_CONTAINER (stage), box);
<para><type>ClutterBoxLayout</type> is not a reflowing layout: <para><type>ClutterBoxLayout</type> is not a reflowing layout:
that is, if the layout's container changes size, the actors inside that is, if the layout's container changes size, the actors inside
aren't automatically repositioned to fill the available area. aren't automatically repositioned to occupy or find new positions
If you want that behaviour, use <type>ClutterFlowLayout</type> in its available area. If you want that behaviour, use
instead.</para> <type>ClutterFlowLayout</type> instead.</para>
<para>If you want the container to be resizable, but still want <para>If you want the container to be resizable, but find that
access to the actors inside it if they go outside its clip area, resizing the container obscures its child actors, you could put
you can provide another way to get to them. For example, you the container inside a scrollable area. Then the container's actors
could put the container inside a scrollable area, so the can be scrolled to if they go out of sight.
container's actors can be scrolled to if they go out of sight.</para> <link linkend="events-mouse-scroll">This recipe</link> explains
how to make a container scrollable.</para>
<section> <section>
<title>Layout properties</title> <title>Layout properties</title>
@ -963,15 +964,18 @@ clutter_container_add_actor (CLUTTER_CONTAINER (stage), box);
<para>The main issue you may face when applying these properties <para>The main issue you may face when applying these properties
is understanding how they interact. As this is harder to describe is understanding how they interact. As this is harder to describe
than to show, you can run the than to show, you can run the
<link linkend="layouts-box-example-3">third example</link> <link linkend="layouts-box-example-3">example</link>
below to toggle and tweak the various properties.</para> below to toggle and tweak various properties and see
how they affect the layout's appearance.</para>
<note> <note>
<para>The second example sets child properties (fill, alignment, <para>The "toggle and tweak"
expand) on all children of the layout when those properties are <link linkend="layouts-box-example-3">example</link> sets
changed. If you want to see the effect of setting these to child properties (fill, alignment, expand) on all children
different values for <emphasis>each</emphasis> child, you of the layout when those properties are changed. If you want
will have to experiment yourself.</para> to see the effect of setting these to different values for
<emphasis>each</emphasis> child, you will have to experiment
yourself.</para>
</note> </note>
<section> <section>
@ -1019,10 +1023,11 @@ clutter_container_add_actor (CLUTTER_CONTAINER (stage), box);
<para>Sets the number of pixels to place between actors <para>Sets the number of pixels to place between actors
in the layout.</para> in the layout.</para>
<para>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).</para>
</formalpara> </formalpara>
<para>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).</para>
</listitem> </listitem>
<listitem> <listitem>
@ -1035,11 +1040,11 @@ clutter_container_add_actor (CLUTTER_CONTAINER (stage), box);
prepend actors to the row or column; the default is prepend actors to the row or column; the default is
<constant>FALSE</constant>, meaning that actors are <constant>FALSE</constant>, meaning that actors are
appended to the row or column when added.</para> appended to the row or column when added.</para>
<para>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.</para>
</formalpara> </formalpara>
<para>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.</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -1067,11 +1072,11 @@ clutter_container_add_actor (CLUTTER_CONTAINER (stage), box);
set whether an actor will fill its allocated horizontal set whether an actor will fill its allocated horizontal
or vertical space (respectively) within the layout. Setting or vertical space (respectively) within the layout. Setting
these properties only has an effect where an actor is smaller these properties only has an effect where an actor is smaller
(on the fill axis or axes) than the layout's container.</para> (on the appropriate fill axes) than the layout's container.</para>
<para>Note that the actor's size is not actually changed <para>Note that the actor's actual size is not changed
if it is set to fill: the reported width and height are if it is set to fill: the reported width and height are
not affected.</para> unaffected.</para>
</listitem> </listitem>
<listitem> <listitem>
@ -1142,9 +1147,9 @@ clutter_container_add_actor (CLUTTER_CONTAINER (stage), box);
introduction</link> for more about easing and duration introduction</link> for more about easing and duration
properties).</para> properties).</para>
<para>The <link linkend="layouts-box-example-3">third example</link> <para>The <link linkend="layouts-box-example-3">"toggle and tweak"
uses animation for layout changes, and can give you some idea example</link> uses animation for layout changes, and can give
of what to expect in your own animated layouts.</para> you some idea of what to expect in your own animated layouts.</para>
</section> </section>
</section> </section>
@ -1172,8 +1177,8 @@ clutter_container_add_actor (CLUTTER_CONTAINER (stage), box);
</example> </example>
<example id="layouts-box-example-3"> <example id="layouts-box-example-3">
<title>A demonstrator for some of <type>ClutterBoxLayout's</type> <title>A demonstrator for "toggling and tweaking" a
properties</title> <type>ClutterBoxLayout's</type> properties</title>
<programlisting> <programlisting>
<xi:include href="examples/layouts-box-property-effects.c" parse="text"> <xi:include href="examples/layouts-box-property-effects.c" parse="text">
<xi:fallback>a code sample should be here... but isn't</xi:fallback> <xi:fallback>a code sample should be here... but isn't</xi:fallback>