summaryrefslogtreecommitdiff
path: root/src/lib/efl/interfaces/efl_ui_zoom.eo
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-09-02 11:57:27 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2019-09-02 11:57:27 +0200
commitc7c535cee8c4a24bf913bd9403f01bbf095bb1df (patch)
treed3e45424eb7aede58d318bef6b4a832802ad9a93 /src/lib/efl/interfaces/efl_ui_zoom.eo
parentbf58531dbaacb9ff78583278b04785e85a4c34cd (diff)
docs: Switch remaining #doxygen-style refs to @eo-style
Diffstat (limited to '')
-rw-r--r--src/lib/efl/interfaces/efl_ui_zoom.eo75
1 files changed, 32 insertions, 43 deletions
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 @@
1enum @beta Efl.Ui.Zoom_Mode 1enum @beta Efl.Ui.Zoom_Mode
2{ 2{
3 [[Types of zoom available.]] 3 [[Types of zoom available.]]
4 manual = 0, [[Zoom controlled normally by efl_ui_zoom_set]] 4 manual = 0, [[Zoom controlled manually by @Efl.Ui.Zoom.zoom_level.]]
5 auto_fit, [[Zoom until photo fits in zoomable object]] 5 auto_fit, [[Zoom until whole image fits inside object. Parts of the object might be left blank.]]
6 auto_fill, [[Zoom until photo fills zoomable object]] 6 auto_fill, [[Zoom until image fills the object. Parts of the image might not show.]]
7 auto_fit_in, [[Zoom in until photo fits in zoomable object]] 7 auto_fit_in, [[Zoom in until image fits inside object.]]
8 last [[Sentinel value to indicate last enum field during iteration]] 8 last [[Internal. Sentinel value to indicate last enum field during iteration.]]
9} 9}
10 10
11interface @beta Efl.Ui.Zoom 11interface @beta Efl.Ui.Zoom
@@ -27,55 +27,44 @@ interface @beta Efl.Ui.Zoom
27 } 27 }
28 } 28 }
29 @property zoom_level { 29 @property zoom_level {
30 set { 30 [[Zoom level of the image.
31 [[Set the zoom level of the photo 31
32 This selects the zoom level. If $zoom is 1, it means no zoom. If
33 it's smaller than 1, it means zoom in. If it's bigger than 1,
34 it means zoom out. For example, $zoom 1 will be 1:1 pixel for
35 pixel. $zoom 2 will be 2:1 (that is 2x2 photo pixels will
36 display as 1 on-screen pixel) which is a zoom out. 4:1 will
37 be 4x4 photo pixels as 1 screen pixel, and so on. The $zoom
38 parameter must be greater than 0. It is suggested to stick
39 to powers of 2. (1, 2, 4, 8, 16, 32, etc.).
32 40
33 This sets the zoom level. If $zoom is 1, it means no zoom. If 41 Note that if you set @.zoom_mode to anything other than
34 it's smaller than 1, it means zoom in. If it's bigger than 1, 42 @Efl.Ui.Zoom_Mode.manual (which is the default value) the
35 it means zoom out. For example, $zoom 1 will be 1:1 pixel for 43 @.zoom_level might be changed at any time by the zoomable
36 pixel. $zoom 2 will be 2:1 (that is 2x2 photo pixels will 44 object itself to account for image and viewport size changes.
37 display as 1 on-screen pixel) which is a zoom out. 4:1 will 45 ]]
38 be 4x4 photo pixels as 1 screen pixel, and so on. The $zoom 46 set {
39 parameter must be greater than 0. It is suggested to stick
40 to powers of 2. (1, 2, 4, 8, 16, 32, etc.).
41 ]]
42 } 47 }
43 get { 48 get {
44 [[Get the zoom level of the photo
45
46 This returns the current zoom level of the zoomable object.
47 Note that if you set the fill mode to other than
48 #EFL_UI_ZOOM_MODE_MANUAL (which is the default), the
49 zoom level may be changed at any time by the zoomable object
50 itself to account for photo size and zoomable viewport size.
51 ]]
52 } 49 }
53 values { 50 values {
54 zoom: double; [[The zoom level to set]] 51 zoom: double; [[The image's current zoom level.]]
55 } 52 }
56 } 53 }
57 @property zoom_mode { 54 @property zoom_mode {
58 set { 55 [[Zoom mode.
59 [[Set the zoom mode
60
61 This sets the zoom mode to manual or one of several automatic
62 levels. Manual (EFL_UI_ZOOM_MODE_MANUAL) means that zoom
63 is set manually by @.zoom_level.set and will stay at that level until
64 changed by code or until zoom mode is changed. This is the
65 default mode. The Automatic modes will allow the zoomable object
66 to automatically adjust zoom mode based on properties.
67 56
68 #EFL_UI_ZOOM_MODE_AUTO_FIT) will adjust zoom so the photo 57 This sets the zoom mode to manual or one of several automatic
69 fits EXACTLY inside the scroll frame with no pixels outside this 58 levels. @Efl.Ui.Zoom_Mode.manual means that zoom is controlled
70 region. #EFL_UI_ZOOM_MODE_AUTO_FILL will be similar but 59 manually by @.zoom_level and will stay at that level until
71 ensure no pixels within the frame are left unfilled. 60 changed by code or until @.zoom_mode is changed. This is the
72 ]] 61 default mode. The Automatic modes will allow the zoomable object
62 to automatically adjust zoom mode based on image and viewport
63 size changes.
64 ]]
65 set {
73 } 66 }
74 get { 67 get {
75 [[Get the zoom mode
76
77 This gets the current zoom mode of the zoomable object.
78 ]]
79 } 68 }
80 values { 69 values {
81 mode: Efl.Ui.Zoom_Mode; [[The zoom mode.]] 70 mode: Efl.Ui.Zoom_Mode; [[The zoom mode.]]