projects
/
platform
/
core
/
uifw
/
dali-toolkit.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Merge "Add ALIASES for new DALi doxygen tagging rule to dali.doxy.in" into devel...
[platform/core/uifw/dali-toolkit.git]
/
dali-toolkit
/
public-api
/
controls
/
control-impl.h
diff --git
a/dali-toolkit/public-api/controls/control-impl.h
b/dali-toolkit/public-api/controls/control-impl.h
index
8ffcbda
..
aa86d6a
100644
(file)
--- a/
dali-toolkit/public-api/controls/control-impl.h
+++ b/
dali-toolkit/public-api/controls/control-impl.h
@@
-35,14
+35,15
@@
namespace Dali
namespace Toolkit
{
namespace Toolkit
{
+/**
+ * @addtogroup dali_toolkit_controls
+ * @{
+ */
+
class StyleManager;
namespace Internal
{
class StyleManager;
namespace Internal
{
-class FocusManager;
-class KeyboardFocusManager;
-class KeyInputFocusManager;
-
/**
* @brief This is the internal base class for all controls.
*
/**
* @brief This is the internal base class for all controls.
*
@@
-101,6
+102,13
@@
public:
void SetBackgroundImage( Image image );
/**
void SetBackgroundImage( Image image );
/**
+ * @brief Set the background with a property map.
+ *
+ * @param[in] map The background property map.
+ */
+ void SetBackground(const Property::Map& map);
+
+ /**
* @copydoc Dali::Toolkit::Control::ClearBackground
*/
void ClearBackground();
* @copydoc Dali::Toolkit::Control::ClearBackground
*/
void ClearBackground();
@@
-225,13
+233,16
@@
public:
*/
bool IsKeyboardFocusGroup();
*/
bool IsKeyboardFocusGroup();
- // Called by Focus Manager
-
/**
/**
- * @brief Called by the
focus manager and keyboard focus manager to Activate the Control
+ * @brief Called by the
AccessibilityManager to activate the Control.
*/
DALI_INTERNAL void AccessibilityActivate();
*/
DALI_INTERNAL void AccessibilityActivate();
+ /**
+ * @brief Called by the KeyboardFocusManager.
+ */
+ DALI_INTERNAL void KeyboardEnter();
+
// Signals
/**
// Signals
/**
@@
-273,7
+284,7
@@
protected: // From CustomActorImpl, not to be used by application developers
/**
* @copydoc CustomActorImpl::OnStageConnection()
*/
/**
* @copydoc CustomActorImpl::OnStageConnection()
*/
- virtual void OnStageConnection();
+ virtual void OnStageConnection(
int depth
);
/**
* @copydoc CustomActorImpl::OnStageDisconnection()
/**
* @copydoc CustomActorImpl::OnStageDisconnection()
@@
-316,9
+327,9
@@
protected: // From CustomActorImpl, not to be used by application developers
virtual bool OnKeyEvent( const KeyEvent& event );
/**
virtual bool OnKeyEvent( const KeyEvent& event );
/**
- * @copydoc CustomActorImpl::On
Mouse
WheelEvent()
+ * @copydoc CustomActorImpl::OnWheelEvent()
*/
*/
- virtual bool On
MouseWheelEvent( const Mouse
WheelEvent& event );
+ virtual bool On
WheelEvent( const
WheelEvent& event );
/**
* @copydoc CustomActorImpl::OnRelayout()
/**
* @copydoc CustomActorImpl::OnRelayout()
@@
-468,6
+479,14
@@
public: // API for derived classes to override
*/
virtual bool OnAccessibilityValueChange( bool isIncrease );
*/
virtual bool OnAccessibilityValueChange( bool isIncrease );
+ /**
+ * @brief This method should be overridden by deriving classes when they wish to respond
+ * the accessibility zoom action
+ *
+ * @return true if the zoom action has been consumed by this control
+ */
+ virtual bool OnAccessibilityZoom();
+
// Keyboard focus
/**
// Keyboard focus
/**
@@
-493,7
+512,7
@@
public: // API for derived classes to override
* @param[in] loopEnabled Whether the focus movement should be looped within the control.
* @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
*/
* @param[in] loopEnabled Whether the focus movement should be looped within the control.
* @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
*/
- virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus
Navigation
Direction direction, bool loopEnabled );
+ virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus
::
Direction direction, bool loopEnabled );
/**
* @brief Informs this control that its chosen focusable actor will be focused.
/**
* @brief Informs this control that its chosen focusable actor will be focused.
@@
-505,6
+524,14
@@
public: // API for derived classes to override
*/
virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
*/
virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
+ /**
+ * @brief This method is called when the control has enter pressed on it.
+ *
+ * Derived classes should override this to perform custom actions.
+ * @return true if this control supported this action.
+ */
+ virtual bool OnKeyboardEnter();
+
// Gestures
/**
// Gestures
/**
@@
-600,7
+627,7
@@
private:
* @param handle
* @return implementation
*/
* @param handle
* @return implementation
*/
-Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
+
DALI_IMPORT_API
Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
/**
* @brief Get implementation from the handle
/**
* @brief Get implementation from the handle
@@
-609,10
+636,13
@@
Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
* @param handle
* @return implementation
*/
* @param handle
* @return implementation
*/
-const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
+
DALI_IMPORT_API
const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
} // namespace Internal
} // namespace Internal
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
} // namespace Toolkit
} // namespace Dali