X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Factors%2Flayer.h;h=064059920e064ef1eedcdf6e1f2c2b0e33c246e4;hb=refs%2Fchanges%2F57%2F114957%2F2;hp=7615ecc3aabcb4b6b14e01cb4a38ebd628692e8b;hpb=126643e4e5898def936baf13dd82612fc718f878;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/public-api/actors/layer.h b/dali/public-api/actors/layer.h index 7615ecc..0640599 100644 --- a/dali/public-api/actors/layer.h +++ b/dali/public-api/actors/layer.h @@ -1,8 +1,8 @@ -#ifndef __DALI_LAYER_H__ -#define __DALI_LAYER_H__ +#ifndef DALI_LAYER_H +#define DALI_LAYER_H /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2016 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -38,7 +38,7 @@ class Layer; } /** - * @brief Rectangle describing area on screen that a layer can draw to + * @brief Rectangle describing area on screen that a layer can draw to. * * @SINCE_1_0.0 * @see Dali::Layer::SetClippingBox() @@ -82,14 +82,19 @@ class DALI_IMPORT_API Layer : public Actor public: /** - * @brief An enumeration of properties belonging to the Layer class. + * @brief Enumeration for the instance of properties belonging to the Layer class. * * Properties additional to Actor. - * * @SINCE_1_0.0 */ struct Property { + /** + * @brief Enumeration for the instance of properties belonging to the Layer class. + * + * Properties additional to Actor. + * @SINCE_1_0.0 + */ enum { CLIPPING_ENABLE = DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX, ///< name "clippingEnable", type bool @SINCE_1_0.0 @@ -108,7 +113,7 @@ public: { /** * @DEPRECATED_1_1.45, use LAYER_UI instead - * @brief UI control rendering mode + * @brief UI control rendering mode. * @SINCE_1_0.0 * @see LAYER_UI */ @@ -144,7 +149,7 @@ public: /** * @brief Layer will use depth test. * - * When using this mode depth test will be used. A depth clear will happen for each layer, + * When using this mode, depth test will be used. A depth clear will happen for each layer, * which means actors in a layer "above" other layers will be rendered in front of actors in * those layers regardless of their Z positions (see Layer::Raise() and Layer::Lower()). * Opaque renderers are drawn first and write to the depth buffer. @@ -162,7 +167,7 @@ public: }; /** - * @brief TREE_DEPTH_MULTIPLIER is used by the rendering sorting algorithm to decide which actors to render first. + * @brief Enumeration for TREE_DEPTH_MULTIPLIER is used by the rendering sorting algorithm to decide which actors to render first. * @SINCE_1_0.0 */ enum TreeDepthMultiplier @@ -170,23 +175,23 @@ public: TREE_DEPTH_MULTIPLIER = 10000, }; /** - * @brief The sort function type + * @brief The sort function type. * * @SINCE_1_0.0 - * @param[in] position This is the actor translation from camera. + * @param[in] position This is the actor translation from camera */ typedef float (*SortFunctionType)( const Vector3& position ); /** - * @brief Create an empty Layer handle. + * @brief Creates an empty Layer handle. * - * This can be initialised with Layer::New(...). + * This can be initialized with Layer::New(...). * @SINCE_1_0.0 */ Layer(); /** - * @brief Create a Layer object. + * @brief Creates a Layer object. * * @SINCE_1_0.0 * @return A handle to a newly allocated Layer @@ -194,18 +199,18 @@ public: static Layer New(); /** - * @brief Downcast a handle to Layer handle. + * @brief Downcasts a handle to Layer handle. * - * If handle points to a Layer the downcast produces valid - * handle. If not the returned handle is left uninitialized. + * If handle points to a Layer, the downcast produces valid handle. + * If not, the returned handle is left uninitialized. * @SINCE_1_0.0 - * @param[in] handle Handle to An object + * @param[in] handle Handle to an object * @return Handle to a Layer or an uninitialized handle */ static Layer DownCast( BaseHandle handle ); /** - * @brief Destructor + * @brief Destructor. * * This is non-virtual since derived Handle types must not contain data or virtual methods. * @SINCE_1_0.0 @@ -213,26 +218,26 @@ public: ~Layer(); /** - * @brief Copy constructor + * @brief Copy constructor. * * @SINCE_1_0.0 - * @param [in] copy The actor to copy + * @param[in] copy The actor to copy */ Layer(const Layer& copy); /** - * @brief Assignment operator + * @brief Assignment operator. * * @SINCE_1_0.0 - * @param [in] rhs The actor to copy + * @param[in] rhs The actor to copy * @return A reference to this */ Layer& operator=(const Layer& rhs); /** - * @brief Query the depth of the layer + * @brief Queries the depth of the layer. * - * 0 is bottom most layer, higher number is on top. + * 0 is the bottom most layer, higher number is on top. * @SINCE_1_0.0 * @return The current depth of the layer * @pre Layer is on the stage. @@ -241,7 +246,7 @@ public: unsigned int GetDepth() const; /** - * @brief Increment the depth of the layer. + * @brief Increments the depth of the layer. * * @SINCE_1_0.0 * @pre Layer is on the stage. @@ -249,7 +254,7 @@ public: void Raise(); /** - * @brief Decrement the depth of the layer. + * @brief Decrements the depth of the layer. * * @SINCE_1_0.0 * @pre Layer is on the stage. @@ -259,7 +264,7 @@ public: /** * @brief Ensures the layers depth is greater than the target layer. * - * If the layer already is above the target layer its depth is not changed. + * If the layer already is above the target layer, its depth is not changed. * If the layer was below target, its new depth will be immediately above target. * @SINCE_1_0.0 * @param target Layer to get above of @@ -272,7 +277,7 @@ public: /** * @brief Ensures the layers depth is less than the target layer. * - * If the layer already is below the target layer its depth is not changed. + * If the layer already is below the target layer, its depth is not changed. * If the layer was above target, its new depth will be immediately below target. * @SINCE_1_0.0 * @param target Layer to get below of @@ -299,7 +304,7 @@ public: /** * @brief Moves the layer directly above the given layer. * - * After the call this layers depth will be immediately above target. + * After the call, this layers depth will be immediately above target. * @SINCE_1_0.0 * @param target Layer to get on top of * @pre Layer is on the stage. @@ -311,7 +316,7 @@ public: /** * @brief Moves the layer directly below the given layer. * - * After the call this layers depth will be immediately below target. + * After the call, this layers depth will be immediately below target. * @SINCE_1_0.0 * @param target Layer to get below of * @pre Layer is on the stage. @@ -321,7 +326,7 @@ public: void MoveBelow( Layer target ); /** - * @brief Set the behavior of the layer. + * @brief Sets the behavior of the layer. * * @SINCE_1_0.0 * @param[in] behavior The desired behavior @@ -329,7 +334,7 @@ public: void SetBehavior( Behavior behavior ); /** - * @brief Get the behavior of the layer. + * @brief Gets the behavior of the layer. * * @SINCE_1_0.0 * @return The behavior of the layer @@ -341,16 +346,16 @@ public: * * Clipping is initially disabled; see also SetClippingBox(). * @SINCE_1_0.0 - * @param [in] enabled True if clipping is enabled. + * @param[in] enabled True if clipping is enabled * - * @note When clipping is enabled, the default clipping box is empty (0,0,0,0) which means everything is clipped. + * @note When clipping is enabled, the default clipping box is empty (0,0,0,0), which means everything is clipped. */ void SetClipping(bool enabled); /** - * @brief Query whether clipping is enabled for a layer. + * @brief Queries whether clipping is enabled for a layer. * @SINCE_1_0.0 - * @return True if clipping is enabled. + * @return True if clipping is enabled */ bool IsClipping() const; @@ -360,27 +365,26 @@ public: * The contents of the layer will not be visible outside this box, when clipping is * enabled. The default clipping box is empty (0,0,0,0) which means everything is clipped. * You can only do rectangular clipping using this API in window coordinates. - * For other kinds of clipping, see Dali::Actor::SetDrawMode(). * @SINCE_1_0.0 - * @param [in] x The X-coordinate of the top-left corner of the box - * @param [in] y The Y-coordinate of the top-left corner of the box - * @param [in] width The width of the box - * @param [in] height The height of the box + * @param[in] x The X-coordinate of the top-left corner of the box + * @param[in] y The Y-coordinate of the top-left corner of the box + * @param[in] width The width of the box + * @param[in] height The height of the box */ void SetClippingBox(int x, int y, int width, int height); /** - * @brief Sets the clipping box of a layer, in window coordinates. + * @brief Sets the clipping box of a layer in window coordinates. * - * The contents of the layer will not be visible outside this box, when clipping is + * The contents of the layer will not be visible outside this box when clipping is * enabled. The default clipping box is empty (0,0,0,0). * @SINCE_1_0.0 - * @param [in] box The clipping box + * @param[in] box The clipping box */ void SetClippingBox(ClippingBox box); /** - * @brief Retrieves the clipping box of a layer, in window coordinates. + * @brief Retrieves the clipping box of a layer in window coordinates. * * @SINCE_1_0.0 * @return The clipping box @@ -396,7 +400,7 @@ public: * However, it's possible to disable the depth test by calling this method. * * @SINCE_1_0.0 - * @param[in] disable \e True disables depth test. \e false sets the default behavior. + * @param[in] disable \e True disables depth test. \e false sets the default behavior */ void SetDepthTestDisabled( bool disable ); @@ -404,7 +408,7 @@ public: * @brief Retrieves whether depth test is disabled. * * @SINCE_1_0.0 - * @return \e True if depth test is disabled. + * @return \e True if depth test is disabled */ bool IsDepthTestDisabled() const; @@ -422,12 +426,12 @@ public: * @endcode * * @SINCE_1_0.0 - * @param[in] function The sort function pointer + * @param[in] function The sort function pointer * @note If the sort function returns a low number, the actor with the data will be * drawn in front of an actor whose data yields a high value from the sort function. * - * @note All child layers use the same sort function. If a child layer is added to this - * layer then the sort function used by the child layer will also be the same. + * @note All child layers use the same sort function. If a child layer is added to this + * layer, then the sort function used by the child layer will also be the same. * */ void SetSortFunction( SortFunctionType function ); @@ -438,7 +442,7 @@ public: * If set, any layers behind this layer will not be hit-test. * * @SINCE_1_0.0 - * @param[in] consume Whether the layer should consume touch (including gestures). + * @param[in] consume Whether the layer should consume touch (including gestures) */ void SetTouchConsumed( bool consume ); @@ -446,7 +450,7 @@ public: * @brief Retrieves whether the layer consumes touch (including gestures). * * @SINCE_1_0.0 - * @return True if consuming touch, false otherwise. + * @return @c True if consuming touch, @c false otherwise */ bool IsTouchConsumed() const; @@ -456,7 +460,7 @@ public: * If set, any layers behind this layer will not be hit-test. * * @SINCE_1_0.0 - * @param[in] consume Whether the layer should consume hover. + * @param[in] consume Whether the layer should consume hover */ void SetHoverConsumed( bool consume ); @@ -464,17 +468,18 @@ public: * @brief Retrieves whether the layer consumes hover. * * @SINCE_1_0.0 - * @return True if consuming hover, false otherwise. + * @return @c True if consuming hover, @c false otherwise */ bool IsHoverConsumed() const; public: // Not intended for application developers /** + * @internal * @brief This constructor is used by Layer::New() methods. * * @SINCE_1_0.0 - * @param [in] Layer A pointer to a newly allocated Dali resource + * @param[in] Layer A pointer to a newly allocated Dali resource */ explicit DALI_INTERNAL Layer(Internal::Layer* Layer); }; @@ -484,4 +489,4 @@ public: // Not intended for application developers */ } // namespace Dali -#endif //__DALI_LAYER_H__ +#endif // DALI_LAYER_H