*
* Elementary configuration is formed by a set options bounded to a
* given @ref Profile profile, like @ref Theme theme, @ref Fingers
- * "finger size", etc. These are functions with which one syncronizes
+ * "finger size", etc. These are functions with which one synchronizes
* changes made to those values to the configuration storing files, de
* facto. You most probably don't want to use the functions in this
- * group unlees you're writing an elementary configuration manager.
+ * group unless you're writing an elementary configuration manager.
*
* @{
*/
* Save back Elementary's configuration, so that it will persist on
* future sessions.
*
- * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
+ * @return @c EINA_TRUE, when successful. @c EINA_FALSE, otherwise.
* @ingroup Config
*
* This function will take effect -- thus, do I/O -- immediately. Use
* Reload Elementary's configuration, bounded to current selected
* profile.
*
- * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
+ * @return @c EINA_TRUE, when successful. @c EINA_FALSE, otherwise.
* @ingroup Config
*
* Useful when you want to force reloading of configuration values for
* Elementary-based applications. There are, for example, profiles
* aimed at desktop computer applications and others aimed at mobile,
* touchscreen-based ones. You most probably don't want to use the
- * functions in this group unlees you're writing an elementary
+ * functions in this group unless you're writing an elementary
* configuration manager.
*
* @{
* Get the number of pixels one should travel while dragging a
* scroller's view to actually trigger scrolling.
*
- * @return the thumb scroll threshould
+ * @return the thumb scroll threshold
*
* One would use higher values for touch screens, in general, because
* of their inherent imprecision.
* Set the number of pixels one should travel while dragging a
* scroller's view to actually trigger scrolling.
*
- * @param threshold the thumb scroll threshould
+ * @param threshold the thumb scroll threshold
*
- * @see elm_thumbscroll_threshould_get()
+ * @see elm_thumbscroll_threshold_get()
* @ingroup Scrolling
*/
EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
* scroller's view to actually trigger scrolling, for all Elementary
* application windows.
*
- * @param threshold the thumb scroll threshould
+ * @param threshold the thumb scroll threshold
*
- * @see elm_thumbscroll_threshould_get()
+ * @see elm_thumbscroll_threshold_get()
* @ingroup Scrolling
*/
// XXX: deprecate and replace with elm_config_all_flush()
* list self scrolling animation after a mouse up event
* (pixels/second).
*
- * @return the thumb scroll momentum threshould
+ * @return the thumb scroll momentum threshold
*
* @ingroup Scrolling
*/
* list self scrolling animation after a mouse up event
* (pixels/second).
*
- * @param threshold the thumb scroll momentum threshould
+ * @param threshold the thumb scroll momentum threshold
*
- * @see elm_thumbscroll_momentum_threshould_get()
+ * @see elm_thumbscroll_momentum_threshold_get()
* @ingroup Scrolling
*/
EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
* list self scrolling animation after a mouse up event
* (pixels/second), for all Elementary application windows.
*
- * @param threshold the thumb scroll momentum threshould
+ * @param threshold the thumb scroll momentum threshold
*
- * @see elm_thumbscroll_momentum_threshould_get()
+ * @see elm_thumbscroll_momentum_threshold_get()
* @ingroup Scrolling
*/
// XXX: deprecate and replace with elm_config_all_flush()
* mouse dragging.
*
* @param friction the thumb scroll sensitivity friction. @c 0.1 for
- * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
+ * minimum sensitivity, @c 1.0 for maximum sensitivity. 0.25
* is proper.
*
* @see elm_thumbscroll_sensitivity_friction_get()
* mouse dragging, for all Elementary application windows.
*
* @param friction the thumb scroll sensitivity friction. @c 0.1 for
- * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
+ * minimum sensitivity, @c 1.0 for maximum sensitivity. 0.25
* is proper.
*
* @see elm_thumbscroll_sensitivity_friction_get()
*/
/**
- * Get the duration for occuring long press event.
+ * Get the duration for occurring long press event.
*
* @return Timeout for long press event
* @ingroup Longpress
EAPI double elm_longpress_timeout_get(void);
/**
- * Set the duration for occuring long press event.
+ * Set the duration for occurring long press event.
*
* @param lonpress_timeout Timeout for long press event
* @ingroup Longpress
*
* @param engine_only If 1 only engine cursors will be enabled, if 0 will
* look for them on theme before.
- * @return EINA_TRUE if value is valid and setted (0 or 1)
+ * @return EINA_TRUE if value is valid and set (0 or 1)
* @ingroup Cursors
*/
EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
*
* Once the icon object is set, a previously set one will be deleted.
* @warning Setting the same icon for two items will cause the icon to
- * dissapear from the first item.
+ * disappear from the first item.
*
* @see elm_ctxpopup_item_append()
*
*
* @param it Ctxpopup item
* @return label string or @c NULL, if the item does not have label or an
- * error occured
+ * error occurred
*
* @see elm_ctxpopup_item_append()
* @see elm_ctxpopup_item_label_set()
* @param obj Ctxpopup object
* @param content Content to be swallowed
*
- * If the content object is already set, a previous one will bedeleted. If
+ * If the content object is already set, a previous one will be deleted. If
* you want to keep that old content object, use the
* elm_ctxpopup_content_unset() function.
*
*
* All directions may have contents at the same time, except for
* "smart". This is a special placement hint and its use case
- * independs of the calculations coming from
+ * depends of the calculations coming from
* elm_hover_best_content_location_get(). Its use is for cases when
* one desires only one hover content, but with a dynamic special
* placement within the hover area. The content's geometry, whenever
*
* Once the icon object is set, a previously set one will be deleted.
* @warning Setting the same icon for two items will cause the icon to
- * dissapear from the first item.
+ * disappear from the first item.
*
* If an icon was passed as argument on item creation, with function
* elm_diskselector_item_append(), it will be already
*
* An item with label "January" would be displayed on side position as
* "Jan" if max length is set to 3 with function
- * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
+ * elm_diskselector_side_label_length_set(), or "Janu", if this property
* is set to 4.
*
* When this @p item is selected, the entire label will be displayed,
* elm_diskselector_item_append(), it will be already
* displayed by the item.
*
- * @see elm_diskselector_side_label_lenght_set()
+ * @see elm_diskselector_side_label_length_set()
* @see elm_diskselector_item_label_get()
* @see elm_diskselector_item_append()
*
*
* @param obj The frame object
*
- * @return The label of this frame objet or NULL if unable to get frame
+ * @return The label of this frame object or NULL if unable to get frame
*
* @deprecated use elm_object_text_get() instead.
*/
/**
* @def elm_layout_label_set
- * Convienience macro to set the label in a layout that follows the
+ * Convenience macro to set the label in a layout that follows the
* Elementary naming convention for its parts.
*
* @ingroup Layout
* @param it The menu item object.
* @param label The label to set for @p item
*
- * @warning Don't use this funcion on items created with
+ * @warning Don't use this function on items created with
* elm_menu_item_add_object() or elm_menu_item_separator_add().
*
* @deprecated Use elm_object_item_text_set() instead
* cursor decorations <b>defined in a theme file</b>, which can have,
* given a cursor name/type, <b>alternate styles</b> on it. It
* works analogously as elm_object_cursor_style_set(), but here
- * applyed only to toolbar item objects.
+ * applies only to toolbar item objects.
*
- * @warning Before you set a cursor style you should have definen a
+ * @warning Before you set a cursor style you should have defined a
* custom cursor previously on the item, with
* elm_toolbar_item_cursor_set()
*
*
* Once the icon object is set, a previously set one will be deleted.
* @warning Setting the same icon for two items will cause the icon to
- * dissapear from the first item.
+ * disappear from the first item.
*
* If an icon was passed as argument on item creation, with function
* elm_segment_control_item_add(), it will be already
*
* Once the icon object is set, a previously set one will be deleted.
* @warning Setting the same icon for two items will cause the icon to
- * dissapear from the first item.
+ * disappear from the first item.
*
* If an icon was passed as argument on item creation, with function
* elm_list_item_append() or similar, it will be already
*
* Once the icon object is set, a previously set one will be deleted.
* @warning Setting the same icon for two items will cause the icon to
- * dissapear from the first item.
+ * disappear from the first item.
*
* If an icon was passed as argument on item creation, with function
* elm_list_item_append() or similar, it will be already
* @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.
*
* @deprecated Use elm_object_item_tooltip_window_mode_set() instead
* @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.
*
* @deprecated Use elm_object_item_tooltip_window_mode_get() instead
* @see elm_list_item_cursor_set()
* @see elm_list_item_cursor_unset()
*
- * @deprecated Please use elm_object_item_cursor_get() insteas
+ * @deprecated Please use elm_object_item_cursor_get() instead
* @ingroup List
*/
EINA_DEPRECATED EAPI const char *elm_list_item_cursor_get(const Elm_Object_Item *it);
* cursor decorations <b>defined in a theme file</b>, which can have,
* given a cursor name/type, <b>alternate styles</b> on it. It
* works analogously as elm_object_cursor_style_set(), but here
- * applyed only to list item objects.
+ * applies only to list item objects.
*
- * @warning Before you set a cursor style you should have definen a
+ * @warning Before you set a cursor style you should have defined a
* custom cursor previously on the item, with
* elm_list_item_cursor_set()
*
* @param shrink_mode Toolbar's items display behavior.
*
* The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
- * but will enforce a minimun size so all the items will fit, won't scroll
+ * but will enforce a minimum size so all the items will fit, won't scroll
* and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
* will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
* pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
* @param y vertical coordinate of the point to rotate.
* @param cx rotation's center horizontal position.
* @param cy rotation's center vertical position.
- * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
+ * @param degree amount of degrees from 0.0 to 360.0 to rotate around Z axis.
* @param xx Pointer where to store rotated x.
* @param yy Pointer where to store rotated y.
*
* Available styles for it:
* - @c "default"
*
- * Default contents parts of the diskseletor items that you can use for are:
+ * Default contents parts of the diskselector items that you can use for are:
* @li "icon" - An icon in the diskselector item
*
* Default text parts of the diskselector items that you can use for are:
*
* Default side label max length is 3.
*
- * This property will be applyed over all items, included before or
+ * This property will be applied over all items, included before or
* later this function call.
*
* @ingroup Diskselector
* @param obj The diskselector object.
* @param num The number of items the diskselector will display.
*
- * Default value is 3, and also it's the minimun. If @p num is less
+ * Default value is 3, and also it's the minimum. If @p num is less
* than 3, it will be set to 3.
*
* Also, it can be set on theme, using data item @c display_item_num
* Associated @p data can be properly freed when item is deleted if a
* callback function is set with elm_object_item_del_cb_set().
*
- * If a function is passed as argument, it will be called everytime this item
+ * If a function is passed as argument, it will be called every time this item
* is selected, i.e., the user stops the diskselector with this
* item on center position. If such function isn't needed, just passing
* @c NULL as @p func is enough. The same should be done for @p data.
* diskselector will be selected.
*
* The selected item always will be centered on diskselector, with
- * full label displayed, i.e., max lenght set to side labels won't
+ * full label displayed, i.e., max length set to side labels won't
* apply on the selected item. More details on
* elm_diskselector_side_label_length_set().
*
* This sets the selected state of the given item @p it.
* @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
*
- * If a new item is selected the previosly selected will be unselected.
- * Previoulsy selected item can be get with function
+ * If a new item is selected the previously selected will be unselected.
+ * Previously selected item can be get with function
* elm_diskselector_selected_item_get().
*
* If the item @p it is unselected, the first item of diskselector will
*
* An entry is a convenience widget which shows a box that the user can
* enter text into. Entries by default don't scroll, so they grow to
- * accomodate the entire text, resizing the parent window as needed. This
+ * accommodate the entire text, resizing the parent window as needed. This
* can be changed with the elm_entry_scrollable_set() function.
*
* They can also be single line or multi line (the default) and when set
* enclosed text.
* @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
* @li \<link\>...\</link\>: Underlines the enclosed text.
- * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
+ * @li \<hilight\>...\</hilight\>: Highlights the enclosed text.
*
* @section entry-special Special markups
*
* Besides those used to format text, entries support two special markup
- * tags used to insert clickable portions of text or items inlined within
+ * tags used to insert click-able portions of text or items inlined within
* the text.
*
* @subsection entry-anchors Anchors
* @li relsize: Size is adjusted for the item to fit within the current
* line height.
*
- * Besides their size, items are specificed a @c vsize value that affects
+ * Besides their size, items are specified a @c vsize value that affects
* how their final size and position are calculated. The possible values
* are:
* @li ascent: Item will be placed within the line's baseline and its
*
* @section entry-files Loading and saving files
*
- * Entries have convinience functions to load text from a file and save
+ * Entries have convenience functions to load text from a file and save
* changes back to it after a short delay. The automatic saving is enabled
* by default, but can be disabled with elm_entry_autosave_set() and files
* can be loaded directly as plain text or have any markup in them
EAPI void elm_entry_markup_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data);
/**
- * Prepend a markup filter function for text insdrted in the entry
+ * Prepend a markup filter function for text inserted in the entry
*
* Prepend the given callback to the list. See elm_entry_markup_filter_append()
* for more information
EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
/**
- * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
+ * This sets the scrolled entry's scrollbar policy (i.e. enabling/disabling
* them).
*
* Setting an entry to single-line mode with elm_entry_single_line_set()
* Show the input panel (virtual keyboard) based on the input panel property of entry such as layout, autocapital types, and so on.
*
* Note that input panel is shown or hidden automatically according to the focus state of entry widget.
- * This API can be used in the case of manually controling by using elm_entry_input_panel_enabled_set(en, EINA_FALSE)
+ * This API can be used in the case of manually controlling by using elm_entry_input_panel_enabled_set(en, EINA_FALSE)
*
* @param obj The entry object
*/
* Hide the input panel (virtual keyboard).
*
* Note that input panel is shown or hidden automatically according to the focus state of entry widget.
- * This API can be used in the case of manually controling by using elm_entry_input_panel_enabled_set(en, EINA_FALSE)
+ * This API can be used in the case of manually controlling by using elm_entry_input_panel_enabled_set(en, EINA_FALSE)
*
* @param obj The entry object
*/
*
* Add this filter to an entry to limit the characters that it will accept
* based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
- * The funtion works on the UTF-8 representation of the string, converting
+ * The function works on the UTF-8 representation of the string, converting
* it from the set markup, thus not accounting for any format in it.
*
* The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
/**
* @brief Get flip front visibility state
*
- * @param obj The flip objct
+ * @param obj The flip object
* @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
* showing.
*/
* @param mode The mode type
*
* Flips the front and back contents using the @p mode animation. This
- * efectively hides the currently visible content and shows the hidden one.
+ * effectively hides the currently visible content and shows the hidden one.
*
* There a number of possible animations to use for the flipping:
* @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
* drag a side of the flip to reveal the back page and cause it to flip).
* By default a flip is not interactive. You may also need to set which
* sides of the flip are "active" for flipping and how much space they use
- * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
- * and elm_flip_interacton_direction_hitsize_set()
+ * (a minimum of a finger size) with elm_flip_interaction_direction_enabled_set()
+ * and elm_flip_interaction_direction_hitsize_set()
*
- * The four avilable mode of interaction are:
+ * The four available mode of interaction are:
* @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
* @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
* @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
*
* @note ELM_FLIP_INTERACTION_ROTATE won't cause
* ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
- * happen, those can only be acheived with elm_flip_go();
+ * happen, those can only be achieved with elm_flip_go();
*/
EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
* @param dir The direction to check
* @return If that direction is enabled or not
*
- * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
+ * Gets the enabled state set by elm_flip_interaction_direction_enabled_set()
*
* @see elm_flip_interaction_set()
*/
* @param dir The direction to check
* @return The size set for that direction
*
- * Returns the amount os sensitive area set by
- * elm_flip_interacton_direction_hitsize_set().
+ * Returns the amount of sensitive area set by
+ * elm_flip_interaction_direction_hitsize_set().
*/
EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
projects / framework / uifw / elementary.git / commitdiff