Fix typos in documentation #11.
Signed-off-by: Sanjeev BA <iamsanjeev@gmail.com> SVN revision: 67914
This commit is contained in:
parent
22518d5a24
commit
410abe34d1
|
@ -48,13 +48,13 @@
|
|||
* @enum _Elm_Toolbar_Shrink_Mode
|
||||
* @typedef Elm_Toolbar_Shrink_Mode
|
||||
*
|
||||
* Set toolbar's items display behavior, it can be scrollabel,
|
||||
* Set toolbar's items display behavior, it can be scrollable,
|
||||
* show a menu with exceeding items, or simply hide them.
|
||||
*
|
||||
* @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
|
||||
* from elm config.
|
||||
*
|
||||
* Values <b> don't </b> work as bitmask, only one can be choosen.
|
||||
* Values <b> don't </b> work as bitmask, only one can be chosen.
|
||||
*
|
||||
* @see elm_toolbar_shrink_mode_set()
|
||||
* @see elm_toolbar_shrink_mode_get()
|
||||
|
@ -63,7 +63,7 @@
|
|||
*/
|
||||
typedef enum
|
||||
{
|
||||
ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
|
||||
ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimum size to fit all the items. */
|
||||
ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
|
||||
ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
|
||||
ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
|
||||
|
@ -221,7 +221,7 @@ EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Obje
|
|||
* 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 clicks over an unselected item.
|
||||
* If such function isn't needed, just passing
|
||||
* @c NULL as @p func is enough. The same should be done for @p data.
|
||||
|
@ -256,7 +256,7 @@ EAPI Elm_Object_Item *elm_toolbar_item_append(Evas_Object *obj, cons
|
|||
* 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 clicks over an unselected item.
|
||||
* If such function isn't needed, just passing
|
||||
* @c NULL as @p func is enough. The same should be done for @p data.
|
||||
|
@ -292,7 +292,7 @@ EAPI Elm_Object_Item *elm_toolbar_item_prepend(Evas_Object *obj, con
|
|||
* 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 clicks over an unselected item.
|
||||
* If such function isn't needed, just passing
|
||||
* @c NULL as @p func is enough. The same should be done for @p data.
|
||||
|
@ -328,7 +328,7 @@ EAPI Elm_Object_Item *elm_toolbar_item_insert_before(Evas_Object *ob
|
|||
* 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 clicks over an unselected item.
|
||||
* If such function isn't needed, just passing
|
||||
* @c NULL as @p func is enough. The same should be done for @p data.
|
||||
|
@ -469,8 +469,8 @@ EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Object
|
|||
* 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_toolbar_selected_item_get().
|
||||
*
|
||||
* Selected items will be highlighted.
|
||||
|
@ -624,7 +624,7 @@ EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Objec
|
|||
* @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.
|
||||
|
@ -810,7 +810,7 @@ EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Object_Ite
|
|||
EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_add(Elm_Object_Item *it, const char *icon, const char *label, Evas_Smart_Cb func, const void *data);
|
||||
|
||||
/**
|
||||
* Delete a previoulsy added state to @p item.
|
||||
* Delete a previously added state to @p item.
|
||||
*
|
||||
* @param it The toolbar item.
|
||||
* @param state The state to be deleted.
|
||||
|
@ -829,7 +829,7 @@ EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Object_Item *it
|
|||
*
|
||||
* If @p state is @c NULL, it won't select any state and the default item's
|
||||
* icon and label will be used. It's the same behaviour than
|
||||
* elm_toolbar_item_state_unser().
|
||||
* elm_toolbar_item_state_unset().
|
||||
*
|
||||
* @see elm_toolbar_item_state_unset()
|
||||
*
|
||||
|
|
|
@ -35,7 +35,7 @@
|
|||
* object appear on its old place. These effects are:
|
||||
*
|
||||
* @li @ref elm_transit_effect_flip_add
|
||||
* @li @ref elm_transit_effect_resizable_flip_add
|
||||
* @li @ref elm_transit_effect_resizeable_flip_add
|
||||
* @li @ref elm_transit_effect_fade_add
|
||||
* @li @ref elm_transit_effect_blend_add
|
||||
*
|
||||
|
@ -160,8 +160,8 @@ EAPI Elm_Transit *elm_transit_add(void);
|
|||
* Call this function if you wants to stop the animation before the duration
|
||||
* time. Make sure the @p transit object is still alive with
|
||||
* elm_transit_del_cb_set() function.
|
||||
* All added effects will be deleted, calling its repective data_free_cb
|
||||
* functions. The function setted by elm_transit_del_cb_set() will be called.
|
||||
* All added effects will be deleted, calling its respective data_free_cb
|
||||
* functions. The function set by elm_transit_del_cb_set() will be called.
|
||||
*
|
||||
* @see elm_transit_del_cb_set()
|
||||
*
|
||||
|
@ -181,7 +181,7 @@ EAPI void elm_transit_del(Elm_Transit *transit);
|
|||
* effect list become empty again, the @p transit will be killed by
|
||||
* elm_transit_del(transit) function.
|
||||
*
|
||||
* Exemple:
|
||||
* Example:
|
||||
* @code
|
||||
* Elm_Transit *transit = elm_transit_add();
|
||||
* elm_transit_effect_add(transit,
|
||||
|
@ -237,7 +237,7 @@ EAPI void elm_transit_effect_del(Elm_Transit *transit, Elm_Tra
|
|||
* transit stays without objects, it will die.
|
||||
* @note When you add an object into the @p transit, its state from
|
||||
* evas_object_pass_events_get(obj) is saved, and it is applied when the
|
||||
* transit ends, if you change this state whith evas_object_pass_events_set()
|
||||
* transit ends, if you change this state with evas_object_pass_events_set()
|
||||
* after add the object, this state will change again when @p transit stops to
|
||||
* run.
|
||||
*
|
||||
|
@ -338,13 +338,13 @@ EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *tra
|
|||
/**
|
||||
* Set the user-callback function when the transit is deleted.
|
||||
*
|
||||
* @note Using this function twice will overwrite the first function setted.
|
||||
* @note Using this function twice will overwrite the first function set.
|
||||
* @note the @p transit object will be deleted after call @p cb function.
|
||||
*
|
||||
* @param transit The transit object.
|
||||
* @param cb Callback function pointer. This function will be called before
|
||||
* the deletion of the transit.
|
||||
* @param data Callback funtion user data. It is the @p op parameter.
|
||||
* @param data Callback function user data. It is the @p op parameter.
|
||||
*
|
||||
* @ingroup Transit
|
||||
*/
|
||||
|
@ -353,10 +353,10 @@ EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Tra
|
|||
/**
|
||||
* Set reverse effect automatically.
|
||||
*
|
||||
* If auto reverse is setted, after running the effects with the progress
|
||||
* parameter from 0 to 1, it will call the effecs again with the progress
|
||||
* from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
|
||||
* where the duration was setted with the function elm_transit_add and
|
||||
* If auto reverse is set, after running the effects with the progress
|
||||
* parameter from 0 to 1, it will call the effects again with the progress
|
||||
* from 1 to 0. The transit will last for a time equal to (2 * duration * repeat),
|
||||
* where the duration was set with the function elm_transit_add and
|
||||
* the repeat with the function elm_transit_repeat_times_set().
|
||||
*
|
||||
* @param transit The transit object.
|
||||
|
@ -479,7 +479,7 @@ EAPI void elm_transit_go(Elm_Transit *transit);
|
|||
* Pause/Resume the transition.
|
||||
*
|
||||
* If you call elm_transit_go again, the transit will be started from the
|
||||
* beginning, and will be unpaused.
|
||||
* beginning, and will be played.
|
||||
*
|
||||
* @note @p transit can not be NULL
|
||||
*
|
||||
|
@ -655,9 +655,9 @@ EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, fl
|
|||
EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
|
||||
|
||||
/**
|
||||
* Add the Resizable Flip Effect to Elm_Transit.
|
||||
* Add the Resizeable Flip Effect to Elm_Transit.
|
||||
*
|
||||
* @note This API is one of the facades. It creates resizable flip effect context
|
||||
* @note This API is one of the facades. It creates resizeable flip effect context
|
||||
* and add it's required APIs to elm_transit_effect_add.
|
||||
* @note This effect is applied to each pair of objects in the order they are listed
|
||||
* in the transit list of objects. The first object in the pair will be the
|
||||
|
@ -668,7 +668,7 @@ EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, El
|
|||
* @param transit Transit object.
|
||||
* @param axis Flipping Axis(X or Y).
|
||||
* @param cw Flipping Direction. EINA_TRUE is clock-wise.
|
||||
* @return Resizable flip effect context data.
|
||||
* @return Resizeable flip effect context data.
|
||||
*
|
||||
* @ingroup Transit
|
||||
* @warning It is highly recommended just create a transit with this effect when
|
||||
|
|
|
@ -8,7 +8,7 @@
|
|||
* to display video. The main one, Elm_Video, display a video by using Emotion.
|
||||
* It does embedded the video inside an Edje object, so you can do some
|
||||
* animation depending on the video state change. It does also implement a
|
||||
* ressource management policy to remove this burden from the application writer.
|
||||
* resource management policy to remove this burden from the application writer.
|
||||
*
|
||||
* The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
|
||||
* It take care of updating its content according to Emotion event and provide a
|
||||
|
@ -194,7 +194,7 @@ EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool
|
|||
EAPI double elm_video_audio_level_get(const Evas_Object *video);
|
||||
|
||||
/**
|
||||
* @brief Set the audio level of anElm_Video object.
|
||||
* @brief Set the audio level of an Elm_Video object.
|
||||
*
|
||||
* @param video The video object to proceed the request on.
|
||||
* @param volume The new audio volume.
|
||||
|
|
|
@ -109,7 +109,7 @@ typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
|
|||
struct _Elm_Web_Frame_Load_Error
|
||||
{
|
||||
int code; /**< Numeric error code */
|
||||
Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
|
||||
Eina_Bool is_cancellation; /**< Error produced by canceling a request */
|
||||
const char *domain; /**< Error domain name */
|
||||
const char *description; /**< Error description (already localized) */
|
||||
const char *failing_url; /**< The URL that failed to load */
|
||||
|
@ -280,7 +280,7 @@ typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, con
|
|||
* @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 where to store the value given by the user. Must
|
||||
* be a malloc'ed string or @c NULL if the user cancelled the popup.
|
||||
* be a malloc'ed string or @c NULL if the user canceled the popup.
|
||||
* @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
|
||||
* the user selected @c Ok, @c EINA_FALSE otherwise.
|
||||
*
|
||||
|
@ -305,7 +305,7 @@ typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, cons
|
|||
* @li @p accept_types Mime types accepted
|
||||
* @li @p selected Pointer where to store the list of malloc'ed strings
|
||||
* containing the path to each file selected. Must be @c NULL if the file
|
||||
* dialog is cancelled
|
||||
* dialog is canceled
|
||||
* @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
|
||||
* the user selected @c Ok, @c EINA_FALSE otherwise.
|
||||
*
|
||||
|
|
|
@ -371,8 +371,8 @@ EAPI void elm_widget_focus_steal(Evas_Object *obj);
|
|||
*
|
||||
* Restore the focus state of the sub-tree.
|
||||
*
|
||||
* This API will restore the focus state of the sub-tree to the lastest
|
||||
* state. If a sub-tree is unfocused and wants to get back to the lastest
|
||||
* This API will restore the focus state of the sub-tree to the latest
|
||||
* state. If a sub-tree is unfocused and wants to get back to the latest
|
||||
* focus state, this API will be helpful.
|
||||
*
|
||||
* @param obj The widget root of sub-tree
|
||||
|
|
|
@ -52,7 +52,7 @@
|
|||
* window is shown before doing the virtual "in memory" rendering and then
|
||||
* save the output to the file specified by the file option (and then exit).
|
||||
* If no delay is given, the default is 0.5 seconds. If no file is given the
|
||||
* default output file is "out.png". Repeat option is for continous
|
||||
* default output file is "out.png". Repeat option is for continuous
|
||||
* capturing screenshots. Repeat range is from 1 to 999 and filename is
|
||||
* fixed to "out001.png" Some examples of using the shot engine:
|
||||
*
|
||||
|
@ -99,7 +99,7 @@ typedef enum
|
|||
similar. */
|
||||
ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
|
||||
ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
|
||||
pallete. */
|
||||
palette. */
|
||||
ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
|
||||
ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
|
||||
entry in a menubar is clicked. Typically used
|
||||
|
@ -135,7 +135,7 @@ typedef enum
|
|||
Evas_Object. */
|
||||
ELM_WIN_SOCKET_IMAGE,/**< The window is rendered onto an image buffer
|
||||
and can be shown other process's plug image object.
|
||||
No actural window is created for this type,
|
||||
No actual window is created for this type,
|
||||
instead the window and all of its contents will be
|
||||
rendered to an image buffer and can be shown
|
||||
other process's plug image object*/
|
||||
|
@ -190,7 +190,7 @@ typedef enum
|
|||
* @param name The name of the window
|
||||
* @param type The window type, one of #Elm_Win_Type.
|
||||
*
|
||||
* The @p parent paramter can be @c NULL for every window @p type except
|
||||
* 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.
|
||||
*
|
||||
|
@ -384,7 +384,7 @@ EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj);
|
|||
* Shaped windows, when supported, will render the parts of the window that
|
||||
* has no content, transparent.
|
||||
*
|
||||
* If @p shaped is EINA_FALSE, then it is strongly adviced to have some
|
||||
* If @p shaped is EINA_FALSE, then it is strongly advised to have some
|
||||
* background object or cover the entire window in any other way, or the
|
||||
* parts of the canvas that have no data will show framebuffer artifacts.
|
||||
*
|
||||
|
@ -818,7 +818,7 @@ EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, c
|
|||
/**
|
||||
* Get the style set for the focus highlight object
|
||||
*
|
||||
* Gets the style set for this windows highilght object, or NULL if none
|
||||
* Gets the style set for this windows highlight object, or NULL if none
|
||||
* is set.
|
||||
*
|
||||
* @param obj The window to retrieve the highlights style from
|
||||
|
@ -887,8 +887,8 @@ EAPI void elm_win_screen_position_get(const Evas_Object *obj, i
|
|||
*
|
||||
* @param obj The window object
|
||||
* @param svcname The name of the service to be advertised. ensure that it is unique (when combined with @p svcnum) otherwise creation may fail.
|
||||
* @param svcnum A number (any value, 0 beig the common default) to differentiate multiple instances of services with the same name.
|
||||
* @param svcsys A boolean that if true, specifies to create a system-wide service all users can connect to, otherwise the service is private to the user ide that created the service.
|
||||
* @param svcnum A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name.
|
||||
* @param svcsys A boolean that if true, specifies to create a system-wide service all users can connect to, otherwise the service is private to the user id that created the service.
|
||||
* @return If socket creation is successful
|
||||
*/
|
||||
EAPI Eina_Bool elm_win_socket_listen(Evas_Object *obj, const char *svcname, int svcnum, Eina_Bool svcsys);
|
||||
|
|
Loading…
Reference in New Issue