efl_text_properties: convert docs

This commit is contained in:
Daniel Kolesa 2015-06-16 15:28:24 +01:00
parent 53e630b3ca
commit 56120b79f2
1 changed files with 30 additions and 31 deletions

View File

@ -5,56 +5,55 @@ interface Efl.Text_Properties {
methods {
@property font {
set {
/*@
Set the font family or filename, and size on a given text object.
[[Set the font family or filename, and size on a given text object.
This function allows the font name and size of a text object to be
set. The @p font string has to follow fontconfig's convention on
naming fonts, as it's the underlying library used to query system
fonts by Evas (see the @c fc-list command's output, on your system,
to get an idea). Alternatively, one can use a full path to a font file.
This function allows the font name and size of a text object to
be set. The font string has to follow fontconfig's convention on
naming fonts, as it's the underlying library used to query system
fonts by Evas (see the fc-list command's output, on your system,
to get an idea). Alternatively, one can use a full path to a font
file.
@see evas_object_text_font_get()
@see evas_object_text_font_source_set() */
See also @evas_object_text_font_get,
@evas_object_text_font_source_set.
]]
}
get {
/*@
Retrieve the font family and size in use on a given text object.
[[Retrieve the font family and size in use on a given text object.
This function allows the font name and size of a text object to be
queried. Be aware that the font name string is still owned by Evas
and should @b not have free() called on it by the caller of the
function.
This function allows the font name and size of a text object to
be queried. Be aware that the font name string is still owned by
Evas and should not have free() called on it by the caller of the
function.
@see evas_object_text_font_set() */
See also @evas_object_text_font_set.
]]
}
values {
font: const(char) *; /*@ The font family name or filename. */
size: Efl_Font_Size; /*@ The font size, in points. */
font: const(char) *; [[The font family name or filename.]]
size: Efl_Font_Size; [[The font size, in points.]]
}
}
@property font_source {
set {
/*@
Set the font (source) file to be used on a given text object.
[[Set the font (source) file to be used on a given text object.
This function allows the font file to be explicitly set for a given
text object, overriding system lookup, which will first occur in
the given file's contents.
This function allows the font file to be explicitly set for a
given text object, overriding system lookup, which will first
occur in the given file's contents.
@see evas_object_text_font_get() */
See also @evas_object_text_font_get.
]]
}
get {
/*@
Get the font file's path which is being used on a given text
object.
[[Get the font file's path which is being used on a given text
object.
@return The font file's path.
@see evas_object_text_font_get() for more details */
See @evas_object_text_font_get for more details.
]]
}
values {
font_source: const(char)*; /*@ The font file's path. */
font_source: const(char)*; [[The font file's path.]]
}
}
}