[Elementary.h] Add documentation for File_Selector_Entry
authorMike McCormack <mj.mccormack@samsung.com>
Fri, 4 Nov 2011 02:09:08 +0000 (11:09 +0900)
committerMike McCormack <mj.mccormack@samsung.com>
Fri, 4 Nov 2011 02:09:08 +0000 (11:09 +0900)
src/lib/Elementary.h.in

index 5e93e03..5607c1d 100644 (file)
@@ -6459,29 +6459,366 @@ extern "C" {
     * @}
     */
 
+    /**
+    * @defgroup File_Selector_Entry File Selector Entry
+    *
+    * @image html img/widget/fileselector_entry/preview-00.png
+    * @image latex img/widget/fileselector_entry/preview-00.eps
+    *
+    * This is an entry made to be filled with or display a <b>file
+    * system path string</b>. Besides the entry itself, the widget has
+    * a @ref File_Selector_Button "file selector button" on its side,
+    * which will raise an internal @ref Fileselector "file selector widget",
+    * when clicked, for path selection aided by file system
+    * navigation.
+    *
+    * 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.
+    *
+    * 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.
+    *
+    * Smart callbacks one can register to:
+    * - @c "changed" - The text within the entry was changed
+    * - @c "activated" - The entry has had editing finished and
+    *   changes are to be "committed"
+    * - @c "press" - The entry has been clicked
+    * - @c "longpressed" - The entry has been clicked (and held) for a
+    *   couple seconds
+    * - @c "clicked" - The entry has been clicked
+    * - @c "clicked,double" - The entry has been double clicked
+    * - @c "focused" - The entry has received focus
+    * - @c "unfocused" - The entry has lost focus
+    * - @c "selection,paste" - A paste action has occurred on the
+    *   entry
+    * - @c "selection,copy" - A copy action has occurred on the entry
+    * - @c "selection,cut" - A cut action has occurred on the entry
+    * - @c "unpressed" - The file selector entry's button was released
+    *   after being pressed.
+    * - @c "file,chosen" - The user has selected a path via the file
+    *   selector entry's internal file selector, whose string pointer
+    *   comes as the @c event_info data (a stringshared string)
+    *
+    * Here is an example on its usage:
+    * @li @ref fileselector_entry_example
+    *
+    * @see @ref File_Selector_Button for a similar widget.
+    * @{
+    */
+
+   /**
+    * Add a new file selector entry widget to the given parent
+    * Elementary (container) object
+    *
+    * @param parent The parent object
+    * @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);
+
+   /**
+    * Set the title for a given file selector entry widget's window
+    *
+    * @param obj The file selector entry widget
+    * @param title The title string
+    *
+    * This will change the window's title, when the file selector pops
+    * out after a click on the entry's button. Those windows have the
+    * default (unlocalized) value of @c "Select a file" as titles.
+    *
+    * @note It will only take any effect if the file selector
+    * entry widget is @b not under "inwin mode".
+    *
+    * @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);
+
+   /**
+    * Get the title set for a given file selector entry widget's
+    * window
+    *
+    * @param obj The file selector entry widget
+    * @return Title of the file selector entry's window
+    *
+    * @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);
+
+   /**
+    * Set the size of a given file selector entry widget's window,
+    * holding the file selector itself.
+    *
+    * @param obj The file selector entry widget
+    * @param width The window's width
+    * @param height The window's height
+    *
+    * @note it will only take any effect if the file selector entry
+    * widget is @b not under "inwin mode". The default size for the
+    * window (when applicable) is 400x400 pixels.
+    *
+    * @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);
+
+   /**
+    * Get the size of a given file selector entry widget's window,
+    * holding the file selector itself.
+    *
+    * @param obj The file selector entry widget
+    * @param width Pointer into which to store the width value
+    * @param height Pointer into which to store the height value
+    *
+    * @note Use @c NULL pointers on the size values you're not
+    * interested in: they'll be ignored by the function.
+    *
+    * @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);
+
+   /**
+    * Set the initial file system path and the entry's path string for
+    * a given file selector entry widget
+    *
+    * @param obj The file selector entry widget
+    * @param path The path string
+    *
+    * It must be a <b>directory</b> path, which will have the contents
+    * displayed initially in the file selector's view, when invoked
+    * from @p obj. The default initial path is the @c "HOME"
+    * environment variable's value.
+    *
+    * @see elm_fileselector_entry_path_get()
+    */
    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
+
+   /**
+    * Get the entry's path string for a given file selector entry
+    * widget
+    *
+    * @param obj The file selector entry widget
+    * @return path The path string
+    *
+    * @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);
+
+   /**
+    * 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
+    *
+    * This has the same effect as elm_fileselector_expandable_set(),
+    * but now applied to a file selector entry's internal file
+    * selector.
+    *
+    * @note There's no way to put a file selector entry's internal
+    * file selector in "grid mode", as one may do with "pure" file
+    * selectors.
+    *
+    * @see elm_fileselector_expandable_get()
+    */
    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
+
+   /**
+    * Get whether tree view is enabled for the given file selector
+    * entry widget's internal file selector
+    *
+    * @param obj The file selector entry widget
+    * @return @c EINA_TRUE if @p obj widget's internal file selector
+    * is in tree view, @c EINA_FALSE otherwise (and or errors)
+    *
+    * @see elm_fileselector_expandable_set() for more details
+    */
    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+   /**
+    * Set whether a given file selector entry widget's internal file
+    * selector is to display folders only or the directory contents,
+    * as well.
+    *
+    * @param obj The file selector entry widget
+    * @param only @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
+    *
+    * This has the same effect as elm_fileselector_folder_only_set(),
+    * but now applied to a file selector entry's internal file
+    * selector.
+    *
+    * @see elm_fileselector_folder_only_get()
+    */
    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
+
+   /**
+    * Get whether a given file selector entry widget's internal file
+    * selector is displaying folders only or the directory contents,
+    * as well.
+    *
+    * @param obj The file selector entry widget
+    * @return @c EINA_TRUE if @p obj widget's internal file
+    * selector is only displaying directories, @c EINA_FALSE if files
+    * are being displayed in it too (and on errors)
+    *
+    * @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);
+
+   /**
+    * Enable/disable the file name entry box where the user can type
+    * in a name for a file, in a given file selector entry widget's
+    * internal file selector.
+    *
+    * @param obj The file selector entry widget
+    * @param is_save @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(),
+    * but now applied to a file selector entry's internal file
+    * selector.
+    *
+    * @see elm_fileselector_is_save_get()
+    */
    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
+
+   /**
+    * Get whether the given file selector entry widget's internal
+    * file selector is in "saving dialog" mode
+    *
+    * @param obj The file selector entry widget
+    * @return @c EINA_TRUE, if @p obj widget's internal file selector
+    * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
+    * errors)
+    *
+    * @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);
+
+   /**
+    * Set whether a given file selector entry widget's internal file
+    * selector will raise an Elementary "inner window", instead of a
+    * dedicated Elementary window. By default, it won't.
+    *
+    * @param obj The file selector entry widget
+    * @param value @c EINA_TRUE to make it use an inner window, @c
+    * EINA_TRUE to make it use a dedicated window
+    *
+    * @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);
+
+   /**
+    * Get whether a given file selector entry widget's internal file
+    * selector will raise an Elementary "inner window", instead of a
+    * dedicated Elementary window.
+    *
+    * @param obj The file selector entry widget
+    * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
+    * if it will use a dedicated window
+    *
+    * @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);
+
+   /**
+    * Set the initial file system path for a given file selector entry
+    * widget
+    *
+    * @param obj The file selector entry widget
+    * @param path The path string
+    *
+    * It must be a <b>directory</b> path, which will have the contents
+    * displayed initially in the file selector's view, when invoked
+    * from @p obj. The default initial path is the @c "HOME"
+    * environment variable's value.
+    *
+    * @see elm_fileselector_entry_path_get()
+    */
    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
+
+   /**
+    * Get the parent directory's path to the latest file selection on
+    * a given filer selector entry widget
+    *
+    * @param obj The file selector object
+    * @return The (full) path of the directory of the last selection
+    * on @p obj widget, a @b stringshared string
+    *
+    * @see elm_fileselector_entry_path_set()
+    */
    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 
+   /**
+    * @}
+    */
+
    /* scroller policy */
    typedef enum _Elm_Scroller_Policy
      {