Doxygen update. 54/69554/1
authorWoochan Lee <wc0917.lee@samsung.com>
Mon, 16 May 2016 01:36:01 +0000 (10:36 +0900)
committerWoochan Lee <wc0917.lee@samsung.com>
Mon, 16 May 2016 01:36:18 +0000 (10:36 +0900)
Change-Id: I29e27cced0e8588b139b107cc812351e905686cc

15 files changed:
src/include/efl/mobile/ui_app.h
src/include/efl/mobile/ui_key_listener.h
src/include/efl/mobile/ui_menu.h
src/include/efl/mobile/ui_popup.h
src/include/efl/mobile/ui_standard_view.h
src/include/efl/mobile/ui_view.h
src/include/efl/mobile/ui_viewmgr.h
src/include/efl/ui_base_key_listener.h
src/include/efl/ui_base_overlay.h
src/include/efl/ui_base_view.h
src/include/efl/ui_base_viewmgr.h
src/include/interface/ui_iface_overlay.h
src/include/interface/ui_iface_rotatable.h
src/include/interface/ui_iface_view.h
src/include/interface/ui_iface_viewmgr.h

index 72011888fce3a763d494d9e8d6bab6937ab9b460..7467c15f00a7788acd34a3ceadaaed3d3228d092 100644 (file)
@@ -25,7 +25,12 @@ class ui_viewmgr;
 class ui_app
 {
 public:
-       ///Constructor.
+       /**
+        *  @brief This is a constructor for initializing ui_app.
+        *
+        *  @param pkg The name of package.
+        *  @param loale_dir The path of locale directory.
+        */
        ui_app(const char *pkg, const char *locale_dir);
 
        ///Destructor.
@@ -40,6 +45,8 @@ public:
 
        /**
         *  @brief Return ui_app instance.
+        *
+        *  @return The instance of ui_app.
         */
        static ui_app *get_instance();
 
@@ -84,31 +91,43 @@ protected:
 
        /**
         *  @brief Calling when gets a launch request event.
+        *
+        *  @param app_control_h The instance of app_control_h.
         */
        virtual void on_control(app_control_h app_control);
 
        /**
         *  @brief Calling when device low battery.
+        *
+        *  @param app_event_info_h The instance of app_event_info_h.
         */
        virtual void on_low_battery(app_event_info_h event_info);
 
        /**
         *  @brief Calling when device low memory.
+        *
+        *  @param app_event_info_h The instance of app_event_info_h.
         */
        virtual void on_low_memory(app_event_info_h event_info);
 
        /**
         *  @brief Calling when device region changed.
+        *
+        *  @param app_event_info_h The instance of app_event_info_h.
         */
        virtual void on_region_changed(app_event_info_h event_info);
 
        /**
         *  @brief Calling when device orient changed.
+        *
+        *  @param app_event_info_h The instance of app_event_info_h.
         */
        virtual void on_orient_changed(app_event_info_h event_info);
 
        /**
         *  @brief Calling when language changed.
+        *
+        *  @param app_event_info_h The instance of app_event_info_h.
         */
        virtual void on_lang_changed(app_event_info_h event_info);
 
index bed93271572ac164dc8df24a11774c01d59aade4..63cfcbabe416c5660be301fd03dc2e64e8a15493 100644 (file)
@@ -32,7 +32,11 @@ class ui_viewmgr;
 class ui_key_listener : public ui_base_key_listener
 {
 public:
-       ///Constructor.
+       /**
+        *  @brief This is a constructor for initializing this ui_key_listener.
+        *
+        *  @param The instance of ui_viewmgr.
+        */
        ui_key_listener(ui_viewmgr *viewmgr);
 
        /**
@@ -43,7 +47,7 @@ public:
        virtual bool init();
 
        /**
-        *  @brief Check the menu key event.
+        *  @brief Check the menu key event occurs or not.
         *
         *  @note This is checking H/W key is menu or not.
         */
index 0cbc841fe614c832f97377f54c0e820087434f5b..e7eb6cd7b689722a147a6ed928f9a350bcf917f1 100644 (file)
@@ -36,7 +36,8 @@ class ui_view;
 class ui_menu: public ui_base_overlay
 {
 public:
-       /** @brief menu activate.
+       /**
+        *  @brief menu activate.
         *
         *  @note It makes menu state as show.
         *
@@ -46,7 +47,8 @@ public:
         */
        virtual bool activate();
 
-       /** @brief menu deactivate.
+       /**
+        *  @brief menu deactivate.
         *
         *  @note It makes menu state as hide.
         *
@@ -56,7 +58,8 @@ public:
         */
        virtual bool deactivate();
 
-       /** @brief This is for replacing or setting a content of the menu.
+       /**
+        *  @brief This is for replacing or setting a content of the menu.
         *
         *  @param ctxpopup ctxpopup object. It allows @c NULL for canceling the previous content.
         *
@@ -64,7 +67,8 @@ public:
         */
        virtual bool set_content(Elm_Ctxpopup* ctxpopup);
 
-       /** @brief This is for unsetting a content of the menu.
+       /**
+        *  @brief This is for unsetting a content of the menu.
         *
         *  @return A previous content. If it wasn't, return value will be @c NULL.
         */
@@ -95,7 +99,11 @@ public:
        virtual int get_degree();
 
 protected:
-       ///Constructor.
+       /**
+        *  @brief This is a constructor for initializing this menu.
+        *
+        *  @param The instance of ui_view.
+        */
        ui_menu(ui_view *view);
 
        ///Destructor.
index 52132ee4301c5f7dfc6890b2c0e21f3a9b24ff39..d1d0445b71ff1edfe40c60d4931877b0be9075d9 100644 (file)
@@ -38,13 +38,18 @@ class ui_view;
 class ui_popup : public ui_base_overlay
 {
 public:
-       ///Constructor.
+       /**
+        *  @brief This is a constructor for initializing this popup.
+        *
+        *  @param The instance of ui_view.
+        */
        ui_popup(ui_view *view);
 
        ///Destructor.
        virtual ~ui_popup();
 
-       /** @brief popup activate.
+       /**
+        *  @brief popup activate.
         *
         *  @note It makes popup state as show.
         *
@@ -54,7 +59,8 @@ public:
         */
        virtual bool activate();
 
-       /** @brief popup deactivate.
+       /**
+        *  @brief popup deactivate.
         *
         *  @note It makes popup state as hide.
         *
@@ -64,7 +70,8 @@ public:
         */
        virtual bool deactivate();
 
-       /** @brief This is for replacing or setting a content of the popup.
+       /**
+        *  @brief This is for replacing or setting a content of the popup.
         *
         *  @param popup popup object. It allows @c NULL for canceling the previous content.
         *
@@ -72,7 +79,8 @@ public:
         */
        virtual bool set_content(Elm_Popup* popup);
 
-       /** @brief This is for unsetting a content of the popup.
+       /**
+        *  @brief This is for unsetting a content of the popup.
         *
         *  @return A previous content. If it wasn't, return value will be @c NULL.
         */
index 1da1cff94b59e3107559a48aa76e1f134b5dec3f..6e6eb731ce8fdfada1d4dcdd04bf9c2d85e7efa5 100644 (file)
@@ -36,13 +36,18 @@ namespace efl_viewmanager
 class ui_standard_view: public ui_view
 {
 public:
-       ///Constructor.
+       /**
+        *  @brief This is a constructor for initializing this view resources.
+        *
+        *  @param name view name.
+        */
        ui_standard_view(const char *name = NULL);
 
        ///Destructor.
        virtual ~ui_standard_view();
 
-       /** @brief This is for replacing or setting a content of the view.
+       /**
+        *  @brief This is for replacing or setting a content of the view.
         *
         *  @param content a new content. It allows @c NULL for canceling the previous content.
         *  @param title  title_label The label in the title area. The name of the title label part is "elm.text.title"
@@ -51,7 +56,8 @@ public:
         */
        bool set_content(Evas_Object *content, const char *title = NULL);
 
-       /** @brief This is for replacing or setting a content of the view.
+       /**
+        *  @brief This is for replacing or setting a content of the view.
         *
         *  @param content a new content. It allows @c NULL for canceling the previous content.
         *  @param title  The label in the title area. The name of the title label part is "elm.text.title".
@@ -67,6 +73,8 @@ public:
         *  @brief This is for setting title badge text.
         *
         *  @param text The label in the title badge area.
+        *
+        *  @return true if it succeed, false otherwise.
         */
        bool set_title_badge(const char *text);
 
@@ -74,6 +82,8 @@ public:
         *  @brief This is for setting subtitle text.
         *
         *  @param text The label in the subtitle area.
+        *
+        *  @return true if it succeed, false otherwise.
         */
        bool set_subtitle(const char *text);
 
@@ -81,6 +91,8 @@ public:
         *  @brief This is for setting title_left_btn.
         *
         *  @param title_left_btn The button in the left part of title area.
+        *
+        *  @return true if it succeed, false otherwise.
         */
        bool set_title_left_btn(Elm_Button *title_left_btn);
 
@@ -88,6 +100,8 @@ public:
         *  @brief This is for setting title_right_btn.
         *
         *  @param title_right_btn The button in the right part of title area.
+        *
+        *  @return true if it succeed, false otherwise.
         */
        bool set_title_right_btn(Elm_Button *title_right_btn);
 
@@ -95,6 +109,8 @@ public:
         *  @brief This is for setting title text.
         *
         *  @param text The label in the title area.
+        *
+        *  @return true if it succeed, false otherwise.
         */
        bool set_title(const char *text);
 
@@ -102,6 +118,8 @@ public:
         *  @brief This is for setting toolbar below title.
         *
         *  @param toolbar Toolbar object.
+        *
+        *  @return true if it succeed, false otherwise.
         */
        bool set_toolbar(Elm_Toolbar *toolbar);
 
@@ -110,6 +128,8 @@ public:
         *
         *  @param visible title state set as visible if the given param is true, otherwise title area set as invisible.
         *  @param anim title area will be shown with animation if the given param is true, otherwise title area will be shown without animation.
+        *
+        *  @return true if it succeed, false otherwise.
         */
        bool set_title_visible(bool visible, bool anim);
 
@@ -190,7 +210,7 @@ protected:
         *  @note This interface is designed for toggling touch event on view transition.
         *        ui_iface_viewmgr will call this interface for notifying event blocking toggling on transition time.
         *
-        *  @param block @c true, when blocking is enabled, otherwise @c false.
+        *  @param block @c true, blocking enable, otherwise @c false.
         */
        virtual void set_event_block(bool block);
 
index 48156e77d3805e9ee2b1f2425dc575f5df86755e..078ac074e61d2a01368cb020186208ba10669b28 100644 (file)
@@ -36,7 +36,11 @@ class ui_key_listener;
 class ui_view: public ui_base_view
 {
 public:
-       ///Constructor.
+       /**
+        *  @brief This is a constructor for initializing this view resources.
+        *
+        *  @param name view name.
+        */
        ui_view(const char *name = NULL);
 
        ///Destructor.
@@ -45,7 +49,7 @@ public:
        /**
         *  @brief Get menu object.
         *
-        *  @return menu object if any.
+        *  @return The menu object of connected with view.
         */
        const ui_menu *get_menu();
 
@@ -53,10 +57,10 @@ protected:
        /**
         *  @brief This is making ui_menu instance.
         *
-        *  @note It creates ui_menu instance, if there is no ui_menu instance of this view.
+        *  @note It creates ui_menu instance, if there is no connected ui_menu instance of this view.
         *        It hides menu if there is already menu activated.
         *
-        *  @return menu instance of this view. NULL If the menu already activated.
+        *  @return The menu instance of this view. NULL If the menu already activated.
         */
        virtual ui_menu *on_menu_pre();
 
@@ -68,14 +72,14 @@ protected:
        virtual void on_menu_post();
 
        /**
-        *  @brief H/W back key event occurs on view.
+        *  @brief The H/W menu key event occurs on view.
         *
         *  @param menu menu instance, This is made by key listener when menu key occured.
         */
        virtual void on_menu(ui_menu *menu);
 
        /**
-        *  @brief H/W back key event occurs on view.
+        *  @brief The H/W back key event occurs on view.
         *
         *  @note User can override this function to define application specific action when H/W back key
         *        event occurs. otherwise current view will be popped.
@@ -83,7 +87,7 @@ protected:
        virtual void on_back();
 
        /**
-        *  @brief view rotate changed.
+        *  @brief View rotate changed.
         *
         *  @note This state will be called when view rotation changed.
         *
@@ -95,7 +99,7 @@ protected:
        virtual void on_rotate(int degree);
 
        /**
-        *  @brief view portrait state.
+        *  @brief View portrait state.
         *
         *  @note This state will be called when view rotation changed to portrait.
         *
@@ -105,7 +109,7 @@ protected:
        virtual void on_portrait();
 
        /**
-        *  @brief view landscape state.
+        *  @brief View landscape state.
         *
         *  @note This state will be called when view rotation changed to landscape.
         *
@@ -114,7 +118,7 @@ protected:
         */
        virtual void on_landscape();
 
-       /** @brief view deactivate state.
+       /** @brief View deactivate state.
         *
         *  @note this state will be triggered by ui_iface_viewmgr.
         *
index 2d0de638d7a7d9006f01ae13b32e4790ef5e8087..1a29c55d8e97ad2a6c3f3684c9536f87ccc11e17 100644 (file)
@@ -36,7 +36,14 @@ class ui_viewmgr: public ui_base_viewmgr
 {
 protected:
        //Don't allow to create ui_viewmgr instance
+       /**
+        *  @brief This is a constructor for initializing viewmgr.
+        *
+        *  @param pkg The name of package.
+        */
        ui_viewmgr(const char *pkg);
+
+       ///Destructor.
        virtual ~ui_viewmgr();
 
 private:
index e41ab32ce344c9645ea7dbe440a6c8def216fe85..1852f8534ec2744e549a03703406fafa5c7ba2ca 100644 (file)
@@ -35,7 +35,11 @@ class ui_base_viewmgr;
 class ui_base_key_listener
 {
 protected:
-       ///Constructor.
+       /**
+        *  @brief This is a constructor for initializing key listener.
+        *
+        *  @param viewmgr The instance of ui_base_viewmgr.
+        */
        ui_base_key_listener(ui_base_viewmgr *viewmgr);
 
        ///Destructor.
@@ -44,7 +48,7 @@ protected:
        /**
         *  @brief Init H/W key listener to grab key event(back key).
         *
-        *  @note It makes evas_object_rectangle and add key up callback.
+        *  @note It makes evas_object_rectangle and add key up callback to grab key event.
         *
         *  @see term()
         */
@@ -60,7 +64,7 @@ protected:
        virtual bool term();
 
        /**
-        *  @brief Check the menu key event.
+        *  @brief Check the menu key event occurs or not.
         *
         *  @note This is checking H/W key is menu or not.
         */
index f81854b54e81d17fa2936cfac2e8f499e0b75bc7..998e72d3a00f4c64cbbbfad04ec818b427d92c75 100644 (file)
@@ -35,7 +35,11 @@ class ui_base_view;
 class ui_base_overlay: public ui_iface_overlay
 {
 protected:
-       ///Constructor.
+       /**
+        *  @brief This is a constructor for initializing overlay.
+        *
+        *  @param view The instance of ui_base_view.
+        */
        ui_base_overlay(ui_base_view *view);
 
        ///Destructor.
index 607d751a2ef768ac04531ba8799450e3b22d62f2..c22217d0ec40099c5eeeaffce44bc8dd192b648d 100644 (file)
@@ -31,13 +31,18 @@ namespace efl_viewmanager
 class ui_base_view: public ui_iface_view
 {
 public:
-       ///Constructor.
+       /**
+        *  @brief This is a constructor for initializing this view resources.
+        *
+        *  @param name view name.
+        */
        ui_base_view(const char *name = NULL);
 
        ///Destructor.
        virtual ~ui_base_view();
 
-       /** @brief This is for replacing or setting a content of the view.
+       /**
+        *  @brief This is for replacing or setting a content of the view.
         *
         *  @param content a new content. It allows @c NULL for canceling the previous content.
         *
@@ -45,51 +50,59 @@ public:
         */
        virtual bool set_content(Evas_Object *content);
 
-       /** @brief This is for unsetting a content of the view.
+       /**
+        *  @brief This is for unsetting a content of the view.
         *
         *  @return A previous content. If it wasn't, return value will be @c NULL.
         */
        virtual Evas_Object *unset_content();
 
-       /**  @brief Get a base layout of viewmgr.
+       /**
+        *  @brief Get a base layout of viewmgr.
+        *
+        *  @return The base layout object of viewmgr.
         */
        virtual Evas_Object *get_base();
 
-       /** @brief Set the indicator mode.
+       /**
+        *  @brief Set the indicator mode.
         *
         *  @param indicator The mode to set, one of #ui_base_view_indicator.
         */
        virtual void set_indicator(ui_view_indicator indicator);
 
-       /** @brief Get current view's degree.
+       /**
+        *  @brief Get current view's degree.
         *
         *  @return Current rotation degree, -1 if it fails to get degree information.
         */
        virtual int get_degree();
 
 protected:
-       /** @brief Get a parent object of view.
+       /**
+        *  @brief Get a parent object of view.
         *
         *  @note This is calling viewmgr get_base() method internally.
         *
-        *  @return base layout of viewmgr.
+        *  @return The base layout object of viewmgr.
         */
        Evas_Object *get_parent();
 
-       /** @brief toggle event block.
+       /**
+        *  @brief Toggle event block.
         *
-        *  @note It makes internal conformant event freeze during effect showing.
+        *  @note It makes view content event freeze during effect showing.
         *
         *  @param block @c true, when blocking is enabled, otherwise @c false.
         */
        virtual void set_event_block(bool block);
 
        /**
-        *  @brief view rotate changed.
+        *  @brief View rotate changed.
         *
         *  @note This state will be called when view rotation changed.
         *
-        *  @param degree Current view's degree.
+        *  @param degree The current degree of view.
         *
         *  @see on_portrait()
         *  @see on_landscpae()
@@ -97,7 +110,7 @@ protected:
        virtual void on_rotate(int degree);
 
        /**
-        *  @brief view portrait state.
+        *  @brief View portrait state.
         *
         *  @note This state will be called when view rotation changed to portrait.
         *
@@ -107,7 +120,7 @@ protected:
        virtual void on_portrait();
 
        /**
-        *  @brief view landscape state.
+        *  @brief View landscape state.
         *
         *  @note This state will be called when view rotation changed to landscape.
         *
index f37fa19f3ff5d179feb1eb6f89e1fbccb107710d..b44fdc8d792d60bd68d96e358103696859650da1 100644 (file)
@@ -82,21 +82,17 @@ public:
        virtual ui_base_view *push_view(ui_base_view *view);
 
        /**
-        *  @brief Push a new view into this viewmgr. This function is used for when application switches a current view to a new one.
-        *
-        *  @note Normally, the current view will be hidden by a new view. In default, when user calls this API, view will be switched to @p view instantly,
-        *        only when viewmgr state is activated. Otherwise, the @p view will be shown later when viewmgr is activated. push_view() is designed for providing
-        *        view transition effect. If you want push view instantly without any transition, you could use insert_view_before() or insert_view_after().
-        *        If you want to pop the current view, the please use pop_view().
+        *  @brief Pop the top(last) view from this viewmgr view list.
+        *         This function is used when application switches the current view back to the previous view.
+        *         The top view will be removed from the view stack and then it will be deleted by the viewmgr.
         *
-        *  @param view A view to insert in the viewmgr view list.
+        *  @note If the view is just one left, then viewmgr would be deactivated automatically since the ui application might be invalid anymore. Otherwise,
+        *        the application will be terminated. It's up to system configuration.
         *
-        *  @return @p view, @c NULL when it fails to push a @p view.
+        *  @return @c true on success or @c false otherwise.
         *
-        *  @see activated()
-        *  @see insert_view_before()
-        *  @see insert_view_after()
-        *  @see pop_view()
+        *  @see deactivate()
+        *  @see push_view()
         */
        virtual bool pop_view();
 
@@ -120,15 +116,24 @@ public:
         */
        virtual bool insert_view_after(ui_base_view *view, ui_base_view *after);
 
-       /** @brief Get a window object of viewmgr.
+       /**
+        *  @brief Get a window object of viewmgr.
+        *
+        *  @return The window object of viewmgr.
         */
        Elm_Win *get_window();
 
-       /** @brief Get a conformant object of viewmgr.
+       /**
+        *  @brief Get a conformant object of viewmgr.
+        *
+        *  @return The conformant object of viewmgr.
         */
        Elm_Conformant *get_conformant();
 
-       /** @brief Get a last view of current view stack.
+       /**
+        *  @brief Return a last(top) view.
+        *
+        *  @return The view which is last view of the viewmgr view list.
         */
        ui_base_view *get_last_view();
 
@@ -148,7 +153,10 @@ public:
         */
        ui_base_view *get_view(unsigned int idx);
 
-       /** @brief Get a base layout of viewmgr.
+       /**
+        *  @brief Get a base layout of viewmgr.
+        *
+        *  @return The base layout object of viewmgr.
         */
        Evas_Object *get_base();
 
@@ -156,12 +164,25 @@ protected:
        /**
         *  @brief Set indicator of the view.
         *
-        *  @param indicator The mode to set, one of #ui_view_indicator
+        *  @param indicator The mode to set, one of #ui_view_indicator.
+        *
+        *  @return @c false if current indicator is same with new one, @c true otherwise.
         */
        bool set_indicator(ui_view_indicator indicator);
 
-       ///Constructor
+       /**
+        *  @brief This is a constructor for initializing viewmgr.
+        *
+        *  @param pkg The name of package.
+        *  @param key_listener The instance of ui_base_key_listner.
+        */
        ui_base_viewmgr(const char *pkg, ui_base_key_listener *key_listener);
+
+       /**
+        *  @brief This is a constructor for initializing viewmgr.
+        *
+        *  @param pkg The name of package.
+        */
        ui_base_viewmgr(const char *pkg);
 
        ///Destructor.
index 21ca0f4791c84bc4bcb2d69ed9b55bb391be2753..02698e1b818d7c128610a3f777feec2398f3040b 100644 (file)
@@ -35,7 +35,8 @@ class ui_iface_view;
 class ui_iface_overlay: public ui_iface_rotatable
 {
 public:
-       /** @brief This is for replacing or setting a content of the view.
+       /**
+        *  @brief This is for replacing or setting a content of the view.
         *
         *  @note @p content is a logical object that represents a view in your framework. The actual type of the content could be translated to any certain types.
         *        For instance, the type could be Evas_Object * in EFL and Layer * in Dali.
@@ -46,34 +47,38 @@ public:
         */
        virtual bool set_content(T content);
 
-       /** @brief This is for unsetting a content of the view.
+       /**
+        *  @brief This is for unsetting a content of the view.
         *
         *  @return A previous content. If it wasn't, return value will be @c NULL.
         */
        virtual T unset_content();
 
-       /** @brief H/W back key event occurs on view.
+       /**
+        *  @brief The H/W back key event occurs on view.
         *
         *  @note User can override this function to define application specific action when H/W back key
         *        event occurs. otherwise current view will be popped.
         */
        virtual void on_back();
 
-       /** @brief Overlay activate.
+       /**
+        *  @brief Overlay activate.
         *
         *  @note It makes overlay state as show.
         *
-        *  @return true if it succeed, false otherwise.
+        *  @return @c true on success or @c false otherwise.
         *
         *  @see deactivate()
         */
        virtual bool activate();
 
-       /** @brief Overlay deactivate.
+       /**
+        *  @brief Overlay deactivate.
         *
         *  @note It makes overlay state as hide.
         *
-        *  @return true if it succeed, false otherwise.
+        *  @return @c true on success or @c false otherwise.
         *
         *  @see activate()
         */
@@ -96,14 +101,19 @@ public:
         */
        ui_iface_view *get_view();
 
-       /** @brief Return a content instance of this overlay.
+       /**
+        *  @brief Return a content instance of this overlay.
         *
         *  @return content of overlay.
         */
        virtual T get_content();
 
 protected:
-       ///Constructor.
+       /**
+        *  @brief This is a constructor for initializing overlay.
+        *
+        *  @param view The instance of ui_iface_view.
+        */
        ui_iface_overlay(ui_iface_view *view);
 
        ///Destructor.
index fda9abd0870ed049e9610830a68279ccaf0bff3d..b3d01936397136f89c67b8d0ec88be45ae1cb517 100644 (file)
@@ -32,7 +32,7 @@ class ui_iface_rotatable
 {
 protected:
        /**
-        *  @brief view portrait state.
+        *  @brief View portrait state.
         *
         *  @note This state will be called when view rotation changed to portrait.
         *
@@ -42,7 +42,7 @@ protected:
        virtual void on_portrait() {}
 
        /**
-        *  @brief view landscape state.
+        *  @brief View landscape state.
         *
         *  @note This state will be called when view rotation changed to landscape.
         *
@@ -52,7 +52,7 @@ protected:
        virtual void on_landscape() {}
 
        /**
-        *  @brief view rotate changed.
+        *  @brief View rotate changed.
         *
         *  @note This state will be called when view rotation changed.
         *
@@ -64,7 +64,8 @@ protected:
        virtual void on_rotate(int degree) {}
 
 public:
-       /** @brief Get current view's degree.
+       /**
+        *  @brief Get current view's degree.
         *
         *  @return Current rotation degree, -1 if it fails to get degree information.
         */
index 60ad78511db4a5e853a9f3cdfc4980dc09d04d5c..b162382d3678d93f3ba9eabc79e95e4df6777943 100644 (file)
@@ -40,16 +40,18 @@ class ui_iface_viewmgr;
 class ui_iface_view : public ui_iface_rotatable
 {
 public:
-       /** @brief This is a constructor for initializing this view resources.
+       /**
+        *  @brief This is a constructor for initializing this view resources.
         *
         *  @param name view name.
         */
        ui_iface_view(const char *name = NULL);
 
-       ///Destructor for terminating view.
+       ///Destructor.
        virtual ~ui_iface_view();
 
-       /** @brief set transition style of a view.
+       /**
+        *  @brief Set transition style of a view.
         *
         *  @note @p style is reserved for supporting various kinds of view transition effects.
         *        The actual behaviors with this transition style is up to your frameworks. Default value of the style is NULL.
@@ -64,9 +66,10 @@ public:
         */
        bool set_transition_style(const char *style);
 
-       /** @brief set name of the view.
+       /**
+        *  @brief Set name of the view.
         *
-        *  @note A view can gets a specific name. default value of the name is NULL.
+        *  @note A view can get a specific name. default value of the name is NULL.
         *
         *  @param name a new name of view.
         *
@@ -76,7 +79,8 @@ public:
         */
        bool set_name(const char *name);
 
-       /** @brief set content removable.
+       /**
+        *  @brief Set content removable.
         *
         *  @param removable if @p removable is @c true, content of this view will be removed on unload state. @c false otherwise.
         *
@@ -84,31 +88,36 @@ public:
         */
        void set_removable_content(bool removable);
 
-       /** @brief set the indicator of the view with mode.
+       /**
+        *  @brief Set the indicator of the view with mode.
         *
         *  @param indicator The mode to set, one of #ui_view_indicator.
         */
        void set_indicator(ui_view_indicator indicator);
 
-       /** @brief Return a style name of this view.
+       /**
+        *  @brief Return a style name of this view.
         *
         *  @return style name of view.
         */
        const char *get_transition_style();
 
-       /** @brief Return a name of this view.
+       /**
+        *  @brief Return a name of this view.
         *
         *  @return name of view.
         */
        const char *get_name();
 
-       /** @brief Return a content instance of this view.
+       /**
+        *  @brief Return a content instance of this view.
         *
         *  @return content of view.
         */
        T get_content();
 
-       /** @brief This is for replacing or setting a content of the view.
+       /**
+        *  @brief This is for replacing or setting a content of the view.
         *
         *  @note @p content is a logical object that represents a view in your framework. The actual type of the content could be translated to any certain types.
         *        For instance, the type could be Evas_Object * in EFL and Layer * in Dali.
@@ -119,31 +128,36 @@ public:
         */
        virtual bool set_content(T content);
 
-       /** @brief This is for unsetting a content of the view.
+       /**
+        *  @brief This is for unsetting a content of the view.
         *
         *  @return A previous content. If it wasn't, return value will be @c NULL.
         */
        virtual T unset_content();
 
-       /** @brief Return a state of this view.
+       /**
+        *  @brief Return a state of this view.
         *
-        *  #return current state of view.
+        *  @return current state of view.
         */
        ui_view_state get_state();
 
-       /** @brief Return a state of removable content.
+       /**
+        *  @brief Return a state of removable content.
         *
         *  @return true if the view's content is removable, otherwise false.
         */
        bool get_removable_content();
 
-       /** @brief Return the indicator mode of this view.
+       /**
+        *  @brief Return the indicator mode of this view.
         *
         *  @return indicator state of view.
         */
        ui_view_indicator get_indicator();
 
-       /** @brief H/W back key event occurs on view.
+       /**
+        *  @brief The H/W back key event occurs on view.
         *
         *  @note User can override this function to define application specific action when H/W back key
         *        event occurs. otherwise current view will be popped.
@@ -151,17 +165,29 @@ public:
        virtual void on_back();
 
 protected:
-
-       /** @brief toggle event block.
+       /**
+        *  @brief Toggle event block.
         *
         *  @note This interface is designed for toggling touch event on view transition.
         *        ui_iface_viewmgr will call this interface for notifying event blocking toggling on transition time.
         *
         *  @param block @c true, when blocking is enabled, otherwise @c false.
+        *
+        *  @see get_event_block()
         */
        virtual void set_event_block(bool block);
 
-       /** @brief view load state.
+       /**
+        *  @brief Return the state of event block.
+        *
+        *  @return true if the event block enabled, otherwise false.
+        *
+        *  @see set_event_block()
+        */
+       bool get_event_block();
+
+       /**
+        *  @brief View load state.
         *
         *  @note A view of this state is moving onto the screen. Get ready for this view. Generally, you could prepare this view's content here and set them to
         *        this view. In the most cases, this on_load() will be triggered with this step. load -> deactivated -> activated. Tihs on_load() will be triggered
@@ -169,22 +195,25 @@ protected:
         */
        virtual void on_load();
 
-       /** @brief view unload state.
+       /**
+        *  @brief View unload state.
         *
-     *  @note Remove resources (contents) with regards to this view for saving memory. Otherwise, you could keep those resources (contents) for later access.
-     *        Removing resources might be better in point of performance view. It's up to your scenario. on_unload() will be triggered just right before
-     *        the view is going to be deleted by popping or by somehow. Also, on_unload() will be triggered when this view is pushed behind other views.
+        *  @note Remove resources (contents) with regards to this view for saving memory. Otherwise, you could keep those resources (contents) for later access.
+        *        Removing resources might be better in point of performance view. It's up to your scenario. on_unload() will be triggered just right before
+        *        the view is going to be deleted by popping or by somehow. Also, on_unload() will be triggered when this view is pushed behind other views.
         */
        virtual void on_unload();
 
-       /** @brief view activate state.
-     *
-     *  @note Generally, a view will be activated when show-transition is finished. From whatever its state, when the view comes on the screen,
-     *        on_activate() will be triggered. In the most cases, on_activate() will be triggered with this step. load -> deactivate -> activate
+       /**
+        *  @brief View activate state.
+        *
+        *  @note Generally, a view will be activated when show-transition is finished. From whatever its state, when the view comes on the screen,
+        *        on_activate() will be triggered. In the most cases, on_activate() will be triggered with this step. load -> deactivate -> activate
         */
        virtual void on_activate();
 
-       /** @brief view deactivate state.
+       /**
+        *  @brief View deactivate state.
         *
         *  @note Get ready for unload. Hide transition may be triggered at this point. Deactivate state is triggered on this scenario if this view is still
         *        visible but it shouldn't be interactive with users. In the most cases, when a view is going to be popped or destroyed, on_deactivate() will be
@@ -194,7 +223,8 @@ protected:
         */
        virtual void on_deactivate();
 
-       /** @brief view pause state.
+       /**
+        *  @brief View pause state.
         *
         *  @note If the system blocks application running in some cases such as phone call, system notification, application switching ..., this Pause will be
         *        triggered. Other than that, when application window turns to deactivate (@see ui_iface_viewmgr::deactivate()), on_pause() will be called also.
@@ -202,7 +232,8 @@ protected:
         */
        virtual void on_pause();
 
-       /** @brief view resume state.
+       /**
+        *  @brief View resume state.
         *
         *  @note When a view is returns to the activate state from pause state, this on_resume() will be triggered. Other than that, when the system
         *        allows application to turn to activate or when the window turns to activate (@see ui_iface_viewmgr::activate()), on_resume() will be triggered
@@ -210,7 +241,8 @@ protected:
         */
        virtual void on_resume();
 
-       /** @brief view destroy state.
+       /**
+        *  @brief View destroy state.
         *
         *  @note When this view is on destroyed by popping or by somehow, destroy will be triggered. Most of the cases, you can free your personal resources for
         *        the view because this view instance will be totally freed at the end of destroy. Be awre that you must not request any view functions on this
@@ -218,15 +250,11 @@ protected:
         */
        virtual void on_destroy();
 
-       /** @brief Return the state of event block.
-        *
-        *  @see set_event_block()
-        */
-       bool get_event_block();
-
 private:
-
-       /** @brief Connect with given viewmgr.
+       /**
+        *  @brief Connect with given viewmgr.
+        *
+        *  @param viewmgr The instance of viewmgr.
         *
         *  @return true if it succeed, false otherwise.
         *
@@ -234,7 +262,8 @@ private:
         */
        bool set_viewmgr(ui_iface_viewmgr *viewmgr);
 
-       /** @brief Return the viewmgr instance.
+       /**
+        *  @brief Return the viewmgr instance.
         *
         *  @return ui_iface_viewmgr instance.
         *
index cdf3c9d819bb132f0f043bd2c1d39352292180f7..fab8329c8b477c60f4a8cbe0ab3d249fadf2b9ba 100644 (file)
@@ -90,6 +90,8 @@ public:
 
        /**
         *  @brief Return viewmgr instance.
+        *
+        *  @return viewmgr instance.
         */
        static ui_iface_viewmgr* get_instance();
 
@@ -137,7 +139,7 @@ protected:
         *  @see pop_view()
         *  @see ui_iface_view::set_transition_style()
         */
-       ui_iface_view *push_view(ui_iface_view *view);
+       virtual ui_iface_view *push_view(ui_iface_view *view);
 
        /**
         *  @brief Pop the top(last) view from this viewmgr view list.