win: Added floating mode documentation and added a check for floating parameter.
authorDaniel Juyung Seo <juyung.seo@samsung.com>
Thu, 26 Dec 2013 05:23:29 +0000 (14:23 +0900)
committerDaniel Juyung Seo <juyung.seo@samsung.com>
Thu, 26 Dec 2013 05:23:29 +0000 (14:23 +0900)
The documentation is from the original floating mode commit message.

src/lib/elm_win.c
src/lib/elm_win_legacy.h

index f8c2c79..9d23d1a 100644 (file)
@@ -5463,6 +5463,7 @@ elm_win_floating_mode_set(Evas_Object *obj, Eina_Bool floating)
    ELM_WIN_CHECK(obj);
    ELM_WIN_DATA_GET_OR_RETURN(obj, sd);
 
+   floating = !!floating;
    if (floating == sd->floating) return;
    sd->floating = floating;
 #ifdef HAVE_ELEMENTARY_X
index 08b760a..9938938 100644 (file)
@@ -1278,6 +1278,10 @@ EAPI Ecore_Wl_Window *elm_win_wl_window_get(const Evas_Object *obj);
  * @param obj The window object
  * @param floating If true, the window is floating mode
  *
+ * The floating mode can be used on mobile environment. For example, if the
+ * video-player window sets the floating mode, then e (enlightenment window
+ * manager) changes its geometry and handles it like a popup.
+ *
  * @ingroup Win
  * @see elm_win_floating_mode_get()
  * @since 1.8