(Visuals) Added visual indices
[platform/core/uifw/dali-toolkit.git] / docs / content / programming-guide / image-view.h
index 63a1030..60e119f 100644 (file)
  * @endcode
  *
  * <h3 class="pg">The IMAGE property</h3>
- * the IMAGE property allows you to change many aspects of the image that is renderered.
+ * the IMAGE property allows you to change many aspects of the image that is rendered.
  * This property can either be a string for a image url path or a Property::Map that specifies
  * the image in more detail.
  *
- * <h3 class="pg">Renderers</h3>
- * You can specify a specific renderer instead of using the default Image Renderer, e.g to use the Border Renderer.
+ * <h3 class="pg">Visuals</h3>
+ * You can specify a specific visual instead of using the default Image Visual, e.g to use the Border Visual.
  *
  * @code
- * Property::Map renderer;
- * renderer.Insert("rendererType","border");
- * renderer.Insert("borderColor",COLOR::RED);
- * renderer.Insert("borderSize",20.f);
+ * Property::Map visual;
+ * visual.Insert( Visual::Property::Type,Visual::BORDER );
+ * visual.Insert( BorderVisual::Property::COLOR, COLOR::RED );
+ * visual.Insert( BorderVisual::Property::SIZE, 20.f );
  *
  * Dali::Toolkit::ImageView myImageView = Dali::Toolkit::ImageView::New();
- * myImageView.SetProperty( Control::Property::IMAGE, renderer);
+ * myImageView.SetProperty( Control::Property::IMAGE, visual );
  * @endcode
 
  * <h3 class="pg">Resizing at Load Time</h3>
  *
  * @code
  * Property::Map imageProperty;
- * imageProperty.Insert("imageUrl", "source-image-url.png");
- * imageProperty.Insert("imageFittingMode", "scaleToFill");
- * imageProperty.Insert("fitWidth", 240);
- * imageProperty.Insert("fitHeight", 240);
+ * imageProperty.Insert("url", "source-image-url.png");
+ * imageProperty.Insert("fittingMode", "SCALE_TO_FILL");
+ * imageProperty.Insert("desiredWidth", 240);
+ * imageProperty.Insert("desiredHeight", 240);
  * Dali::Toolkit::ImageView myImageView = Dali::Toolkit::ImageView::New();
  * myImageView.SetProperty( Control::Property::IMAGE, imageProperty);
 
  *
  * The fitting modes and a suggested use-case for each are as follows:
  * <ol>
- *   <li> "shrinkToFit" Full-screen image display: Limit loaded image resolution to device resolution but show all of image.
- *   <li> "scaleToFill" Thumbnail gallery grid: Limit loaded image resolution to screen tile, filling whole tile but losing a few pixels to match the tile shape.
- *   <li> "fitWidth" Image columns: Limit loaded image resolution to column.
- *   <li> "fitHeight" Image rows: Limit loaded image resolution to row height.
+ *   <li> "SHRINK_TO_FIT" Full-screen image display: Limit loaded image resolution to device resolution but show all of image.
+ *   <li> "SCALE_TO_FILL" Thumbnail gallery grid: Limit loaded image resolution to screen tile, filling whole tile but losing a few pixels to match the tile shape.
+ *   <li> "FIT_WIDTH" Image columns: Limit loaded image resolution to column.
+ *   <li> "FIT_HEIGHT" Image rows: Limit loaded image resolution to row height.
  * </ol>
  *
  * The dali-demo project contains a full example under
  * <h2 class="pg">Changing the image</h2>
  * The Image View can be changed by calling Dali::Toolkit::ImageView::SetImage methods or by changing the IMAGE property.
  * @code
- * myImageActor.SetImage( newImage );
+ * myImageView.SetImage( newImage );
  * @endcode
  *
  */