More descriptions for layer parameters
authorCarlos Lopez <genetita@gmail.com>
Wed, 8 Dec 2010 08:40:16 +0000 (09:40 +0100)
committerCarlos Lopez <genetita@gmail.com>
Wed, 8 Dec 2010 08:40:16 +0000 (09:40 +0100)
14 files changed:
synfig-core/src/modules/lyr_std/import.cpp
synfig-core/src/modules/lyr_std/twirl.cpp
synfig-core/src/modules/lyr_std/xorpattern.cpp
synfig-core/src/modules/mod_example/filledrect.cpp
synfig-core/src/modules/mod_example/simplecircle.cpp
synfig-core/src/modules/mod_geometry/outline.cpp
synfig-core/src/modules/mod_geometry/rectangle.cpp
synfig-core/src/modules/mod_geometry/region.cpp
synfig-core/src/modules/mod_gradient/radialgradient.cpp
synfig-core/src/modules/mod_gradient/spiralgradient.cpp
synfig-core/src/modules/mod_particle/plant.cpp
synfig-core/src/synfig/layer_pastecanvas.cpp
synfig-core/src/synfig/layer_polygon.cpp
synfig-core/src/synfig/layer_solidcolor.cpp

index d37eecf..8532f4f 100644 (file)
@@ -218,6 +218,7 @@ Import::get_param_vocab()const
        );
        ret.push_back(ParamDesc("time_offset")
                .set_local_name(_("Time Offset"))
        );
        ret.push_back(ParamDesc("time_offset")
                .set_local_name(_("Time Offset"))
+               .set_description(_("Time Offset to apply to the imported file"))
        );
 
        return ret;
        );
 
        return ret;
index 89a4785..fdd1d52 100644 (file)
@@ -109,6 +109,7 @@ Twirl::get_param_vocab()const
 
        ret.push_back(ParamDesc("center")
                .set_local_name(_("Center"))
 
        ret.push_back(ParamDesc("center")
                .set_local_name(_("Center"))
+               .set_description(_("Center of the circle"))
        );
 
        ret.push_back(ParamDesc("radius")
        );
 
        ret.push_back(ParamDesc("radius")
@@ -120,15 +121,18 @@ Twirl::get_param_vocab()const
 
        ret.push_back(ParamDesc("rotations")
                .set_local_name(_("Rotations"))
 
        ret.push_back(ParamDesc("rotations")
                .set_local_name(_("Rotations"))
+               .set_description(_("The number of rotations of the twirl effect"))
                .set_origin("center")
        );
 
        ret.push_back(ParamDesc("distort_inside")
                .set_local_name(_("Distort Inside"))
                .set_origin("center")
        );
 
        ret.push_back(ParamDesc("distort_inside")
                .set_local_name(_("Distort Inside"))
+               .set_description(_("When checked, distorts inside the circle"))
        );
 
        ret.push_back(ParamDesc("distort_outside")
                .set_local_name(_("Distort Outside"))
        );
 
        ret.push_back(ParamDesc("distort_outside")
                .set_local_name(_("Distort Outside"))
+               .set_description(_("When checked, distorts outside the circle"))
        );
 
        return ret;
        );
 
        return ret;
index 1335514..e79f309 100644 (file)
@@ -122,9 +122,11 @@ XORPattern::get_param_vocab()const
 
        ret.push_back(ParamDesc("origin")
                .set_local_name(_("Origin"))
 
        ret.push_back(ParamDesc("origin")
                .set_local_name(_("Origin"))
+               .set_description(_("Center of the pattern"))
        );
        ret.push_back(ParamDesc("size")
                .set_local_name(_("Size"))
        );
        ret.push_back(ParamDesc("size")
                .set_local_name(_("Size"))
+               .set_description(_("Size of the pattern"))
                .set_origin("origin")
        );
 
                .set_origin("origin")
        );
 
index 20baf14..0522dba 100644 (file)
@@ -122,11 +122,13 @@ FilledRect::get_param_vocab()const
 
        ret.push_back(ParamDesc("point1")
                .set_local_name(_("Point 1"))
 
        ret.push_back(ParamDesc("point1")
                .set_local_name(_("Point 1"))
+               .set_description(_("First corner of the rectangle"))
                .set_box("point2")
        );
 
        ret.push_back(ParamDesc("point2")
                .set_local_name(_("Point 2"))
                .set_box("point2")
        );
 
        ret.push_back(ParamDesc("point2")
                .set_local_name(_("Point 2"))
+               .set_description(_("Second corner of the rectangle"))
        );
 
        ret.push_back(ParamDesc("feather_x")
        );
 
        ret.push_back(ParamDesc("feather_x")
index 2269cbe..a17fff2 100644 (file)
@@ -104,10 +104,12 @@ SimpleCircle::get_param_vocab()const
 
        ret.push_back(ParamDesc("color")
                .set_local_name(_("Color"))
 
        ret.push_back(ParamDesc("color")
                .set_local_name(_("Color"))
+               .set_description(_("Fill color of the layer"))
        );
 
        ret.push_back(ParamDesc("center")
                .set_local_name(_("Center"))
        );
 
        ret.push_back(ParamDesc("center")
                .set_local_name(_("Center"))
+               .set_description(_("Center of the circle"))
        );
 
        ret.push_back(ParamDesc("radius")
        );
 
        ret.push_back(ParamDesc("radius")
index 17e7867..b57d855 100644 (file)
@@ -825,11 +825,13 @@ Outline::get_param_vocab()const
        ret.push_back(ParamDesc("width")
                .set_is_distance()
                .set_local_name(_("Outline Width"))
        ret.push_back(ParamDesc("width")
                .set_is_distance()
                .set_local_name(_("Outline Width"))
+               .set_description(_("Global width of the outline"))
        );
 
        ret.push_back(ParamDesc("expand")
                .set_is_distance()
                .set_local_name(_("Expand"))
        );
 
        ret.push_back(ParamDesc("expand")
                .set_is_distance()
                .set_local_name(_("Expand"))
+               .set_description(_("Value to add to the global width"))
        );
 
        ret.push_back(ParamDesc("sharp_cusps")
        );
 
        ret.push_back(ParamDesc("sharp_cusps")
@@ -851,6 +853,7 @@ Outline::get_param_vocab()const
        );
        ret.push_back(ParamDesc("homogeneous_width")
                .set_local_name(_("Homogeneous"))
        );
        ret.push_back(ParamDesc("homogeneous_width")
                .set_local_name(_("Homogeneous"))
+               .set_description(_("When checked the width takes the length of the spline to interpolate"))
        );
 
        return ret;
        );
 
        return ret;
index ee50b80..0d4b94a 100644 (file)
@@ -122,15 +122,18 @@ Rectangle::get_param_vocab()const
 
        ret.push_back(ParamDesc("color")
                .set_local_name(_("Color"))
 
        ret.push_back(ParamDesc("color")
                .set_local_name(_("Color"))
+               .set_description(_("Fill color of the layer"))
        );
 
        ret.push_back(ParamDesc("point1")
                .set_local_name(_("Point 1"))
                .set_box("point2")
        );
 
        ret.push_back(ParamDesc("point1")
                .set_local_name(_("Point 1"))
                .set_box("point2")
+               .set_description(_("First corner of the rectangle"))
        );
 
        ret.push_back(ParamDesc("point2")
                .set_local_name(_("Point 2"))
        );
 
        ret.push_back(ParamDesc("point2")
                .set_local_name(_("Point 2"))
+               .set_description(_("Second corner of the rectangle"))
        );
 
        ret.push_back(ParamDesc("expand")
        );
 
        ret.push_back(ParamDesc("expand")
index 462d30e..4fa6cdf 100644 (file)
@@ -231,6 +231,7 @@ Region::get_param_vocab()const
        ret.push_back(ParamDesc("bline")
                .set_local_name(_("Vertices"))
                .set_origin("origin")
        ret.push_back(ParamDesc("bline")
                .set_local_name(_("Vertices"))
                .set_origin("origin")
+               .set_description(_("A list of BLine Points"))
        );
 
        return ret;
        );
 
        return ret;
index a9a3bb9..825557b 100644 (file)
@@ -110,10 +110,12 @@ RadialGradient::get_param_vocab()const
 
        ret.push_back(ParamDesc("gradient")
                .set_local_name(_("Gradient"))
 
        ret.push_back(ParamDesc("gradient")
                .set_local_name(_("Gradient"))
+               .set_description(_("Gradient to apply"))
        );
 
        ret.push_back(ParamDesc("center")
                .set_local_name(_("Center"))
        );
 
        ret.push_back(ParamDesc("center")
                .set_local_name(_("Center"))
+               .set_description(_("Center of the gradient"))
        );
 
        ret.push_back(ParamDesc("radius")
        );
 
        ret.push_back(ParamDesc("radius")
@@ -125,10 +127,12 @@ RadialGradient::get_param_vocab()const
 
        ret.push_back(ParamDesc("loop")
                .set_local_name(_("Loop"))
 
        ret.push_back(ParamDesc("loop")
                .set_local_name(_("Loop"))
+               .set_description(_("When checked the gradient is looped"))
        );
 
        ret.push_back(ParamDesc("zigzag")
                .set_local_name(_("ZigZag"))
        );
 
        ret.push_back(ParamDesc("zigzag")
                .set_local_name(_("ZigZag"))
+               .set_description(_("When checked the gradient is summetrical at the center"))
        );
 
        return ret;
        );
 
        return ret;
index 3a2fee5..b4b70c4 100644 (file)
@@ -109,10 +109,12 @@ SpiralGradient::get_param_vocab()const
 
        ret.push_back(ParamDesc("gradient")
                .set_local_name(_("Gradient"))
 
        ret.push_back(ParamDesc("gradient")
                .set_local_name(_("Gradient"))
+               .set_description(_("Gradient to apply"))
        );
 
        ret.push_back(ParamDesc("center")
                .set_local_name(_("Center"))
        );
 
        ret.push_back(ParamDesc("center")
                .set_local_name(_("Center"))
+               .set_description(_("Center of the gradient"))
        );
 
        ret.push_back(ParamDesc("radius")
        );
 
        ret.push_back(ParamDesc("radius")
@@ -124,11 +126,13 @@ SpiralGradient::get_param_vocab()const
 
        ret.push_back(ParamDesc("angle")
                .set_local_name(_("Angle"))
 
        ret.push_back(ParamDesc("angle")
                .set_local_name(_("Angle"))
+               .set_description(_("Rotation of the spiral"))
                .set_origin("center")
        );
 
        ret.push_back(ParamDesc("clockwise")
                .set_local_name(_("Clockwise"))
                .set_origin("center")
        );
 
        ret.push_back(ParamDesc("clockwise")
                .set_local_name(_("Clockwise"))
+               .set_description(_("When checked the spiral turns clockwise"))
        );
 
        return ret;
        );
 
        return ret;
index 7ffdfe3..4e1c0cc 100644 (file)
@@ -395,6 +395,7 @@ Plant::get_param_vocab()const
 
        ret.push_back(ParamDesc("origin")
                .set_local_name(_("Origin"))
 
        ret.push_back(ParamDesc("origin")
                .set_local_name(_("Origin"))
+               .set_description(_("Offset for the Vertices List"))
        );
 
        ret.push_back(ParamDesc("gradient")
        );
 
        ret.push_back(ParamDesc("gradient")
index 6cdd09f..2181a83 100644 (file)
@@ -142,10 +142,12 @@ Layer_PasteCanvas::get_param_vocab()const
 
        ret.push_back(ParamDesc("time_offset")
                .set_local_name(_("Time Offset"))
 
        ret.push_back(ParamDesc("time_offset")
                .set_local_name(_("Time Offset"))
+               .set_description(_("Time Offset to apply to the context"))
        );
 
        ret.push_back(ParamDesc("children_lock")
                .set_local_name(_("Children Lock"))
        );
 
        ret.push_back(ParamDesc("children_lock")
                .set_local_name(_("Children Lock"))
+               .set_description(_("When checked prevents to select the children using the mouse click"))
        );
 
        ret.push_back(ParamDesc("focus")
        );
 
        ret.push_back(ParamDesc("focus")
index 8c92f8f..b7192e5 100644 (file)
@@ -172,6 +172,7 @@ Layer_Polygon::get_param_vocab()const
 
        ret.push_back(ParamDesc("vector_list")
                .set_local_name(_("Vector List"))
 
        ret.push_back(ParamDesc("vector_list")
                .set_local_name(_("Vector List"))
+               .set_description(_("Define the corners of the polygon"))
                .set_origin("origin")
        );
 
                .set_origin("origin")
        );
 
index be1ffdc..690bb41 100644 (file)
@@ -99,6 +99,7 @@ Layer_SolidColor::get_param_vocab()const
 
        ret.push_back(ParamDesc("color")
                .set_local_name(_("Color"))
 
        ret.push_back(ParamDesc("color")
                .set_local_name(_("Color"))
+               .set_description(_("Fill color of the layer"))
        );
 
        return ret;
        );
 
        return ret;