kimcinoo
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

elm: Added # for enum in the documenation.

This commit is contained in:
Daniel Juyung Seo 2014-09-01 00:44:10 +09:00
parent ca27474779
commit 9df412f9b8
17 changed files with 103 additions and 103 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
legacy/elementary/src/lib/elm_datetime.eo
View File

@ -102,7 +102,7 @@ class Elm_Datetime (Elm_Layout)
@ingroup Datetime */
params {
@in Elm_Datetime_Field_Type fieldtype; /*@ Type of the field. ELM_DATETIME_YEAR etc. */
@in Elm_Datetime_Field_Type fieldtype; /*@ Type of the field. #ELM_DATETIME_YEAR etc. */
@in int min; /*@ Reference to field's minimum value */
@in int max; /*@ Reference to field's maximum value */
}
@ -121,7 +121,7 @@ class Elm_Datetime (Elm_Layout)
@see elm_datetime_field_limit_set()
@ingroup Datetime */
params {
@in Elm_Datetime_Field_Type fieldtype; /*@ Type of the field. ELM_DATETIME_YEAR etc. */
@in Elm_Datetime_Field_Type fieldtype; /*@ Type of the field. #ELM_DATETIME_YEAR etc. */
@out int min; /*@ Reference to field's minimum value */
@out int max; /*@ Reference to field's maximum value */
}
@ -241,7 +241,7 @@ class Elm_Datetime (Elm_Layout)
@ingroup Datetime */
params {
@in Elm_Datetime_Field_Type fieldtype; /*@ Type of the field. ELM_DATETIME_YEAR etc. */
@in Elm_Datetime_Field_Type fieldtype; /*@ Type of the field. #ELM_DATETIME_YEAR etc. */
@in bool visible; /*@ @c EINA_TRUE field can be visible, @c EINA_FALSE otherwise. */
}
}
@ -255,7 +255,7 @@ class Elm_Datetime (Elm_Layout)
@ingroup Datetime */
return: bool;
params {
@in Elm_Datetime_Field_Type fieldtype; /*@ Type of the field. ELM_DATETIME_YEAR etc */
@in Elm_Datetime_Field_Type fieldtype; /*@ Type of the field. #ELM_DATETIME_YEAR etc */
}
}
value_max_set {

60
legacy/elementary/src/lib/elm_flip.eo
View File

@ -15,13 +15,13 @@ class Elm_Flip (Elm_Container)
and elm_flip_interaction_direction_hitsize_set()
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
@li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
@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
@li #ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
@note ELM_FLIP_INTERACTION_ROTATE won't cause
ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
@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 achieved with elm_flip_go();
@ingroup Flip */
@ -142,37 +142,37 @@ class Elm_Flip (Elm_Container)
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
@li #ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
around a horizontal axis in the middle of its height, the other content
is shown as the other side of the flip.
@li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
@li #ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
around a vertical axis in the middle of its width, the other content is
shown as the other side of the flip.
@li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
@li #ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
around a diagonal axis in the middle of its width, the other content is
shown as the other side of the flip.
@li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
@li #ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
around a diagonal axis in the middle of its height, the other content is
shown as the other side of the flip.
@li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
@li #ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
as if the flip was a cube, the other content is show as the right face of
the cube.
@li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
@li #ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
right as if the flip was a cube, the other content is show as the left
face of the cube.
@li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
@li #ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
flip was a cube, the other content is show as the bottom face of the cube.
@li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
@li #ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
the flip was a cube, the other content is show as the upper face of the
cube.
@li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
@li #ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
if the flip was a book, the other content is shown as the page below that.
@li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
@li #ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
as if the flip was a book, the other content is shown as the page below
that.
@li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
@li #ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
flip was a book, the other content is shown as the page below that.
@li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
@li #ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
flip was a book, the other content is shown as the page below that.
@image html elm_flip.png
@ -194,37 +194,37 @@ class Elm_Flip (Elm_Container)
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
@li #ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
around a horizontal axis in the middle of its height, the other content
is shown as the other side of the flip.
@li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
@li #ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
around a vertical axis in the middle of its width, the other content is
shown as the other side of the flip.
@li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
@li #ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
around a diagonal axis in the middle of its width, the other content is
shown as the other side of the flip.
@li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
@li #ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
around a diagonal axis in the middle of its height, the other content is
shown as the other side of the flip.
@li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
@li #ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
as if the flip was a cube, the other content is show as the right face of
the cube.
@li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
@li #ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
right as if the flip was a cube, the other content is show as the left
face of the cube.
@li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
@li #ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
flip was a cube, the other content is show as the bottom face of the cube.
@li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
@li #ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
the flip was a cube, the other content is show as the upper face of the
cube.
@li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
@li #ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
if the flip was a book, the other content is shown as the page below that.
@li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
@li #ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
as if the flip was a book, the other content is shown as the page below
that.
@li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
@li #ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
flip was a book, the other content is shown as the page below that.
@li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
@li #ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
flip was a book, the other content is shown as the page below that.
@image html elm_flip.png

14
legacy/elementary/src/lib/elm_gengrid.eo
View File

@ -153,12 +153,12 @@ class Elm_Gengrid (Elm_Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
Set the gengrid select mode.
elm_gengrid_select_mode_set() changes item select mode in the gengrid widget.
- ELM_OBJECT_SELECT_MODE_DEFAULT : Items will only call their selection func and
- #ELM_OBJECT_SELECT_MODE_DEFAULT : Items will only call their selection func and
callback when first becoming selected. Any further clicks will
do nothing, unless you set always select mode.
- ELM_OBJECT_SELECT_MODE_ALWAYS : This means that, even if selected,
- #ELM_OBJECT_SELECT_MODE_ALWAYS : This means that, even if selected,
every click will make the selected callbacks be called.
- ELM_OBJECT_SELECT_MODE_NONE : This will turn off the ability to select items
- #ELM_OBJECT_SELECT_MODE_NONE : This will turn off the ability to select items
entirely and they will neither appear selected nor call selected
callback functions.
@ -171,7 +171,7 @@ class Elm_Gengrid (Elm_Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
Get the gengrid select mode.
@return The select mode
(If getting mode is failed, it returns ELM_OBJECT_SELECT_MODE_MAX)
(If getting mode is failed, it returns #ELM_OBJECT_SELECT_MODE_MAX)
@see elm_gengrid_select_mode_set()
@ -265,9 +265,9 @@ class Elm_Gengrid (Elm_Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
/*@
Set the gengrid multi select mode.
- ELM_OBJECT_MULTI_SELECT_MODE_DEFAULT : select/unselect items whenever each
- #ELM_OBJECT_MULTI_SELECT_MODE_DEFAULT : select/unselect items whenever each
item is clicked.
- ELM_OBJECT_MULTI_SELECT_MODE_WITH_CONTROL : Only one item will be selected
- #ELM_OBJECT_MULTI_SELECT_MODE_WITH_CONTROL : Only one item will be selected
although multi-selection is enabled, if clicked without pressing control
key. This mode is only available with multi-selection.
@ -282,7 +282,7 @@ class Elm_Gengrid (Elm_Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
Get the gengrid multi select mode.
@return The multi select mode
(If getting mode is failed, it returns ELM_OBJECT_MULTI_SELECT_MODE_MAX)
(If getting mode is failed, it returns #ELM_OBJECT_MULTI_SELECT_MODE_MAX)
@see elm_gengrid_multi_select_set()
@see elm_gengrid_multi_select_mode_set()

24
legacy/elementary/src/lib/elm_genlist.eo
View File

@ -46,12 +46,12 @@ class Elm_Genlist (Elm_Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
Set the genlist select mode.
elm_genlist_select_mode_set() changes item select mode in the genlist widget.
- ELM_OBJECT_SELECT_MODE_DEFAULT : Items will call their selection func and
- #ELM_OBJECT_SELECT_MODE_DEFAULT : Items will call their selection func and
callback once when first becoming selected. Any further clicks will
do nothing, unless you set always select mode.
- ELM_OBJECT_SELECT_MODE_ALWAYS : This means that, even if selected,
- #ELM_OBJECT_SELECT_MODE_ALWAYS : This means that, even if selected,
every click will make the selected callbacks be called.
- ELM_OBJECT_SELECT_MODE_NONE : This will turn off the ability to select items
- #ELM_OBJECT_SELECT_MODE_NONE : This will turn off the ability to select items
entirely and they will neither appear selected nor call selected
callback functions.
@ -64,7 +64,7 @@ class Elm_Genlist (Elm_Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
Get the genlist select mode.
@return The select mode
(If getting mode is failed, it returns ELM_OBJECT_SELECT_MODE_MAX)
(If getting mode is failed, it returns #ELM_OBJECT_SELECT_MODE_MAX)
@see elm_genlist_select_mode_set()
@ -213,9 +213,9 @@ class Elm_Genlist (Elm_Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
/*@
Set the genlist multi select mode.
- ELM_OBJECT_MULTI_SELECT_MODE_DEFAULT : select/unselect items whenever each
- #ELM_OBJECT_MULTI_SELECT_MODE_DEFAULT : select/unselect items whenever each
item is clicked.
- ELM_OBJECT_MULTI_SELECT_MODE_WITH_CONTROL : Only one item will be selected
- #ELM_OBJECT_MULTI_SELECT_MODE_WITH_CONTROL : Only one item will be selected
although multi-selection is enabled, if clicked without pressing control
key. This mode is only available with multi-selection.
@ -230,7 +230,7 @@ class Elm_Genlist (Elm_Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
Get the genlist multi select mode.
@return The multi select mode
(If getting mode is failed, it returns ELM_OBJECT_MULTI_SELECT_MODE_MAX)
(If getting mode is failed, it returns #ELM_OBJECT_MULTI_SELECT_MODE_MAX)
@see elm_genlist_multi_select_set()
@see elm_genlist_multi_select_mode_set()
@ -336,20 +336,20 @@ class Elm_Genlist (Elm_Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
This sets the mode used for sizing items horizontally. Valid modes
are #ELM_LIST_LIMIT, #ELM_LIST_SCROLL, and #ELM_LIST_COMPRESS. The default is
ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
#ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
the scroller will scroll horizontally. Otherwise items are expanded
to fill the width of the viewport of the scroller. If it is
ELM_LIST_LIMIT, items will be expanded to the viewport width and
limited to that size. If it is ELM_LIST_COMPRESS, the item width will be
#ELM_LIST_LIMIT, items will be expanded to the viewport width and
limited to that size. If it is #ELM_LIST_COMPRESS, the item width will be
fixed (restricted to a minimum of) to the list width when calculating its
size in order to allow the height to be calculated based on it. This allows,
for instance, text block to wrap lines if the Edje part is configured with
"text.min: 0 1".
@note ELM_LIST_COMPRESS will make list resize slower as it will have to
@note #ELM_LIST_COMPRESS will make list resize slower as it will have to
recalculate every item height again whenever the list width
changes!
@note Homogeneous mode is for that all items in the genlist same
width/height. With ELM_LIST_COMPRESS, it makes genlist items to fast
width/height. With #ELM_LIST_COMPRESS, it makes genlist items to fast
initializing. However there's no sub-objects in genlist which can be
on the flying resizable (such as TEXTBLOCK). If then, some dynamic
resizable objects in genlist would not diplayed properly.

10
legacy/elementary/src/lib/elm_glview.eo
View File

@ -15,7 +15,7 @@ class Elm_Glview (Elm_Widget)
Note that this function returns the actual image size of the
glview. This means that when the scale policy is set to
ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
#ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
size.
@ingroup GLView */
@ -30,10 +30,10 @@ class Elm_Glview (Elm_Widget)
/*@
Set the resize policy for the glview object.
By default, the resize policy is set to ELM_GLVIEW_RESIZE_POLICY_RECREATE.
By default, the resize policy is set to #ELM_GLVIEW_RESIZE_POLICY_RECREATE.
When resize is called it destroys the previous surface and recreates the
newly specified size. If the policy is set to
ELM_GLVIEW_RESIZE_POLICY_SCALE, however, glview only scales the image
#ELM_GLVIEW_RESIZE_POLICY_SCALE, however, glview only scales the image
object and not the underlying GL Surface.
@ingroup GLView */
@ -104,10 +104,10 @@ class Elm_Glview (Elm_Widget)
/*@
Set the render policy for the glview object.
By default, the render policy is set to ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.
By default, the render policy is set to #ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.
This policy is set such that during the render loop, glview is only
redrawn if it needs to be redrawn. (i.e. when it is visible) If the policy
is set to ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
is set to #ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
whether it is visible or needs redrawing.
@ingroup GLView */

14
legacy/elementary/src/lib/elm_hover.eo
View File

@ -38,16 +38,16 @@ class Elm_Hover (Elm_Layout, Evas.Clickable_Interface)
space.
@p pref_axis may be one of
- @c ELM_HOVER_AXIS_NONE -- no preferred orientation
- @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
- @c ELM_HOVER_AXIS_VERTICAL -- vertical
- @c ELM_HOVER_AXIS_BOTH -- both
- #ELM_HOVER_AXIS_NONE -- no preferred orientation
- #ELM_HOVER_AXIS_HORIZONTAL -- horizontal
- #ELM_HOVER_AXIS_VERTICAL -- vertical
- #ELM_HOVER_AXIS_BOTH -- both
If ELM_HOVER_AXIS_HORIZONTAL is chosen the returned position will
If #ELM_HOVER_AXIS_HORIZONTAL is chosen the returned position will
necessarily be along the horizontal axis("left" or "right"). If
ELM_HOVER_AXIS_VERTICAL is chosen the returned position will necessarily
#ELM_HOVER_AXIS_VERTICAL is chosen the returned position will necessarily
be along the vertical axis("top" or "bottom"). Choosing
ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
#ELM_HOVER_AXIS_BOTH or #ELM_HOVER_AXIS_NONE has the same effect and the
returned position may be in either axis.
@see elm_object_part_content_set()

4
legacy/elementary/src/lib/elm_icon.eo
View File

@ -25,8 +25,8 @@ class Elm_Icon (Elm_Image)
}
values {
Elm_Icon_Lookup_Order order; /*@ The icon lookup order (can be one of
ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
or ELM_ICON_LOOKUP_THEME) */
#ELM_ICON_LOOKUP_FDO_THEME, #ELM_ICON_LOOKUP_THEME_FDO, #ELM_ICON_LOOKUP_FDO
or #ELM_ICON_LOOKUP_THEME) */
}
}
standard {

18
legacy/elementary/src/lib/elm_label.eo
View File

@ -61,14 +61,14 @@ class Elm_Label (Elm_Layout)
elm_label_slide_mode_set() changes label slide mode.
By default, slide mode is none. Possible values for @p mode are:
@li ELM_LABEL_SLIDE_MODE_NONE - no slide effect
@li ELM_LABEL_SLIDE_MODE_AUTO - slide only if the label area is bigger than
@li #ELM_LABEL_SLIDE_MODE_NONE - no slide effect
@li #ELM_LABEL_SLIDE_MODE_AUTO - slide only if the label area is bigger than
the text width length
@li ELM_LABEL_SLIDE_MODE_ALWAYS -slide always
@li #ELM_LABEL_SLIDE_MODE_ALWAYS -slide always
@warning ELM_LABEL_SLIDE_MODE_AUTO, ELM_LABEL_SLIDE_MODE_ALWAYS only work
@warning #ELM_LABEL_SLIDE_MODE_AUTO, #ELM_LABEL_SLIDE_MODE_ALWAYS only work
with the themes "slide_short", "slide_long" and "slide_bounce".
@warning ELM_LABEL_SLIDE_MODE_AUTO, ELM_LABEL_SLIDE_MODE_ALWAYS don't work
@warning #ELM_LABEL_SLIDE_MODE_AUTO, #ELM_LABEL_SLIDE_MODE_ALWAYS don't work
if the line wrap(elm_label_line_wrap_set()) or
ellipsis(elm_label_ellipsis_set()) is set.
@ -126,10 +126,10 @@ class Elm_Label (Elm_Layout)
@brief Set the wrapping behavior of the label
By default no wrapping is done. Possible values for @p wrap are:
@li ELM_WRAP_NONE - No wrapping
@li ELM_WRAP_CHAR - wrap between characters
@li ELM_WRAP_WORD - wrap between words
@li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
@li #ELM_WRAP_NONE - No wrapping
@li #ELM_WRAP_CHAR - wrap between characters
@li #ELM_WRAP_WORD - wrap between words
@li #ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
@ingroup Label */
}

14
legacy/elementary/src/lib/elm_list.eo
View File

@ -42,12 +42,12 @@ class Elm_List (Elm_Layout, Elm_Interface_Scrollable,
Set the list select mode.
elm_list_select_mode_set() changes item select mode in the list widget.
- ELM_OBJECT_SELECT_MODE_DEFAULT : Items will only call their selection func and
- #ELM_OBJECT_SELECT_MODE_DEFAULT : Items will only call their selection func and
callback when first becoming selected. Any further clicks will
do nothing, unless you set always select mode.
- ELM_OBJECT_SELECT_MODE_ALWAYS : This means that, even if selected,
- #ELM_OBJECT_SELECT_MODE_ALWAYS : This means that, even if selected,
every click will make the selected callbacks be called.
- ELM_OBJECT_SELECT_MODE_NONE : This will turn off the ability to select items
- #ELM_OBJECT_SELECT_MODE_NONE : This will turn off the ability to select items
entirely and they will neither appear selected nor call selected
callback functions.
@ -60,7 +60,7 @@ class Elm_List (Elm_Layout, Elm_Interface_Scrollable,
Get the list select mode.
@return The select mode
(If getting mode is failed, it returns ELM_OBJECT_SELECT_MODE_MAX)
(If getting mode is failed, it returns #ELM_OBJECT_SELECT_MODE_MAX)
@see elm_list_select_mode_set()
@ -133,9 +133,9 @@ class Elm_List (Elm_Layout, Elm_Interface_Scrollable,
/*@
Set the list multi select mode.
- ELM_OBJECT_MULTI_SELECT_MODE_DEFAULT : select/unselect items whenever each
- #ELM_OBJECT_MULTI_SELECT_MODE_DEFAULT : select/unselect items whenever each
item is clicked.
- ELM_OBJECT_MULTI_SELECT_MODE_WITH_CONTROL : Only one item will be selected
- #ELM_OBJECT_MULTI_SELECT_MODE_WITH_CONTROL : Only one item will be selected
although multi-selection is enabled, if clicked without pressing control
key. This mode is only available with multi-selection.
@ -150,7 +150,7 @@ class Elm_List (Elm_Layout, Elm_Interface_Scrollable,
Get the list multi select mode.
@return The multi select mode
(If getting mode is failed, it returns ELM_OBJECT_MULTI_SELECT_MODE_MAX)
(If getting mode is failed, it returns #ELM_OBJECT_MULTI_SELECT_MODE_MAX)
@see elm_list_multi_select_set()
@see elm_list_multi_select_mode_set()

6
legacy/elementary/src/lib/elm_map.eo
View File

@ -303,17 +303,17 @@ class Elm_Map (Elm_Widget, Elm_Interface_Scrollable,
Map widget retrieves tile images that composes the map from a web service.
This web service can be set with this method
for ELM_MAP_SOURCE_TYPE_TILE type.
for #ELM_MAP_SOURCE_TYPE_TILE type.
A different service can return a different maps with different
information and it can use different zoom values.
Map widget provides route data based on a external web service.
This web service can be set with this method
for ELM_MAP_SOURCE_TYPE_ROUTE type.
for #ELM_MAP_SOURCE_TYPE_ROUTE type.
Map widget also provide geoname data based on a external web service.
This web service can be set with this method
for ELM_MAP_SOURCE_TYPE_NAME type.
for #ELM_MAP_SOURCE_TYPE_NAME type.
The @p source_name need to match one of the names provided by
elm_map_sources_get().

2
legacy/elementary/src/lib/elm_notify.eo
View File

@ -10,7 +10,7 @@ class Elm_Notify (Elm_Container)
Sets the alignment in which the notify will appear in its parent.
@note To fill the notify box in the parent area, please pass the
@c ELM_NOTIFY_ALIGN_FILL to @p horizontal, @p vertical.
#ELM_NOTIFY_ALIGN_FILL to @p horizontal, @p vertical.
@since 1.8
@ingroup Notify */

6
legacy/elementary/src/lib/elm_photocam.eo
View File

@ -110,7 +110,7 @@ class Elm_Photocam (Elm_Widget, Elm_Interface_Scrollable,
@return The current zoom level
This returns the current zoom level of the photocam object. Note that if
you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
you set the fill mode to other than #ELM_PHOTOCAM_ZOOM_MODE_MANUAL
(which is the default), the zoom level may be changed at any time by the
photocam object itself to account for photo size and photocam viewport
size.
@ -134,9 +134,9 @@ class Elm_Photocam (Elm_Widget, Elm_Interface_Scrollable,
elm_photocam_zoom_set() and will stay at that level until changed by code
or until zoom mode is changed. This is the default mode. The Automatic
modes will allow the photocam object to automatically adjust zoom mode
based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
based on properties. #ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
the photo fits EXACTLY inside the scroll frame with no pixels outside this
region. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
region. #ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
pixels within the frame are left unfilled.
@ingroup Photocam */

8
legacy/elementary/src/lib/elm_scroller_legacy.h
View File

@ -49,9 +49,9 @@ EAPI void elm_scroller_region_show(Evas_Object *obj, Ev
* @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
* #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.
*
* @ingroup Scroller
@ -432,7 +432,7 @@ EAPI void elm_scroller_gravity_get(const Evas_Object *o
*
* This function will block scrolling movement (by input of a user) in
* a given direction. One can disable movements in the X axis, the Y
* axis or both. The default value is @c ELM_SCROLLER_MOVEMENT_NO_BLOCK,
* axis or both. The default value is #ELM_SCROLLER_MOVEMENT_NO_BLOCK,
* where movements are allowed in both directions.
*
* What makes this function different from

2
legacy/elementary/src/lib/elm_systray.eo
View File

@ -94,7 +94,7 @@ class Elm_Systray (Eo.Base)
}
methods {
register {
/*@ Register this Status Notifier Item in the System Tray Watcher. This function should only be called after the event ELM_EVENT_SYSTRAY_READY is emitted. */
/*@ Register this Status Notifier Item in the System Tray Watcher. This function should only be called after the event #ELM_EVENT_SYSTRAY_READY is emitted. */
return: bool;
}
}

2
legacy/elementary/src/lib/elm_thumb.eo
View File

@ -68,7 +68,7 @@ class Elm_Thumb (Elm_Layout, Efl.File, Evas.Clickable_Interface)
/*@
Get the animation state for the thumb object.
@return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
@return getting The animation setting or #ELM_THUMB_ANIMATION_LAST,
on errors.
@see elm_thumb_animate_set()

10
legacy/elementary/src/lib/elm_toolbar.eo
View File

@ -66,12 +66,12 @@ class Elm_Toolbar (Elm_Widget, Elm_Interface_Scrollable,
Set the toolbar select mode.
elm_toolbar_select_mode_set() changes item select mode in the toolbar widget.
- ELM_OBJECT_SELECT_MODE_DEFAULT : Items will only call their selection func and
- #ELM_OBJECT_SELECT_MODE_DEFAULT : Items will only call their selection func and
callback when first becoming selected. Any further clicks will
do nothing, unless you set always select mode.
- ELM_OBJECT_SELECT_MODE_ALWAYS : This means that, even if selected,
- #ELM_OBJECT_SELECT_MODE_ALWAYS : This means that, even if selected,
every click will make the selected callbacks be called.
- ELM_OBJECT_SELECT_MODE_NONE : This will turn off the ability to select items
- #ELM_OBJECT_SELECT_MODE_NONE : This will turn off the ability to select items
entirely and they will neither appear selected nor call selected
callback functions.
@ -84,7 +84,7 @@ class Elm_Toolbar (Elm_Widget, Elm_Interface_Scrollable,
Get the toolbar select mode.
@return The select mode
(If getting mode is failed, it returns ELM_OBJECT_SELECT_MODE_MAX)
(If getting mode is failed, it returns #ELM_OBJECT_SELECT_MODE_MAX)
@see elm_toolbar_select_mode_set()
@ -290,7 +290,7 @@ class Elm_Toolbar (Elm_Widget, Elm_Interface_Scrollable,
@return The toolbar more item.
Toolbar generates 'more' item when there is no more space to fit items in
and toolbar is in ELM_TOOLBAR_SHRINK_MENU or ELM_TOOLBAR_SHRINK_EXPAND mode.
and toolbar is in #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_EXPAND mode.
The more item can be manipulated by elm_object_item_text_set() and
elm_object_item_content_set.

4
legacy/elementary/src/lib/elm_win.eo
View File

@ -1118,7 +1118,7 @@ class Elm_Win (Elm_Widget, Elm_Interface_Atspi_Window,
/*@
Get the inlined image object handle
When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
When you create a window with elm_win_add() of type #ELM_WIN_INLINED_IMAGE,
then the window is in fact an evas image object inlined in the parent
canvas. You can get this object (be careful to not manipulate it as it
is under control of elementary), and use it to do things like get pixel
@ -1135,7 +1135,7 @@ class Elm_Win (Elm_Widget, Elm_Interface_Atspi_Window,
/*@
Get the type of a window.
@return The type of a window object. If the object is not window object, return ELM_WIN_UNKNOWN.
@return The type of a window object. If the object is not window object, return #ELM_WIN_UNKNOWN.
@ingroup Win */
return: Elm_Win_Type;