* The specified @c control is an instance of Window, or this control's parent container.
* @exception E_MAX_EXCEEDED The number of child controls has exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks When the control is added, it is placed at the top of the drawing stack maintained by the container.@n
- * This means the last control added is drawn last
- * @remarks A control becomes displayable only after it has been added to a displayable container. Some methods may not work normally if the methods
- * of the control are called before adding the control to a container. After the control is added to a %Container, the OnInitializing()
- * method of the control are called before adding the control to a container. After the control is added to a %Container, the
- * OnInitializing() method of the control is invoked for the initialization of the control such as creating and adding child controls.
- * @see Tizen::Ui::Control::OnInitializing()
+ * @remarks
+ * - When the control is added, it is placed at the top of the drawing stack maintained by the container.@n
+ * This means the last control added is drawn last
+ * - A control becomes displayable only after it has been added to a displayable container. Some methods may not work normally if the methods
+ * of the control are called before adding the control to a container. After the control is added to a %Container, the Control::OnInitializing()
+ * method of the control are called before adding the control to a container. After the control is added to a %Container, the
+ * %Control::OnInitializing() method of the control is invoked for the initialization of the control such as creating and adding child controls.
* @see Tizen::Ui::Control::OnTerminating()
* @code
* {
* pPanel->Construct(Rectangle(100, 250, 300, 300));
*
* Form* pForm = new Form();
- * pForm->Construct(FORM_STYLE_NORMAL|FORM_STYLE_TITLE|FORM_STYLE_PORTRAIT_INDICATOR);
+ * pForm->Construct(FORM_STYLE_NORMAL|FORM_STYLE_PORTRAIT_INDICATOR);
* pForm->AddControl(*pPanel);
*
* //...
* - When a control is added, it is placed at the top of the drawing stack maintained by the container.@n
* This means the control that is added last is drawn last.
* - A control becomes displayable only after it has been added to a displayable container.
- * Some methods may not work normally if the methods of the control are called before adding the control to a container. After the control is added to a %Container, the OnInitializing()
+ * Some methods may not work normally if the methods of the control are called before adding the control to a container.
+ * After the control is added to a %Container, the Control::OnInitializing()
* method of the control are called before adding the control to a container. After the control is added to a %Container, the
- * OnInitializing() method of the control is invoked for the initialization of the control such as creating and adding child controls.
- * @see Tizen::Ui::Control::OnInitializing()
+ * %Control::OnInitializing() method of the control is invoked for the initialization of the control such as creating and adding child controls.
* @see Tizen::Ui::Control::OnTerminating()
* @code
* {
* pPanel->Construct(Rectangle(100, 250, 300, 300));
*
* Form* pForm = new Form();
- * pForm->Construct(FORM_STYLE_NORMAL|FORM_STYLE_TITLE|FORM_STYLE_PORTRAIT_INDICATOR);
+ * pForm->Construct(FORM_STYLE_NORMAL|FORM_STYLE_PORTRAIT_INDICATOR);
* pForm->AddControl(pPanel);
*
* //...
result AddControl(Control* pControl);
/**
- * Before the system calls OnDraw() method to allow the user to do custom drawing, this method is called to clear the canvas. The user can override this method to change this default behavior.
+ * Before the system calls OnDraw() method to allow the user to do custom drawing, this method is called to clear the canvas. @n
+ * The user can override this method to change this default behavior.
*
* @since 2.0
*
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified instance is not found within the indicated range (that is, the @c control is not found).
* @exception E_SYSTEM A system error has occurred.
- * @remarks The removed child control is deleted from the memory. Before deletion, OnTerminating() of the child control is called.
- * If OnTerminating() method is overridden and returns an exception, that exception is propagated.
- * @see Tizen::Ui::Control::OnTerminating()
+ * @remarks The removed child control is deleted from the memory. Before deletion, Control::OnTerminating() of the child control is called.
+ * If %Control::OnTerminating() method is overridden and returns an exception, that exception is propagated.
*/
result RemoveControl(const Control& control);
* @exception E_OBJ_NOT_FOUND The specified instance is not found within the indicated range (that is, the @c control is not found).
* @exception E_INVALID_ARG The specified @c pControl is @c null.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The removed child control is deleted from the memory. Before deletion, OnTerminating() of the child control is called.
- * If OnTerminating() method is overridden and returns an exception, that exception is propagated.
- * @see Tizen::Ui::Control::OnTerminating()
+ * @remarks The removed child control is deleted from the memory. Before deletion, Control::OnTerminating() of the child control is called.
+ * If %Control::OnTerminating() method is overridden and returns an exception, that exception is propagated.
*/
result RemoveControl(Control* pControl);
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c index is out of range.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The removed child control is deleted from the memory. Before deletion, OnTerminating() of the child control is called.
- * If OnTerminating() method is overridden and returns an exception, that exception is propagated.
- * @see Tizen::Ui::Control::OnTerminating()
+ * @remarks The removed child control is deleted from the memory. Before deletion, Control::OnTerminating() of the child control is called.
+ * If %Control::OnTerminating() method is overridden and returns an exception, that exception is propagated.
*/
result RemoveControl(int index);
*
* @since 2.0
*
- * @remarks The removed child controls are deleted from the memory. Before deletion, OnTerminating() of the child control is called.
- * @see Tizen::Ui::Control::OnTerminating()
+ * @remarks The removed child controls are deleted from the memory. Before deletion, Control::OnTerminating() of the child control is called.
*/
void RemoveAllControls(void);
* else @c null if the layout does not exist
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks The returned layout can be @c null, if it is not set.
*/
Layout* GetPortraitLayoutN(void) const;
* else @c null if the layout does not exist
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks The returned layout can be @c null, if it is not set.
*/
Layout* GetLandscapeLayoutN(void) const;
* else @c null if the layout does not exist
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks The returned layout can be @c null, if it is not set.
*/
Layout* GetLayoutN(void) const;
* @exception E_INVALID_ARG A specified input parameter is invalid.@n
* The specified control is not a child of this
* container.
- * @remarks If multiple child control are set as "always on top", then
- * their relative order is not specified. If the specified child
- * control is a container, then all its children inherit this
- * property and they are "always on top" of other controls.@n
- * If the method is called on a child control with a @c false
- * value, then it's state becomes normal. The relative order
- * of child controls in normal state is not specified.
+ * @remarks
+ * - If multiple child control are set as "always on top", then
+ * their relative order is not specified. If the specified child
+ * control is a container, then all its children inherit this
+ * property and they are "always on top" of other controls.
+ * - If the method is called on a child control with a @c false
+ * value, then it's state becomes normal. The relative order
+ * of child controls in normal state is not specified.
* @see IsControlAlwaysOnTop()
*/
result SetControlAlwaysOnTop(Tizen::Ui::Control& control, bool alwaysOnTop);
* @exception E_INVALID_ARG A specified input parameter is invalid.@n
* The specified control is not a child of this
* container.
- * @remarks If multiple child control are set as "always at bottom", then
- * their relative order is not specified. If the specified child
- * control is a container, then all its children inherit this
- * property and they become "always at bottom" as well.@n
- * If the method is called on a child control with a @c false
- * value, then it's state becomes normal. The relative order
- * of child controls in normal state is not specified.
+ * @remarks
+ * - If multiple child control are set as "always at bottom", then
+ * their relative order is not specified. If the specified child
+ * control is a container, then all its children inherit this
+ * property and they become "always at bottom" as well.
+ * - If the method is called on a child control with a @c false
+ * value, then it's state becomes normal. The relative order
+ * of child controls in normal state is not specified.
* @see IsControlAlwaysAtBottom()
*/
result SetControlAlwaysAtBottom(Tizen::Ui::Control& control, bool alwaysAtBottom);
* @exception E_INVALID_ARG A specified input parameter is invalid.@n
* The specified control is not a child of this
* container.
- * @remarks The specific error code can be accessed using the GetLastResult()
- * method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetControlAlwaysAtBottom()
*/
bool IsControlAlwaysAtBottom(const Tizen::Ui::Control& control) const;
* else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @remarks This method must be called from the derived classes's construct methods.
- * @remarks If the @c resizable is @c false, IsResizable() returns @c false.
- * @see IsResizable()
+ * @remarks
+ * - This method must be called from the derived classes's construct methods.
+ * - If the @c resizable is @c false, IsResizable() returns @c false.
*/
result Construct(const Tizen::Graphics::Rectangle& rect, bool resizable = true, bool movable = true);
* else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @remarks This method must be called from the derived classes's construct methods.
- * @remarks If the @c resizable is @c false, IsResizable() returns @c false.
- * @see IsResizable()
+ * @remarks
+ * - This method must be called from the derived classes's construct methods.
+ * - If the @c resizable is @c false, IsResizable() returns @c false.
*/
result Construct(const Tizen::Graphics::FloatRectangle& rect, bool resizable = true, bool movable = true);
* else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @remarks This method must be called from the derived classes's construct methods.
- * @remarks If the @c resizable is @c false, IsResizable() returns @c false.
- * @see IsResizable()
- * @see Tizen::Ui::Layout
+ * @remarks
+ * - This method must be called from the derived classes's construct methods.
+ * - If the @c resizable is @c false, IsResizable() returns @c false.
* @see Tizen::Ui::Container::GetLayoutN()
*/
result Construct(const Tizen::Ui::Layout& layout, const Tizen::Graphics::Rectangle& rect, bool resizable = true, bool movable = true);
* else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @remarks This method must be called from the derived classes's construct methods.
- * @remarks If the @c resizable is @c false, IsResizable() returns @c false.
- * @see IsResizable()
- * @see Tizen::Ui::Layout
+ * @remarks
+ * - This method must be called from the derived classes's construct methods.
+ * - If the @c resizable is @c false, IsResizable() returns @c false.
* @see Tizen::Ui::Container::GetLayoutN()
*/
result Construct(const Tizen::Ui::Layout& layout, const Tizen::Graphics::FloatRectangle& rect, bool resizable = true, bool movable = true);
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @remarks If the @c resizable is @c false, IsResizable() returns @c false.
- * @see IsResizable()
- * @see Tizen::Ui::Layout
- * @see Tizen::Ui::Layout
* @see Tizen::Ui::Container::GetLayoutN()
* @see Tizen::Ui::Container::GetPortraitLayoutN()
* @see Tizen::Ui::Container::GetLandscapeLayoutN()
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @remarks If the @c resizable is @c false, IsResizable() returns @c false.
- * @see IsResizable()
- * @see Tizen::Ui::Layout
- * @see Tizen::Ui::Layout
* @see Tizen::Ui::Container::GetLayoutN()
* @see Tizen::Ui::Container::GetPortraitLayoutN()
* @see Tizen::Ui::Container::GetLandscapeLayoutN()
* @exception E_SYSTEM A system error has occurred.
* @remarks The @c control must be first added to this container. @n
* Call the Invalidate() method after this, to apply the change to be shown.
- * @see Invalidate()
* @see GetControlAt()
*
*/
* @exception E_SYSTEM A system error has occurred.
* @remarks The @c control must be first added to this container. @n
* Then the Invalidate() method is called to show the applied changes.
- * @see Invalidate()
* @see GetControlAt()
*
*/
void RemoveDragDropEventListenerF(IDragDropEventListenerF& listener);
/**
- * Overrides this method to provide user-specific initialization code before the control is added to a container.
+ * Overrides this method to provide user-specific initialization code before the control is added to a container. @n
+ * The %OnInitializing() method is called when the control is about to be added to a container.
+ * To cancel adding the control to the parent, return @c E_FAILURE in this method.
*
* @since 2.0
*
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_FAILURE The method has failed.
- * @remarks This method is called when the control is about to be added to a container.
- * @remarks To cancel adding this control to the parent, return @c E_FAILURE in this method.
* @see OnTerminating()
*/
virtual result OnInitializing(void);
/**
- * Overrides this method to provide user-specific termination code.
+ * Overrides this method to provide user-specific termination code. @n
+ * The %OnTerminating() method is called right before the control is removed from the container, or Destroy() method is called. @n
+ * To cancel the removal or Destroy() operation, return any exception other than @c E_SUCCESS.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_FAILURE The method has failed.
- * @remarks
- * - This method is called right before the control is removed from the container, or Destroy() method is called.
- * - To cancel the removal or Destroy() operation, return any exception other than @c E_SUCCESS.
* @see OnInitializing()
*/
virtual result OnTerminating(void);
* @since 2.1
*
* @exception E_SUCCESS The method is successful.
- * @remarks The control is deleted from memory. Before it is deleted, OnTerminating() is called if it is attached to the main tree.
- * @remarks If OnTerminating() method is overridden and returns an exception, that exception is propagated.
- * @see Tizen::Ui::Control:OnTerminating()
+ * @remarks
+ * - The control is deleted from memory. Before it is deleted, Control::OnTerminating() is called if it is attached to the main tree.
+ * - If %Control::OnTerminating() method is overridden and returns an exception, that exception is propagated.
*/
result Destroy(void);
*
* @return @c true if the control is movable, @n
* else @c false
+ *
* @exception E_SUCCESS The method is successful.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks When control is not movable SetPosition() and SetBounds() return @c E_UNSUPPORTED_OPERATION.
- * @see SetPosition()
- * @see SetBounds()
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - If the control is not movable, SetPosition() and SetBounds() return @c E_UNSUPPORTED_OPERATION.
*/
bool IsMovable(void) const;
* @return @c true if the control is resizable, @n
* else @c false
* @exception E_SUCCESS The method is successful.
- * @remarks Even if this method returns @c true, the size can be changed internally.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks When control is not resizable,
- * SetSize(), SetBounds(), SetMinimumSize() and SetMaximumSize() return @c E_UNSUPPORTED_OPERATION.
- * @see SetSize()
- * @see SetBounds()
- * @see SetMinimumSize()
- * @see SetMaximumSize()
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - If the control is not resizable, SetSize(), SetBounds(), SetMinimumSize() and SetMaximumSize() return @c E_UNSUPPORTED_OPERATION.
*/
bool IsResizable(void) const;
*
* @return An instance of the Tizen::Graphics::Rectangle that represents the position of top-left corner,
* the width, and the height of the control
- * @remarks The shape of the control is rectangular that 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 container.
+ * @remarks The position of the top-left point is relative to the top-left corner of the parent container.
* @see SetBounds()
*/
Tizen::Graphics::Rectangle GetBounds(void) const;
*
* @return An instance of the Tizen::Graphics::FloatRectangle that represents the position of top-left corner,
* the width, and the height of the control
- * @remarks The shape of the control is rectangular that 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 container.
+ * @remarks The position of the top-left point is relative to the top-left corner of the parent container.
* @see SetBounds()
*/
Tizen::Graphics::FloatRectangle GetBoundsF(void) const;
* @param[out] y The y position of top-left corner of the control
* @param[out] width The width of the rectangular region
* @param[out] height The height of the rectangular region
- * @remarks The shape of the control is regarded as a rectangle that 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 container.
+ * @remarks The position of the top-left point is relative to the top-left corner of the parent container.
* @see SetBounds()
*/
void GetBounds(int& x, int& y, int& width, int& height) const;
* @param[out] y The y position of top-left corner of the control
* @param[out] width The width of the rectangular region
* @param[out] height The height of the rectangular region
- * @remarks The shape of the control is regarded as a rectangle that 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 container.
+ * @remarks The position of the top-left point is relative to the top-left corner of the parent container.
* @see SetBounds()
*/
void GetBounds(float& x, float& y, float& width, float& height) const;
*
* @since 2.0
*
- * @return The position of the control's top-left corner
- * @remarks The position of top-left corner is relative to the top-left corner of its parent container.
+ * @return The position of the control's top-left corner that is relative to the top-left corner of its parent container
* @see GetBounds()
*/
Tizen::Graphics::Point GetPosition(void) const;
*
* @since 2.1
*
- * @return The position of the control's top-left corner
- * @remarks The position of top-left corner is relative to the top-left corner of its parent container.
+ * @return The position of the control's top-left corner that is relative to the top-left corner of its parent container
* @see GetBounds()
*/
Tizen::Graphics::FloatPoint GetPositionF(void) const;
*
* @since 2.0
*
- * @param[out] x The x position of the control's top-left corner
- * @param[out] y The y position of the control's top-left corner
- * @remarks The position of top-left corner is relative to the top-left corner of its parent container.
+ * @param[out] x The x position of the control's top-left corner that is relative to the top-left corner of its parent container
+ * @param[out] y The y position of the control's top-left corner that is relative to the top-left corner of its parent container
* @see GetBounds()
*/
void GetPosition(int& x, int& y) const;
*
* @since 2.1
*
- * @param[out] x The x position of the control's top-left corner
- * @param[out] y The y position of the control's top-left corner
- * @remarks The position of top-left corner is relative to the top-left corner of its parent container.
+ * @param[out] x The x position of the control's top-left corner that is relative to the top-left corner of its parent container
+ * @param[out] y The y position of the control's top-left corner that is relative to the top-left corner of its parent container
* @see GetBounds()
*/
void GetPosition(float& x, float& y) const;
void GetSize(float& width, float& height) const;
/**
- * Gets the x position of the control. @n
- * The position of control is relative to the top-left corner of its parent container.
+ * Gets the x position of the control.
*
* @since 2.0
*
- * @return The x position of the control
+ * @return The x position of the control @n
+ * The position of control is relative to the top-left corner of its parent container.
* @see GetBounds()
* @see GetPosition()
* @see GetY()
int GetX(void) const;
/**
- * Gets the x position of the control. @n
- * The position of control is relative to the top-left corner of its parent container.
+ * Gets the x position of the control.
*
* @since 2.1
*
- * @return The x position of the control
+ * @return The x position of the control @n
+ * The position of control is relative to the top-left corner of its parent container.
* @see GetBounds()
* @see GetPosition()
* @see GetYF()
float GetXF(void) const;
/**
- * Gets the y position of the control. @n
- * The position of control is relative to the top-left corner of its parent container.
+ * Gets the y position of the control.
*
* @since 2.0
*
- * @return The y position of the control
+ * @return The y position of the control @n
+ * The position of control is relative to the top-left corner of its parent container.
* @see GetBounds()
* @see GetPosition()
* @see GetX()
int GetY(void) const;
/**
- * Gets the y position of the control. @n
- * The position of control is relative to the top-left corner of its parent container.
+ * Gets the y position of the control.
*
* @since 2.1
*
- * @return The y position of the control
+ * @return The y position of the control @n
+ * The position of control is relative to the top-left corner of its parent container.
* @see GetBounds()
* @see GetPosition()
* @see GetXF()
*
* @since 2.0
*
- * @return The minimum size of the control
+ * @return The minimum size of the control @n
+ * The first call of the method returns the system-defined minimum size.
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The first call of the method returns the system-defined minimum size.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Graphics::Dimension GetMinimumSize(void) const;
*
* @since 2.1
*
- * @return The minimum size of the control
+ * @return The minimum size of the control @n
+ * The first call of the method returns the system-defined minimum size.
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The first call of the method returns the system-defined minimum size.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Graphics::FloatDimension GetMinimumSizeF(void) const;
*
* @since 2.0
*
- * @return The maximum size of the control
+ * @return The maximum size of the control @n
+ * The first call of the method returns the system-defined maximum size.
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The first call of the method returns the system-defined maximum size.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Graphics::Dimension GetMaximumSize(void) const;
*
* @since 2.1
*
- * @return The maximum size of the control
+ * @return The maximum size of the control @n
+ * The first call of the method returns the system-defined maximum size.
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The first call of the method returns the system-defined maximum size.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Graphics::FloatDimension GetMaximumSizeF(void) const;
* @since 2.0
*
* @return An error code
- * @param[in] rect The new bounds of the control
+ * @param[in] rect The new bounds of the control @n
+ * The size of the control must be within the range defined by the minimum size and the maximum size.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The control has not been constructed as yet.
* @exception E_UNSUPPORTED_OPERATION This control is neither movable nor resizable.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
* @remarks Do not override this method.
- * @remarks The size of the control must be within the range defined by the minimum size and the maximum size.
* @see IsMovable()
* @see IsResizable()
* @see GetMinimumSize()
* @since 2.1
*
* @return An error code
- * @param[in] rect The new bounds of the control
+ * @param[in] rect The new bounds of the control @n
+ * The size of the control must be within the range defined by the minimum size and the maximum size.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The control has not been constructed as yet.
* @exception E_UNSUPPORTED_OPERATION This control is neither movable nor resizable.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
* @remarks Do not override this method.
- * @remarks The size of the control must be within the range defined by the minimum size and the maximum size.
* @see IsMovable()
* @see IsResizable()
* @see GetMinimumSize()
* @since 2.0
*
* @return An error code
- * @param[in] x The new x position of the control
- * @param[in] y The new y position of the control
- * @param[in] width The new width of the control
- * @param[in] height The new height of the control
+ * @param[in] x The new x position of the control @n
+ * The size of the control must be within the range defined by the minimum size and the maximum size.
+ * @param[in] y The new y position of the control @n
+ * The size of the control must be within the range defined by the minimum size and the maximum size.
+ * @param[in] width The new width of the control @n
+ * The size of the control must be within the range defined by the minimum size and the maximum size.
+ * @param[in] height The new height of the control @n
+ * The size of the control must be within the range defined by the minimum size and the maximum size.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The control has not been constructed as yet.
* @exception E_UNSUPPORTED_OPERATION This control is neither movable nor resizable.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
* @remarks Do not override this method.
- * @remarks The size of the control must be within the range defined by the minimum size and the maximum size.
* @see IsMovable()
* @see IsResizable()
* @see GetMinimumSize()
* @since 2.1
*
* @return An error code
- * @param[in] x The new x position of the control
- * @param[in] y The new y position of the control
- * @param[in] width The new width of the control
- * @param[in] height The new height of the control
+ * @param[in] x The new x position of the control @n
+ * The size of the control must be within the range defined by the minimum size and the maximum size.
+ * @param[in] y The new y position of the control @n
+ * The size of the control must be within the range defined by the minimum size and the maximum size.
+ * @param[in] width The new width of the control @n
+ * The size of the control must be within the range defined by the minimum size and the maximum size.
+ * @param[in] height The new height of the control @n
+ * The size of the control must be within the range defined by the minimum size and the maximum size.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The control has not been constructed as yet.
* @exception E_UNSUPPORTED_OPERATION This control is neither movable nor resizable.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
* @remarks Do not override this method.
- * @remarks The size of the control must be within the range defined by the minimum size and the maximum size.
* @see IsMovable()
* @see IsResizable()
* @see GetMinimumSize()
* @since 2.0
*
* @return An error code
- * @param[in] position The new position
+ * @param[in] position The new position @n
+ * The position of the control are relative to the top-left corner of its parent.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The control has not been constructed as yet.
* @exception E_UNSUPPORTED_OPERATION This control is not movable.
* @exception E_SYSTEM A system error has occurred.
* @remarks Do not override this method.
- * @remarks The position of the control are relative to the top-left corner of its parent.
* @see IsMovable()
* @see SetBounds()
*/
* @since 2.1
*
* @return An error code
- * @param[in] position The new position
+ * @param[in] position The new position @n
+ * The position of the control are relative to the top-left corner of its parent.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The control has not been constructed as yet.
* @exception E_UNSUPPORTED_OPERATION This control is not movable.
* @exception E_SYSTEM A system error has occurred.
* @remarks Do not override this method.
- * @remarks The position of the control are relative to the top-left corner of its parent.
* @see IsMovable()
* @see SetBounds()
*/
*
* @since 2.0
* @return An error code
- * @param[in] x The new x position of the control
- * @param[in] y The new y position of the control
+ * @param[in] x The new x position of the control @n
+ * The value is relative to the top-left corner of its parent.
+ * @param[in] y The new y position of the control @n
+ * The value is relative to the top-left corner of its parent.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The control has not been constructed as yet.
* @exception E_UNSUPPORTED_OPERATION This control is not movable.
* @exception E_SYSTEM A system error has occurred.
* @remarks Do not override this method.
- * @remarks The x,y position of the control are relative to the top-left corner of its parent.
* @see IsMovable()
* @see SetBounds()
*/
*
* @since 2.1
* @return An error code
- * @param[in] x The new x position of the control
- * @param[in] y The new y position of the control
+ * @param[in] x The new x position of the control @n
+ * The value is relative to the top-left corner of its parent.
+ * @param[in] y The new y position of the control @n
+ * The value is relative to the top-left corner of its parent.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The control has not been constructed as yet.
* @exception E_UNSUPPORTED_OPERATION This control is not movable.
* @exception E_SYSTEM A system error has occurred.
* @remarks Do not override this method.
- * @remarks The x,y position of the control are relative to the top-left corner of its parent.
* @see IsMovable()
* @see SetBounds()
*/
result SetPosition(float x, float y);
/**
- * Sets the size of the control. @n
- * The @c width and @c height parameters contain the width and height values of the object, respectively.
+ * Sets the size of the control.
*
* @since 2.0
*
* @return An error code
- * @param[in] size The new width and height
+ * @param[in] size The new width and height @n
+ * The size of the control must be within the range defined by the minimum size and the maximum size.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The control has not been constructed as yet.
* @exception E_UNSUPPORTED_OPERATION This control is not resizable.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
* @remarks Do not override this method.
- * @remarks The size of the control must be within the range defined by the minimum size and the maximum size.
* @see IsResizable()
* @see GetMinimumSize()
* @see GetMaximumSize()
/**
* Sets the size of the control.
- * The @c width and @c height parameters contain the width and height values of the object, respectively.
*
* @since 2.1
*
* @return An error code
- * @param[in] size The new width and height
+ * @param[in] size The new width and height @n
+ * The size of the control must be within the range defined by the minimum size and the maximum size.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The control has not been constructed as yet.
* @exception E_UNSUPPORTED_OPERATION This control is not resizable.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
* @remarks Do not override this method.
- * @remarks The size of the control must be within the range defined by the minimum size and the maximum size.
* @see IsResizable()
* @see GetMinimumSize()
* @see GetMaximumSize()
result SetSize(const Tizen::Graphics::FloatDimension& size);
/**
- * Sets the size of the control. @n
- * The @c width and @c height parameters contain the width and height values of the object, respectively.
+ * Sets the size of the control.
*
* @since 2.0
*
* @return An error code
- * @param[in] width The new width of the control
- * @param[in] height The new height of the control
+ * @param[in] width The new width of the control @n
+ * The size of the control must be within the range defined by the minimum size and the maximum size.
+ * @param[in] height The new height of the control @n
+ * The size of the control must be within the range defined by the minimum size and the maximum size.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The control has not been constructed as yet.
* @exception E_UNSUPPORTED_OPERATION This control is not resizable.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
* @remarks Do not override this method.
- * @remarks The size of the control must be within the range defined by the minimum size and the maximum size.
* @see IsResizable()
* @see GetMinimumSize()
* @see GetMaximumSize()
/**
* Sets the size of the control.
- * The @c width and @c height parameters contain the width and height values of the object, respectively.
*
* @since 2.1
*
* @return An error code
- * @param[in] width The new width of the control
- * @param[in] height The new height of the control
+ * @param[in] width The new width of the control @n
+ * The size of the control must be within the range defined by the minimum size and the maximum size.
+ * @param[in] height The new height of the control @n
+ * The size of the control must be within the range defined by the minimum size and the maximum size.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The control has not been constructed as yet.
* @exception E_UNSUPPORTED_OPERATION This control is not resizable.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
* @remarks Do not override this method.
- * @remarks The size of the control must be within the range defined by the minimum size and the maximum size.
* @see IsResizable()
* @see GetMinimumSize()
* @see GetMaximumSize()
* @exception E_UNSUPPORTED_OPERATION This control is not resizable.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method can affect the maximum size and the current size of the control. @n
- * The control needs to be redrawn to reflect the change in its size. @n
- * If the current maximum size or the control size is smaller than the new minimum size,
- * it becomes the same as the new minimum size.
+ * @remarks
+ * - This method can affect the maximum size and the current size of the control.
+ * - The control needs to be redrawn to reflect the change in its size.
+ * - If the current maximum size or the control size is smaller than the new minimum size,
+ * it becomes the same as the new minimum size.
* @see IsResizable()
*/
result SetMinimumSize(const Tizen::Graphics::Dimension& newMinDim);
* @exception E_UNSUPPORTED_OPERATION This control is not resizable.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method can affect the maximum size and the current size of the control. @n
- * The control needs to be redrawn to reflect the change in its size. @n
- * If the current maximum size or the control size is smaller than the new minimum size,
- * it becomes the same as the new minimum size.
+ * @remarks
+ * - This method can affect the maximum size and the current size of the control.
+ * - The control needs to be redrawn to reflect the change in its size.
+ * - If the current maximum size or the control size is smaller than the new minimum size,
+ * it becomes the same as the new minimum size.
* @see IsResizable()
*/
result SetMinimumSize(const Tizen::Graphics::FloatDimension& newMinDim);
* @exception E_UNSUPPORTED_OPERATION This control is not resizable.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method can affect the minimum size and the current size of the control. @n
- * The control needs to be redrawn to reflect the change in its size. @n
- * If the current minimum size or the control size is greater than the new maximum size,
- * it becomes the same as the new maximum size.
+ * @remarks
+ * - This method can affect the minimum size and the current size of the control.
+ * - The control needs to be redrawn to reflect the change in its size.
+ * - If the current minimum size or the control size is greater than the new maximum size,
+ * it becomes the same as the new maximum size.
* @see IsResizable()
*/
result SetMaximumSize(const Tizen::Graphics::Dimension& newMaxDim);
* @exception E_UNSUPPORTED_OPERATION This control is not resizable.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method can affect the minimum size and the current size of the control. @n
- * The control needs to be redrawn to reflect the change in its size. @n
- * If the current minimum size or the control size is greater than the new maximum size,
- * it becomes the same as the new maximum size.
+ * @remarks
+ * - This method can affect the minimum size and the current size of the control.
+ * - The control needs to be redrawn to reflect the change in its size.
+ * - If the current minimum size or the control size is greater than the new maximum size,
+ * it becomes the same as the new maximum size.
* @see IsResizable()
*/
result SetMaximumSize(const Tizen::Graphics::FloatDimension& newMaxDim);
* Sets an empty string to reset.
* @exception E_SUCCESS The method is successful.
* @exception E_FILE_NOT_FOUND The specified font cannot be found or accessed.
- * @remarks At first, the value of @c fontName is considered app font name if it matches one of the face names of the font files which are located in @b '/res/font'.
- * If not, the value of @c fontName is considered system font name if it matches one of the retrieved values using Tizen::Graphics::Font::GetSystemFontListN().
- * @remarks The control first attempts to find the control font. If it fails, then it searches for the application default font and the system font, in sequence.
+ * @remarks
+ * - At first, the value of @c fontName is considered app font name if it matches one of the face names of the font files which are located in @b '/res/font'.
+ * If not, the value of @c fontName is considered system font name if it matches one of the retrieved values using
+ * Tizen::Graphics::Font::GetSystemFontListN().
+ * - The control first attempts to find the control font. If it fails, then it searches for the application default font and the system font, in sequence.
* @see GetFont()
*/
result SetFont(const Tizen::Base::String& fontName);
*
* @return @c true if the specified @c point is inside the control, @n
* else @c false
- * @param[in] point The point to check
- * @remarks The specified @c point must be defined relative to the top-left corner of the control.
+ * @param[in] point The point to check @n
+ * The value must be defined relative to the top-left corner of the control.
*/
bool Contains(const Tizen::Graphics::Point& point) const;
*
* @return @c true if the specified @c point is inside the control, @n
* else @c false
- * @param[in] point The point to check
- * @remarks The specified @c point must be defined relative to the top-left corner of the control.
+ * @param[in] point The point to check @n
+ * The value must be defined relative to the top-left corner of the control.
*/
bool Contains(const Tizen::Graphics::FloatPoint& point) const;
*
* @return @c true if the specified point is inside the control, @n
* else @c false
- * @param[in] x The x position of the point to check
- * @param[in] y The y position of the point to check
- * @remarks The specified point must be defined relative to the top-left corner of the control.
+ * @param[in] x The x position of the point to check @n
+ * The value must be defined relative to the top-left corner of the control.
+ * @param[in] y The y position of the point to check @n
+ * The value must be defined relative to the top-left corner of the control.
*/
bool Contains(int x, int y) const;
*
* @return @c true if the specified point is inside the control, @n
* else @c false
- * @param[in] x The x position of the point to check
- * @param[in] y The y position of the point to check
- * @remarks The specified point must be defined relative to the top-left corner of the control.
+ * @param[in] x The x position of the point to check @n
+ * The value must be defined relative to the top-left corner of the control.
+ * @param[in] y The y position of the point to check @n
+ * The value must be defined relative to the top-left corner of the control.
*/
bool Contains(float x, float y) const;
*
* @since 2.0
* @final Although this method is virtual, it should not be overridden.
- * If overridden, it may not work as expected.
+ * If overridden, it may not work as expected.
*
* @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. @n
* Note: This control cannot be displayed.
* @exception E_SYSTEM A system error has occurred.
- * @remarks Do not override this method.
*/
virtual result Show(void);
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
* Note: This control cannot be displayed.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks OnDraw() is not called immediately, but called asynchronously just before the screen is updated.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - OnDraw() is not called immediately, but called asynchronously just before the screen is updated.
* @see InvalidateBounds()
* @see Show()
*/
void InvalidateBounds(const Tizen::Graphics::FloatRectangle& bounds);
/**
- * Draws the control asynchronously.
+ * Draws the control asynchronously. @n
+ * This method posts a draw event in the event queue. @n
+ * Drawing requested by %RequestRedraw() occurs when the draw event is fired to the control.
*
* @since 2.0
*
* @param[in] show Set to @c true to also show the %Control, @n
- * else @c false
- * @remarks This method posts a draw event in the event queue. @n
- * Drawing requested by %RequestRedraw() occurs when the draw event is fired to the control.
+ * else @c false
*/
void RequestRedraw(bool show = true) const;
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation.
- * @remarks The method allocates a Tizen::Graphics::Canvas whose bounds are equal to that of the control.
- * It is the developer's responsibility to deallocate the canvas after use.
- * The canvas is guaranteed to be valid only if the properties of the parent controls of the canvas remain unchanged.
- * Therefore, one must delete previously allocated canvas and create a new canvas using the %GetCanvasN() method
- * if the size or position of the control is changed.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks The Frame and Form (and between different Form instances) share a single frame-buffer. Therefore,
- * if custom drawing is performed on the graphic canvas of Frame and Form
- * then it will appear on the screen regardless of which control is currently visible on the screen.
- * @see GetCanvasN(const Tizen::Graphics::Rectangle& bounds) const
- * @see GetCanvasN(int x, int y, int width, int height) const
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The method allocates a Tizen::Graphics::Canvas whose bounds are equal to that of the control.
+ * The canvas is guaranteed to be valid only if the properties of the parent controls of the canvas remain unchanged.
+ * Therefore, one must delete previously allocated canvas and create a new canvas using the %GetCanvasN() method
+ * if the size or position of the control is changed.
+ * - The Frame and Form (and between different Form instances) share a single frame-buffer. Therefore,
+ * if custom drawing is performed on the graphic canvas of Frame and Form
+ * then it will appear on the screen regardless of which control is currently visible on the screen.
+ * @see GetCanvasN(const Tizen::Graphics::Rectangle&) const
+ * @see GetCanvasN(int, int, int, int) const
* @code
* result
* MyForm::OnDraw(void)
* Canvas* pCanvas = GetCanvasN();
* if (pCanvas != null)
* {
- * // add your drawing code here
+ * // adds your drawing code here
* }
* if (pCanvas)
+ * {
* delete pCanvas;
- * // Do not call Show(). It will be called automatically after OnDraw() callback.
+ * }
+ * // Do not call Show(). It will be called automatically after OnDraw() callback.
* return r;
* }
* @endcode
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified bounds does not intercept with the bounds of the control.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation.
- * @remarks Only the graphic canvas of displayable controls can be obtained.
- * If the specified area is not inside the control,
- * the graphics canvas of overlapped area between the control and the specified bound is returned. @n
- * @remarks The method allocates an Tizen::Graphics::Canvas whose bounds are equal to that of the control.
- * It is the developer's responsibility to deallocate the canvas after use.
- * The canvas is guaranteed to be valid only if the properties of the parent controls of the canvas remain unchanged.
- * Therefore, one must delete previously allocated canvas and create a new canvas using the %GetCanvasN() method
- * if the size or position of the control is changed.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks The Frame and Form (and between different Form instances) share a single frame-buffer. Therefore,
- * if custom drawing is performed on the graphic canvas of Frame and Form
- * then it will appear on the screen regardless of which control is currently visible on the screen.
- * @see GetCanvasN(void) const
- * @see GetCanvasN(int x, int y, int width, int height) const
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - Only the graphic canvas of displayable controls can be obtained.
+ * If the specified area is not inside the control,
+ * the graphics canvas of overlapped area between the control and the specified bound is returned.
+ * - The method allocates an Tizen::Graphics::Canvas whose bounds are equal to that of the control.
+ * The canvas is guaranteed to be valid only if the properties of the parent controls of the canvas remain unchanged.
+ * Therefore, one must delete previously allocated canvas and create a new canvas using the %GetCanvasN() method
+ * if the size or position of the control is changed.
+ * - The Frame and Form (and between different Form instances) share a single frame-buffer. Therefore,
+ * if custom drawing is performed on the graphic canvas of Frame and Form
+ * then it will appear on the screen regardless of which control is currently visible on the screen.
+ * @see GetCanvasN() const
+ * @see GetCanvasN(int, int, int, int) const
*/
Tizen::Graphics::Canvas* GetCanvasN(const Tizen::Graphics::Rectangle& bounds) const;
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified bounds does not intercept with the bounds of the control.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation.
- * @remarks Only the graphic canvas of displayable controls can be obtained.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - Only the graphic canvas of displayable controls can be obtained.
* If the specified area is not inside the control,
- * the graphics canvas of overlapped area between the control and the specified bound is returned. @n
- * @remarks The method allocates an Tizen::Graphics::Canvas whose bounds are equal to that of the control.
- * It is the developer's responsibility to deallocate the canvas after use.
+ * the graphics canvas of overlapped area between the control and the specified bound is returned.
+ * - The method allocates an Tizen::Graphics::Canvas whose bounds are equal to that of the control.
* The canvas is guaranteed to be valid only if the properties of the parent controls of the canvas remain unchanged.
* Therefore, one must delete previously allocated canvas and create a new canvas using the %GetCanvasN() method
* if the size or position of the control is changed.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks The Frame and Form (and between different Form instances) share a single frame-buffer. Therefore,
+ * - The Frame and Form (and between different Form instances) share a single frame-buffer. Therefore,
* if custom drawing is performed on the graphic canvas of Frame and Form
* then it will appear on the screen regardless of which control is currently visible on the screen.
- * @see GetCanvasN(void) const
- * @see GetCanvasN(float x, float y, float width, float height) const
+ * @see GetCanvasN() const
+ * @see GetCanvasN(float, float, float, float) const
*/
Tizen::Graphics::Canvas* GetCanvasN(const Tizen::Graphics::FloatRectangle& bounds) const;
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified bounds do not intercept with the bounds of the control.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation.
- * @remarks Only the graphic canvas of displayable controls can be obtained.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - Only the graphic canvas of displayable controls can be obtained.
* If the specified area is not inside the control,
- * the graphics canvas of the overlapped area between the control and the specified bound is returned. @n
- * @remarks The method allocates an Tizen::Graphics::Canvas whose bounds are equal to that of the control.
- * It is the developer's responsibility to deallocate the canvas after use.
+ * the graphics canvas of the overlapped area between the control and the specified bound is returned.
+ * - The method allocates an Tizen::Graphics::Canvas whose bounds are equal to that of the control.
* The canvas is guaranteed to be valid only if properties of the parent controls of the canvas remain unchanged.
* Therefore, one must delete the previously allocated canvas and create a new canvas using the %GetCanvasN() method
* if the size or position of the control is changed.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks The Frame and Form (and between different Form instances) share a single frame-buffer. Therefore,
+ * - The Frame and Form (and between different Form instances) share a single frame-buffer. Therefore,
* if custom drawing is performed on the graphic canvas of Frame and Form
* then it will appear on the screen regardless of which control is currently visible on the screen.
- * @see GetCanvasN(void) const
- * @see GetCanvasN(const Tizen::Graphics::Rectangle& bounds) const
+ * @see GetCanvasN() const
+ * @see GetCanvasN(const Tizen::Graphics::Rectangle&) const
*/
Tizen::Graphics::Canvas* GetCanvasN(int x, int y, int width, int height) const;
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified bounds do not intercept with the bounds of the control.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation.
- * @remarks Only the graphic canvas of displayable controls can be obtained.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - Only the graphic canvas of displayable controls can be obtained.
* If the specified area is not inside the control,
- * the graphics canvas of the overlapped area between the control and the specified bound is returned. @n
- * @remarks The method allocates an Tizen::Graphics::Canvas whose bounds are equal to that of the control.
+ * the graphics canvas of the overlapped area between the control and the specified bound is returned.
+ * - The method allocates an Tizen::Graphics::Canvas whose bounds are equal to that of the control.
* It is the developer's responsibility to deallocate the canvas after use.
* The canvas is guaranteed to be valid only if properties of the parent controls of the canvas remain unchanged.
* Therefore, one must delete the previously allocated canvas and create a new canvas using the %GetCanvasN() method
* if the size or position of the control is changed.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks The Frame and Form (and between different Form instances) share a single frame-buffer. Therefore,
+ * - The Frame and Form (and between different Form instances) share a single frame-buffer. Therefore,
* if custom drawing is performed on the graphic canvas of Frame and Form
* then it will appear on the screen regardless of which control is currently visible on the screen.
- * @see GetCanvasN(void) const
- * @see GetCanvasN(const Tizen::Graphics::FloatRectangle& bounds) const
+ * @see GetCanvasN() const
+ * @see GetCanvasN(const Tizen::Graphics::FloatRectangle&) const
*/
Tizen::Graphics::Canvas* GetCanvasN(float x, float y, float width, float height) const;
* @since 2.0
*
* @return @c true if the control is currently visible on the screen, @n
- * else @c false
- * @remarks If this method is called before the control is added to a parent, @c false is returned.
+ * else @c false either this method is called before the control is added to a parent or the control is not visible on the screen
* @see GetShowState()
* @see SetShowState()
*/
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation.
* Note: This control cannot be displayed.
* @exception E_SYSTEM A system error has occurred.
- * @remarks Do not override this method.
- * @remarks Even if this method is invoked, the control is not drawn or shown. @n
+ * @remarks
+ * - Do not override this method.
+ * - Even if this method is invoked, the control is not drawn or shown. @n
* To display the control, use the Invalidate() methods. @n
* Once the control's show state is set to @c false,
* the show state needs to be set to @c true again before you invalidate the control.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation.
* Note: The control does not permit to change its focus ability.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The focus ability of the container classes like Panel is @c false by default.
- * @remarks The RadioGroup class does not render the UI.
+ * @remarks
+ * - The focus ability of the container classes like Panel is @c false by default.
+ * - The RadioGroup class does not render the UI.
* Therefore, RadioGroup::SetFocusable() returns @c E_SYSTEM.
*/
result SetFocusable(bool focusable);
* @since 2.0
*
* @return @c true if the control currently has the input focus, @n
- * else @c false
- * @remarks If this method is called before the control is added to a parent, @c false is returned.
+ * else @c false either this method is called before the control is added to a parent or the control currently has not the input focus
* @see SetFocus()
*/
bool HasFocus(void) const;
* @since 2.0
*
* @return @c true if the control is enabled, @n
- * else @c false
- * @remarks If this method is called before the control is added to a parent, @c false is returned.
+ * else @c false either this method is called before the control is added to a parent or the control is disabled
* @see SetEnabled()
*/
bool IsEnabled(void) const;
* @since 2.0
*
* @return @c true if the device is in touch mode, @n
- * else @c false
- * @remarks This method returns @c false, for devices with QWERTY keyboard.
- * The user can navigate the UI using directional keys.
+ * else @c false the device is either with QWERTY keyboard or not in touch mode
+ * @remarks The user can navigate the UI using directional keys if the device is with QWERTY keyboard.
*/
bool IsInTouchMode(void) const;
void SetDropEnabled(bool enable);
/**
- * Sends a user event to the control.
+ * Sends a user event to the control. @n
+ * The %SendUserEvent() method posts a user event in the event queue and returns immediately to support asynchronous actions of the framework.
*
* @since 2.0
*
* @param[in] requestId The user-defined event ID
* @param[in] pArgs A pointer to the argument list
- * @remarks This method posts a user event in the event queue
- * and returns immediately to support asynchronous actions of the framework.
* @see OnUserEventReceived()
*/
void SendUserEvent(RequestId requestId, const Tizen::Base::Collection::IList* pArgs) const;
* Stops the current UI event dispatch sequence by indicating the current input event is consumed.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated. Instead of using this method, use IPropagatedKeyEventListener or IPropagatedTouchEventListener to consume event. @n To propagate the event, return @c true inside the implementation of IPropagatedKeyEventListener or IPropagatedTouchEventListener.
+ * @deprecated This method is deprecated. Instead of using this method, use IPropagatedKeyEventListener or IPropagatedTouchEventListener to consume event. @n
+ * To propagate the event, return @c true inside the implementation of IPropagatedKeyEventListener or IPropagatedTouchEventListener.
* @since 2.0
*
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks If this method is invoked during an UI event (key or touch) propagation sequence,
- * the method will stop the propagation and consequently the system will not be notified of the event.@n
- * The method will not have any effect if no UI event is being dispatched. @n
- * It is recommended that this method is called within IKeyEventListener or
- * ITouchEventListener to stop the event from propagating to the next step.
+ * @remarks
+ * - If this method is invoked during an UI event (key or touch) propagation sequence,
+ * the method will stop the propagation and consequently the system will not be notified of the event.
+ * - The method will not have any effect if no UI event is being dispatched.
+ * - It is recommended that this method is called within IKeyEventListener or ITouchEventListener to stop the event from propagating to the next step.
*/
result ConsumeInputEvent(void);
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPERATION This method is not supported.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks This method is not supported in the following class that is derived from Panel class:
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - This method is not supported in the following class that is derived from Panel class:
* @li OverlayPanel
- * @remarks The bounds of the %Panel control must be within the client area of the Form control to get a valid composited scene.
+ * - The bounds of the %Panel control must be within the client area of the Form control to get a valid composited scene.
*/
Tizen::Graphics::Bitmap* GetCapturedBitmapN(void) const;
*
* @since 2.1
*
- * @param[in] pListener The event listener to which the propagated touch events are dispatched
+ * @param[in] pListener The event listener to which the propagated touch events are dispatched @n
+ * Pass @c null to unregister the event listener.
* @remarks The specified event listener should be allocated in heap memory.
- * To unregister the event listener, pass @c null to @c pListener.
-
*/
void SetPropagatedTouchEventListener(IPropagatedTouchEventListener* pListener);
*
* @since 2.1
*
- * @param[in] pListener The event listener to which the propagated touch events are dispatched
+ * @param[in] pListener The event listener to which the propagated touch events are dispatched @n
+ * Pass @c null to unregister the event listener.
* @remarks The specified event listener should be allocated in heap memory.
- * To unregister the event listener, pass @c null to @c pListener.
-
*/
void SetPropagatedKeyEventListener(IPropagatedKeyEventListener* pListener);
* @since 2.1
*
* @param[in] pPreviousFocus The pointer to the previous focus of the control
- * @remarks Focus UI supports linear navigation of controls from top-left to bottom-right direction. This method allows for customizing the default navigation behavior.
- * @remarks The platform will not take the ownership of @c pPreviousFocus after this call.
+ * @remarks
+ * - Focus UI supports linear navigation of controls from top-left to bottom-right direction.
+ * This method allows for customizing the default navigation behavior.
+ * - The platform will not take the ownership of @c pPreviousFocus after this call.
* @see SetNextFocus()
* @see GetPreviousFocus()
*/
* @since 2.1
*
* @param[in] pNextFocus The pointer to the next focus of the control
- * @remarks Focus UI supports linear navigation of controls from top-left to bottom-right direction. This method allows for customizing the default navigation behavior.
- * @remarks The platform will not take the ownership of @c pNextFocus after this call.
+ * @remarks
+ * - Focus UI supports linear navigation of controls from top-left to bottom-right direction.
+ * This method allows for customizing the default navigation behavior.
+ * - The platform will not take the ownership of @c pNextFocus after this call.
* @see SetPreviousFocus()
* @see GetNextFocus()
*/
Control* GetNextFocus(void) const;
/**
- * Sets the touch press threshold of the Control in inch.
+ * Sets the touch press threshold of the Control in inch. @n
+ * The touch move events will be fired if the move distance exceeds the set allowance value. For example, set 0.5 if the distance is 0.5 inch.
*
* @since 2.1
*
* @param[in] distance The logical threshold to fire touch move event
- * @remarks A touch move events will start to fire if the move distance exceeds the set allowance value.
- * For example, Set 0.5 if the distance is 0.5 inch.
- * This method is offered to control sensitivity of move events.
- */
+ * @remarks This method is offered to control sensitivity of move events.
+ */
void SetTouchPressThreshold(float distance);
/**
*
* @param[in] enable Set to @c true to enable effect sound, @n
* else @c false
- * @remarks If the effect sound is disabled for a container, then all of its child controls also will have the effect sound disabled.
+ * @remarks If the effect sound is disabled for a container, then all of its child controls also will have the effect sound disabled.
*/
void SetEffectSoundEnabled (bool enable);
ITouchEventListener* GetDefaultTouchEventListener(void) const;
/**
- * Sets the default key event listener.
+ * Sets the default key event listener. @n
+ * The registered listener will be notified to handle the key events after all application event listeners has been notified.
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated. Instead of using this method, use the SetPropagatedKeyEventListener() method.
* @param[in] pDefaultListener The default key event listener
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The registered listener will be notified to handle the key events
- * after all application event listeners has been notified.
* @see GetDefaultkeyEventListener()
*/
result SetDefaultKeyEventListener(IKeyEventListener* pDefaultListener);
/**
- * Sets the default touch event listener.
+ * Sets the default touch event listener. @n
+ * The registered listener will be notified to handle the touch events after all application event listeners has been notified.
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated. Instead of using this method, use the SetPropagatedTouchEventListener() method.
* @param[in] pDefaultListener The default key event listener
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The registered listener will be notified to handle the touch events
- * after all application event listeners has been notified.
* @see GetDefaultTouchEventListener()
*/
result SetDefaultTouchEventListener(ITouchEventListener* pDefaultListener);
*
* @return An error code
* @param[in] rect An instance of the Tizen::Graphics::Rectangle class @n
- * This instance represents the x and y coordinates of the top-left corner of the created window along with
- * its width and height.@n
- * The optimal size of the control is defined in
- * <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
- * @param[in] aniFrames An IList of %AnimationFrames used in the animation
+ * This instance represents the x and y coordinates of the top-left corner of the created window along with
+ * its width and height.@n
+ * The size of the control must be within the range defined by the minimum size and the maximum size. @n
+ * The optimal size of the control is defined in
+ * <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
+ * @param[in] aniFrames An Tizen::Base::Collection::IList of %AnimationFrames used in the animation
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
- * @remarks
- * - A control is fully usable only after it has been added to a container, therefore some methods may fail if used earlier.
- * - The size of the control must be within the range defined by the minimum size and the maximum size.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @remarks A control is fully usable only after it has been added to a container, therefore some methods may fail if used earlier.
*/
result Construct(const Tizen::Graphics::Rectangle& rect, const Tizen::Base::Collection::IList& aniFrames);
*
* @return An error code
* @param[in] rect An instance of the Tizen::Graphics::FloatRectangle class @n
- * This instance represents the x and y coordinates of the top-left corner of the created window along with
- * its width and height.@n
- * The optimal size of the control is defined in
- * <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
- * @param[in] aniFrames An IList of %AnimationFrames used in the animation
+ * This instance represents the x and y coordinates of the top-left corner of the created window along with
+ * its width and height.@n
+ * The size of the control must be within the range defined by the minimum size and the maximum size. @n
+ * The optimal size of the control is defined in
+ * <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
+ * @param[in] aniFrames An Tizen::Base::Collection::IList of %AnimationFrames used in the animation
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
- * @remarks
- * - A control is fully usable only after it has been added to a container, therefore some methods may fail if used earlier.
- * - The size of the control must be within the range defined by the minimum size and the maximum size.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @remarks A control is fully usable only after it has been added to a container, therefore some methods may fail if used earlier.
*/
result Construct(const Tizen::Graphics::FloatRectangle& rect, const Tizen::Base::Collection::IList& aniFrames);
/**
- * Sets the repeat count of the animation. @n
- * If this value is not set, the default value is @c 1.
+ * Sets the repeat count of the animation.
*
* @since 2.0
*
- * @param[in] count The repeat count
+ * @param[in] count The repeat count @n
+ * If this value is not set, the default value is @c 1.
*/
void SetRepeatCount(int count);
~AnimationFrame(void);
/**
- * Sets the bitmap to be displayed during animation play.
+ * Sets the bitmap to be displayed during animation play.
*
* @since 2.0
*
*
* @return An error code
* @param[in] rect An instance of the Tizen::Graphics::Rectangle class @n
- * This instance represents the x and y coordinates of the top-left corner
- * of the created window along with its width and height.@n
- * The optimal size of the control is defined in
- * <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
+ * This instance represents the x and y coordinates of the top-left corner of the created window along with its width and height.@n
+ * The optimal size of the control is defined in
+ * <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
* @param[in] text The text to display on the button
- * To display the text in multi-lines or to denote the end of line, use '\\n'.
- * @exception E_SUCCESS The method is successful.
+ * To display the text in multi-lines or to denote the end of line, use '\\n'.
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
*/
*
* @return An error code
* @param[in] rect An instance of the Tizen::Graphics::FloatRectangle class @n
- * This instance represents the x and y coordinates of the top-left corner
- * of the created window along with its width and height.@n
- * The optimal size of the control is defined in
- * <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
+ * This instance represents the x and y coordinates of the top-left corner of the created window along with its width and height.@n
+ * The optimal size of the control is defined in
+ * <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
* @param[in] text The text to display on the button @n
* To display the text in multi-lines or to denote the end of line, use '\\n'.
- * @exception E_SUCCESS The method is successful.
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
*/
* @since 2.0
*
* @return The color, @n
- * else RGBA(0, 0, 0, 0) if an error occurs
+ * else RGBA(0, 0, 0, 0) if an error occurs
* @param[in] status The status
* @exception E_SUCCESS The method is successful.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @since 2.0
*
* @return An error code
- * @param[in] size The text size
+ * @param[in] size The text size @n
+ * The size must be greater than @c 0.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid. @n
- * The specified @c size must be greater than @c 0.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
* @see GetTextSize()
*/
* @since 2.1
*
* @return An error code
- * @param[in] size The text size
+ * @param[in] size The text size @n
+ * The size must be greater than @c 0.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid. @n
- * The specified @c size must be greater than @c 0.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
* @see GetTextSize()
*/
*
* @return An error code
* @param[in] style The style of the button item
- * @param[in] actionId The action ID of the button item
+ * @param[in] actionId The action ID of the button item @n
+ * The value must be a positive integer.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid. @n
- * The specified @c actionId of the specified item must be a positive integer.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
*/
result Construct(ButtonItemStyle style, int actionId);
*
* @since 2.0
* @return An error code
- * @param[in] actionId The action ID of the button item
+ * @param[in] actionId The action ID of the button item @n
+ * The value must be a positive integer.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid. @n
- * The specified @c actionId of the specified item must be a positive integer.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
*/
result SetActionId(int actionId);
* else @c null if no bitmap image is displayed
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation.
- * @remarks If the size is greater than the default size, the bitmap image is scaled accordingly.
+ * @remarks If the size of the bitmap is greater than the default size, the bitmap image is scaled accordingly.
*/
result SetBackgroundBitmap(ButtonItemStatus status, const Tizen::Graphics::Bitmap* pBitmap);
* @return An error code
* @param[in] status The item status
* @param[in] pIcon The icon to set, @n
- * else @c null if no icon is displayed
+ * else @c null if no icon is displayed @n
+ * If an icon is not set for a state, the icon for @c BUTTON_ITEM_STATUS_NORMAL is used.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation.
- * @remarks
- * - If the style of %ButtonItem is @c BUTTON_ITEM_STYLE_TEXT, the method returns @c E_INVALID_OPERATION.
- * - If an icon is not set for a state, the icon for @c BUTTON_ITEM_STATUS_NORMAL is used.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
+ * - The style of %ButtonItem is @c BUTTON_ITEM_STYLE_TEXT.
*/
result SetIcon(ButtonItemStatus status, const Tizen::Graphics::Bitmap* pIcon);
* @since 2.0
*
* @return An error code
- * @param[in] text The text to set
+ * @param[in] text The text to set @n
+ * Use @htmlonly '\n' @endhtmlonly to denote the end of the first line.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The style of %ButtonItem is ::BUTTON_ITEM_STYLE_ICON.
- * @remarks
- * - If the text cannot be displayed in a line, then the text is automatically displayed in two lines and the ellipsis is applied if the text
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
+ * - The style of %ButtonItem is ::BUTTON_ITEM_STYLE_ICON.
+ * @remarks If the text cannot be displayed in a line, then the text is automatically displayed in two lines and the ellipsis is applied if the text
* is longer than two lines.
- * - Use @htmlonly '\n' @endhtmlonly to denote the end of the first line.
*/
result SetText(const Tizen::Base::String& text);
*
* @return An error code
* @param[in] rect An instance of the Tizen::Graphics::Rectangle class @n
- * This instance represents the x and y coordinates of the top-left corner of the created window
- * along with the width and height of the window.@n
- * The optimal size of the control is defined in
- *
<a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
+ * This instance represents the x and y coordinates of the top-left corner of the created window
+ * along with the width and height of the window.@n
+ * The optimal size of the control is defined in
+ * <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
* @param[in] style The style of the %CheckButton control
- * @param[in] backgroundStyle The background style set of the %CheckButton control
- * @param[in] showTitle Set to @c true to enable the title, @n
- * else @c false
+ * @param[in] backgroundStyle The background style set of the %CheckButton control
+ * @param[in] showTitle Set to @c true to enable the title, @n
+ * else @c false
* @param[in] text The text of the %CheckButton control
- * @param[in] groupStyle The group style of the %CheckButton control
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid.@n
- * The specified size is less than the minimum size of the control.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The background style of @c BACKGROUND_STYLE_NONE does not work with group styles except ::GROUP_STYLE_NONE.
+ * @param[in] groupStyle The group style of the %CheckButton control
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * - The specified size is less than the minimum size of the control.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation.
+ * - The background style of @c BACKGROUND_STYLE_NONE does not work with group styles except ::GROUP_STYLE_NONE.
* @exception E_SYSTEM A system error has occurred.
- * @remarks A control is fully usable only after it has been added to a container, therefore some methods may fail if used earlier.
+ * @remarks A control is fully usable only after it has been added to a container, therefore some methods may fail if used earlier.
*/
result Construct(const Tizen::Graphics::Rectangle& rect, CheckButtonStyle style, BackgroundStyle backgroundStyle =
BACKGROUND_STYLE_DEFAULT, bool showTitle = false, const Tizen::Base::String& text = L"", GroupStyle groupStyle = GROUP_STYLE_NONE);
/**
* Initializes this instance of %CheckButton with the specified parameters.
*
- * @since 2.1
+ * @since 2.1
*
* @return An error code
* @param[in] rect An instance of the Tizen::Graphics::FloatRectangle class @n
- * This instance represents the x and y coordinates of the top-left corner of the created window
- * along with the width and height of the window.@n
- * The optimal size of the control is defined in
- *
<a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
+ * This instance represents the x and y coordinates of the top-left corner of the created window
+ * along with the width and height of the window.@n
+ * The optimal size of the control is defined in
+ * <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
* @param[in] style The style of the %CheckButton control
* @param[in] backgroundStyle The background style set of the %CheckButton control
* @param[in] showTitle Set to @c true to enable the title, @n
* @param[in] text The text of the %CheckButton control
* @param[in] groupStyle The group style of the %CheckButton control
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid.@n
- * The specified size is less than the minimum size of the control.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The background style of @c BACKGROUND_STYLE_NONE does not work with group styles except ::GROUP_STYLE_NONE.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * - The specified size is less than the minimum size of the control.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation.
+ * - The background style of @c BACKGROUND_STYLE_NONE does not work with group styles except ::GROUP_STYLE_NONE.
* @exception E_SYSTEM A system error has occurred.
- * @remarks A control is fully usable only after it has been added to a container, therefore some methods may fail if used earlier.
+ * @remarks A control is fully usable only after it has been added to a container, therefore some methods may fail if used earlier.
*/
result Construct(const Tizen::Graphics::FloatRectangle& rect, CheckButtonStyle style, BackgroundStyle backgroundStyle =
BACKGROUND_STYLE_DEFAULT, bool showTitle = false, const Tizen::Base::String& text = L"", GroupStyle groupStyle = GROUP_STYLE_NONE);
* @param[in] color The color to set
* @param[in] status The status
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation.@n
- * The operation is not supported if the background style is ::BACKGROUND_STYLE_NONE.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation.
+ * - The operation is not supported if the background style is ::BACKGROUND_STYLE_NONE.
* @exception E_SYSTEM A system error has occurred.
*/
result SetColor(CheckButtonStatus status, const Tizen::Graphics::Color& color);
*
* @return An error code
* @param[in] point The position of this %ColorPicker in the container @n
- * The optimal size of the control is defined in
- *
<a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
+ * The optimal size of the control is defined in
+ * <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks A control is fully usable only after it has been added to a container. Therefore, some methods may fail if the control is used earlier.
+ * @remarks A control is fully usable only after it has been added to a container. Therefore, some methods may fail if the control is used earlier.
*/
result Construct(const Tizen::Graphics::Point& point);
*
* @return An error code
* @param[in] point The position of this %ColorPicker in the container @n
- * The optimal size of the control is defined in
- *
<a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
+ * The optimal size of the control is defined in
+ * <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks A control is fully usable only after it has been added to a container. Therefore, some methods may fail if the control is used earlier.
+ * @remarks A control is fully usable only after it has been added to a container. Therefore, some methods may fail if the control is used earlier.
*/
result Construct(const Tizen::Graphics::FloatPoint& point);
* For full construction, the %Construct() method must be called right after calling this constructor.
*
* @since 2.0
- *
*/
ContextMenu(void);
*
* @return An error code
* @param[in] point The x and y coordinates of the anchor of %ContextMenu @n
- * The optimal size of the control is defined in
- *
<a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
+ * The optimal size of the control is defined in
+ * <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
* @param[in] style The context menu style
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance has already been constructed.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The default owner will be the current Form (or Frame). It is possible that this control may not be visible
+ * @remarks The default owner will be the current Form (or Frame). It is possible that this control may not be visible
* due to this ownership relationship. @n In this case, use the SetOwner() method to change the ownership to the top-most window.
*/
result Construct(const Tizen::Graphics::Point& point, ContextMenuStyle style);
* The item color for the @c CONTEXT_MENU_ITEM_STATUS_NORMAL status is always the same as the
* color of the %ContextMenu control.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid. @n
- * The item color for @c CONTEXT_MENU_ITEM_STATUS_NORMAL is not supported.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * - The item color for @c CONTEXT_MENU_ITEM_STATUS_NORMAL is not supported.
* @exception E_INVALID_STATE This instance is in an invalid state.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* as the color of the %ContextMenu control.
* @param[in] color The color to set
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid. @n
- * The item color for @c CONTEXT_MENU_ITEM_STATUS_NORMAL is not supported.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * - The item color for @c CONTEXT_MENU_ITEM_STATUS_NORMAL is not supported.
* @exception E_INVALID_STATE This instance is in an invalid state.
* @exception E_SYSTEM A system error has occurred.
* @see GetItemColor()
* @param[in] alignment The horizontal alignment of text
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_INVALID_OPERATION The specified element does not handle text.@n
- * The specified element does not contain text.
+ * @exception E_INVALID_OPERATION The specified element either does not handle text or does not contain text.
* @exception E_SYSTEM A system error has occurred.
*/
result SetElementTextHorizontalAlignment(int elementId, HorizontalAlignment alignment);
* @param[in] alignment The vertical alignment of text
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_INVALID_OPERATION The specified element does not handle text.@n
- * The specified element does not contain text.
+ * @exception E_INVALID_OPERATION The specified element either does not handle text or does not contain text.
* @exception E_SYSTEM A system error has occurred.
*/
result SetElementTextVerticalAlignment(int elementId, VerticalAlignment alignment);
* @return An error code
* @param[in] elementId The element ID
* @param[in] mask The auto-link mask @n
- * Multiple link types can be combined using bitwise OR operator. @n For more information,
+ * Multiple link types of Tizen::Base::Utility::LinkType can be combined using bitwise OR operator. @n For more information,
* see <a href="../org.tizen.native.appprogramming/html/guide/ui/auto_link_detection.htm">AutoLink Detection</a>. @n
- * If it is set to @c 0, the auto-link detection is disabled.
+ * If the value is set to @c 0, the auto-link detection is disabled.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_INVALID_OPERATION The specified element does not handle text.
* @exception E_SYSTEM A system error has occurred.
- * @see Tizen::Base::Utility::LinkType
*/
result SetElementAutoLinkMask(int elementId, unsigned long mask);
*
* @since 2.0
*
- * @return The current hour value between @c 0 to @c 23, @n
+ * @return The current hour value between @c 0 to @c 23 regardless of whether the time display mode is 12-hour or 24-hour, @n
* else @c -1 if an error occurs
- * @remarks Whether the time display mode is 12-hour or 24-hour, this method always returns the hour value ranging from @c 0 to @c 23.
*/
int GetHour(void) const;
* @since 2.0
*
* @return An error code
- * @param[in] size The text size
+ * @param[in] size The text size @n
+ * The value should be greater than or equal to minimum font size which is 4.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid. @n
* The specified @c size cannot be a negative integer.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The specified @c size should be greater than or equal to minimum font size which is 4.
* @see GetTextSize()
*/
result SetTextSize(int size);
* @since 2.1
*
* @return An error code
- * @param[in] size The text size
+ * @param[in] size The text size @n
+ * The value should be greater than or equal to minimum font size which is 4.0f.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid. @n
* The specified @c size cannot be a negative integer.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The specified @c size should be greater than or equal to minimum font size which is 4.0f.
* @see GetTextSizeF()
*/
result SetTextSize(float size);
*
* @since 2.0
*
- * @param[in] guideText The guide text
- * @remarks This is the default text that is displayed in the %EditArea control when the focus is given to it.
+ * @param[in] guideText The guide text that is displayed in the %EditArea control when the focus is given to it.
*/
void SetGuideText(const Tizen::Base::String& guideText);
result SetCurrentLanguage(Tizen::Locales::LanguageCode languageCode);
/**
- * Gets the current input language.
+ * Gets the current input language of the keypad that is associated with the current %EditArea.
*
* @since 2.0
*
* @return An error code
* @param[out] language The current input language
* @exception E_SUCCESS The method is successful.
- * @remarks The application can get the current language of the keypad that is associated with the current %EditArea.
*/
result GetCurrentLanguage(Tizen::Locales::LanguageCode& language) const;
/**
- * Sets the text filter.
+ * Sets the text filter. @n
+ * The %EditArea control checks with the registered filter to decide whether the user-entered text should be replaced or not.
*
* @since 2.1
*
* @param[in] pFilter The filter to set
- * @remarks The %EditArea control checks with the registered filter to decide whether the user-entered text should be replaced or not.
*/
void SetEditTextFilter(IEditTextFilter* pFilter);
*
* @return An error code
* @param[in] rect An instance of the Graphics::Rectangle class @n
- * This instance represents the x and y coordinates of the top-left corner of the created window along with
- * the width and height of the control. @n
- * The optimal size of the control is defined in
- * <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
+ * This instance represents the x and y coordinates of the top-left corner of the created window along with
+ * the width and height of the control. @n
+ * If the size is less than the minimum size, %EditField is constructed with the minimum size. @n
+ * The optimal size of the control is defined in
+ * <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
* @param[in] style The style of the %EditField control
* @param[in] inputStyle The input style of the %EditField control
* @param[in] showTitle Set to @c true to display the title, @n
* @remarks
* - A control is fully usable only after it has been added to a container. Therefore, some methods may fail if the control has been used
* earlier. The %EditField style of SMALL property cannot be used together with group styles.
- * - If the specified size is less than the minimum size, %EditField is constructed with the minimum size.
- * - Following are the input styles used for creating the different orientations of a keypad: @n
- * @c INPUT_STYLE_FULLSCREEN: The orientation is decided by the G-sensor value. @n
- * @c INPUT_STYLE_OVERLAY: The orientation is the same as that of a parent form.
+ * - Following are the input styles used for creating the different orientations of a keypad:
+ * - @c INPUT_STYLE_FULLSCREEN: The orientation is decided by the G-sensor value.
+ * - @c INPUT_STYLE_OVERLAY: The orientation is the same as that of a parent form.
*/
result Construct(const Tizen::Graphics::Rectangle& rect, EditFieldStyle style = EDIT_FIELD_STYLE_NORMAL, InputStyle inputStyle = INPUT_STYLE_FULLSCREEN, bool showTitle = false, int limitLength = 100, GroupStyle groupStyle = GROUP_STYLE_NONE);
*
* @return An error code
* @param[in] rect An instance of the Tizen::Graphics::FloatRectangle class @n
- * This instance represents the x and y coordinates of the top-left corner of the created window along with
- * the width and height of the control. @n
- * The optimal size of the control is defined in
- * <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
+ * This instance represents the x and y coordinates of the top-left corner of the created window along with
+ * the width and height of the control. @n
+ * If the size is less than the minimum size, %EditField is constructed with the minimum size. @n
+ * The optimal size of the control is defined in
+ * <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
* @param[in] style The style of the %EditField control
* @param[in] inputStyle The input style of the %EditField control
* @param[in] showTitle Set to @c true to display the title, @n
* @remarks
* - A control is fully usable only after it has been added to a container. Therefore, some methods may fail if the control has been used
* earlier. The %EditField style of SMALL property cannot be used together with group styles.
- * - If the specified size is less than the minimum size, %EditField is constructed with the minimum size.
- * - Following are the input styles used for creating the different orientations of a keypad: @n
- * @c INPUT_STYLE_FULLSCREEN: The orientation is decided by the G-sensor value. @n
- * @c INPUT_STYLE_OVERLAY: The orientation is the same as that of a parent form.
+ * - Following are the input styles used for creating the different orientations of a keypad:
+ * - @c INPUT_STYLE_FULLSCREEN: The orientation is decided by the G-sensor value.
+ * - @c INPUT_STYLE_OVERLAY: The orientation is the same as that of a parent form.
*/
result Construct(const Tizen::Graphics::FloatRectangle& rect, EditFieldStyle style = EDIT_FIELD_STYLE_NORMAL, InputStyle inputStyle = INPUT_STYLE_FULLSCREEN, bool showTitle = false, int limitLength = 100, GroupStyle groupStyle = GROUP_STYLE_NONE);
*
* @return An error code
* @param[in] rect An instance of the Tizen::Graphics::FloatRectangle class @n
- * This instance represents the x and y coordinates of the top-left corner of the created window along with
- * the width and height of the control. @n
- * The optimal size of the control is defined in
- * <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
+ * This instance represents the x and y coordinates of the top-left corner of the created window along with
+ * the width and height of the control. @n
+ * If the size is less than the minimum size, EditFied() is constructed with the minimum size. @n
+ * The optimal size of the control is defined in
+ * <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
* @param[in] style The style of the %EditField control
* @param[in] inputStyle The input style of the %EditField control
* @param[in] titleStyle The title style
* @remarks
* - A control is fully usable only after it has been added to a container. Therefore, some methods may fail if the control is used earlier.
* The %EditField style of SMALL property cannot be used together with group styles.
- * - If the specified size is less than the minimum size, EditFied() is constructed with the minimum size.
- * - Following are the input styles used for creating different orientations of a keypad: @n
- * @c INPUT_STYLE_FULLSCREEN: The orientation is decided by the G-sensor value.@n
- * @c INPUT_STYLE_OVERLAY: The orientation is similar to the parent form.
+ * - Following are the input styles used for creating different orientations of a keypad:
+ * - @c INPUT_STYLE_FULLSCREEN: The orientation is decided by the G-sensor value.
+ * - @c INPUT_STYLE_OVERLAY: The orientation is similar to the parent form.
*/
result Construct(const Tizen::Graphics::Rectangle& rect, EditFieldStyle style, InputStyle inputStyle, EditFieldTitleStyle titleStyle, bool enableClear = false, int limitLength = 100, GroupStyle groupStyle = GROUP_STYLE_NONE);
*
* @return An error code
* @param[in] rect An instance of the Tizen::Graphics::FloatRectangle class @n
- * This instance represents the x and y coordinates of the top-left corner of the created window along with
- * the width and height of the control. @n
- * The optimal size of the control is defined in
- * <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
+ * This instance represents the x and y coordinates of the top-left corner of the created window along with
+ * the width and height of the control. @n
+ * If the size is less than the minimum size, EditFied() is constructed with the minimum size. @n
+ * The optimal size of the control is defined in
+ * <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
* @param[in] style The style of the %EditField control
* @param[in] inputStyle The input style of the %EditField control
* @param[in] titleStyle The title style
* @remarks
* - A control is fully usable only after it has been added to a container. Therefore, some methods may fail if the control is used earlier.
* The %EditField style of SMALL property cannot be used together with group styles.
- * - If the specified size is less than the minimum size, EditFied() is constructed with the minimum size.
- * - Following are the input styles used for creating different orientations of a keypad: @n
- * @c INPUT_STYLE_FULLSCREEN: The orientation is decided by the G-sensor value.@n
- * @c INPUT_STYLE_OVERLAY: The orientation is similar to the parent form.
+ * - Following are the input styles used for creating different orientations of a keypad:
+ * - @c INPUT_STYLE_FULLSCREEN: The orientation is decided by the G-sensor value.
+ * - @c INPUT_STYLE_OVERLAY: The orientation is similar to the parent form.
*/
result Construct(const Tizen::Graphics::FloatRectangle& rect, EditFieldStyle style, InputStyle inputStyle, EditFieldTitleStyle titleStyle, bool enableClear = false, int limitLength = 100, GroupStyle groupStyle = GROUP_STYLE_NONE);
* @since 2.0
*
* @return An error code
- * @param[in] size The text size
+ * @param[in] size The text size @n
+ * The size should be greater than or equal to minimum font size which is 4.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid. @n
* The @c size cannot be a negative integer.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The specified @c size should be greater than or equal to minimum font size which is 4.
* @see GetTextSize()
*/
result SetTextSize(int size);
* @since 2.1
*
* @return An error code
- * @param[in] size The text size
+ * @param[in] size The text size @n
+ * The size should be greater than or equal to minimum font size which is 4.0f.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid. @n
* The @c size cannot be a negative integer.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The specified @c size should be greater than or equal to minimum font size which is 4.0f.
* @see GetTextSizeF()
*/
result SetTextSize(float size);
*
* @since 2.0
*
- * @param[in] guideText The guide text
- * @remarks This is the default text that is displayed in the %EditField
- * control when the focus is given to it and no text is entered.
+ * @param[in] guideText The guide text that is displayed in the %EditField control when the focus is given to it and no text is entered.
*/
void SetGuideText(const Tizen::Base::String& guideText);
* @since 2.0
*
* @return An error code
- * @param[out] language The current input language
+ * @param[out] language The current input language of the keypad that is associated with the current %EditField
* @exception E_SUCCESS The method is successful.
- * @remarks The application can get the current language of the keypad that is associated with the current %EditField.
*/
result GetCurrentLanguage(Tizen::Locales::LanguageCode& language) const;
* @since 2.1
*
* @return An error code
- * @param[in] size The text size
+ * @param[in] size The text size @n
+ * The size should be greater than or equal to minimum font size which is 4.0f.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c size is invalid, @n
* or the specified @c size is a negative integer.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The specified @c size should be greater than or equal to minimum font size which is 4.0f.
* @see GetTextSizeF()
*/
result SetTextSize(float size);
* @since 2.0
*
* @return An error code
- * @param[out] start The start index of the text block
- * @param[out] end The end index of the text block
+ * @param[out] start The start index of the text block @n
+ * The value is @c 0 if no text block is selected.
+ * @param[out] end The end index of the text block @n
+ * The value is @c 0 if no text block is selected.
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The method returns the start and end indexes as @c 0 if no text block is selected.
* @see ReleaseBlock()
* @see SetBlockRange()
*/
* @exception E_UNSUPPORTED_OPERATION This operation is not supported. @n
* This device does not support the software back button.
* @exception E_SYSTEM A system error has occurred.
- * @remarks
- * - When the back button is pressed, IFormBackEventListener::OnFormBackRequested() is called.
+ * @remarks When the back button is pressed, IFormBackEventListener::OnFormBackRequested() is called.
* @see Tizen::Ui::Controls::IFormBackEventListener
*/
result SetBackButton(void);
*
* @return An error code
* @param[in] formStyle The form style @n
- * Multiple form styles can be combined using bitwise OR.
+ * Multiple form styles of FormStyle can be combined using bitwise OR.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @if OSPDEPREC - ::FORM_STYLE_HEADER and ::FORM_STYLE_TITLE are specified at the same time.
* @exception E_MAX_EXCEEDED The total number of Frames and Forms exceeds the system limitation.
* @exception E_SYSTEM A system error has occurred.
* @remarks The maximum number of Forms that an application can construct is limited by available memory.
- * @see FormStyle
*/
result Construct(unsigned long formStyle);
* @return An error code
* @param[in] layout The layout for both the portrait and landscape mode
* @param[in] formStyle The form style @n
- * Multiple form styles can be combined using bitwise OR.
+ * Multiple form styles of FormStyle can be combined using bitwise OR.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid, or
* the specified layout is already bound to another container.
* @remarks
* - The maximum number of Forms that an application can construct is limited by available memory.
* - The children are arranged within the client area bounds of the form area by @c layout.
- * @see FormStyle
*/
result Construct(const Tizen::Ui::Layout& layout, unsigned long formStyle);
* @param[in] portraitLayout The layout for the portrait mode
* @param[in] landscapeLayout The layout for the landscape mode
* @param[in] formStyle The form style @n
- * Multiple form styles can be combined using bitwise OR.
+ * Multiple form styles of FormStyle can be combined using bitwise OR.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid, or
* the specified layout is already bound to another container.
* @remarks
* - The maximum number of Forms that an application can construct is limited by available memory.
* - The children are arranged within the bounds of the form area by @c layout.
- * @see FormStyle
*/
result Construct(const Tizen::Ui::Layout& portraitLayout, const Tizen::Ui::Layout& landscapeLayout, unsigned long formStyle);
*
* @since 2.0
*
- * @return The bounds of the client area
- * @remarks The client area of the %Form control does not include the title, indicator, header and footer areas.
+ * @return The bounds of the client area @n
+ * The client area of the %Form control does not include the title, indicator, header and footer areas.
* header and footer areas.
- *
*/
Tizen::Graphics::Rectangle GetClientAreaBounds(void) const;
*
* @since 2.1
*
- * @return The bounds of the client area
- * @remarks The client area of the %Form control does not include the title, indicator, header and footer areas.
+ * @return The bounds of the client area @n
+ * The client area of the %Form control does not include the title, indicator, header and footer areas.
* header and footer areas.
*
*/
*
* @return A pointer to the Footer control, @n
* else @c null if there is no %Footer
- * @remarks The retrieved pointer may be temporary. Therefore, it should not be stored after immediate use. @n
- * The optimal size of the control is defined in
+ * @remarks
+ * - The retrieved pointer may be temporary. Therefore, it should not be stored after immediate use.
+ * - The optimal size of the control is defined in
* <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
*/
Footer* GetFooter(void) const;
*
* @return A pointer to the Header control, @n
* else @c null if there is no %Header
- * @remarks The retrieved pointer may be temporary. Therefore, it should not be
- * stored after immediate use. @n
- * The optimal size of the control is defined in
+ * @remarks
+ * - The retrieved pointer may be temporary. Therefore, it should not be
+ * stored after immediate use.
+ * - The optimal size of the control is defined in
* <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
*/
Header* GetHeader(void) const;
* @since 2.0
*
* @param[in] pFormBackEventListener The %Form back event listener to set
- * @see Tizen::Ui::Controls::IFormBackEventListener.
*/
void SetFormBackEventListener(IFormBackEventListener* pFormBackEventListener);
* @since 2.2
*
* @param[in] pFormMenuEventListener The %Form menu event listener to set
- * @see Tizen::Ui::Controls::IFormMenuEventListener.
*/
void SetFormMenuEventListener(IFormMenuEventListener* pFormMenuEventListener);
* else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of a specified operation. @n
- * If the style of %Form is not ::FORM_STYLE_PORTRAIT_INDICATOR_AUTO_HIDE,
- * the method returns @c E_INVALID_OPERATION.
+ * If the style of %Form is not ::FORM_STYLE_PORTRAIT_INDICATOR_AUTO_HIDE
* @remarks If this method is not explicitly called, the notification tray is opened.
* @see IsNotificationTrayOpenEnabled()
*/
* else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of a specified operation. @n
- * If the style of %Form is not ::FORM_STYLE_PORTRAIT_INDICATOR_AUTO_HIDE,
- * the method returns @c E_INVALID_OPERATION.
+ * If the style of %Form is not ::FORM_STYLE_PORTRAIT_INDICATOR_AUTO_HIDE.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetNotificationTrayOpenEnabled()
*/
projects / platform / framework / native / uifw.git / commitdiff