*/
enum OverlayPanelEvaluationOption
{
- OVERLAY_PANEL_EVAL_OPT_GREATER_THAN, /**< The option evaluating the overlay panel bounds and finding the minimum bounds greater than the input bounds */
- OVERLAY_PANEL_EVAL_OPT_LESS_THAN /**< The option evaluating the overlay panel bounds and finding the maximum bounds smaller than input bounds */
+ OVERLAY_PANEL_EVAL_OPT_GREATER_THAN, /**< The option evaluating the overlay panel bounds and finding the minimum
+ bounds greater than the input bounds */
+ OVERLAY_PANEL_EVAL_OPT_LESS_THAN /**< The option evaluating the overlay panel bounds and finding the maximum
+ bounds smaller than input bounds */
};
/**
* %OverlayPanel. The Form that houses an %OverlayPanel can only have a black, opaque background.
* The overlay panel can manipulate the rotation and the size of input buffer.
*
- * Example: Please refer to the camera preview example of %Tizen::Media::Camera
+ * The following example demonstrates how to use the %OverlayPanel class.
*
* @code
//Sample code for OverlayPanelSampleForm.h
};
/**
- * This is the default constructor for this class.
- * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
+ * This is the default constructor for this class. @n
+ * The object is not fully constructed after this constructor is called. @n
+ * For full construction, the %Construct() method must be called right after calling this constructor.
*
* @since 2.1
*/
*
* @return An error code
* @param[in] rect The location and size of the %OverlayPanel control @n
- * The maximum size is equal to screen size. for example 720 x 1280 on a HD screen, or 480 x 800 on a WVGA screen. @n
+ * The maximum size is equal to screen size. for example 720 x 1280 on a HD screen, or 480 x 800 on a
+ * WVGA screen.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter @c is invalid.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The size of the control must be within the range defined by the minimum size and the maximum size.
- * To guarantee the size of the render buffer equal to the size of the %OverlayPanel after constructed, checks bounds of @c rect using EvaluateBounds() method before calling this method.
- * @remarks Do not use %OverlayPanel in combination with %OverlayRegion. If used, %OverlayPanel may not work as expected.
+ * @remarks
+ * - The size of the control must be within the range defined by the minimum size and the maximum size.
+ * - To guarantee the size of the render buffer equal to the size of the %OverlayPanel after constructed, checks bounds of
+ * @c rect using EvaluateBounds() method before calling this method.
+ * - Do not use %OverlayPanel in combination with %OverlayRegion. If used, %OverlayPanel may not work as expected.
* @see %Tizen::Ui::Container
*/
result Construct(const Tizen::Graphics::Rectangle& rect);
*
* @return An error code
* @param[in] rect The location and size of the %OverlayPanel control @n
- * The maximum size is equal to screen size. for example 720 x 1280 on a HD screen, or 480 x 800 on a WVGA screen. @n
+ * The maximum size is equal to screen size. for example 720 x 1280 on a HD screen, or 480 x 800 on a
+ * WVGA screen.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter @c is invalid.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The size of the control must be within the range defined by the minimum size and the maximum size.
- * To guarantee the size of the render buffer equal to the size of the %OverlayPanel after constructed, checks bounds of @c rect using EvaluateBounds() method before calling this method.
- * @remarks Do not use %OverlayPanel in combination with %OverlayRegion. If used, %OverlayPanel may not work as expected.
+ * @remarks
+ * - The size of the control must be within the range defined by the minimum size and the maximum size.
+ * - To guarantee the size of the render buffer equal to the size of the %OverlayPanel after constructed, checks bounds of
+ * @c rect using EvaluateBounds() method before calling this method.
+ * - Do not use %OverlayPanel in combination with %OverlayRegion. If used, %OverlayPanel may not work as expected.
* @see %Tizen::Ui::Container
*/
result Construct(const Tizen::Graphics::FloatRectangle& rect);
* Changes the size of the displayed renderer.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated. Instead of using this class, use the %OverlayRegion class, that supports video playback and camera preview.
+ * @deprecated This method is deprecated. Instead of using this class, use the %OverlayRegion class, that supports video playback and
+ * camera preview.
* @since 2.0
*
* @param[in] dim The dimension of the window to draw
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation.
- * @remarks A OverlayPanel becomes displayable only after it has been added to a form.
- * If you want to resize window to draw render buffer, calls this function after the OverlayPanel is added to a %Form control
+ * @remarks
+ * - A %OverlayPanel becomes displayable only after it has been added to a form.
+ * - If you want to resize window to draw render buffer, calls this function after the %OverlayPanel is added to a %Form control
* @code
* OverlayPanel* pOverlayPanel = new OverlayPanel();
* pOverlayPanel->Construct(Rectangle(100, 250, 300, 300));
* AddControl(pOverlayPanel);
*
* //...
- * result r = pOverlayPanel->SetRenderSize(Dimesion(300, 200));
+ * result r = pOverlayPanel->SetRenderSize(Dimension(300, 200));
* //...
* @endcode
*/
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation.
- * @remarks A OverlayPanel becomes displayable only after it has been added to a form.
- * If you want to resize window to draw render buffer, calls this function after the OverlayPanel is added to a %Form control
+ * @remarks
+ * - A %OverlayPanel becomes displayable only after it has been added to a form.
+ * - If you want to resize window to draw render buffer, calls this function after the %OverlayPanel is added to a %Form control
* @code
* OverlayPanel* pOverlayPanel = new OverlayPanel();
* pOverlayPanel->Construct(FloatRectangle(100.0, 250.0, 300.0, 300.0));
* AddControl(pOverlayPanel);
*
* //...
- * result r = pOverlayPanel->SetRenderSize(FloatDimesion(300.0, 200.0));
+ * result r = pOverlayPanel->SetRenderSize(FloatDimension(300.0, 200.0));
* //...
* @endcode
*/
*
* @since 2.1
*
- * @param[in] destDim The dimension of the window to be drawn
+ * @param[in] destDim The dimension of the window to draw
* @param[in] srcBuffer The source buffer
* @param[in] srcDim The source dimension
* @param[in] srcFormat The pixel format of buffer data
*
* @since 2.1
*
- * @param[in] destDim The dimension of the window to be drawn
+ * @param[in] destDim The dimension of the window to draw
* @param[in] srcBuffer The source buffer
* @param[in] srcDim The source dimension
* @param[in] srcFormat The pixel format of buffer data
* Gets the masking color of this control.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because masking color does not exist on OverlayPanel any more.
+ * @deprecated This method is deprecated because masking color does not exist on %OverlayPanel any more.
* @remarks Do not call this method. It is not supported.
* @since 2.0
*
* @exception E_INVALID_ARG The specified input parameter @c is invalid.
* @exception E_UNSUPPORTED_OPTION The specified input parameter @c is not supported.
* @exception E_OPERATION_FAILED The operation has failed.
- * @remarks Due to the hardware accelerated rendering, there are limitations for an overlay panel. @n
- * The hardware capability for an overlay region is checked by using the GetWidthUnit(), GetHeightUnit() and GetMaxCount(). @n
- * If the application runs on multi-screen resolutions, the specified bounds may not meet the hardware limitations of the overlay panel.
- * In such cases, Construct() will return E_INVALID_ARG. @n
- * To prevent this kind of problem, the application must use the OverlayPanel::EvaluateBounds() method to get a validated bounds
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - Due to the hardware accelerated rendering, there are limitations for an overlay panel.
+ * - The hardware capability for an overlay region is checked by using the GetWidthUnit(), GetHeightUnit() and GetMaxCount().
+ * - If the application runs on multi-screen resolutions, the specified bounds may not meet the hardware limitations of the overlay
+ * panel. In such cases, Construct() will return @c E_INVALID_ARG. @n
+ * To prevent this kind of problem, the application must the this method to get a validated bounds
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
static result EvaluateBounds(OverlayPanelEvaluationOption option, Tizen::Graphics::Rectangle& rect, bool& modified);
* @exception E_INVALID_ARG The specified input parameter @c is invalid.
* @exception E_UNSUPPORTED_OPTION The specified input parameter @c is not supported.
* @exception E_OPERATION_FAILED The operation has failed.
- * @remarks Due to the hardware accelerated rendering, there are limitations for an overlay panel. @n
- * The hardware capability for an overlay region is checked by using the GetWidthUnit(), GetHeightUnit() and GetMaxCount(). @n
- * If the application runs on multi-screen resolutions, the specified bounds may not meet the hardware limitations of the overlay panel.
- * In such cases, Construct() will return E_INVALID_ARG. @n
- * To prevent this kind of problem, the application must use the OverlayPanel::EvaluateBounds() method to get a validated bounds
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - Due to the hardware accelerated rendering, there are limitations for an overlay panel.
+ * - The hardware capability for an overlay region is checked by using the GetWidthUnit(), GetHeightUnit() and GetMaxCount().
+ * - If the application runs on multi-screen resolutions, the specified bounds may not meet the hardware limitations of the overlay
+ * panel. In such cases, Construct() will return E_INVALID_ARG. @n
+ * To prevent this kind of problem, the application must use this method to get a validated bounds
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
static result EvaluateBounds(OverlayPanelEvaluationOption option, Tizen::Graphics::FloatRectangle& rect, bool& modified);
*
* @since 2.1
*
- * @return A list of the pixel formats supported by the %OverlayPanel class, @n
+ * @return
+ * - A list of the pixel formats supported by the %OverlayPanel class, @n
* else @c null if no pixel format is supported or an exception occurs
- * @remark The specific error code can be accessed using the GetLastResult() method. @n
- * The return value and each item in the list must be deleted by the caller. @n
- * The format list can vary depending on the device. After checking the supported formats using this API, it's better to use a proper pixel format. @n
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value and each item in the list must be deleted by the caller.
+ * - The format list can vary depending on the device. After checking the supported formats using this method,
+ * it's better to use a proper pixel format.
*/
static Tizen::Base::Collection::IListT<BufferPixelFormat>* GetSupportedBufferPixelFormatListN(void);
*/
enum OverlayRegionType
{
- OVERLAY_REGION_TYPE_PRIMARY_CAMERA = 1, /**< The primary camera type @n
- An overlay region displays the auto-rotated primary camera input that comes from Camera. */
- OVERLAY_REGION_TYPE_SECONDARY_CAMERA, /**< The secondary camera type @n
- An overlay region displays the auto-rotated and mirrored secondary camera input that comes from Camera. */
- OVERLAY_REGION_TYPE_NORMAL, /**< The normal type @n
- An overlay region displays the user input as it is. */
+ OVERLAY_REGION_TYPE_PRIMARY_CAMERA = 1 /**< The primary camera type @n An overlay region displays the auto-rotated
+ primary camera input that comes from Camera. */
+ OVERLAY_REGION_TYPE_SECONDARY_CAMERA, /**< The secondary camera type @n An overlay region displays the auto-rotated
+ and mirrored secondary camera input that comes from Camera. */
+ OVERLAY_REGION_TYPE_NORMAL, /**< The normal type @n An overlay region displays the user input as it is. */
OVERLAY_REGION_TYPE_MAX, // This enum value is for internal use only. Using this enum value can cause behavioral, security-related, and consistency-related issues in the application.
OVERLAY_REGION_TYPE_MIN = 0 // This enum value is for internal use only. Using this enum value can cause behavioral, security-related, and consistency-related issues in the application.
};
*/
enum OverlayRegionEvaluationOption
{
- OVERLAY_REGION_EVALUATION_OPTION_GREATER_THAN, /**< The option evaluating the overlay region bounds and finding the minimum bounds greater than the input bounds */
- OVERLAY_REGION_EVALUATION_OPTION_LESS_THAN, /**< The option evaluating the overlay region bounds and finding the maximum bounds smaller than input bounds */
+ OVERLAY_REGION_EVALUATION_OPTION_GREATER_THAN, /**< The option evaluating the overlay region bounds and finding the minimum
+ bounds greater than the input bounds */
+ OVERLAY_REGION_EVALUATION_OPTION_LESS_THAN, /**< The option evaluating the overlay region bounds and finding the maximum
+ bounds smaller than input bounds */
};
* @final This class is not intended for extension.
*
* The %OverlayRegion class displays a region of an overlay surface, which is used to play back a video or show the camera preview.
- * @n
+ *
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_overlay_region.htm">OverlayRegion</a>.
*
+ * The following example demonstrates how to use the %OverlayRegion class.
* @code
//Sample code for OverlayRegionSampleForm.h
#include <FGraphics.h>
*
* @since 2.0
*
- * @return An instance of Rectangle that represents the position of the top-left corner, the width, and the height of the overlay region
- * @remarks The shape of an overlay region is rectangular, which is defined by the top-left point, and the width or height. The position of the top-left
- * point is relative to the top-left corner of the parent form.
+ * @return An instance of Tizen::Graphics::Rectangle that represents the position of the top-left corner, the width, and
+ * the height of the overlay region
+ * @remarks The shape of an overlay region is rectangular, which is defined by the top-left point, and the width or height. @n
+ * The position of the top-left point is relative to the top-left corner of the parent form.
*
*/
Tizen::Graphics::Rectangle GetBounds(void) const;
*
* @since 2.1
*
- * @return An instance of FloatRectangle that represents the position of the top-left corner, the width, and the height of the overlay region
- * @remarks The shape of an overlay region is rectangular, which is defined by the top-left point, and the width or height. The position of the top-left
- * point is relative to the top-left corner of the parent form.
+ * @return An instance of Tizen::Graphics::FloatRectangle that represents the position of the top-left corner, the width,
+ * and the height of the overlay region
+ * @remarks The shape of an overlay region is rectangular, which is defined by the top-left point, and the width or height. @n
+ * The position of the top-left point is relative to the top-left corner of the parent form.
*
*/
Tizen::Graphics::FloatRectangle GetBoundsF(void) const;
* @param[out] y The y position of the top-left corner of the overlay region
* @param[out] width The width of the rectangular region
* @param[out] height The height of the rectangular region
- * @remarks The shape of an overlay region is rectangular, which is defined by the top-left point, and the width or height. The position of the top-left
- * point is relative to the top-left corner of the parent form.
+ * @remarks The shape of an overlay region is rectangular, which is defined by the top-left point, and the width or height. @n
+ * The position of the top-left point is relative to the top-left corner of the parent form.
*
*/
void GetBounds(int& x, int& y, int& width, int& height) const;
* @param[out] y The y position of the top-left corner of the overlay region
* @param[out] width The width of the rectangular region
* @param[out] height The height of the rectangular region
- * @remarks The shape of an overlay region is rectangular, which is defined by the top-left point, and the width or height. The position of the top-left
- * point is relative to the top-left corner of the parent form.
+ * @remarks The shape of an overlay region is rectangular, which is defined by the top-left point, and the width or height. @n
+ * The position of the top-left point is relative to the top-left corner of the parent form.
*
*/
void GetBounds(float& x, float& y, float& width, float& height) const;
/**
* Sets the input buffer. @n
- * Due to the hardware accelerated rendering, there are limitations for an input buffer. The input buffer has the same restriction regarding its size as
- * the overlay region and it can be checked by using the GetWidthUnit(), GetHeightUnit() and GetMaxCount(). If the specified condition is not satisfied,
- * the E_INVALID_ARG exception is returned. If an input buffer does not fit to the bounds of the overlay region, it will be scaled up or down to the overlay
- * region bounds without keeping the ratio of input.
+ * Due to the hardware accelerated rendering, there are limitations for an input buffer. @n
+ * The input buffer has the same restriction regarding its size as the overlay region and it can be checked by using the GetWidthUnit(),
+ * GetHeightUnit() and GetMaxCount(). If the specified condition is not satisfied, the @c E_INVALID_ARG exception is returned. @n
+ * If an input buffer does not fit to the bounds of the overlay region, it will be scaled up or down to the overlay region bounds without
+ * keeping the ratio of input.
*
* @since 2.0
*
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, that is, this control cannot be displayed.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, that is,
+ * this control cannot be displayed.
* @exception E_SYSTEM A system error has occurred.
*/
result Show(void);
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_UNSUPPORTED_OPTION A specified input parameter is not supported.
* @exception E_SYSTEM A system error has occurred.
- * @remarks Due to the hardware accelerated rendering, there are limitations for an overlay region. @n
- * The hardware capability for an overlay region is checked by using the GetWidthUnit(), GetHeightUnit() and GetMaxCount(). @n
- * If the application runs on multi-screen resolutions, the specified bounds may not meet the hardware limitations of the overlay region. In
- * such cases, GetOverlayRegionN() will return E_INVALID_ARG. @n
- * To prevent this kind of problem, the application must use the OverlayRegion::EvaluateBounds() method to get a validated bounds that can be
- * used as the input bounds of the GetOverlayRegionN() method.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - Due to the hardware accelerated rendering, there are limitations for an overlay region.
+ * - The hardware capability for an overlay region is checked by using the GetWidthUnit(), GetHeightUnit() and GetMaxCount().
+ * - If the application runs on multi-screen resolutions, the specified bounds may not meet the hardware limitations of the
+ * overlay region. In such cases, Form::GetOverlayRegionN(const Tizen::Graphics::Rectangle&, OverlayRegionType) will return
+ * @c E_INVALID_ARG. @n To prevent this kind of problem, the application must use this method to get a validated bounds that can be
+ * used as the input bounds of the %Form::GetOverlayRegionN() method.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
static bool EvaluateBounds(OverlayRegionEvaluationOption option, Tizen::Graphics::Rectangle& rect, bool& modified);
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_UNSUPPORTED_OPTION A specified input parameter is not supported.
* @exception E_SYSTEM A system error has occurred.
- * @remarks Due to the hardware accelerated rendering, there are limitations for an overlay region. @n
- * The hardware capability for an overlay region is checked by using the GetWidthUnit(), GetHeightUnit() and GetMaxCount(). @n
- * If the application runs on multi-screen resolutions, the specified bounds may not meet the hardware limitations of the overlay region. In
- * such cases, GetOverlayRegionNF() will return E_INVALID_ARG. @n
- * To prevent this kind of problem, the application must use the OverlayRegion::EvaluateBoundsF() method to get a validated bounds that can be
- * used as the input bounds of the GetOverlayRegionNF() method.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - Due to the hardware accelerated rendering, there are limitations for an overlay region.
+ * - The hardware capability for an overlay region is checked by using the GetWidthUnit(), GetHeightUnit() and GetMaxCount().
+ * - If the application runs on multi-screen resolutions, the specified bounds may not meet the hardware limitations of the overlay
+ * region. In such cases, Form::GetOverlayRegionN(const Tizen::Graphics::FloatRectangle&, OverlayRegionType) will return @c E_INVALID_ARG. @n To prevent this kind of problem, the application
+ * must use this method to get a validated bounds that can be used as the input bounds of the %Form::GetOverlayRegionN() method.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
static bool EvaluateBounds(OverlayRegionEvaluationOption option, Tizen::Graphics::FloatRectangle& rect, bool& modified);
* else @c null if no pixel format is supported or an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remark The specific error code can be accessed using the GetLastResult() method. @n
- * The return value and each item in the list must be deleted by the caller. @n
- * The format list can vary depending on the device. After checking the supported formats using this API, it's better to use a proper pixel format. @n
+ * @remark
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value and each item in the list must be deleted by the caller.
+ * - The format list can vary depending on the device. After checking the supported formats using this method,
+ * it's better to use a proper pixel format.
*/
static Tizen::Base::Collection::IListT< OverlayRegionBufferPixelFormat >* GetSupportedBufferPixelFormatListN(void);
projects / framework / osp / uifw.git / commitdiff