forked from enlightenment/efl
doc: add missing parameters and fix references for some elm widgets
This commit is contained in:
parent
4642fe2f64
commit
0258ac77b0
|
@ -15,11 +15,11 @@
|
|||
* This is a push-button. Press it and run some function. It can contain
|
||||
* a simple label and icon object and it also has an autorepeat feature.
|
||||
*
|
||||
* This widget inherits from the @ref Layout one, so that all the
|
||||
* This widget inherits from the @ref Elm_Layout one, so that all the
|
||||
* functions acting on it also work for button objects.
|
||||
*
|
||||
* This widget emits the following signals, besides the ones sent from
|
||||
* @ref Layout:
|
||||
* @ref Elm_Layout :
|
||||
* @li "clicked": the user clicked the button (press/release).
|
||||
* @li "repeated": the user pressed the button without releasing it.
|
||||
* @li "pressed": button was pressed.
|
||||
|
@ -34,11 +34,11 @@
|
|||
* @li default: a normal button.
|
||||
* @li anchor: Like default, but the button fades away when the mouse is not
|
||||
* over it, leaving only the text or icon.
|
||||
* @li hoversel_vertical: Internally used by @ref Hoversel to give a
|
||||
* @li hoversel_vertical: Internally used by @ref Elm_Hoversel to give a
|
||||
* continuous look across its options.
|
||||
* @li hoversel_vertical_entry: Another internal for @ref Hoversel.
|
||||
* @li naviframe: Internally used by @ref Naviframe for its back button.
|
||||
* @li colorselector: Internally used by @ref Colorselector
|
||||
* @li hoversel_vertical_entry: Another internal for @ref Elm_Hoversel.
|
||||
* @li naviframe: Internally used by @ref Elm_Naviframe for its back button.
|
||||
* @li colorselector: Internally used by @ref Elm_Colorselector
|
||||
* for its left and right buttons.
|
||||
*
|
||||
* Default content parts of the button widget that you can use for are:
|
||||
|
|
|
@ -17,11 +17,11 @@
|
|||
* - setting the day names of the week (e.g. "Thu" or "Thursday")
|
||||
* - setting the year and month format.
|
||||
*
|
||||
* This widget inherits from the @ref Layout one, so that all the
|
||||
* This widget inherits from the @ref Elm_Layout one, so that all the
|
||||
* functions acting on it also work for calendar objects.
|
||||
*
|
||||
* This widget emits the following signals, besides the ones sent from
|
||||
* @ref Layout:
|
||||
* @ref Elm_Layout :
|
||||
* - @c "changed" - emitted when the date in the calendar is changed.
|
||||
* - @c "display,changed" - emitted when the current month displayed in the
|
||||
* calendar is changed.
|
||||
|
|
|
@ -23,11 +23,11 @@
|
|||
* like the radio objects, you can set a pointer to a boolean directly
|
||||
* with elm_check_state_pointer_set() for it to modify.
|
||||
*
|
||||
* This widget inherits from the @ref Layout one, so that all the
|
||||
* This widget inherits from the @ref Elm_Layout one, so that all the
|
||||
* functions acting on it also work for check objects.
|
||||
*
|
||||
* This widget emits the following signals, besides the ones sent from
|
||||
* @ref Layout:
|
||||
* @ref Elm_Layout :
|
||||
* - @c "changed" - This is called whenever the user changes the state of
|
||||
* the check objects (@p event_info is always @c NULL).
|
||||
* - @c "focused" - When the check has received focus. (since 1.8)
|
||||
|
|
|
@ -15,11 +15,11 @@
|
|||
* can be picked by user from the color set by clicking on individual
|
||||
* color item on the palette or by selecting it from selector.
|
||||
*
|
||||
* This widget inherits from the @ref Layout one, so that all the
|
||||
* This widget inherits from the @ref Elm_Layout one, so that all the
|
||||
* functions acting on it also work for check objects.
|
||||
*
|
||||
* This widget emits the following signals, besides the ones sent from
|
||||
* @ref Layout:
|
||||
* @ref Elm_Layout :
|
||||
* - @c "changed" - When the color value changes on selector
|
||||
* event_info is NULL.
|
||||
* - @c "color,item,selected" - When user clicks on color item. The
|
||||
|
|
|
@ -301,6 +301,9 @@ EAPI void elm_config_scroll_page_scroll_friction_set(double friction);
|
|||
* Get enable status of context menu disabled.
|
||||
*
|
||||
* @see elm_config_context_menu_disabled_set()
|
||||
*
|
||||
* @return @c EINA_TRUE if context menu is disabled, otherwise @c EINA_FALSE.
|
||||
*
|
||||
* @ingroup Elm_Entry
|
||||
* @since 1.17
|
||||
*/
|
||||
|
|
|
@ -19,11 +19,11 @@
|
|||
* space required for such stuff, and when they popup, as a keyboard
|
||||
* shows when an entry is selected, conformant content won't change.
|
||||
*
|
||||
* This widget inherits from the @ref Layout one, so that all the
|
||||
* This widget inherits from the @ref Elm_Layout one, so that all the
|
||||
* functions acting on it also work for conformant objects.
|
||||
*
|
||||
* This widget emits the following signals, besides the ones sent from
|
||||
* @ref Layout:
|
||||
* @ref Elm_Layout :
|
||||
* @li "virtualkeypad,state,on": if virtualkeypad state is switched to "on".
|
||||
* (since 1.8)
|
||||
* @li "virtualkeypad,state,off": if virtualkeypad state is switched to "off".
|
||||
|
|
|
@ -27,12 +27,12 @@
|
|||
* elm_entry_markup_filter_append() and related functions, inline "items" and
|
||||
* formatted markup text.
|
||||
*
|
||||
* This widget inherits from the @ref Layout one, so that all the
|
||||
* This widget inherits from the @ref Elm_Layout one, so that all the
|
||||
* functions acting on it also work for entry objects (since 1.8).
|
||||
*
|
||||
* This widget implements the @b @ref elm-scrollable-interface
|
||||
* interface, so that all (non-deprecated) functions for the base
|
||||
* @ref Scroller widget also work for entries (since 1.8).
|
||||
* @ref Elm_Scroller widget also work for entries (since 1.8).
|
||||
*
|
||||
* Some calls on the entry's API are marked as @b deprecated, as they
|
||||
* just wrap the scrollable widgets counterpart functions. Use the
|
||||
|
@ -231,7 +231,7 @@
|
|||
* @section entry-signals Emitted signals
|
||||
*
|
||||
* This widget emits the following signals, besides the ones sent from
|
||||
* @ref Layout:
|
||||
* @ref Elm_Layout :
|
||||
* @li "aborted": The escape key was pressed on a single line entry. (since 1.7)
|
||||
* @li "activated": The enter key was pressed on a single line entry.
|
||||
* @li "anchor,clicked": An anchor has been clicked. The event_info
|
||||
|
|
|
@ -53,6 +53,7 @@ EAPI const char *elm_entry_entry_get(const Evas_Object *obj);
|
|||
*
|
||||
* @ingroup Elm_Entry
|
||||
*
|
||||
* @param[in] obj The entry object
|
||||
* @param[in] file The path to the file to load and save
|
||||
* @param[in] format The file format
|
||||
*/
|
||||
|
@ -67,6 +68,7 @@ EAPI Eina_Bool elm_entry_file_set(Evas_Object *obj, const char *file, E
|
|||
*
|
||||
* @ingroup Elm_Entry
|
||||
*
|
||||
* @param[in] obj The entry object
|
||||
* @param[out] file The path to the file to load and save
|
||||
* @param[out] format The file format
|
||||
*/
|
||||
|
|
|
@ -21,7 +21,7 @@
|
|||
* the Edje documentation and the EDC reference to get more
|
||||
* information about what can be done with Edje.
|
||||
*
|
||||
* Just like @ref List, @ref Box, and other container widgets, any
|
||||
* Just like @ref Elm_List, @ref Elm_Box, and other container widgets, any
|
||||
* object added to the Layout will become its child, meaning that it
|
||||
* will be deleted if the Layout is deleted, moved if the Layout is
|
||||
* moved, and so on.
|
||||
|
@ -68,7 +68,7 @@
|
|||
*
|
||||
* @section secBox Box (@c BOX part)
|
||||
*
|
||||
* An Edje @c BOX part is very similar to the Elementary @ref Box
|
||||
* An Edje @c BOX part is very similar to the Elementary @ref Elm_Box
|
||||
* widget. It allows one to add objects to the box and have them
|
||||
* distributed along its area, accordingly to the specified @c layout
|
||||
* property (now by @c layout we mean the chosen layouting design of
|
||||
|
@ -76,14 +76,14 @@
|
|||
*
|
||||
* A similar effect for having a box with its position, size and other
|
||||
* things controlled by the layout theme would be to create an
|
||||
* Elementary @ref Box widget and add it as content in a @c SWALLOW part.
|
||||
* Elementary @ref Elm_Box widget and add it as content in a @c SWALLOW part.
|
||||
*
|
||||
* The main difference to that, by using the layout box instead, is
|
||||
* that its behavior, like layouting format, padding, align, etc.,
|
||||
* will <b>all be controlled by the theme</b>. This means, for
|
||||
* example, that a signal could be sent to the layout's theme (with
|
||||
* elm_layout_signal_emit()) and the signal be handled by changing the
|
||||
* box's padding, or alignment, or both. Using the Elementary @ref Box
|
||||
* box's padding, or alignment, or both. Using the Elementary @ref Elm_Box
|
||||
* widget is not necessarily harder or easier, it just depends on the
|
||||
* circumstances and requirements.
|
||||
*
|
||||
|
@ -99,14 +99,14 @@
|
|||
* @section secTable Table (@c TABLE part)
|
||||
*
|
||||
* Just like the @ref secBox, the layout table is very similar to the
|
||||
* Elementary @ref Table widget. It allows one to add objects to the
|
||||
* Elementary @ref Elm_Table widget. It allows one to add objects to the
|
||||
* table by specifying the row and column where the object should be
|
||||
* added, and any column or row span, if necessary.
|
||||
*
|
||||
* Again, we could have this design by adding a @ref table widget to a
|
||||
* Again, we could have this design by adding a @ref Elm_Table widget to a
|
||||
* @c SWALLOW part, using elm_layout_content_set(). The same
|
||||
* difference happens here when choosing to use the layout table (a
|
||||
* @c TABLE part) instead of the @ref table in a @c SWALLOW part. It's
|
||||
* @c TABLE part) instead of the @ref Elm_Table in a @c SWALLOW part. It's
|
||||
* just a matter of convenience.
|
||||
*
|
||||
* The layout table can be used through the @c elm_layout_table_* set of
|
||||
|
|
Loading…
Reference in New Issue