elementary/popup - [E-devel] [Patch][elementary] elc_popup, focus next hook implement...
[framework/uifw/elementary.git] / src / lib / elc_fileselector_entry.h
index d584b7f..c5ac356 100644 (file)
  * This file selector may appear in an Elementary window or in an
  * inner window. When a file is chosen from it, the (inner) window
  * is closed and the selected file's path string is exposed both as
- * an smart event and as the new text on the entry.
+ * a smart event and as the new text on the entry.
  *
  * This widget encapsulates operations on its internal file
  * selector on its own API. There is less control over its file
- * selector than that one would have instatiating one directly.
+ * selector than that one would have instantiating one directly.
  *
  * Smart callbacks one can register to:
  * - @c "changed" - The text within the entry was changed
  *   selector entry's internal file selector, whose string pointer
  *   comes as the @c event_info data (a stringshared string)
  *
+ * Default text parts of the fileselector_button widget that you can use for
+ * are:
+ * @li "default" - Label of the fileselector_button
+ *
+ * Default content parts of the fileselector_entry widget that you can use for
+ * are:
+ * @li "button icon" - Button icon of the fileselector_entry
+ *
+ * Supported elm_object common APIs.
+ * @li elm_object_part_text_set
+ * @li elm_object_part_text_get
+ * @li elm_object_part_content_set
+ * @li elm_object_part_content_get
+ * @li elm_object_part_content_unset
+ * @li elm_object_disabled_set
+ * @li elm_object_disabled_get
+ *
  * Here is an example on its usage:
  * @li @ref fileselector_entry_example
  *
  * @return a new file selector entry widget handle or @c NULL, on
  * errors
  */
-EAPI Evas_Object *
-                                 elm_fileselector_entry_add(Evas_Object *parent)
-EINA_ARG_NONNULL(1);
-
-/**
- * Set the label for a given file selector entry widget's button
- *
- * @param obj The file selector entry widget
- * @param label The text label to be displayed on @p obj widget's
- * button
- *
- * @deprecated use elm_object_text_set() instead.
- */
-EINA_DEPRECATED EAPI void        elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
-
-/**
- * Get the label set for a given file selector entry widget's button
- *
- * @param obj The file selector entry widget
- * @return The widget button's label
- *
- * @deprecated use elm_object_text_set() instead.
- */
-EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
-/**
- * Set the icon on a given file selector entry widget's button
- *
- * @param obj The file selector entry widget
- * @param icon The icon object for the entry's button
- *
- * Once the icon object is set, a previously set one will be
- * deleted. If you want to keep the latter, use the
- * elm_fileselector_entry_button_icon_unset() function.
- *
- * @see elm_fileselector_entry_button_icon_get()
- */
-EAPI void                        elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
-
-/**
- * Get the icon set for a given file selector entry widget's button
- *
- * @param obj The file selector entry widget
- * @return The icon object currently set on @p obj widget's button
- * or @c NULL, if none is
- *
- * @see elm_fileselector_entry_button_icon_set()
- */
-EAPI Evas_Object                *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
-/**
- * Unset the icon used in a given file selector entry widget's
- * button
- *
- * @param obj The file selector entry widget
- * @return The icon object that was being used on @p obj widget's
- * button or @c NULL, on errors
- *
- * Unparent and return the icon object which was set for this
- * widget's button.
- *
- * @see elm_fileselector_entry_button_icon_set()
- */
-EAPI Evas_Object                *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Evas_Object                *elm_fileselector_entry_add(Evas_Object *parent);
 
 /**
  * Set the title for a given file selector entry widget's window
@@ -136,7 +90,7 @@ EAPI Evas_Object                *elm_fileselector_entry_button_icon_unset(Evas_O
  *
  * @see elm_fileselector_entry_window_title_get()
  */
-EAPI void                        elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
+EAPI void                        elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title);
 
 /**
  * Get the title set for a given file selector entry widget's
@@ -147,7 +101,7 @@ EAPI void                        elm_fileselector_entry_window_title_set(Evas_Ob
  *
  * @see elm_fileselector_entry_window_title_get() for more details
  */
-EAPI const char                 *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI const char                 *elm_fileselector_entry_window_title_get(const Evas_Object *obj);
 
 /**
  * Set the size of a given file selector entry widget's window,
@@ -163,7 +117,7 @@ EAPI const char                 *elm_fileselector_entry_window_title_get(const E
  *
  * @see elm_fileselector_entry_window_size_get()
  */
-EAPI void                        elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
+EAPI void                        elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height);
 
 /**
  * Get the size of a given file selector entry widget's window,
@@ -178,7 +132,7 @@ EAPI void                        elm_fileselector_entry_window_size_set(Evas_Obj
  *
  * @see elm_fileselector_entry_window_size_set(), for more details
  */
-EAPI void                        elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
+EAPI void                        elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height);
 
 /**
  * Set the initial file system path and the entry's path string for
@@ -194,7 +148,7 @@ EAPI void                        elm_fileselector_entry_window_size_get(const Ev
  *
  * @see elm_fileselector_entry_path_get()
  */
-EAPI void                        elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
+EAPI void                        elm_fileselector_entry_path_set(Evas_Object *obj, const char *path);
 
 /**
  * Get the entry's path string for a given file selector entry
@@ -205,15 +159,14 @@ EAPI void                        elm_fileselector_entry_path_set(Evas_Object *ob
  *
  * @see elm_fileselector_entry_path_set() for more details
  */
-EAPI const char                 *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI const char                 *elm_fileselector_entry_path_get(const Evas_Object *obj);
 
 /**
  * Enable/disable a tree view in the given file selector entry
  * widget's internal file selector
  *
  * @param obj The file selector entry widget
- * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
- * disable
+ * @param value @c EINA_TRUE to enable tree view, @c EINA_FALSE to disable
  *
  * This has the same effect as elm_fileselector_expandable_set(),
  * but now applied to a file selector entry's internal file
@@ -225,7 +178,7 @@ EAPI const char                 *elm_fileselector_entry_path_get(const Evas_Obje
  *
  * @see elm_fileselector_expandable_get()
  */
-EAPI void                        elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
+EAPI void                        elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value);
 
 /**
  * Get whether tree view is enabled for the given file selector
@@ -237,7 +190,7 @@ EAPI void                        elm_fileselector_entry_expandable_set(Evas_Obje
  *
  * @see elm_fileselector_expandable_set() for more details
  */
-EAPI Eina_Bool                   elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool                   elm_fileselector_entry_expandable_get(const Evas_Object *obj);
 
 /**
  * Set whether a given file selector entry widget's internal file
@@ -245,7 +198,7 @@ EAPI Eina_Bool                   elm_fileselector_entry_expandable_get(const Eva
  * as well.
  *
  * @param obj The file selector entry widget
- * @param only @c EINA_TRUE to make @p obj widget's internal file
+ * @param value @c EINA_TRUE to make @p obj widget's internal file
  * selector only display directories, @c EINA_FALSE to make files
  * to be displayed in it too
  *
@@ -255,7 +208,7 @@ EAPI Eina_Bool                   elm_fileselector_entry_expandable_get(const Eva
  *
  * @see elm_fileselector_folder_only_get()
  */
-EAPI void                        elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
+EAPI void                        elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value);
 
 /**
  * Get whether a given file selector entry widget's internal file
@@ -269,7 +222,7 @@ EAPI void                        elm_fileselector_entry_folder_only_set(Evas_Obj
  *
  * @see elm_fileselector_entry_folder_only_set() for more details
  */
-EAPI Eina_Bool                   elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool                   elm_fileselector_entry_folder_only_get(const Evas_Object *obj);
 
 /**
  * Enable/disable the file name entry box where the user can type
@@ -277,7 +230,7 @@ EAPI Eina_Bool                   elm_fileselector_entry_folder_only_get(const Ev
  * internal file selector.
  *
  * @param obj The file selector entry widget
- * @param is_save @c EINA_TRUE to make @p obj widget's internal
+ * @param value @c EINA_TRUE to make @p obj widget's internal
  * file selector a "saving dialog", @c EINA_FALSE otherwise
  *
  * This has the same effect as elm_fileselector_is_save_set(),
@@ -286,7 +239,7 @@ EAPI Eina_Bool                   elm_fileselector_entry_folder_only_get(const Ev
  *
  * @see elm_fileselector_is_save_get()
  */
-EAPI void                        elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
+EAPI void                        elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value);
 
 /**
  * Get whether the given file selector entry widget's internal
@@ -299,7 +252,7 @@ EAPI void                        elm_fileselector_entry_is_save_set(Evas_Object
  *
  * @see elm_fileselector_entry_is_save_set() for more details
  */
-EAPI Eina_Bool                   elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool                   elm_fileselector_entry_is_save_get(const Evas_Object *obj);
 
 /**
  * Set whether a given file selector entry widget's internal file
@@ -313,7 +266,7 @@ EAPI Eina_Bool                   elm_fileselector_entry_is_save_get(const Evas_O
  * @see elm_win_inwin_add() for more information on inner windows
  * @see elm_fileselector_entry_inwin_mode_get()
  */
-EAPI void                        elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
+EAPI void                        elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
 
 /**
  * Get whether a given file selector entry widget's internal file
@@ -326,7 +279,7 @@ EAPI void                        elm_fileselector_entry_inwin_mode_set(Evas_Obje
  *
  * @see elm_fileselector_entry_inwin_mode_set() for more details
  */
-EAPI Eina_Bool                   elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool                   elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj);
 
 /**
  * Set the initial file system path for a given file selector entry
@@ -342,7 +295,7 @@ EAPI Eina_Bool                   elm_fileselector_entry_inwin_mode_get(const Eva
  *
  * @see elm_fileselector_entry_path_get()
  */
-EAPI void                        elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
+EAPI void                        elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path);
 
 /**
  * Get the parent directory's path to the latest file selection on
@@ -354,7 +307,7 @@ EAPI void                        elm_fileselector_entry_selected_set(Evas_Object
  *
  * @see elm_fileselector_entry_path_set()
  */
-EAPI const char                 *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI const char                 *elm_fileselector_entry_selected_get(const Evas_Object *obj);
 
 /**
  * @}