efl-util: update documentation for notification levels 71/157071/7
authorDoyoun Kang <doyoun.kang@samsung.com>
Mon, 23 Oct 2017 08:30:00 +0000 (17:30 +0900)
committerEditor Lionbridge <TizenEditor.SEL@lionbridge.com>
Wed, 25 Oct 2017 12:11:09 +0000 (15:11 +0300)
- Changed enumeration from deprecated enum to new enum.
- Added guide for new enumeration

PS6: Reviewed.
PS7: Rewrote one clumsy paragraph.

Change-Id: Ic8c3bf1bb87172338d70ee1801023b1557781d8d

org.tizen.guides/html/images/efl_notilevels.png
org.tizen.guides/html/native/ui/efl/efl_util_n.htm

index 0aa3425..1ec7183 100644 (file)
Binary files a/org.tizen.guides/html/images/efl_notilevels.png and b/org.tizen.guides/html/images/efl_notilevels.png differ
index 707d9cc..cea4704 100644 (file)
 
 <p>Each window is set to a specific layer according to its type or properties. Most application windows belong to the normal layer. However, for an important alarm or other information crucial to the user, you can set the window to belong to the notification layer. This ensures that the user notices the information immediately, because the window belonging to the notification layer is always shown above the windows in the normal layer.</p>
 
-<p>The notification layer contains 3 levels, which define the priority of a notification window:</p>
+<p>The notification layer contains 4 levels, which define the priority of a notification window:</p>
 <ul>
-<li><code>EFL_UTIL_NOTIFICATION_LEVEL_1</code>: Default level, to which most windows are set. It is used as a normal notification popup.</li>
-<li><code>EFL_UTIL_NOTIFICATION_LEVEL_2</code>: Higher level; the windows on this level are always on top of the level 1 windows. It is used for the lock screen window in general.</li>
-<li><code>EFL_UTIL_NOTIFICATION_LEVEL_3</code>: Highest level, which very few applications can use. It is used in case the user needs to be notified in any circumstances. For example, the incoming call popup uses this level.</li></ul>
+<li><code>EFL_UTIL_NOTIFICATION_LEVEL_DEFAULT</code>: Default level, to which most windows are set. It is used as a normal notification popup.</li>
+<li><code>EFL_UTIL_NOTIFICATION_LEVEL_MEDIUM</code>: Higher level than default; the windows on this level are always on top of the default level windows. It is used for the lock screen window in general.</li>
+<li><code>EFL_UTIL_NOTIFICATION_LEVEL_HIGH</code>: Higher level than medium; the windows on this level are always on top of the medium windows.</li>
+<li><code>EFL_UTIL_NOTIFICATION_LEVEL_TOP</code>: Highest level, which very few applications can use. It is used in case the user needs to be notified in any circumstances. For example, the incoming call popup uses this level.</li></ul>
 
 <p align="center"><strong>Figure: Notification levels</strong></p>
 <p align="center"><img alt="Notification levels" src="../../../images/efl_notilevels.png" /></p>
 <p>To create notification windows and access the current notification level of an existing notification window:</p>
 
 <ul>
-<li>Create a notification window with the default notification level (<code>EFL_UTIL_NOTIFICATION_LEVEL_1</code>):
+<li>Create a notification window with the default notification level (<code>EFL_UTIL_NOTIFICATION_LEVEL_DEFAULT</code>):
 
 <ol><li>To create a new window and give it the <code>NOTIFICATION</code> type, call the <code>elm_win_add()</code> function with the third parameter set to <code>ELM_WIN_NOTIFICATION</code>:
 <pre class="prettyprint">
@@ -180,10 +181,14 @@ create_win(const char *name)
         return NULL;
 </pre></li>
 
-<li>To set the notification level, call the <code>efl_util_set_notification_window_level()</code> function:
+<li>To set the notification level, call the <code>efl_util_set_notification_window_level()</code> function.
+<p>If the window is not of the notification type, the function returns the <code>EFL_UTIL_ERROR_NOT_SUPPORTED_WINDOW_TYPE</code> error. If the application does not have a permission to set a notification level, the function returns the <code>TIZEN_ERROR_PERMISSION_DENIED</code> error.</p>
 <pre class="prettyprint">
     /* Set the NOTIFICATION level */
-    <span class="highlight">error = efl_util_set_notification_window_level(eo, EFL_UTIL_NOTIFICATION_LEVEL_1);</span>
+    <span class="highlight">error = efl_util_set_notification_window_level(eo, EFL_UTIL_NOTIFICATION_LEVEL_DEFAULT);</span>
+    if (error != EFL_UTIL_ERROR_NONE) {
+        /* Error handling for each error code */
+    }
 
     elm_win_title_set(eo, name);
     elm_win_autodel_set(eo, EINA_TRUE);
@@ -215,11 +220,17 @@ get_notification_level(Evas_Object *eo)
     /* Check the return value */
     if (error== EFL_UTIL_ERROR_NONE) {
         switch (notification_level) {
-        case EFL_UTIL_NOTIFICATION_LEVEL_1:
-            /* Do something for level 1 */
+        case EFL_UTIL_NOTIFICATION_LEVEL_DEFAULT:
+            /* Do something for default level */
+            break;
+        case EFL_UTIL_NOTIFICATION_LEVEL_MEDIUM:
+            /* Do something for medium level */
+            break;
+        case EFL_UTIL_NOTIFICATION_LEVEL_HIGH:
+            /* Do something for high level */
             break;
-        case EFL_UTIL_NOTIFICATION_LEVEL_2:
-            /* Do something for level 2 */
+        case EFL_UTIL_NOTIFICATION_LEVEL_TOP:
+            /* Do something for top level */
             break;
         }
     } else {
@@ -237,7 +248,6 @@ get_notification_level(Evas_Object *eo)
 <ol><li>Create the <code>efl_util_screenshot_h</code> structure and initialize the structure members with the <code>efl_util_screenshot_initialize()</code> function:
 <pre class="prettyprint">
 #include &lt;tbm_surface.h&gt;
-#include &lt;X11/Xlib.h&gt;
 
 void
 capture()