Patch by Jérôme Pinot <ngc891@gmail.com>.
- #link on the beginning of a new line does give ugly output:
http://ngc891.blogdns.net/pub/projects/debug/doxygen-formating-eww.png
- some typos
- some missing @c
- in elm_web, convert remaining @li parameter lists to @param
- minor random fixes
SVN revision: 71486
* We are just adding the list, so as you can see, defaults for it are:
* @li Items are displayed vertically.
* @li Only one item can be selected.
- * @li The list doesn't bouce.
+ * @li The list doesn't bounce.
*
* To add items, we are just appending it on a loop, using function
- * elm_list_item_append(), that will be better exaplained on
+ * elm_list_item_append(), that will be better explained on
* items management example.
* @dontinclude list_example_01.c
* @skipline lbl[]
* (layout) file system entries in its view
*
* @param obj The file selector object
- * @param mode The mode of the fileselector, being it one of
- * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
- * first one, naturally, will display the files in a list. The
- * latter will make the widget to display its entries in a grid
- * form.
+ * @param mode The mode of the fileselector, being it one of #ELM_FILESELECTOR_LIST
+ * (default) or #ELM_FILESELECTOR_GRID. The first one, naturally, will display
+ * the files in a list. The latter will make the widget to display its entries
+ * in a grid form.
*
* @note By using elm_fileselector_expandable_set(), the user may
* trigger a tree view for that list.
*
* <pre>
*
- * |-------------------- | |----------------- ---| |----------------- ---|
+ * |---------------------| |---------------------| |---------------------|
* | Title Area | | Title Area | | Title Area |
* |Icon| Text | |Icon| Text | |Icon| Text |
- * |------------------- -| |---------------- ----| |------------------ --|
+ * |---------------------| |---------------------| |---------------------|
* | Item 1 | | | | |
- * |------------------- -| | | | |
+ * |---------------------| | | | |
* | Item 2 | | | | Description |
- * |------------------ --| | Content | | |
+ * |---------------------| | Content | | |
* | Item 3 | | | | |
- * |------------------ --| | | | |
- * | . | |------------------ --| |------------------- -|
+ * |---------------------| | | | |
+ * | . | |---------------------| |---------------------|
* | . | | Action Area | | Action Area |
* | . | | Btn1 |Btn2|. |Btn3 | | Btn1 |Btn2| |Btn3 |
- * |------------------ --| |------------------- -| |------------------- -|
+ * |---------------------| |---------------------| |---------------------|
* | Item N | Content Based Layout Description based Layout
- * |------------------ --|
+ * |---------------------|
* | Action Area |
* | Btn1 |Btn2|. |Btn3 |
- * |------------------- -|
+ * |---------------------|
* Item Based Layout
*
* </pre>
* Add a new background to the parent
*
* @param parent The parent object
- * @return The new object or NULL if it cannot be created
+ * @return The new object or @c NULL if it cannot be created
*
* @ingroup Bg
*/
* elm_bg_option_set().
*
* @note Once the image of @p obj is set, a previously set one will be
- * deleted, even if @p file is NULL.
+ * deleted, even if @p file is @c NULL.
*
* @note This will only affect the contents of one of the background's
* swallow spots, namely @c "elm.swallow.background". If you want to
* Get the mode of display for a given background widget's image
*
* @param obj The background object handle
- * @return The image displaying mode in use for @a obj or
- * #ELM_BG_OPTION_LAST, on errors.
+ * @return The image displaying mode in use for @a obj or #ELM_BG_OPTION_LAST,
+ * on errors.
*
* @see elm_bg_option_set() for more details
*
* @param policy_h Horizontal scrollbar policy.
* @param policy_v Vertical scrollbar policy.
*
- * This sets the scrollbar visibility policy for the given scroller.
- * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
- * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
+ * This sets the scrollbar visibility policy for the given
+ * scroller. #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if
+ * it is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
* it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
* This applies respectively for the horizontal and vertical scrollbars.
*
- * The both are disabled by default, i.e., are set to
- * #ELM_SCROLLER_POLICY_OFF.
+ * The both are disabled by default, i.e., are set to #ELM_SCROLLER_POLICY_OFF.
*
* @ingroup Diskselector
*/
* Control pasting of text and images for the widget.
*
* Normally the entry allows both text and images to be pasted.
- * By setting cnp_mode to be ELM_CNP_MODE_NO_IMAGE, this prevents images from being copy or past.
- * By setting cnp_mode to be ELM_CNP_MODE_PLAINTEXT, this remove all tags in text .
+ * By setting cnp_mode to be #ELM_CNP_MODE_NO_IMAGE, this prevents images from being copy or past.
+ * By setting cnp_mode to be #ELM_CNP_MODE_PLAINTEXT, this remove all tags in text .
*
* @note this only changes the behaviour of text.
*
* @param obj The entry object
- * @param cnp_mode One of #Elm_Cnp_Mode: #ELM_CNP_MODE_MARKUP,
- * #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
+ * @param cnp_mode One of #Elm_Cnp_Mode: #ELM_CNP_MODE_MARKUP, #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
*
* @ingroup Entry
*/
* This gets the copy & paste mode of the entry.
*
* @param obj The entry object
- * @return mode One of #Elm_Cnp_Mode: #ELM_CNP_MODE_MARKUP,
- * #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
+ * @return mode One of #Elm_Cnp_Mode: #ELM_CNP_MODE_MARKUP, #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
*
* @ingroup Entry
*/
* When creating the popup hover, entry will request that it's
* themed according to @p style.
*
- * Setting style no NULL means disabling automatic hover.
+ * Setting style no @c NULL means disabling automatic hover.
*
* @param obj The entry object
* @param style The style to use for the underlying hover
* Get the style, the hover created by entry will use.
*
* @param obj The entry object
- * @return The style to use by the hover. NULL means the default is used.
+ * @return The style to use by the hover. @c NULL means the default is used.
*
* @see elm_object_style_set()
*
* @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
*
* Elementary policies define applications' behavior,
- * somehow. These behaviors are divided in policy groups (see
- * #Elm_Policy enumeration). This call will emit the Ecore event
- * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
+ * somehow. These behaviors are divided in policy groups
+ * (see #Elm_Policy enumeration). This call will emit the Ecore
+ * event #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
* handlers. An #Elm_Event_Policy_Changed struct will be passed,
* then.
*
* object itself, while the @c part one is the name string of one
* of the existing text parts in the Edje group implementing the
* item's theme. This function @b must return a strdup'()ed string,
- * as the caller will free() it when done. See
- * #Elm_Gengrid_Item_Text_Get_Cb.
+ * as the caller will free() it when done.
+ * See #Elm_Gengrid_Item_Text_Get_Cb.
* - @c func.content_get - This function is called when an item object
* is actually created. The @c data parameter will point to the
* same data passed to elm_gengrid_item_append() and related item
* If an item changes (internal (boolean) state, text or content
* changes), then use elm_gengrid_item_update() to have gengrid
* update the item with the new state. A gengrid will re-"realize"
- * the item, thus calling the functions in the
- * #Elm_Gengrid_Item_Class set for that item.
+ * the item, thus calling the functions in the #Elm_Gengrid_Item_Class
+ * set for that item.
*
* To programmatically (un)select an item, use
* elm_gengrid_item_selected_set(). To get its selected state use
*
* This sets the scrollbar visibility policy for the given gengrid
* scroller. #ELM_SCROLLER_POLICY_AUTO means the scrollbar is
- * made visible if it is needed, and otherwise kept hidden.
- * #ELM_SCROLLER_POLICY_ON turns it on all the time, and
- * #ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
- * respectively for the horizontal and vertical scrollbars. Default is
- * #ELM_SCROLLER_POLICY_AUTO
+ * made visible if it is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON
+ * turns it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
+ * This applies respectively for the horizontal and vertical scrollbars.
+ * Default is #ELM_SCROLLER_POLICY_AUTO
*
* @see elm_gengrid_scroller_policy_get()
*
* existing (content) swallow parts in the Edje group implementing the item's
* theme. It must return @c NULL, when no content is desired, or a valid
* object handle, otherwise. The object will be deleted by the genlist on
- * its deletion or when the item is "unrealized". See
- * #Elm_Genlist_Item_Content_Get_Cb.
+ * its deletion or when the item is "unrealized".
+ * See #Elm_Genlist_Item_Content_Get_Cb.
* - @c func.state_get - The @c part parameter is the name string of one of
* the state parts in the Edje group implementing the item's theme. Return
* @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
* the applications internal data (eg. the struct with the original item
* data). The parent parameter is the parent genlist item this belongs to if
* it is a tree or an indexed group, and NULL if there is no parent. The
- * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
- * #ELM_GENLIST_ITEM_TREE and #ELM_GENLIST_ITEM_GROUP. If
- * #ELM_GENLIST_ITEM_TREE is set then this item is displayed as an item
- * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
- * is set then this item is group index item that is displayed at the top
- * until the next group comes. The func parameter is a convenience callback
- * that is called when the item is selected and the data parameter will be
- * the func_data parameter, obj be the genlist object and event_info will be
- * the genlist item.
+ * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE, #ELM_GENLIST_ITEM_TREE
+ * and #ELM_GENLIST_ITEM_GROUP. If #ELM_GENLIST_ITEM_TREE is set then this
+ * item is displayed as an item that is able to expand and have child items.
+ * If #ELM_GENLIST_ITEM_GROUP is set then this item is group index item that
+ * is displayed at the top until the next group comes. The func parameter is
+ * a convenience callback that is called when the item is selected and the
+ * data parameter will be the func_data parameter, @c obj be the genlist
+ * object and event_info will be the genlist item.
*
* elm_genlist_item_append() adds an item to the end of the list, or if
* there is a parent, to the end of all the child items of the parent.
*
* This sets the scrollbar visibility policy for the given genlist
* scroller. #ELM_SCROLLER_POLICY_AUTO means the scrollbar is
- * made visible if it is needed, and otherwise kept hidden.
- * #ELM_SCROLLER_POLICY_ON turns it on all the time, and
- * #ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
- * respectively for the horizontal and vertical scrollbars. Default is
- * #ELM_SCROLLER_POLICY_AUTO
+ * made visible if it is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON
+ * turns it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
+ * This applies respectively for the horizontal and vertical scrollbars.
+ * Default is #ELM_SCROLLER_POLICY_AUTO
*
* @see elm_genlist_scroller_policy_get()
*
* will be shown at the end of the widget.
*
* @warning This doesn't work with slide(elm_label_slide_set()) or if the
- * chosen wrap method was ELM_WRAP_WORD.
+ * chosen wrap method was #ELM_WRAP_WORD.
*
* @ingroup Label
*/
EAPI Eina_Bool elm_label_slide_get(const Evas_Object *obj);
/**
- * @brief Set the slide duration(speed) of the label
+ * @brief Set the slide duration (speed) of the label
*
* @param obj The label object
* @param duration The duration in seconds in moving text from slide begin position
EINA_LIST_FOREACH (sd->subs, l, sub_d)
{
if (sub_d->type == TEXT)
- edje_object_part_text_escaped_set
- (ELM_WIDGET_DATA(sd)->resize_obj, sub_d->part, sub_d->p.text.text);
+ {
+ edje_object_part_text_escaped_set
+ (ELM_WIDGET_DATA(sd)->resize_obj, sub_d->part, sub_d->p.text.text);
+ }
+ }
+}
+
+static void
+_parts_table_fix(Elm_Layout_Smart_Data *sd)
+{
+ const Eina_List *l;
+ Elm_Layout_Sub_Object_Data *sub_d;
+
+ EINA_LIST_FOREACH (sd->subs, l, sub_d)
+ {
+ if (sub_d->type == TABLE_PACK)
+ {
+ edje_object_part_table_pack
+ (ELM_WIDGET_DATA(sd)->resize_obj, sub_d->part, sub_d->obj,
+ sub_d->p.table.col, sub_d->p.table.row,
+ sub_d->p.table.colspan, sub_d->p.table.rowspan);
+ }
}
}
_visuals_refresh(Evas_Object *obj,
Elm_Layout_Smart_Data *sd)
{
- _parts_signals_emit(sd);
+ _parts_table_fix(sd);
_parts_text_fix(sd);
+ _parts_signals_emit(sd);
_parts_cursors_apply(sd);
ELM_LAYOUT_CLASS(ELM_WIDGET_DATA(sd)->api)->sizing_eval(obj);
* Set which mode to use for the list object.
*
* @param obj The list object
- * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
- * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
+ * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL, #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
*
* Set list's resize behavior, transverse axis scroll and
* items cropping. See each mode's description for more details.
* Get the mode the list is at.
*
* @param obj The list object
- * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
- * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
+ * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL, #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
*
* @note see elm_list_mode_set() for more information.
*
* @param policy_h Horizontal scrollbar policy.
* @param policy_v Vertical scrollbar policy.
*
- * This sets the scrollbar visibility policy for the given scroller.
- * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
- * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
- * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
- * This applies respectively for the horizontal and vertical scrollbars.
+ * This sets the scrollbar visibility policy for the given scroller. #ELM_SCROLLER_POLICY_AUTO
+ * means the scrollbar is made visible if it is needed, and otherwise kept
+ * hidden. #ELM_SCROLLER_POLICY_ON turns it on all the time, and #ELM_SCROLLER_POLICY_OFF
+ * always keeps it off. This applies respectively for the horizontal and vertical scrollbars.
*
- * The both are disabled by default, i.e., are set to
- * #ELM_SCROLLER_POLICY_OFF.
+ * The both are disabled by default, i.e., are set to #ELM_SCROLLER_POLICY_OFF.
*
* @ingroup List
*/
typedef enum
{
ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should prioritize time. */
- ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should prioritized distance. */
+ ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should prioritize distance. */
ELM_MAP_ROUTE_METHOD_LAST
} Elm_Map_Route_Method;
*
* By default these values are 0 (world map) and 18 (maximum zoom).
*
- * This function should be used when zoom mode is set to
- * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
- * with elm_map_zoom_mode_set().
+ * This function should be used when zoom mode is set to #ELM_MAP_ZOOM_MODE_MANUAL.
+ * This is the default mode, and can be set with elm_map_zoom_mode_set().
*
* @see elm_map_zoom_mode_set()
* @see elm_map_zoom_get()
* Set the zoom mode used by the map object.
*
* @param obj The map object.
- * @param mode The zoom mode of the map, being it one of
- * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
- * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
+ * @param mode The zoom mode of the map, being it one of #ELM_MAP_ZOOM_MODE_MANUAL
+ * (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT, or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
*
* This sets the zoom mode to manual or one of the automatic levels.
* Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
* Get the zoom mode used by the map object.
*
* @param obj The map object.
- * @return The zoom mode of the map, being it one of
- * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
- * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
+ * @return The zoom mode of the map, being it one of #ELM_MAP_ZOOM_MODE_MANUAL
+ * (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT, or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
*
* This function returns the current zoom mode used by the map object.
*
*
* You can change the state (hidden, paused, etc.) or set the content
* or icon of the group overlays by chaning the state of the class overlay.
- * Do not modifty the group overlay itself.
+ * Do not modify the group overlay itself.
*
* Also these changes have a influence on the overlays in the same class
* even if each overlay is alone and is not grouped.
* @param tlon The destination longitude.
* @param tlat The destination latitude.
* @return The created overlay or @c NULL upon failure.
- *
+ *
* Overlay created with this method can be deleted with elm_map_overlay_del().
*
* @see elm_map_overlay_del()
*
* It will take @p type on consideration to define the route,
* depending if the user will be walking or driving, the route may vary.
- * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
- * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
+ * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE,
+ * or #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
*
* Another parameter is what the route should prioritize, the minor distance
* or the less time to be spend on the route. So @p method should be one
* @return name A #Elm_Map_Name handle for this coordinate.
*
* If you want to get address from geographic coordinates, set input @p address
- * as NULL and set @p lon, @p lat as you want to convert.
+ * as @c NULL and set @p lon, @p lat as you want to convert.
* If address is set except NULL, @p lon and @p lat are checked.
*
* To get the string for this address, elm_map_name_address_get()
* - @c func.get - When an item is displayed, this function is
* called, and it's where one should create the item object, de
* facto. For example, the object can be a pure Evas image object
- * or an Elementary @ref Photocam "photocam" widget. See
- * #SlideshowItemGetFunc.
+ * or an Elementary @ref Photocam "photocam" widget.
+ * See #SlideshowItemGetFunc.
* - @c func.del - When an item is no more displayed, this function
* is called, where the user must delete any data associated to
* the item. See #SlideshowItemDelFunc.
SlideshowItemGetFunc get;
SlideshowItemDelFunc del;
} func;
-}; /**< #Elm_Slideshow_Item_Class member definitions */
+}; /**< member definitions of #Elm_Slideshow_Item_Class */
/**
* Add a new slideshow widget to the given parent Elementary
* @param it The toolbar item.
* @param priority The item priority. The default is zero.
*
- * This is used only when the toolbar shrink mode is set to
- * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
+ * This is used only when the toolbar shrink mode is set
+ * to #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
* When space is less than required, items with low priority
* will be removed from the toolbar and added to a dynamically-created menu,
* while items with higher priority will remain on the toolbar,
* @brief Is the video actually playing.
*
* @param video The video object to proceed the request on.
- * @return EINA_TRUE if the video is actually playing.
+ * @return @c EINA_TRUE if the video is actually playing.
*
* You should consider watching event on the object instead of polling
* the object state.
* @brief Is it possible to seek inside the video.
*
* @param video The video object to proceed the request on.
- * @return EINA_TRUE if is possible to seek inside the video.
+ * @return @c EINA_TRUE if is possible to seek inside the video.
*
* @ingroup Video
*/
* @brief Is the audio muted.
*
* @param video The video object to proceed the request on.
- * @return EINA_TRUE if the audio is muted.
+ * @return @c EINA_TRUE if the audio is muted.
*
* @ingroup Video
*/
* Elm_Video object.
*
* @param video The video object.
- * @return the time(in seconds) since the beginning of the media file.
+ * @return The time (in seconds) since the beginning of the media file.
*
* @ingroup Video
*/
* Elm_Video object.
*
* @param video The video object.
- * @param position the time(in seconds) since the beginning of the media file.
+ * @param position The time (in seconds) since the beginning of the media file.
*
* @ingroup Video
*/
* @brief Get the total playing time (in seconds) of the Elm_Video object.
*
* @param video The video object.
- * @return the total duration(in seconds) of the media file.
+ * @return The total duration (in seconds) of the media file.
*
* @ingroup Video
*/
* @brief Set whether the object can remember the last played position.
*
* @param video The video object.
- * @return whether the object remembers the last played position (EINA_TRUE)
+ * @return whether the object remembers the last played position (@c EINA_TRUE)
* or not.
*
* @note This API only serves as indication. System support is required.
EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
/**
- * @brief Get the title (for ex. DVD title) from this emotion object.
+ * @brief Get the title (for instance DVD title) from this emotion object.
*
* @param video The Elm_Video object.
* @return A string containing the title.
/**
* Callback type for the create_window hook.
*
- * The function parameters are:
- * @li @p data User data pointer set when setting the hook function
- * @li @p obj The elm_web object requesting the new window
- * @li @p js Set to @c EINA_TRUE if the request was originated from
+ * @param data User data pointer set when setting the hook function.
+ * @param obj The elm_web object requesting the new window.
+ * @param js Set to @c EINA_TRUE if the request was originated from
* JavaScript. @c EINA_FALSE otherwise.
- * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
+ * @param window_features A pointer of #Elm_Web_Window_Features indicating
* the features requested for the new window.
*
- * The returned value of the function should be the @c elm_web widget where
- * the request will be loaded. That is, if a new window or tab is created,
- * the elm_web widget in it should be returned, and @b NOT the window
- * object.
- * Returning @c NULL should cancel the request.
+ * @return The @c elm_web widget where the request will be loaded. That is,
+ * if a new window or tab is created, the elm_web widget in it should be
+ * returned, and @b NOT the window object. Returning @c NULL should cancel
+ * the request.
*
* @see elm_web_window_create_hook_set()
*
/**
* Callback type for the JS alert hook.
*
- * The function parameters are:
- * @li @p data User data pointer set when setting the hook function
- * @li @p obj The elm_web object requesting the new window
- * @li @p message The message to show in the alert dialog
+ * @param data User data pointer set when setting the hook function.
+ * @param obj The elm_web object requesting the new window.
+ * @param message The message to show in the alert dialog.
*
- * The function should return the object representing the alert dialog.
+ * @return The object representing the alert dialog.
* Elm_Web will run a second main loop to handle the dialog and normal
* flow of the application will be restored when the object is deleted, so
* the user should handle the popup properly in order to delete the object
/**
* Callback type for the JS confirm hook.
*
- * The function parameters are:
- * @li @p data User data pointer set when setting the hook function
- * @li @p obj The elm_web object requesting the new window
- * @li @p message The message to show in the confirm dialog
- * @li @p ret Pointer to store the user selection. @c EINA_TRUE if
+ * @param data User data pointer set when setting the hook function.
+ * @param obj The elm_web object requesting the new window.
+ * @param message The message to show in the confirm dialog.
+ * @param ret Pointer to store the user selection. @c EINA_TRUE if
* the user selected @c Ok, @c EINA_FALSE otherwise.
*
- * The function should return the object representing the confirm dialog.
+ * @return The object representing the confirm dialog.
* Elm_Web will run a second main loop to handle the dialog and normal
* flow of the application will be restored when the object is deleted, so
* the user should handle the popup properly in order to delete the object
/**
* Callback type for the JS prompt hook.
*
- * The function parameters are:
- * @li @p data User data pointer set when setting the hook function
- * @li @p obj The elm_web object requesting the new window
- * @li @p message The message to show in the prompt dialog
- * @li @p def_value The default value to present the user in the entry
- * @li @p value Pointer to store the value given by the user. Must
+ * @param data User data pointer set when setting the hook function.
+ * @param obj The elm_web object requesting the new window.
+ * @param message The message to show in the prompt dialog.
+ * @param def_value The default value to present the user in the entry
+ * @param value Pointer to store the value given by the user. Must
* be a malloc'ed string or @c NULL if the user canceled the popup.
- * @li @p ret Pointer to store the user selection. @c EINA_TRUE if
+ * @param ret Pointer to store the user selection. @c EINA_TRUE if
* the user selected @c Ok, @c EINA_FALSE otherwise.
*
- * The function should return the object representing the prompt dialog.
+ * @return The object representing the prompt dialog.
* Elm_Web will run a second main loop to handle the dialog and normal
* flow of the application will be restored when the object is deleted, so
* the user should handle the popup properly in order to delete the object
/**
* Callback type for the JS file selector hook.
*
- * The function parameters are:
- * @li @p data User data pointer set when setting the hook function
- * @li @p obj The elm_web object requesting the new window
- * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
- * @li @p accept_types Mime types accepted
- * @li @p selected Pointer to store the list of malloc'ed strings
+ * @param data User data pointer set when setting the hook function.
+ * @param obj The elm_web object requesting the new window.
+ * @param allows_multiple @c EINA_TRUE if multiple files can be selected.
+ * @param accept_types Mime types accepted.
+ * @param selected Pointer to store the list of malloc'ed strings
* containing the path to each file selected. Must be @c NULL if the file
- * dialog is canceled
- * @li @p ret Pointer to store the user selection. @c EINA_TRUE if
+ * dialog is canceled.
+ * @param ret Pointer to store the user selection. @c EINA_TRUE if
* the user selected @c Ok, @c EINA_FALSE otherwise.
*
- * The function should return the object representing the file selector
- * dialog.
+ * @return The object representing the file selector dialog.
* Elm_Web will run a second main loop to handle the dialog and normal
* flow of the application will be restored when the object is deleted, so
* the user should handle the popup properly in order to delete the object
* console message hook will be called for the user to handle. There is no
* default implementation of this hook.
*
- * The function parameters are:
- * @li @p data User data pointer set when setting the hook function
- * @li @p obj The elm_web object that originated the message
- * @li @p message The message sent
- * @li @p line_number The line number
- * @li @p source_id Source id
+ * @param data User data pointer set when setting the hook function.
+ * @param obj The elm_web object that originated the message.
+ * @param message The message sent.
+ * @param line_number The line number.
+ * @param source_id Source id.
*
* @see elm_web_console_message_hook_set()
*
* Add a new web object to the parent.
*
* @param parent The parent object.
- * @return The new object or NULL if it cannot be created.
+ * @return The new object or @c NULL if it cannot be created.
*
* @see elm_web_uri_set()
* @see elm_web_webkit_view_get()
* interfere with elm_web behavior.
*
* @param obj The web object.
- * @return The internal ewk_view object or NULL if it does not
+ * @return The internal ewk_view object or @c NULL if it does not
* exist. (Failure to create or Elementary compiled without
* ewebkit)
*
* Gets the status of the tab propagation
*
* @param obj The web object to query
- * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
+ * @return @c EINA_TRUE if tab propagation is enabled, @c EINA_FALSE otherwise
*
* @see elm_web_tab_propagate_set()
*
*
* @param obj The web object
* @param uri The URI to set
- * @return EINA_TRUE if the URI could be set, EINA_FALSE if an error occurred
+ * @return @c EINA_TRUE if the URI could be set, @c EINA_FALSE if an error occurred.
*
* @ingroup Web
*/
* stringshared.
*
* @param obj The web object
- * @return A stringshared internal string with the current URI, or NULL on
+ * @return A stringshared internal string with the current URI, or @c NULL on
* failure
*
* @ingroup Web
* stringshared.
*
* @param obj The web object
- * @return A stringshared internal string with the current title, or NULL on
+ * @return A stringshared internal string with the current title, or @c NULL on
* failure
*
* @ingroup Web
* The string returned must be freed by the user when it's done with it.
*
* @param obj The web object
- * @return A newly allocated string, or NULL if nothing is selected or an
+ * @return A newly allocated string, or @c NULL if nothing is selected or an
* error occurred
*
* @ingroup Web
* any memory and objects related to this popup can be freed.
*
* @param obj The web object
- * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
+ * @return @c EINA_TRUE if the menu was successfully destroyed, or @c EINA_FALSE
* if there was no menu to destroy
*
* @ingroup Web
*
* @param obj The web object
*
- * @return EINA_TRUE on success, EINA_FALSE otherwise
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
*
* @ingroup Web
*/
* @param obj The web object
* @param highlight Whether to highlight the marks or not
*
- * @return EINA_TRUE on success, EINA_FALSE otherwise
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
*
* @ingroup Web
*/
*
* @param obj The web object
*
- * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
+ * @return @c EINA_TRUE is marks are set to be highlighted, @c EINA_FALSE
* otherwise
*
* @ingroup Web
*
* Cancels the loading of the current page in the web object. This will
* cause a "load,error" signal to be emitted, with the is_cancellation
- * flag set to EINA_TRUE.
+ * flag set to @c EINA_TRUE.
*
* @param obj The web object
*
- * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
+ * @return @c EINA_TRUE if the cancel was successful, @c EINA_FALSE otherwise
*
* @ingroup Web
*/
*
* @param obj The web object
*
- * @return EINA_TRUE on success, EINA_FALSE otherwise
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
*
* @ingroup Web
*/
*
* @param obj The web object
*
- * @return EINA_TRUE on success, EINA_FALSE otherwise
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
*
* @ingroup Web
*/
*
* @param obj The web object
*
- * @return EINA_TRUE on success, EINA_FALSE otherwise
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
*
* @see elm_web_history_enabled_set()
* @see elm_web_back_possible()
*
* @param obj The web object
*
- * @return EINA_TRUE on success, EINA_FALSE otherwise
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
*
* @see elm_web_history_enabled_set()
* @see elm_web_forward_possible_get()
* @param obj The web object
* @param steps The number of steps to jump
*
- * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
+ * @return @c EINA_TRUE on success, @c EINA_FALSE on error or if not enough
* history exists to jump the given number of steps
*
* @see elm_web_history_enabled_set()
*
* @param obj The web object
*
- * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
+ * @return @c EINA_TRUE if it's possible to back in history, @c EINA_FALSE
* otherwise
*
* @ingroup Web
*
* @param obj The web object
*
- * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
+ * @return @c EINA_TRUE if it's possible to forward in history, @c EINA_FALSE
* otherwise
*
* @ingroup Web
* @param obj The web object
* @param steps The number of steps to check for
*
- * @return EINA_TRUE if enough history exists to perform the given jump,
- * EINA_FALSE otherwise
+ * @return @c EINA_TRUE if enough history exists to perform the given jump,
+ * @c EINA_FALSE otherwise
*
* @ingroup Web
*/
*
* @param obj The web object
*
- * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
+ * @return @c EINA_TRUE if history is enabled, @c EINA_FALSE otherwise
*
* @ingroup Web
*/
*
* @param obj The web object
*
- * @return The current zoom mode set for the object, or
- * ::ELM_WEB_ZOOM_MODE_LAST on error
+ * @return The current zoom mode set for the object,
+ * or ::ELM_WEB_ZOOM_MODE_LAST on error
*
* @ingroup Web
*/
* normal separated window.
*
* @param obj The web object
- * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
+ * @param value @c EINA_TRUE to use Inwin, @c EINA_FALSE to use a normal window
*
* @ingroup Web
*/
*
* @param obj The web object
*
- * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
+ * @return @c EINA_TRUE if Inwin mode is set, @c EINA_FALSE otherwise
*
* @ingroup Web
*/
* @param wf The web window features object
* @param flag The web window feature flag whose value is required.
*
- * @return EINA_TRUE if the flag is set, EINA_FALSE otherwise
+ * @return @c EINA_TRUE if the flag is set, @c EINA_FALSE otherwise
*
* @ingroup Web
*/
* @param name The name of the window
* @param type The window type, one of #Elm_Win_Type.
*
- * The @p parent parameter can be @c NULL for every window @p type except
- * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
- * which the image object will be created.
+ * The @p parent parameter can be @c NULL for every window @p type
+ * except #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the
+ * canvas on which the image object will be created.
*
- * @return The created object, or NULL on failure
+ * @return The created object, or @c NULL on failure
*
* @ingroup Win
*/
*
* This creates a window like elm_win_add() but also puts in a standard
* background with elm_bg_add(), as well as setting the window title to
- * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
+ * @p title. The window type created is of type ELM_WIN_BASIC, with @c NULL
* as the parent widget.
*
- * @return The created object, or NULL on failure
+ * @return The created object, or @c NULL on failure
*
* @see elm_win_add()
*
projects / platform / upstream / elementary.git / commitdiff