forked from enlightenment/efl
Label: migrate docs.
This commit is contained in:
parent
4b9f1ebedd
commit
0cca6007f9
|
@ -13,186 +13,109 @@ class Elm.Label (Elm.Layout)
|
|||
eo_prefix: elm_obj_label;
|
||||
methods {
|
||||
@property wrap_width {
|
||||
[[Control wrap width of the label
|
||||
|
||||
This function sets the maximum width size hint of the label.
|
||||
|
||||
Warning: This is only relevant if the label is inside a container.]]
|
||||
set {
|
||||
/*@
|
||||
@brief Set wrap width of the label
|
||||
|
||||
This function sets the maximum width size hint of the label.
|
||||
|
||||
@warning This is only relevant if the label is inside a container.
|
||||
|
||||
@ingroup Label */
|
||||
}
|
||||
get {
|
||||
/*@
|
||||
@brief Get wrap width of the label
|
||||
|
||||
@return The wrap width in pixels at a minimum where words need to wrap
|
||||
|
||||
@see elm_label_wrap_width_set()
|
||||
|
||||
@ingroup Label */
|
||||
}
|
||||
values {
|
||||
w: Evas.Coord; /*@ The wrap width in pixels at a minimum where words need to wrap */
|
||||
w: Evas.Coord; [[The wrap width in pixels at a minimum where words need to wrap]]
|
||||
}
|
||||
}
|
||||
@property slide_speed {
|
||||
[[Control the slide speed of the label
|
||||
|
||||
Note: If you set the duration of the slide using @.slide_duration.set
|
||||
you cannot get the correct speed using this function until the label
|
||||
is actually rendered and resized.
|
||||
|
||||
See @.slide_duration.set]]
|
||||
set {
|
||||
/*@
|
||||
@brief Set the slide speed of the label
|
||||
|
||||
@see elm_label_slide_duration_set()
|
||||
|
||||
@ingroup Label */
|
||||
}
|
||||
get {
|
||||
/*@
|
||||
@brief Get the slide speed of the label
|
||||
|
||||
@return The slide animation speed in px per seconds
|
||||
|
||||
@note If you set the duration of the slide using elm_label_slide_duration_set()
|
||||
you cannot get the correct speed using this function until the label
|
||||
is actually rendered and resized.
|
||||
|
||||
@see elm_label_slide_speed_set()
|
||||
|
||||
@ingroup Label */
|
||||
}
|
||||
values {
|
||||
speed: double; /*@ The speed of the slide animation in px per seconds */
|
||||
speed: double; [[The speed of the slide animation in px per seconds]]
|
||||
}
|
||||
}
|
||||
@property slide_mode {
|
||||
[[Control the slide mode of the label widget.
|
||||
|
||||
By default, slide mode is none. Possible values for $mode are:
|
||||
@Elm.Label.Slide_Mode.none - no slide effect
|
||||
@Elm.Label.Slide_Mode.auto - slide only if the label area is bigger than
|
||||
the text width length
|
||||
@Elm.Label.Slide_Mode.always - slide always
|
||||
|
||||
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
|
||||
if the line wrap(elm_label_line_wrap_set()) or
|
||||
ellipsis(elm_label_ellipsis_set()) is set.
|
||||
|
||||
@since 1.8]]
|
||||
set {
|
||||
/*@
|
||||
@brief Set the slide mode of the label widget.
|
||||
|
||||
elm_label_slide_mode_set() changes label slide mode.
|
||||
By default, slide mode is none. Possible values for $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
|
||||
the text width length
|
||||
@li #ELM_LABEL_SLIDE_MODE_ALWAYS -slide always
|
||||
|
||||
@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
|
||||
if the line wrap(elm_label_line_wrap_set()) or
|
||||
ellipsis(elm_label_ellipsis_set()) is set.
|
||||
|
||||
@see elm_label_slide_mode_get().
|
||||
@since 1.8
|
||||
|
||||
@ingroup Label */
|
||||
}
|
||||
get {
|
||||
/*@
|
||||
@brief Get the slide mode of the label widget.
|
||||
|
||||
@return The slide mode
|
||||
|
||||
@see elm_label_slide_mode_set()
|
||||
@since 1.8
|
||||
|
||||
@ingroup Label */
|
||||
}
|
||||
values {
|
||||
mode: Elm.Label.Slide_Mode; /*@ The slide mode */
|
||||
mode: Elm.Label.Slide_Mode; [[The slide mode]]
|
||||
}
|
||||
}
|
||||
@property slide_duration {
|
||||
[[Control the slide duration of the label
|
||||
|
||||
Note: If you set the speed of the slide using @.slide_speed.set
|
||||
you cannot get the correct duration using this function until the label
|
||||
is actually rendered and resized.]]
|
||||
set {
|
||||
/*@
|
||||
@brief Set the slide duration of the label
|
||||
|
||||
@see elm_label_slide_speed_set()
|
||||
|
||||
@ingroup Label */
|
||||
}
|
||||
get {
|
||||
/*@
|
||||
@brief Get the slide duration of the label
|
||||
|
||||
@return The duration time in moving text from slide begin position to slide end position
|
||||
|
||||
@note If you set the speed of the slide using elm_label_slide_speed_set()
|
||||
you cannot get the correct duration using this function until the label
|
||||
is actually rendered and resized.
|
||||
|
||||
@see elm_label_slide_duration_set()
|
||||
|
||||
@ingroup Label */
|
||||
}
|
||||
values {
|
||||
duration: double; /*@ The duration in seconds in moving text from slide begin position
|
||||
to slide end position */
|
||||
duration: double; [[The duration in seconds in moving text from slide begin position to slide end position]]
|
||||
}
|
||||
}
|
||||
@property line_wrap {
|
||||
[[Control the wrapping behavior of the label
|
||||
|
||||
By default no wrapping is done. Possible values for $wrap are:
|
||||
$ELM_WRAP_NONE - No wrapping
|
||||
$ELM_WRAP_CHAR - wrap between characters
|
||||
$ELM_WRAP_WORD - wrap between words
|
||||
$ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap]]
|
||||
set {
|
||||
/*@
|
||||
@brief Set the wrapping behavior of the label
|
||||
|
||||
By default no wrapping is done. Possible values for $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
|
||||
|
||||
@ingroup Label */
|
||||
}
|
||||
get {
|
||||
/*@
|
||||
@brief Get the wrapping behavior of the label
|
||||
|
||||
@return Wrap type
|
||||
|
||||
@see elm_label_line_wrap_set()
|
||||
|
||||
@ingroup Label */
|
||||
}
|
||||
values {
|
||||
wrap: Elm.Wrap.Type; /*@ To wrap text or not */
|
||||
wrap: Elm.Wrap.Type; [[To wrap text or not]]
|
||||
}
|
||||
}
|
||||
@property ellipsis {
|
||||
[[Control the ellipsis behavior of the label
|
||||
|
||||
If set to true and the text doesn't fit in the label an ellipsis("...")
|
||||
will be shown at the end of the widget.
|
||||
|
||||
Warning This doesn't work with slide(elm_label_slide_set()) or if the
|
||||
chosen wrap method was $ELM_WRAP_WORD.]]
|
||||
set {
|
||||
/*@
|
||||
@brief Set the ellipsis behavior of the label
|
||||
|
||||
If set to true and the text doesn't fit in the label an ellipsis("...")
|
||||
will be shown at the end of the widget.
|
||||
|
||||
@warning This doesn't work with slide(elm_label_slide_set()) or if the
|
||||
chosen wrap method was #ELM_WRAP_WORD.
|
||||
|
||||
@ingroup Label */
|
||||
}
|
||||
get {
|
||||
/*@
|
||||
@brief Get the ellipsis behavior of the label
|
||||
|
||||
@return If true, an ellipsis will be shown at the end of the label area.
|
||||
|
||||
@see elm_label_ellipsis_set()
|
||||
|
||||
@ingroup Label */
|
||||
}
|
||||
values {
|
||||
ellipsis: bool; /*@ To ellipsis text or not */
|
||||
ellipsis: bool; [[To ellipsis text or not]]
|
||||
}
|
||||
}
|
||||
slide_go {
|
||||
/*@
|
||||
@brief Start slide effect.
|
||||
|
||||
@see elm_label_slide_mode_set()
|
||||
@since 1.8
|
||||
|
||||
@ingroup Label */
|
||||
[[Start slide effect.
|
||||
|
||||
See @.slide_mode.set.]]
|
||||
}
|
||||
}
|
||||
implements {
|
||||
|
|
Loading…
Reference in New Issue