Fix typos in documentation #5
Signed-off-by: Sanjeev BA <iamsanjeev@gmail.com> SVN revision: 67908
This commit is contained in:
parent
9f596b2f3d
commit
a1309b1a9e
|
@ -10,7 +10,7 @@
|
|||
* (thus, the "flip" in the name).
|
||||
*
|
||||
* User clicks to flip sheets which are @b held for some time will
|
||||
* make the flip selector to flip continuosly and automatically for
|
||||
* make the flip selector to flip continuously and automatically for
|
||||
* the user. The interval between flips will keep growing in time,
|
||||
* so that it helps the user to reach an item which is distant from
|
||||
* the current selection.
|
||||
|
@ -192,7 +192,7 @@ EAPI Elm_Object_Item *elm_flipselector_last_item_get(const Evas_Objec
|
|||
*
|
||||
* @param obj The flipselector object
|
||||
* @return The selected item or @c NULL, if the widget has no items
|
||||
* (and on erros)
|
||||
* (and on errors)
|
||||
*
|
||||
* @ingroup Flipselector
|
||||
*/
|
||||
|
@ -269,7 +269,7 @@ EAPI Elm_Object_Item *elm_flipselector_item_next_get(Elm_Object_Item
|
|||
* @param interval The (first) interval value in seconds
|
||||
*
|
||||
* This interval value is @b decreased while the user holds the
|
||||
* mouse pointer either flipping up or flipping doww a given flip
|
||||
* mouse pointer either flipping up or flipping down a given flip
|
||||
* selector.
|
||||
*
|
||||
* This helps the user to get to a given item distant from the
|
||||
|
|
|
@ -12,7 +12,7 @@
|
|||
* objects by input (tab key) or programmatically. The default
|
||||
* focus chain for an application is the one define by the order in
|
||||
* which the widgets where added in code. One will cycle through
|
||||
* top level widgets, and, for each one containg sub-objects, cycle
|
||||
* top level widgets, and, for each one containing sub-objects, cycle
|
||||
* through them all, before returning to the level
|
||||
* above. Elementary also allows one to set @b custom focus chains
|
||||
* for their applications.
|
||||
|
@ -53,7 +53,7 @@ EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
|
|||
/**
|
||||
* Get the enable status of the highlight animation
|
||||
*
|
||||
* @return The focus hilight mode set
|
||||
* @return The focus highlight mode set
|
||||
*
|
||||
* Get whether the focus highlight, if enabled, will animate its switch from
|
||||
* one object to the next
|
||||
|
|
|
@ -121,7 +121,7 @@ EAPI void elm_font_overlay_all_apply(void);
|
|||
*
|
||||
* @ingroup Fonts
|
||||
*
|
||||
* @note The reverse translation can be achived with
|
||||
* @note The reverse translation can be achieved with
|
||||
* elm_font_fontconfig_name_get(), for one style only (single font
|
||||
* instance, not family).
|
||||
*/
|
||||
|
@ -147,7 +147,7 @@ EAPI void elm_font_properties_free(Elm_Font_Properties *efp);
|
|||
*
|
||||
* @ingroup Fonts
|
||||
*
|
||||
* @note The reverse translation can be achived with
|
||||
* @note The reverse translation can be achieved with
|
||||
* elm_font_properties_get(), for one style only (single font
|
||||
* instance, not family).
|
||||
*/
|
||||
|
|
|
@ -6,7 +6,7 @@
|
|||
*
|
||||
* @brief Frame is a widget that holds some content and has a title.
|
||||
*
|
||||
* The default look is a frame with a title, but Frame supports multple
|
||||
* The default look is a frame with a title, but Frame supports multiple
|
||||
* styles:
|
||||
* @li default
|
||||
* @li pad_small
|
||||
|
|
|
@ -415,12 +415,12 @@ EAPI void elm_gengrid_align_get(const Evas_Object *obj,
|
|||
* @b reordered
|
||||
*
|
||||
* @param obj The gengrid object
|
||||
* @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
|
||||
* @param reorder_mode Use @c EINA_TRUE to turn reordering on,
|
||||
* @c EINA_FALSE to turn it off
|
||||
*
|
||||
* If a gengrid is set to allow reordering, a click held for more
|
||||
* than 0.5 over a given item will highlight it specially,
|
||||
* signalling the gengrid has entered the reordering state. From
|
||||
* signaling the gengrid has entered the reordering state. From
|
||||
* that time on, the user will be able to, while still holding the
|
||||
* mouse button down, move the item freely in the gengrid's
|
||||
* viewport, replacing to said item to the locations it goes to.
|
||||
|
@ -439,7 +439,7 @@ EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj
|
|||
* @b reordered
|
||||
*
|
||||
* @param obj The gengrid object
|
||||
* @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
|
||||
* @return @c EINA_TRUE, if reordering is on, @c EINA_FALSE if it's
|
||||
* off
|
||||
*
|
||||
* @see elm_gengrid_reorder_mode_set() for more details
|
||||
|
@ -821,7 +821,7 @@ EAPI void elm_gengrid_page_size_set(Evas_Object *obj, E
|
|||
*
|
||||
* @see elm_gengrid_last_page_get()
|
||||
* @see elm_gengrid_page_show()
|
||||
* @see elm_gengrid_page_brint_in()
|
||||
* @see elm_gengrid_page_bring_in()
|
||||
*/
|
||||
EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
|
||||
|
||||
|
@ -837,7 +837,7 @@ EAPI void elm_gengrid_current_page_get(const Evas_Objec
|
|||
*
|
||||
* @see elm_gengrid_current_page_get()
|
||||
* @see elm_gengrid_page_show()
|
||||
* @see elm_gengrid_page_brint_in()
|
||||
* @see elm_gengrid_page_bring_in()
|
||||
*/
|
||||
EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
|
||||
|
||||
|
@ -919,7 +919,7 @@ EAPI void elm_gengrid_horizontal_set(Evas_Object *obj,
|
|||
* @return @c EINA_TRUE, if @p obj is set to expand horizontally,
|
||||
* @c EINA_FALSE if it's set to expand vertically.
|
||||
*
|
||||
* @see elm_gengrid_horizontal_set() for more detais
|
||||
* @see elm_gengrid_horizontal_set() for more details
|
||||
*
|
||||
* @ingroup Gengrid
|
||||
*/
|
||||
|
@ -1107,7 +1107,7 @@ EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Object_
|
|||
* @param it The item to display
|
||||
*
|
||||
* This causes gengrid to @b redraw its viewport's contents to the
|
||||
* region contining the given @p item item, if it is not fully
|
||||
* region containing the given @p item item, if it is not fully
|
||||
* visible.
|
||||
*
|
||||
* @see elm_gengrid_item_bring_in()
|
||||
|
@ -1233,7 +1233,7 @@ EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_
|
|||
* @param disable If EINA_TRUE, size restrictions are disabled
|
||||
* @return EINA_FALSE on failure, EINA_TRUE on success
|
||||
*
|
||||
* This function allows a tooltip to expand beyond its parant window's canvas.
|
||||
* This function allows a tooltip to expand beyond its parent window's canvas.
|
||||
* It will instead be limited only by the size of the display.
|
||||
*/
|
||||
EAPI Eina_Bool elm_gengrid_item_tooltip_window_mode_set(Elm_Object_Item *it, Eina_Bool disable);
|
||||
|
@ -1244,7 +1244,7 @@ EAPI Eina_Bool elm_gengrid_item_tooltip_window_mode_set(Elm_
|
|||
* @return If EINA_TRUE, size restrictions are disabled
|
||||
*
|
||||
* This function returns whether a tooltip is allowed to expand beyond
|
||||
* its parant window's canvas.
|
||||
* its parent window's canvas.
|
||||
* It will instead be limited only by the size of the display.
|
||||
*/
|
||||
EAPI Eina_Bool elm_gengrid_item_tooltip_window_mode_get(const Elm_Object_Item *it);
|
||||
|
@ -1399,7 +1399,7 @@ EAPI void elm_gengrid_clear(Evas_Object *obj);
|
|||
* Get the selected item in a given gengrid widget
|
||||
*
|
||||
* @param obj The gengrid object.
|
||||
* @return The selected item's handleor @c NULL, if none is
|
||||
* @return The selected item's handle or @c NULL, if none is
|
||||
* selected at the moment (and on errors)
|
||||
*
|
||||
* This returns the selected item in @p obj. If multi selection is
|
||||
|
@ -1420,7 +1420,7 @@ EAPI Elm_Object_Item *elm_gengrid_selected_item_get(const Evas_Objec
|
|||
*
|
||||
* This returns a list of the selected items, in the order that
|
||||
* they appear in the grid. This list is only valid as long as no
|
||||
* more items are selected or unselected (or unselected implictly
|
||||
* more items are selected or unselected (or unselected implicitly
|
||||
* by deletion). The list contains #Gengrid item pointers as
|
||||
* data, naturally.
|
||||
*
|
||||
|
|
|
@ -110,7 +110,7 @@
|
|||
* Items can be added by several calls. All of them return a @ref
|
||||
* Elm_Object_Item handle that is an internal member inside the genlist.
|
||||
* They all take a data parameter that is meant to be used for a handle to
|
||||
* the applications internal data (eg the struct with the original item
|
||||
* 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,
|
||||
|
@ -145,7 +145,7 @@
|
|||
* let you know which item is the parent (and thus know how to skip them if
|
||||
* wanted).
|
||||
*
|
||||
* @section Genlist_Muti_Selection Multi-selection
|
||||
* @section Genlist_Multi_Selection Multi-selection
|
||||
*
|
||||
* If the application wants multiple items to be able to be selected,
|
||||
* elm_genlist_multi_select_set() can enable this. If the list is
|
||||
|
@ -896,7 +896,7 @@ EAPI Elm_Object_Item *elm_genlist_item_direct_sorted_insert(Evas_Obj
|
|||
|
||||
/* operations to retrieve existing items */
|
||||
/**
|
||||
* Get the selectd item in the genlist.
|
||||
* Get the selected item in the genlist.
|
||||
*
|
||||
* @param obj The genlist object
|
||||
* @return The selected item, or NULL if none is selected.
|
||||
|
@ -986,7 +986,7 @@ EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Obj
|
|||
/**
|
||||
* Get the item that is at the x, y canvas coords.
|
||||
*
|
||||
* @param obj The gelinst object.
|
||||
* @param obj The genlist object.
|
||||
* @param x The input x coordinate
|
||||
* @param y The input y coordinate
|
||||
* @param posret The position relative to the item returned here
|
||||
|
@ -1169,7 +1169,7 @@ EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Objec
|
|||
* has been expanded/contracted.
|
||||
*
|
||||
* Calling this function won't show or hide any child of this item (if it is
|
||||
* a parent). You must manually delete and create them on the callbacks fo
|
||||
* a parent). You must manually delete and create them on the callbacks of
|
||||
* the "expanded" or "contracted" signals.
|
||||
*
|
||||
* @see elm_genlist_item_expanded_get()
|
||||
|
@ -1346,7 +1346,7 @@ EAPI void elm_genlist_item_middle_show(Elm_Object_Item
|
|||
EAPI void elm_genlist_item_middle_bring_in(Elm_Object_Item *it);
|
||||
|
||||
/**
|
||||
* Tells genlist to "orphan" contents fetchs by the item class
|
||||
* Tells genlist to "orphan" contents fetched by the item class
|
||||
*
|
||||
* @param it The item
|
||||
*
|
||||
|
@ -1445,7 +1445,7 @@ EAPI void elm_genlist_item_fields_update(Elm_Object_Ite
|
|||
* @param it The item
|
||||
* @param itc The item class for the item
|
||||
*
|
||||
* This sets another class fo the item, changing the way that it is
|
||||
* This sets another class of the item, changing the way that it is
|
||||
* displayed. After changing the item class, elm_genlist_item_update() is
|
||||
* called on the item @p it.
|
||||
*
|
||||
|
@ -1561,7 +1561,7 @@ EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_
|
|||
* @param disable If EINA_TRUE, size restrictions are disabled
|
||||
* @return EINA_FALSE on failure, EINA_TRUE on success
|
||||
*
|
||||
* This function allows a tooltip to expand beyond its parant window's canvas.
|
||||
* This function allows a tooltip to expand beyond its parent window's canvas.
|
||||
* It will instead be limited only by the size of the display.
|
||||
*/
|
||||
EAPI Eina_Bool elm_genlist_item_tooltip_window_mode_set(Elm_Object_Item *it, Eina_Bool disable);
|
||||
|
@ -1572,7 +1572,7 @@ EAPI Eina_Bool elm_genlist_item_tooltip_window_mode_set(Elm_
|
|||
* @return If EINA_TRUE, size restrictions are disabled
|
||||
*
|
||||
* This function returns whether a tooltip is allowed to expand beyond
|
||||
* its parant window's canvas.
|
||||
* its parent window's canvas.
|
||||
* It will instead be limited only by the size of the display.
|
||||
*/
|
||||
EAPI Eina_Bool elm_genlist_item_tooltip_window_mode_get(const Elm_Object_Item *it);
|
||||
|
|
Loading…
Reference in New Issue