result Construct(const Rectangle& rect);
/**
- * Initializes this instance of %Canvas with the specified parameter.
+ * Initializes this instance of %Canvas with a specified parameter.
*
* @since 2.1
*
result Copy(const Point& destPoint, const Canvas& srcCanvas, const Rectangle& srcRect);
/**
- * Copies the specified rectangular region from the specified instance of %Canvas to the current instance of
- * %Canvas at the specified location.
+ * Copies a specified rectangular region from a specified instance of %Canvas to the current instance of
+ * %Canvas at a specified location.
*
* @since 2.1
*
result Copy(const Rectangle& destRect, const Canvas& srcCanvas, const Rectangle& srcRect);
/**
- * Copies the scaled image of the specified rectangular region from the specified instance of
+ * Copies the scaled image of a specified rectangular region from a specified instance of
* %Canvas to the current instance of %Canvas.
*
* @since 2.1
*
* @return The line width, @n
* else @c -1.0f if the method fails
- * @remarks The default value is 1.0f.
+ * @remarks The default value is @c 1.0f.
*/
float GetLineWidthF(void) const;
* @since 2.1
*
* @return An error code
- * @param[out] pattern The list containing the information of dash pattern.
+ * @param[out] pattern The list containing the information of dash pattern
* @param[out] offset The offset into the dash pattern at which the stroke must start
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specific input parameter is invalid.
* @since 2.1
*
* @return An error code
- * @param[in] pattern The list containing the information of dash pattern.
+ * @param[in] pattern The list containing the information of dash pattern
* @param[in] offset The offset into the dash pattern at which the stroke must start
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specific input parameter is invalid.
result GetPixel(const Point& point, Color& color) const;
/**
- * Gets the color information at the specified point.
+ * Gets the color information at a specified point.
*
* @since 2.1
*
result SetPixel(const Point& point);
/**
- * Sets a point at the specified coordinate.
+ * Sets a point at a specified coordinate.
*
* @since 2.0
*
result FillRectangle(const Color& color, const Rectangle& rect);
/**
- * Fills a rectangular region of the current instance of %Canvas with the specified color.
+ * Fills a rectangular region of the current instance of %Canvas with a specified color.
*
* @since 2.1
*
result FillEllipse(const Color& color, const Rectangle& rect);
/**
- * Draws a filled ellipse with the specified color.
+ * Draws a filled ellipse with a specified color.
*
* @since 2.1
*
result FillTriangle(const Color& color, const Point& point1, const Point& point2, const Point& point3);
/**
- * Draw a filled triangle with the specified color.
+ * Draw a filled triangle with a specified color.
*
* @since 2.1
*
* else @c null if the method fails
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks If a font is not set with the SetFont() method, this method returns the system default font.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - If a font is not set with the SetFont() method, this method returns the system default font.
*/
Font* GetFontN(void) const;
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OPERATION_FAILED The operation has failed.
- * @remarks The foreground color (RGB value only) of the %Canvas control is used as the text color.
- * @remarks The em square has a defined font size. As a result, if the font's glyph exceeds its em square, it will be scaled down when it is drawn.
+ * @remarks
+ * - The foreground color (RGB value only) of the %Canvas control is used as the text color.
+ * - The em square has a defined font size. As a result, if the font's glyph exceeds its em square, it will be scaled down when it is drawn.
*/
result DrawText(const Point& point, const Tizen::Base::String& text);
/**
- * Draws a text at the specified location.
+ * Draws a text at a specified location.
*
* @since 2.1
*
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OPERATION_FAILED The operation has failed.
- * @remarks The foreground color (RGB value only) of the %Canvas control is used as the text color.
- * @remarks The em square has a defined font size. As a result, if the font's glyph exceeds its em square, it will be scaled down when it is drawn.
+ * @remarks
+ * - The foreground color (RGB value only) of the %Canvas control is used as the text color.
+ * - The em square has a defined font size. As a result, if the font's glyph exceeds its em square, it will be scaled down when it is drawn.
*/
result DrawText(const FloatPoint& point, const Tizen::Base::String& text);
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method.
* @exception E_OPERATION_FAILED The operation has failed.
- * @remarks The foreground color (RGB value only) of the %Canvas control is used as the text color.
- * @remarks The em square has a defined font size. As a result, if the font's glyph exceeds its em square, it will be scaled down when it is drawn.
+ * @remarks
+ * - The foreground color (RGB value only) of the %Canvas control is used as the text color.
+ * - The em square has a defined font size. As a result, if the font's glyph exceeds its em square, it will be scaled down when it is drawn.
*/
result DrawText(const Point& point, const Tizen::Base::String& text, int length);
/**
- * Draws a text at the specified location and length.
+ * Draws a text at a specified location and length.
*
* @since 2.1
*
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method.
* @exception E_OPERATION_FAILED The operation has failed.
- * @remarks The foreground color (RGB value only) of the %Canvas control is used as the text color.
- * @remarks The em square has a defined font size. As a result, if the font's glyph exceeds its em square, it will be scaled down when it is drawn.
+ * @remarks
+ * - The foreground color (RGB value only) of the %Canvas control is used as the text color.
+ * - The em square has a defined font size. As a result, if the font's glyph exceeds its em square, it will be scaled down when it is drawn.
*/
result DrawText(const FloatPoint& point, const Tizen::Base::String& text, int length);
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method.
* @exception E_OPERATION_FAILED The operation has failed.
- * @remarks The foreground color (RGB value only) of the %Canvas control is used as the text color.
- * @remarks The em square has a defined font size. As a result, if the font's glyph exceeds its em square, it will be scaled down when it is drawn.
+ * @remarks
+ * - The foreground color (RGB value only) of the %Canvas control is used as the text color.
+ * - The em square has a defined font size. As a result, if the font's glyph exceeds its em square, it will be scaled down when it is drawn.
*/
result DrawText(const Point& point, const Tizen::Base::String& text, const Color& outlineColor);
/**
- * Draws a text with an outline rendering at the specified location.
+ * Draws a text with an outline rendering at a specified location.
*
* @since 2.1
*
* @return An error code
* @param[in] point The location to draw the text
- * @param[in] text The text to draw @n
+ * @param[in] text The text to draw
* @param[in] outlineColor The color that is set as outline color
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method.
* @exception E_OPERATION_FAILED The operation has failed.
- * @remarks The foreground color (RGB value only) of the %Canvas control is used as the text color.
- * @remarks The em square has a defined font size. As a result, if the font's glyph exceeds its em square, it will be scaled down when it is drawn.
+ * @remarks
+ * - The foreground color (RGB value only) of the %Canvas control is used as the text color.
+ * - The em square has a defined font size. As a result, if the font's glyph exceeds its em square, it will be scaled down when it is drawn.
*/
result DrawText(const FloatPoint& point, const Tizen::Base::String& text, const Color& outlineColor);
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method.
* @exception E_OPERATION_FAILED The operation has failed.
- *
- * @remarks The foreground color (RGB value only) of the %Canvas control is used as the text color.
- * @remarks The em square has a defined font size. As a result, if the font's glyph exceeds its em square, it will be scaled down when it is drawn.
+ * @remarks
+ * - The foreground color (RGB value only) of the %Canvas control is used as the text color.
+ * - The em square has a defined font size. As a result, if the font's glyph exceeds its em square, it will be scaled down when it is drawn.
*/
result DrawText(const Point& point, const Tizen::Base::String& text, int length, const Color& outlineColor);
/**
- * Draws a text with an outline rendering at the specified location and length.
+ * Draws a text with an outline rendering at a specified location and length.
*
* @since 2.1
*
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method.
* @exception E_OPERATION_FAILED The operation has failed.
- *
- * @remarks The foreground color (RGB value only) of the %Canvas control is used as the text color.
- * @remarks The em square has a defined font size. As a result, if the font's glyph exceeds its em square, it will be scaled down when it is drawn.
+ * @remarks
+ * - The foreground color (RGB value only) of the %Canvas control is used as the text color.
+ * - The em square has a defined font size. As a result, if the font's glyph exceeds its em square, it will be scaled down when it is drawn.
*/
result DrawText(const FloatPoint& point, const Tizen::Base::String& text, int length, const Color& outlineColor);
* @param[in] enrichedText The TextElement to draw
* @exception E_SUCCESS The method is successful.
* @exception E_DEVICE_UNAVAILABLE A specified device is invalid.
- *
- * @remarks The foreground color (RGB value only) of the %Canvas control is used as the text color.
- * @remarks The em square has a defined font size. As a result, if the font's glyph exceeds its em square, it will be scaled down when it is drawn.
+ * @remarks
+ * - The foreground color (RGB value only) of the %Canvas control is used as the text color.
+ * - The em square has a defined font size. As a result, if the font's glyph exceeds its em square, it will be scaled down when it is drawn.
*/
result DrawText(const Point& point, const EnrichedText& enrichedText);
/**
- * Draws an enriched text at the specified area.
+ * Draws an enriched text at a specified area.
*
* @since 2.1
*
* @param[in] enrichedText The TextElement to draw
* @exception E_SUCCESS The method is successful.
* @exception E_DEVICE_UNAVAILABLE A specified device is invalid.
- *
- * @remarks The foreground color (RGB value only) of the %Canvas control is used as the text color.
- * @remarks The em square has a defined font size. As a result, if the font's glyph exceeds its em square, it will be scaled down when it is drawn.
+ * @remarks
+ * - The foreground color (RGB value only) of the %Canvas control is used as the text color.
+ * - The em square has a defined font size. As a result, if the font's glyph exceeds its em square, it will be scaled down when it is drawn.
*/
result DrawText(const FloatPoint& point, const EnrichedText& enrichedText);
result DrawBitmap(const Point& point, const Bitmap& bitmap);
/**
- * Draws a bitmap image at the specified location.
+ * Draws a bitmap image at a specified location.
*
* @since 2.1
*
result DrawBitmap(const Rectangle& rect, const Bitmap& bitmap);
/**
- * Draws a bitmap image at the specified location.
+ * Draws a bitmap image at a specified location.
*
* @since 2.1
*
result DrawBitmap(const Rectangle& destRect, const Bitmap& srcBitmap, const Rectangle& srcRect);
/**
- * Draws a color data corresponding to a rectangle of pixels from the specified bitmap onto %Canvas.
+ * Draws a color data corresponding to a rectangle of pixels from a specified bitmap onto %Canvas.
*
* @since 2.1
*
result DrawBitmap(const Point& point, const Bitmap& bitmap, FlipDirection dir);
/**
- * Draws a flipped bitmap image at the specified location.
+ * Draws a flipped bitmap image at a specified location.
*
* @since 2.1
*
result DrawBitmap(const Point& point, const Bitmap& bitmap, const Point& pivot, int degree);
/**
- * Draws a rotated bitmap image at the specified location.
+ * Draws a rotated bitmap image at a specified location.
*
* @since 2.1
*
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method.
- *
* @remarks BitmapPixelFormat::BITMAP_PIXEL_FORMAT_R8G8B8A8 is not applicable for this method. @n
* The nine-patched bitmap must have a stretchable section by drawing one (or more) 1-pixel-wide black line(s) in the
* left and top part of the border.
result DrawNinePatchedBitmap(const Rectangle& rect, const Bitmap& bitmap);
/**
- * Draws a nine-patched bitmap at the specified location.
+ * Draws a nine-patched bitmap at a specified location.
*
* @since 2.1
*
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method.
- *
* @remarks BitmapPixelFormat::BITMAP_PIXEL_FORMAT_R8G8B8A8 is not applicable for this method. @n
* The nine-patched bitmap must have a stretchable section by drawing one (or more) 1-pixel-wide black line(s) in the
* left and top part of the border.
*
* @since 2.1
*
- * @return The Rectangle instance containing the location and size of the current %Canvas instance
+ * @return The FloatRectangle instance containing the location and size of the current %Canvas instance
* @remarks If this %Canvas instance is a Window %Canvas, it returns FloatRectangle(0.0f, 0.0f, w, h).
*/
FloatRectangle GetBoundsF(void) const;
*
* @since 2.1
*
- * @return The Rectangle instance containing the actual location and size of the current %Canvas instance
+ * @return The FloatRectangle instance containing the actual location and size of the current %Canvas instance
* @remarks If this %Canvas instance is a Window %Canvas, it returns FloatRectangle(0.0f, 0.0f, w, h).
*/
FloatRectangle GetActualBounds(void) const;
/**
* Sets the clip rectangle for a %Canvas control. @n
- * When a clip rectangle is set, any drawing is restricted within the specified rectangular area. The
+ * When a clip rectangle is set, any drawing is restricted within a specified rectangular area. The
* rectangular area defined is clipped at the edges of the %Canvas control so as to prevent the clipped rectangle
* from falling outside the %Canvas control.
*
*
* @since 2.1
*
- * @return An instance of Rectangle indicating the bounds of the clip rectangle
+ * @return An instance of FloatRectangle indicating the bounds of the clip rectangle
*/
FloatRectangle GetClipBoundsF(void) const;
* @exception E_SUCCESS The method is successful.
* @exception E_TIMEOUT The operation cannot be completed within the specified time period.
* @exception E_SYSTEM An unknown operating system error has occurred.
- *
* @remarks BufferInfo contains a valid physical memory information, regardless of the
* logical position and size of the %Canvas control.
*/
* @param[in] point The new position
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPERATION Window %Canvas does not support moving the position.
- *
- * @remarks Canvas::SetPosition(const Point& point) is not supported anymore since Tizen2.1. @n
+ * @remarks Canvas::SetPosition(const Point& point) is not supported anymore since Tizen 2.1. @n
* This function has influence on only Memory canvas. However, Memory Canvas Show() is deprecated in Tizen2.0, and this method has no meaning since Tizen2.0 and deprecated since Tizen2.1.
*/
result SetPosition(const Point& point);
* @param[in] y The new y-coordinate
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPERATION Window %Canvas does not support moving the position.
- *
- * @remarks Canvas::SetPosition(int x, int y) is not supported anymore since Tizen2.1. @n
+ * @remarks Canvas::SetPosition(int x, int y) is not supported anymore since Tizen 2.1. @n
* This function has influence on only Memory canvas. However, Memory Canvas Show() is deprecated in Tizen2.0, and this method has no meaning since Tizen2.0 and deprecated since Tizen2.1.
*/
result SetPosition(int x, int y);
result Construct(const Tizen::Graphics::Dimension& dim);
/**
- * Initializes this instance of %EnrichedText with the specified parameter.
+ * Initializes this instance of %EnrichedText with a specified parameter.
*
* @since 2.1
*
* @since 2.0
*
* @return An error code
- * @param[in] size The new size of the %EnrichedText @n
+ * @param[in] size The new size of the %EnrichedText instance @n
* The width and height must be greater than @c 0.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The value of the parameter is outside the valid range defined by the method.
* @since 2.1
*
* @return An error code
- * @param[in] size The new size of the %EnrichedText @n
+ * @param[in] size The new size of the %EnrichedText instance @n
* The width and height must be greater than @c 0.0f.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The value of the parameter is outside the valid range defined by the method.
*
* @since 2.1
*
- * @return An instance of %FloatDimension containing the width and the height of the %EnrichedText instance
+ * @return An instance of FloatDimension containing the width and the height of the %EnrichedText instance
*
*/
Tizen::Graphics::FloatDimension GetSizeF(void) const;
int GetLineHeight(int lineIndex) const;
/**
- * Gets the line height of the specified line.
+ * Gets the line height of a specified line.
*
* @since 2.1
*
* @since 2.0
*
* @return An error code
- * @param[in] startTextIndex The starting text index of the %EnrichedText
+ * @param[in] startTextIndex The starting text index of the %EnrichedText instance
* @param[in] textLength The length of the specified text @n
* It must be greater than or equal to @c 0.
* @param[out] width The width of the specified text
* @since 2.1
*
* @return An error code
- * @param[in] startTextIndex The starting text index of the %EnrichedText
+ * @param[in] startTextIndex The starting text index of the %EnrichedText instance
* @param[in] textLength The length of the specified text @n
* It must be greater than or equal to @c 0.
* @param[out] width The width of the specified text
result GetTextExtent(int startTextIndex, int textLength, float& width, float& height, int& actualLength) const;
/**
- * Gets the extent of the %EnrichedText instance on the assumption that all %TextElements are
+ * Gets the extent of the %EnrichedText instance on the assumption that all TextElements are
* expanded to one line.
*
* @since 2.0
+ *
* @return An error code
* @param[in] startTextIndex The starting text index of the EnrichedText
* @param[in] textLength The length of the specified text @n
result GetTextExtent(int startTextIndex, int textLength, Tizen::Graphics::Dimension& size, int& actualLength) const;
/**
- * Gets the extent of the %EnrichedText instance on the assumption that all %TextElements are
+ * Gets the extent of the %EnrichedText instance on the assumption that all TextElements are
* expanded to one line.
*
* @since 2.1
+ *
* @return An error code
- * @param[in] startTextIndex The starting text index of the EnrichedText
+ * @param[in] startTextIndex The starting text index of the %EnrichedText instance
* @param[in] textLength The length of the specified text @n
* It must be greater than or equal to @c 0.
* @param[out] size The extent of the specified text
result GetTextExtent(int startTextIndex, int textLength, Tizen::Graphics::FloatDimension& size, int& actualLength) const;
/**
- * Gets the extent of the %EnrichedText instance on the assumption that all %TextElements are
+ * Gets the extent of the %EnrichedText instance on the assumption that all TextElements are
* not expanded to one line. @n The %GetTextExtent() method is useful for finding the extent of %EnrichedText spanning multiple lines.
*
* @since 2.0
- * @return An instance of %Dimension containing the extent of the %EnrichedText instance, @n
+ * @return An instance of Dimension containing the extent of the %EnrichedText instance, @n
* else (-1, -1) if the method fails
*/
Tizen::Graphics::Dimension GetTextExtent(void) const;
/**
- * Gets the extent of the %EnrichedText instance on the assumption that all %TextElements are
- * not expanded to one line. @n The %GetTextExtent() method is useful for finding the extent of %EnrichedText spanning multiple lines.
+ * Gets the extent of the %EnrichedText instance on the assumption that all TextElements are
+ * not expanded to one line. @n The %GetTextExtentF() method is useful for finding the extent of %EnrichedText spanning multiple lines.
*
* @since 2.1
- * @return An instance of %FloatDimension containing the extent of the %EnrichedText instance, @n
+ * @return An instance of FloatDimension containing the extent of the %EnrichedText instance, @n
* else (-1.0f, -1.0f) if the method fails
*/
Tizen::Graphics::FloatDimension GetTextExtentF(void) const;
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OBJ_NOT_FOUND The required instance is not found.
- * @remarks The method throws @c E_OBJ_NOT_FOUND if there is no linked text at the specified position.
+ * @remarks This method throws @c E_OBJ_NOT_FOUND if there is no linked text at the specified position.
* @see Tizen::Base::Utility::LinkInfo
*/
result GetLinkInfoFromPosition(const Point& point, Tizen::Base::Utility::LinkInfo& linkInfo) const;
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OBJ_NOT_FOUND The required instance is not found.
- * @remarks The method throws @c E_OBJ_NOT_FOUND if there is no linked text at the specified position.
+ * @remarks This method throws @c E_OBJ_NOT_FOUND if there is no linked text at the specified position.
* @see Tizen::Base::Utility::LinkInfo
*/
result GetLinkInfoFromPosition(const FloatPoint& point, Tizen::Base::Utility::LinkInfo& linkInfo) const;
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OBJ_NOT_FOUND The required instance is not found.
- * @remarks The method throws @c E_OBJ_NOT_FOUND if there is no linked text at the specified position.
+ * @remarks This method throws @c E_OBJ_NOT_FOUND if there is no linked text at the specified position.
* @see Tizen::Base::Utility::LinkInfo
*/
result GetLinkInfoFromPosition(int x, int y, Tizen::Base::Utility::LinkInfo& linkInfo) const;
/**
- * Gets the information about the link at the specified position.
+ * Gets the information about the link at a specified position.
*
* @since 2.1
*
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OBJ_NOT_FOUND The required instance is not found.
- * @remarks The method throws @c E_OBJ_NOT_FOUND if there is no linked text at the specified position.
+ * @remarks This method throws @c E_OBJ_NOT_FOUND if there is no linked text at the specified position.
* @see Tizen::Base::Utility::LinkInfo
*/
result GetLinkInfoFromPosition(float x, float y, Tizen::Base::Utility::LinkInfo& linkInfo) const;
projects / platform / framework / native / uifw.git / commitdiff