X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Fcontrol-impl.h;h=9cee83eb748cbe42c5a918745cdc95c3a494d023;hp=e3d0676c23c1ee34a63d405b1e396a5401c0ef0a;hb=84e05cec3039abe8ecaaa950d4f93dd4f94282fe;hpb=70fc16a3cea274c6c5c56e5dee0bd5347a6c9389 diff --git a/dali-toolkit/public-api/controls/control-impl.h b/dali-toolkit/public-api/controls/control-impl.h index e3d0676..9cee83e 100644 --- a/dali-toolkit/public-api/controls/control-impl.h +++ b/dali-toolkit/public-api/controls/control-impl.h @@ -251,6 +251,7 @@ public: */ bool IsKeyboardFocusGroup(); + /// @cond internal /** * @brief Called by the AccessibilityManager to activate the Control. * @SINCE_1_0.0 @@ -262,6 +263,7 @@ public: * @SINCE_1_0.0 */ DALI_INTERNAL void KeyboardEnter(); + /// @endcond // Signals @@ -280,6 +282,7 @@ public: */ Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal(); + /// @cond internal /** * @brief Called by the KeyInputFocusManager to emit key event signals. * @@ -288,6 +291,7 @@ public: * @return True if the event was consumed. */ DALI_INTERNAL bool EmitKeyEventSignal( const KeyEvent& event ); + /// @endcond protected: // For derived classes to call @@ -296,22 +300,45 @@ protected: // For derived classes to call * In the case of the visual being an actor or control deeming controlRenderer not required then controlRenderer should be an empty handle. * No parenting is done during registration, this should be done by derived class. * - * @SINCE_1_1.46 + * @SINCE_1_2.0 * * @param[in] index The Property index of the visual, used to reference visual * @param[in] placementActor The actor used to by the visual. * @param[in] visual The visual to register + * @note Derived class must NOT call visual.SetOnStage(placementActor). It is the responsibility of the base class to connect/disconnect registered visual to stage. */ - void RegisterVisual( Property::Index index, Actor placementActor, Toolkit::Visual::Base visual ); + void RegisterVisual( Property::Index index, Actor& placementActor, Toolkit::Visual::Base& visual ); /** * @brief Erase the entry matching the given index from the list of registered visuals * @param[in] index The Property index of the visual, used to reference visual * - * @SINCE_1_1.46 + * @SINCE_1_2.0 */ void UnregisterVisual( Property::Index index ); + /** + * @brief Retrieve the visual associated with the given property index. + * + * @SINCE_1_2.2 + * + * @param[in] index The Property index of the visual. + * @return The registered visual if exist, otherwise empty handle. + * @note For managing object life-cycle, do not store the returned visual as a member which increments its reference count. + */ + Toolkit::Visual::Base GetVisual( Property::Index index ) const; + + /** + * @brief Retrieve the placement actor associated with the given index. + * + * @SINCE_1_2.2 + * + * @@param[in] index The Property index of the visual. + * @return Then placement actor if exist, otherwise empty handle. + * @note For managing object life-cycle, do not store the returned placement actor as a member which increments its reference count. + */ + Actor GetPlacementActor( Property::Index index ) const; + /** * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal * @@ -429,12 +456,18 @@ protected: // Helpers for deriving classes // Construction - // Flags for the constructor + /** + * @brief Flags for the constructor + * @SINCE_1_0.0 + */ enum ControlBehaviour { - REQUIRES_STYLE_CHANGE_SIGNALS = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 0 ), ///< True if needs to monitor style change signals such as theme/font change @SINCE_1_0.0 + CONTROL_BEHAVIOUR_DEFAULT = 0, ///< Default behaviour: Size negotiation is enabled & listens to Style Change signal, but doesn't receive event callbacks. @SINCE_1_2_10 + REQUIRES_STYLE_CHANGE_SIGNALS = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 0 ), ///< True if needs to monitor style change signals such as theme/font change @SINCE_1_0.0 @DEPRECATED_1_2_10 REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation @SINCE_1_0.0 + DISABLE_STYLE_CHANGE_SIGNALS = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 2 ), ///< True if control should not monitor style change signals @SINCE_1_2_10 + LAST_CONTROL_BEHAVIOUR_FLAG }; @@ -685,12 +718,14 @@ public: // API for derived classes to override private: + /// @cond internal // Undefined DALI_INTERNAL Control( const Control& ); DALI_INTERNAL Control& operator=( const Control& ); class Impl; Impl* mImpl; + /// @endcond };