X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;ds=sidebyside;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Fpage-turn-view%2Fpage-turn-view.h;h=42c8b48e686f14b47192c00c170394c481378b54;hb=502a6996c58f8b8de2dd530235852d53d01d2ac0;hp=d65d5ec7446736910004094b01859ae156c820eb;hpb=ae34cf6aef4b3b807bd1e099baa48230b6b32156;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/public-api/controls/page-turn-view/page-turn-view.h b/dali-toolkit/public-api/controls/page-turn-view/page-turn-view.h index d65d5ec..42c8b48 100644 --- a/dali-toolkit/public-api/controls/page-turn-view/page-turn-view.h +++ b/dali-toolkit/public-api/controls/page-turn-view/page-turn-view.h @@ -36,7 +36,8 @@ class PageTurnView; } /** - * PageTurnView is a base class of different mode of pageTurnViews ( portrait or landscape ) + * @brief PageTurnView is a base class of different mode of pageTurnViews ( portrait or landscape ) + * * Page actors are provided from an external PageFactory * PanGesture is used to activate the page bending, streching and tuning forward/backward * @@ -53,12 +54,14 @@ class PageTurnView; * page turning. * * Signals - * | %Signal Name | Method | - * |--------------------|-------------------------------| - * | page-turn-started | @ref PageTurnStartedSignal() | - * | page-turn-finished | @ref PageTurnFinishedSignal() | - * | page-pan-started | @ref PagePanStartedSignal() | - * | page-pan-finished | @ref PagePanFinishedSignal() | + * | %Signal Name | Method | + * |------------------|-------------------------------| + * | pageTurnStarted | @ref PageTurnStartedSignal() | + * | pageTurnFinished | @ref PageTurnFinishedSignal() | + * | pagePanStarted | @ref PagePanStartedSignal() | + * | pagePanFinished | @ref PagePanFinishedSignal() | + * + * @SINCE_1_1.4 */ class DALI_IMPORT_API PageTurnView : public Control { @@ -66,42 +69,46 @@ public: /** * @brief The start and end property ranges for this control. + * @SINCE_1_1.4 */ enum PropertyRange { - PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, - PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices + PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_1.4 + PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices @SINCE_1_1.4 }; struct Property { enum { - PAGE_SIZE = PROPERTY_START_INDEX, ///< name "page-size", type Vector2 - CURRENT_PAGE_ID, ///< name "current-page-id", type Integer + PAGE_SIZE = PROPERTY_START_INDEX, ///< name "pageSize", type Vector2 @SINCE_1_1.4 + CURRENT_PAGE_ID, ///< name "currentPageId", type Integer @SINCE_1_1.4 /** * The two values are the major&minor radius (in pixels) to form an ellipse shape. * The top-left quarter of this ellipse is used to calculate spine normal for simulating shadow. */ - SPINE_SHADOW, ///< name "spine-shadow", type Vector2 + SPINE_SHADOW, ///< name "spineShadow", type Vector2 @SINCE_1_1.4 }; }; /** - * Creates an empty PageTurnView handle. Only derived versions can be instantiated. + * @brief Creates an empty PageTurnView handle. Only derived versions can be instantiated. * Calling member function with an uninitialized handle is not allowed. + * @SINCE_1_1.4 */ PageTurnView(); /** - * Copy constructor. Creates another handle that points to the same real object + * @brief Copy constructor. Creates another handle that points to the same real object + * @SINCE_1_1.4 * @param[in] handle Handle to copy from */ PageTurnView( const PageTurnView& handle ); /** - * Assignment operator. Changes this handle to point to another real object + * @brief Assignment operator. Changes this handle to point to another real object + * @SINCE_1_1.4 */ PageTurnView& operator=( const PageTurnView& handle ); @@ -109,13 +116,15 @@ public: * @brief Destructor * * This is non-virtual since derived Handle types must not contain data or virtual methods. + * @SINCE_1_1.4 */ ~PageTurnView(); /** - * Downcast an Object handle to PageTurnView. + * @brief Downcast an Object handle to PageTurnView. * If handle points to an PageTurnView the downcast produces valid handle. * If not the returned handle is left uninitialized. + * @SINCE_1_1.4 * @param[in] handle Handle to an object * @return handle to a PageTurnView or an uninitialized handle */ @@ -128,41 +137,45 @@ public: //Signal typedef Signal< void ( PageTurnView ) > PagePanSignal; /** - * Signal emitted when a page has started to turn over. + * @brief Signal emitted when a page has started to turn over. * A callback of the following type may be connected: * @code * void YourCallBackName( PageTurnView pageTurnView, unsigned int pageIndex, bool isTurningForward ); * @endcode + * @SINCE_1_1.4 * @return The signal to connect to */ PageTurnSignal& PageTurnStartedSignal(); /** - * Signal emitted when a page has finished turning over. + * @brief Signal emitted when a page has finished turning over. * A callback of the following type may be connected: * @code * void YourCallBackName( PageTurnView pageTurnView, unsigned int pageIndex, bool isTurningForward ); * @endcode + * @SINCE_1_1.4 * @return The signal to connect to */ PageTurnSignal& PageTurnFinishedSignal(); /** - * Signal emitted when a page pan has commenced + * @brief Signal emitted when a page pan has commenced * A callback of the following type may be connected: * @code * void YourCallBackName( PageTurnView pageTurnView ); * @endcode + * @SINCE_1_1.4 * @return The signal to connect to */ PagePanSignal& PagePanStartedSignal(); /** - * Signal emitted when a page pan has finished + * @brief Signal emitted when a page pan has finished * A callback of the following type may be connected: * @code * void YourCallBackName( PageTurnView pageTurnView ); * @endcode + * @SINCE_1_1.4 * @return The signal to connect to */ PagePanSignal& PagePanFinishedSignal(); @@ -170,13 +183,15 @@ public: //Signal public: // Not intended for application developers /** - * Creates a handle using the Toolkit::Internal implementation. + * @brief Creates a handle using the Toolkit::Internal implementation. + * @SINCE_1_1.4 * @param[in] implementation The Control implementation. */ DALI_INTERNAL PageTurnView(Internal::PageTurnView& implementation); /** - * Allows the creation of this Control from an Internal::CustomActor pointer. + * @brief Allows the creation of this Control from an Internal::CustomActor pointer. + * @SINCE_1_1.4 * @param[in] internal A pointer to the internal CustomActor. */ explicit DALI_INTERNAL PageTurnView(Dali::Internal::CustomActor* internal);