diff --git a/src/lib/efl/interfaces/efl_gfx_image.eo b/src/lib/efl/interfaces/efl_gfx_image.eo index 7954ea7b2e..c3d39d8842 100644 --- a/src/lib/efl/interfaces/efl_gfx_image.eo +++ b/src/lib/efl/interfaces/efl_gfx_image.eo @@ -229,27 +229,20 @@ interface @beta Efl.Gfx.Image /* Note: those are obscure features of evas image. Expose in Efl.Gfx.Image? */ @property content_hint { - set { - [[Set the content hint setting of a given image object of the - canvas. + [[Content hint setting for the image. These hints might be used by EFL + to enable optimizations. - This function sets the content hint value of the given image - of the canvas. For example, if you're on the GL engine and - your driver implementation supports it, setting this hint to - #EVAS_IMAGE_CONTENT_HINT_DYNAMIC will make it need zero copies - at texture upload time, which is an "expensive" operation. - ]] + For example, if you're on the GL engine and your driver implementation + supports it, setting this hint to @Efl.Gfx.Image_Content_Hint.dynamic + will make it need zero copies at texture upload time, which is an + "expensive" operation. + ]] + set { } get { - [[Get the content hint setting of a given image object of the - canvas. - - This returns #EVAS_IMAGE_CONTENT_HINT_NONE on error. - ]] } values { - hint: Efl.Gfx.Image_Content_Hint; [[Dynamic or static content hint, - see @Efl.Gfx.Image_Content_Hint]] + hint: Efl.Gfx.Image_Content_Hint; [[Dynamic or static content hint.]] } } @property scale_hint { diff --git a/src/lib/efl/interfaces/efl_ui_scrollbar.eo b/src/lib/efl/interfaces/efl_ui_scrollbar.eo index ff40310f72..6aa71c3d03 100644 --- a/src/lib/efl/interfaces/efl_ui_scrollbar.eo +++ b/src/lib/efl/interfaces/efl_ui_scrollbar.eo @@ -3,10 +3,10 @@ import efl_ui_layout_orientable; enum @beta Efl.Ui.Scrollbar_Mode { [[When should the scrollbar be shown.]] - auto = 0, [[Visible if necessary]] - on, [[Always visible]] - off, [[Always invisible]] - last [[For internal use only]] + auto = 0, [[Visible if necessary.]] + on, [[Always visible.]] + off, [[Always invisible.]] + last [[For internal use only.]] } interface @beta Efl.Ui.Scrollbar diff --git a/src/lib/efl/interfaces/efl_ui_zoom.eo b/src/lib/efl/interfaces/efl_ui_zoom.eo index 9cf90d6ea5..390b9372af 100644 --- a/src/lib/efl/interfaces/efl_ui_zoom.eo +++ b/src/lib/efl/interfaces/efl_ui_zoom.eo @@ -1,11 +1,11 @@ enum @beta Efl.Ui.Zoom_Mode { [[Types of zoom available.]] - manual = 0, [[Zoom controlled normally by efl_ui_zoom_set]] - auto_fit, [[Zoom until photo fits in zoomable object]] - auto_fill, [[Zoom until photo fills zoomable object]] - auto_fit_in, [[Zoom in until photo fits in zoomable object]] - last [[Sentinel value to indicate last enum field during iteration]] + manual = 0, [[Zoom controlled manually by @Efl.Ui.Zoom.zoom_level.]] + auto_fit, [[Zoom until whole image fits inside object. Parts of the object might be left blank.]] + auto_fill, [[Zoom until image fills the object. Parts of the image might not show.]] + auto_fit_in, [[Zoom in until image fits inside object.]] + last [[Internal. Sentinel value to indicate last enum field during iteration.]] } interface @beta Efl.Ui.Zoom @@ -27,55 +27,44 @@ interface @beta Efl.Ui.Zoom } } @property zoom_level { - set { - [[Set the zoom level of the photo + [[Zoom level of the image. - This sets the zoom level. If $zoom is 1, it means no zoom. If - it's smaller than 1, it means zoom in. If it's bigger than 1, - it means zoom out. For example, $zoom 1 will be 1:1 pixel for - pixel. $zoom 2 will be 2:1 (that is 2x2 photo pixels will - display as 1 on-screen pixel) which is a zoom out. 4:1 will - be 4x4 photo pixels as 1 screen pixel, and so on. The $zoom - parameter must be greater than 0. It is suggested to stick - to powers of 2. (1, 2, 4, 8, 16, 32, etc.). - ]] + This selects the zoom level. If $zoom is 1, it means no zoom. If + it's smaller than 1, it means zoom in. If it's bigger than 1, + it means zoom out. For example, $zoom 1 will be 1:1 pixel for + pixel. $zoom 2 will be 2:1 (that is 2x2 photo pixels will + display as 1 on-screen pixel) which is a zoom out. 4:1 will + be 4x4 photo pixels as 1 screen pixel, and so on. The $zoom + parameter must be greater than 0. It is suggested to stick + to powers of 2. (1, 2, 4, 8, 16, 32, etc.). + + Note that if you set @.zoom_mode to anything other than + @Efl.Ui.Zoom_Mode.manual (which is the default value) the + @.zoom_level might be changed at any time by the zoomable + object itself to account for image and viewport size changes. + ]] + set { } get { - [[Get the zoom level of the photo - - This returns the current zoom level of the zoomable object. - Note that if you set the fill mode to other than - #EFL_UI_ZOOM_MODE_MANUAL (which is the default), the - zoom level may be changed at any time by the zoomable object - itself to account for photo size and zoomable viewport size. - ]] } values { - zoom: double; [[The zoom level to set]] + zoom: double; [[The image's current zoom level.]] } } @property zoom_mode { + [[Zoom mode. + + This sets the zoom mode to manual or one of several automatic + levels. @Efl.Ui.Zoom_Mode.manual means that zoom is controlled + manually by @.zoom_level 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 zoomable object + to automatically adjust zoom mode based on image and viewport + size changes. + ]] set { - [[Set the zoom mode - - This sets the zoom mode to manual or one of several automatic - levels. Manual (EFL_UI_ZOOM_MODE_MANUAL) means that zoom - is set manually by @.zoom_level.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 zoomable object - to automatically adjust zoom mode based on properties. - - #EFL_UI_ZOOM_MODE_AUTO_FIT) will adjust zoom so the photo - fits EXACTLY inside the scroll frame with no pixels outside this - region. #EFL_UI_ZOOM_MODE_AUTO_FILL will be similar but - ensure no pixels within the frame are left unfilled. - ]] } get { - [[Get the zoom mode - - This gets the current zoom mode of the zoomable object. - ]] } values { mode: Efl.Ui.Zoom_Mode; [[The zoom mode.]] diff --git a/src/lib/elementary/efl_ui_clock.eo b/src/lib/elementary/efl_ui_clock.eo index 6b92a3cf67..a24e6eadab 100644 --- a/src/lib/elementary/efl_ui_clock.eo +++ b/src/lib/elementary/efl_ui_clock.eo @@ -130,6 +130,9 @@ class @beta Efl.Ui.Clock extends Efl.Ui.Layout_Base Hour: default value will be in terms of 24 hr format (0~23) Minute: default value range is from 0 to 59. + + Compare with @.field_limit which allows setting limits to each + individual time field. ]] values { mintime: Efl.Time; [[Time structure containing the minimum time value.]] @@ -150,6 +153,9 @@ class @beta Efl.Ui.Clock extends Efl.Ui.Layout_Base Hour: default value will be in terms of 24 hr format (0~23) Minute: default value range is from 0 to 59. + + Compare with @.field_limit which allows setting limits to each + individual time field. ]] values { maxtime: Efl.Time; [[Time structure containing the maximum time value.]] @@ -176,48 +182,52 @@ class @beta Efl.Ui.Clock extends Efl.Ui.Layout_Base } } @property field_visible { - [[ The field to be visible/not.]] + [[Visibility of each field. + + Allows, for example, hiding the year field by setting + @Efl.Ui.Clock_Type.year's visibility to $false. + + Setting this API to $true in itself doesn't ensure that the field is + visible. The field's format also must be present in the overall clock + format. If a field's visibility is set to $false then it won't appear + even though its format is present. In summary, if this API is set to + true and the corresponding field's format is present in clock format, + the field is visible. + + By default the field visibility is set to $true. + ]] set{} get{} keys { - fieldtype: Efl.Ui.Clock_Type; [[Type of the field. #EFL_UI_CLOCK_TYPE_YEAR etc.]] + fieldtype: Efl.Ui.Clock_Type; [[Type of the field.]] } values { visible: bool; [[$true field can be visible, $false otherwise.]] } } @property field_limit { + [[Numerical limits of each field. + + Limits can be set to individual fields, independently, except + for the AM/PM field. Any field can display the values only in between + these minimum and maximum limits unless the corresponding time + value is restricted from MinTime to MaxTime. That is, min/max + field limits always work under the limitations of mintime/maxtime. + + There is no provision to set the limits of AM/PM field. + + Compare with @.time_min and @.time_max which set a global limit to + the acceptable dates instead of to each individual field. + ]] set { - [[Set a field to be visible or not. - - Setting this API to $true in itself doen't ensure that the field is - visible. The field's format also must be present - in the overall clock format. If a field's visibility is set - to $false then it won't appear even though its format is - present. In summary, if this API is - set to true and the corresponding field's format is present - in clock format, the field is visible. - - By default the field visibility is set to $true. - ]] } get { - [[ Get the field limits of a field. - - Limits can be set to individual fields, independently, except - for the AM/PM field. Any field can display the values only in between - these minimum and maximum limits unless the corresponding time - value is restricted from MinTime to MaxTime. That is, min/max - field limits always work under the limitations of mintime/maxtime. - - There is no provision to set the limits of AM/PM field. - ]] } keys { - fieldtype: Efl.Ui.Clock_Type; [[Type of the field. #EFL_UI_CLOCK_TYPE_YEAR etc.]] + fieldtype: Efl.Ui.Clock_Type; [[Type of the field.]] } values { - min: int; [[Reference to field's minimum value.]] - max: int; [[Reference to field's maximum value.]] + min: int; [[Acceptable minimum value for this field.]] + max: int; [[Acceptable maximum value for this field.]] } } } diff --git a/src/lib/elementary/efl_ui_flip.eo b/src/lib/elementary/efl_ui_flip.eo index e95d77e889..9545d1f318 100644 --- a/src/lib/elementary/efl_ui_flip.eo +++ b/src/lib/elementary/efl_ui_flip.eo @@ -2,29 +2,46 @@ import efl_ui_layout_orientable; enum @beta Efl.Ui.Flip_Mode { - [[Efl UI flip mode ]] - rotate_y_center_axis, [[Rotate Y center axis flip mode]] - rotate_x_center_axis, [[Rotate X center axis flip mode]] - rotate_xz_center_axis, [[Rotate XZ center axis flip mode]] - rotate_yz_center_axis, [[Rotate YZ center axis flip mode]] - cube_left, [[Cube left flip mode]] - cube_right, [[Cube right flip mode]] - cube_up, [[Cube up flip mode]] - cube_down, [[Cube down flip mode]] - page_left, [[Page left flip mode]] - page_right, [[Page right flip mode]] - page_up, [[Page up flip mode]] - page_down, [[Page down flip mode]] - cross_fade, [[Cross fade flip mode]] + [[Efl UI flip mode used by @Efl.Ui.Flip.go and @Efl.Ui.Flip.go_to.]] + rotate_y_center_axis, [[Rotate Y center axis flip mode: Rotates 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.]] + rotate_x_center_axis, [[Rotate X center axis flip mode: Rotates 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.]] + rotate_xz_center_axis, [[Rotate XZ center axis flip mode: Rotates 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.]] + rotate_yz_center_axis, [[Rotate YZ center axis flip mode: Rotates 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.]] + cube_left, [[Cube left flip mode: Rotates the currently visible content to the left as if + the flip was a cube, the other content is shown as the right face of the cube.]] + cube_right, [[Cube right flip mode: Rotates the currently visible content to the right as if + the flip was a cube, the other content is shown as the left face of the cube.]] + cube_up, [[Cube up flip mode: Rotates the currently visible content up as if the flip was a + cube, the other content is shown as the bottom face of the cube.]] + cube_down, [[Cube down flip mode: Rotates the currently visible content down as if the flip + was a cube, the other content is shown as the upper face of the cube.]] + page_left, [[Page left flip mode: Moves the currently visible content to the left as if the + flip was a book, the other content is shown as the page below that.]] + page_right, [[Page right flip mode: Moves the currently visible content to the right as if + the flip was a book, the other content is shown as the page below it.]] + page_up, [[Page up flip mode: Moves the currently visible content up as if the flip was a + book, the other content is shown as the page below it.]] + page_down, [[Page down flip mode: Moves the currently visible content down as if the flip + was a book, the other content is shown as the page below that.]] + cross_fade, [[Cross fade flip mode: Fades out the currently visible content, while fading in + the invisible content.]] } enum @beta Efl.Ui.Flip_Interaction { - [[Efl UI flip interaction]] - none, [[No interaction]] - rotate, [[Rotate interaction]] - cube, [[Cube interaction]] - page [[Page interaction]] + [[Efl UI flip interaction mode used by @Efl.Ui.Flip.interaction.]] + none, [[No interaction.]] + rotate, [[Rotate interaction.]] + cube, [[Cube interaction.]] + page [[Page interaction.]] } class @beta Efl.Ui.Flip extends Efl.Ui.Widget implements Efl.Pack_Linear @@ -32,28 +49,28 @@ class @beta Efl.Ui.Flip extends Efl.Ui.Widget implements Efl.Pack_Linear [[Efl UI flip class]] methods { @property interaction { + [[Interactive flip mode. + + This selects if the flip should be interactive (allow user to + click and 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 @.interaction_direction_enabled_set + and @.interaction_direction_hitsize_set. + + The four available modes of interaction are @Efl.Ui.Flip_Interaction.none, + @Efl.Ui.Flip_Interaction.rotate, @Efl.Ui.Flip_Interaction.cube and + @Efl.Ui.Flip_Interaction.page. + + Note: @Efl.Ui.Flip_Interaction.rotate cannot trigger + @Efl.Ui.Flip_Mode.rotate_xz_center_axis or + @Efl.Ui.Flip_Mode.rotate_yz_center_axis animations. These are only + available through the @.go and @.go_to methods. + ]] set { - [[Set the interactive flip mode. - - This sets if the flip should be interactive (allow user to - click and 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 @.interaction_direction_enabled_set - and @.interaction_direction_hitsize_set. - - The four available mode of interaction are - #ELM_FLIP_INTERACTION_NONE, #ELM_FLIP_INTERACTION_ROTATE, - #ELM_FLIP_INTERACTION_CUBE and #ELM_FLIP_INTERACTION_PAGE. - - 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 @.go. - ]] } get { - [[Get the interactive flip mode.]] } values { mode: Efl.Ui.Flip_Interaction; [[The interactive flip mode to use.]] @@ -74,7 +91,7 @@ class @beta Efl.Ui.Flip extends Efl.Ui.Widget implements Efl.Pack_Linear entire flip. There is however a consideration to be made in that the area will never be smaller than the finger size set (as set in your Elementary configuration), and dragging must always start - from the opposite half of the flip (eg. right half of the flip + from the opposite half of the flip (e.g. right half of the flip when dragging to the left). Note: The $dir parameter is not actually related to the direction @@ -128,40 +145,7 @@ class @beta Efl.Ui.Flip extends Efl.Ui.Widget implements Efl.Pack_Linear This effectively hides the currently visible content and shows the hidden one. - There a number of possible animations to use for flipping, - namely #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), - #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), - #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), - #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). - #ELM_FLIP_CUBE_LEFT (rotate the currently visible content to the - left as if the flip was a cube, the other content is shown as the - right face of the cube), #ELM_FLIP_CUBE_RIGHT (rotate the - currently visible content to the right as if the flip was a - cube, the other content is shown as the left face of the cube), - #ELM_FLIP_CUBE_UP (rotate the currently visible content up as if - the flip was a cube, the other content is shown as the bottom face - of the cube), #ELM_FLIP_CUBE_DOWN (rotate the currently visible - content down as if the flip was a cube, the other content is shown - as the upper face of the cube), #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), - #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 it), #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 it), #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) and #ELM_FLIP_CROSS_FADE - (fade out the currently visible content, while fading in the - invisible content). + Compare with @.go_to which only switches sides if necessary. ]] /* FIXME-doc * @image html elm_flip.png @@ -172,44 +156,13 @@ class @beta Efl.Ui.Flip extends Efl.Ui.Widget implements Efl.Pack_Linear } } go_to { - [[Runs the flip animation to front or back. + [[Runs the flip animation to front or back as selected with $front. + If the flip is already showing this side, nothing is done + (Compare with @.go which always switches sides). Flips the front and back contents using the $mode animation. This effectively hides the currently visible content and shows he hidden one. - - There a number of possible animations to use for flipping, - namely #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), - #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), - #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), - #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). - #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), #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), - #ELM_FLIP_CUBE_UP (rotate the currently visible content up as if - the flip was a cube, the other content is shown as the bottom face - of the cube), #ELM_FLIP_CUBE_DOWN (rotate the currently visible - content down as if the flip was a cube, the other content is shown - as the upper face of the cube), #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), - #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 it), #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 it) and #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). ]] /* FIXME-doc * @image html elm_flip.png diff --git a/src/lib/elementary/efl_ui_text.eo b/src/lib/elementary/efl_ui_text.eo index cc948528fc..502a4ee37b 100644 --- a/src/lib/elementary/efl_ui_text.eo +++ b/src/lib/elementary/efl_ui_text.eo @@ -56,8 +56,6 @@ class @beta Efl.Ui.Text extends Efl.Ui.Layout_Base implements Efl.Input.Clickabl [[Control pasting of text and images for the widget. Normally the entry allows both text and images to be pasted. - By setting cnp_mode to be #ELM_CNP_MODE_NO_IMAGE this prevents images from being copied or pasted. - By setting cnp_mode to be #ELM_CNP_MODE_PLAINTEXT this remove all tags in text . Note: This only changes the behaviour of text. ]] diff --git a/src/lib/elementary/elm_interface_scrollable.eo b/src/lib/elementary/elm_interface_scrollable.eo index 92b127cb80..20255addbe 100644 --- a/src/lib/elementary/elm_interface_scrollable.eo +++ b/src/lib/elementary/elm_interface_scrollable.eo @@ -9,10 +9,10 @@ enum Elm.Scroller.Policy See also @Elm.Interface_Scrollable.policy.set. ]] - auto = 0, [[Show scrollbars as needed]] - on, [[Always show scrollbars]] - off, [[Never show scrollbars]] - last [[Sentinel value to indicate last enum field during iteration]] + auto = 0, [[Show scrollbars as needed.]] + on, [[Always show scrollbars.]] + off, [[Never show scrollbars.]] + last [[Internal. Sentinel value to indicate last enum field during iteration.]] } enum Elm.Scroller.Single_Direction @@ -21,10 +21,10 @@ enum Elm.Scroller.Single_Direction See also @Elm.Interface_Scrollable.single_direction.set. ]] - none = 0, [[Scroll every direction]] - soft, [[Scroll single direction if the direction is certain]] - hard, [[Scroll only single direction]] - last [[Sentinel value to indicate last enum field during iteration]] + none = 0, [[Scroll every direction.]] + soft, [[Scroll single direction if the direction is certain.]] + hard, [[Scroll only single direction.]] + last [[Internal. Sentinel value to indicate last enum field during iteration.]] } mixin @beta Elm.Interface_Scrollable requires Efl.Ui.Widget extends Efl.Ui.Scrollable, Efl.Ui.Focus.Manager_Sub, Efl.Ui.Widget_Focus_Manager @@ -113,12 +113,7 @@ mixin @beta Elm.Interface_Scrollable requires Efl.Ui.Widget extends Efl.Ui.Scrol } } @property policy { - [[Scrollbar visibility policy - - #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.]] + [[Scrollbar visibility policy]] set { } get {