forked from enlightenment/efl
423 lines
14 KiB
Plaintext
423 lines
14 KiB
Plaintext
class Evas_Text (Evas_Object)
|
|
{
|
|
legacy_prefix: evas_object_text;
|
|
properties {
|
|
font_source {
|
|
set {
|
|
/*@
|
|
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.
|
|
|
|
@see evas_object_text_font_get() */
|
|
}
|
|
get {
|
|
/*@
|
|
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 */
|
|
}
|
|
values {
|
|
const char* font_source; /*@ The font file's path. */
|
|
}
|
|
}
|
|
shadow_color {
|
|
set {
|
|
/*@
|
|
Sets the shadow color for the given text object.
|
|
|
|
Shadow effects, which are fading colors decorating the text
|
|
underneath it, will just be shown if the object is set to one of
|
|
the following styles:
|
|
|
|
- #EVAS_TEXT_STYLE_SHADOW
|
|
- #EVAS_TEXT_STYLE_OUTLINE_SHADOW
|
|
- #EVAS_TEXT_STYLE_FAR_SHADOW
|
|
- #EVAS_TEXT_STYLE_OUTLINE_SOFT_SHADOW
|
|
- #EVAS_TEXT_STYLE_SOFT_SHADOW
|
|
- #EVAS_TEXT_STYLE_FAR_SOFT_SHADOW
|
|
|
|
One can also change the direction where the shadow grows to, with
|
|
evas_object_text_style_set().
|
|
|
|
@see evas_object_text_shadow_color_get() */
|
|
}
|
|
get {
|
|
/*@
|
|
Retrieves the shadow color for the given text object.
|
|
|
|
@note Use @c NULL pointers on the color components you're not
|
|
interested in: they'll be ignored by the function.
|
|
|
|
@see evas_object_text_shadow_color_set() for more details. */
|
|
}
|
|
values {
|
|
int r; /*@ The red component of the given color. */
|
|
int g; /*@ The green component of the given color. */
|
|
int b; /*@ The blue component of the given color. */
|
|
int a; /*@ The alpha component of the given color. */
|
|
}
|
|
}
|
|
ellipsis {
|
|
set {
|
|
/*@
|
|
@brief Sets the ellipsis that should be used for the text object.
|
|
|
|
This is a value between 0.0 and 1.0 indicating the position of the text
|
|
to be shown. 0.0 means the start will be shown and the end trimmed, 1.0
|
|
means the beginning will be trimmed and the end will be shown, and any value
|
|
in between will cause ellipsis to be added in both end of the text and the
|
|
requested part to be shown.
|
|
-1.0 means ellipsis is turned off.
|
|
|
|
@since 1.8 */
|
|
}
|
|
get {
|
|
/*@
|
|
@brief Gets the ellipsis currently set on the text object.
|
|
|
|
@return The ellipsis set on the text object.
|
|
@see evas_object_text_ellipsis_set.
|
|
@since 1.8 */
|
|
}
|
|
values {
|
|
double ellipsis; /*@ the ellipsis. */
|
|
}
|
|
}
|
|
bidi_delimiters {
|
|
set {
|
|
/*@
|
|
@brief Sets the BiDi delimiters used in the textblock.
|
|
|
|
BiDi delimiters are use for in-paragraph separation of bidi segments. This
|
|
is useful for example in recipients fields of e-mail clients where bidi
|
|
oddities can occur when mixing RTL and LTR.
|
|
|
|
@since 1.1 */
|
|
}
|
|
get {
|
|
/*@
|
|
@brief Gets the BiDi delimiters used in the textblock.
|
|
|
|
BiDi delimiters are use for in-paragraph separation of bidi segments. This
|
|
is useful for example in recipients fields of e-mail clients where bidi
|
|
oddities can occur when mixing RTL and LTR.
|
|
|
|
@return A null terminated string of delimiters, e.g ",|". If empty, returns NULL.
|
|
@since 1.1 */
|
|
}
|
|
values {
|
|
const char* delim; /*@ A null terminated string of delimiters, e.g ",|". */
|
|
}
|
|
}
|
|
outline_color {
|
|
set {
|
|
/*@
|
|
Sets the outline color for the given text object.
|
|
|
|
Outline effects (colored lines around text glyphs) will just be
|
|
shown if the object is set to one of the following styles:
|
|
- #EVAS_TEXT_STYLE_OUTLINE
|
|
- #EVAS_TEXT_STYLE_SOFT_OUTLINE
|
|
- #EVAS_TEXT_STYLE_OUTLINE_SHADOW
|
|
- #EVAS_TEXT_STYLE_OUTLINE_SOFT_SHADOW
|
|
|
|
@see evas_object_text_outline_color_get() */
|
|
}
|
|
get {
|
|
/*@
|
|
Retrieves the outline color for the given text object.
|
|
|
|
@note Use @c NULL pointers on the color components you're not
|
|
interested in: they'll be ignored by the function.
|
|
|
|
@see evas_object_text_outline_color_set() for more details. */
|
|
}
|
|
values {
|
|
int r; /*@ The red component of the given color. */
|
|
int g; /*@ The green component of the given color. */
|
|
int b; /*@ The blue component of the given color. */
|
|
int a; /*@ The alpha component of the given color. */
|
|
}
|
|
}
|
|
text {
|
|
set {
|
|
/*@
|
|
Sets the text string to be displayed by the given text object.
|
|
|
|
@see evas_object_text_text_get() */
|
|
}
|
|
get {
|
|
/*@
|
|
Retrieves the text string currently being displayed by the given
|
|
text object.
|
|
|
|
@return The text string currently being displayed on it.
|
|
|
|
@note Do not free() the return value.
|
|
|
|
@see evas_object_text_text_set() */
|
|
}
|
|
values {
|
|
const char* text; /*@ Text string to display on it. */
|
|
}
|
|
}
|
|
glow2_color {
|
|
set {
|
|
/*@
|
|
Sets the 'glow 2' color for the given text object.
|
|
|
|
'Glow 2' effects, which are glowing colors decorating the text's
|
|
(immediate) surroundings, will just be shown if the object is set
|
|
to the #EVAS_TEXT_STYLE_GLOW style. See also
|
|
evas_object_text_glow_color_set().
|
|
|
|
@see evas_object_text_glow2_color_get() */
|
|
}
|
|
get {
|
|
/*@
|
|
Retrieves the 'glow 2' color for the given text object.
|
|
|
|
@note Use @c NULL pointers on the color components you're not
|
|
interested in: they'll be ignored by the function.
|
|
|
|
@see evas_object_text_glow2_color_set() for more details. */
|
|
}
|
|
values {
|
|
int r; /*@ The red component of the given color. */
|
|
int g; /*@ The green component of the given color. */
|
|
int b; /*@ The blue component of the given color. */
|
|
int a; /*@ The alpha component of the given color. */
|
|
}
|
|
}
|
|
font {
|
|
set {
|
|
/*@
|
|
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.
|
|
|
|
@see evas_object_text_font_get()
|
|
@see evas_object_text_font_source_set() */
|
|
}
|
|
get {
|
|
/*@
|
|
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.
|
|
|
|
@see evas_object_text_font_set() */
|
|
}
|
|
values {
|
|
const char* font; /*@ The font family name or filename. */
|
|
Evas_Font_Size size; /*@ The font size, in points. */
|
|
}
|
|
}
|
|
style {
|
|
set {
|
|
/*@
|
|
Sets the style to apply on the given text object.
|
|
|
|
Text object styles are one of the values in
|
|
#Evas_Text_Style_Type. Some of those values are combinations of
|
|
more than one style, and some account for the direction of the
|
|
rendering of shadow effects.
|
|
|
|
@note One may use the helper macros #EVAS_TEXT_STYLE_BASIC_SET and
|
|
#EVAS_TEXT_STYLE_SHADOW_DIRECTION_SET to assemble a style value.
|
|
|
|
The following figure illustrates the text styles:
|
|
|
|
@image html text-styles.png
|
|
@image rtf text-styles.png
|
|
@image latex text-styles.eps
|
|
|
|
@see evas_object_text_style_get()
|
|
@see evas_object_text_shadow_color_set()
|
|
@see evas_object_text_outline_color_set()
|
|
@see evas_object_text_glow_color_set()
|
|
@see evas_object_text_glow2_color_set() */
|
|
}
|
|
get {
|
|
/*@
|
|
Retrieves the style on use on the given text object.
|
|
|
|
@return the style type in use.
|
|
|
|
@see evas_object_text_style_set() for more details. */
|
|
}
|
|
values {
|
|
Evas_Text_Style_Type style; /*@ a style type. */
|
|
}
|
|
}
|
|
glow_color {
|
|
set {
|
|
/*@
|
|
Sets the glow color for the given text object.
|
|
|
|
Glow effects, which are glowing colors decorating the text's
|
|
surroundings, will just be shown if the object is set to the
|
|
#EVAS_TEXT_STYLE_GLOW style.
|
|
|
|
@note Glow effects are placed from a short distance of the text
|
|
itself, but no touching it. For glowing effects right on the
|
|
borders of the glyphs, see 'glow 2' effects
|
|
(evas_object_text_glow2_color_set()).
|
|
|
|
@see evas_object_text_glow_color_get() */
|
|
}
|
|
get {
|
|
/*@
|
|
Retrieves the glow color for the given text object.
|
|
|
|
@note Use @c NULL pointers on the color components you're not
|
|
interested in: they'll be ignored by the function.
|
|
|
|
@see evas_object_text_glow_color_set() for more details. */
|
|
}
|
|
values {
|
|
int r; /*@ The red component of the given color. */
|
|
int g; /*@ The green component of the given color. */
|
|
int b; /*@ The blue component of the given color. */
|
|
int a; /*@ The alpha component of the given color. */
|
|
}
|
|
}
|
|
filter_program {
|
|
set {
|
|
/*@ Set an Evas filter program on this Text Object. If the program fails to compile (syntax error, invalid buffer name, etc...), the standard text effects will be applied instead (SHADOW, etc...). switch back to the standard text effects. */
|
|
}
|
|
values {
|
|
const char* program; /*@ The program code, as defined by the @ref evasfiltersref */
|
|
}
|
|
}
|
|
filter_source {
|
|
set {
|
|
/*@ Bind an object to use as a mask or texture with Evas Filters. This will create automatically a new RGBA buffer containing the source object's pixels (as it is rendered). */
|
|
}
|
|
values {
|
|
const char* name; /*@ Object name as used in the program code */
|
|
Eo* eobj; /*@ Eo object to use through proxy rendering */
|
|
}
|
|
}
|
|
max_descent {
|
|
get {
|
|
return Evas_Coord;
|
|
}
|
|
}
|
|
style_pad {
|
|
get {
|
|
/*@
|
|
Gets the text style pad of a text object. */
|
|
}
|
|
values {
|
|
int l; /*@ The left pad (or @c NULL). */
|
|
int r; /*@ The right pad (or @c NULL). */
|
|
int t; /*@ The top pad (or @c NULL). */
|
|
int b; /*@ The bottom pad (or @c NULL). */
|
|
}
|
|
}
|
|
direction {
|
|
get {
|
|
/*@
|
|
Retrieves the direction of the text currently being displayed in the
|
|
text object.
|
|
@return the direction of the text */
|
|
return Evas_BiDi_Direction;
|
|
}
|
|
}
|
|
ascent {
|
|
get {
|
|
return Evas_Coord;
|
|
}
|
|
}
|
|
horiz_advance {
|
|
get {
|
|
return Evas_Coord;
|
|
}
|
|
}
|
|
inset {
|
|
get {
|
|
return Evas_Coord;
|
|
}
|
|
}
|
|
max_ascent {
|
|
get {
|
|
return Evas_Coord;
|
|
}
|
|
}
|
|
vert_advance {
|
|
get {
|
|
return Evas_Coord;
|
|
}
|
|
}
|
|
descent {
|
|
get {
|
|
return Evas_Coord;
|
|
}
|
|
}
|
|
}
|
|
methods {
|
|
last_up_to_pos {
|
|
/*@ Returns the logical position of the last char in the text up to the pos given. this is NOT the position of the last char because of the possibility of RTL in the text. */
|
|
const;
|
|
return int;
|
|
params {
|
|
@in Evas_Coord x; /*@ in */
|
|
@in Evas_Coord y; /*@ in */
|
|
}
|
|
}
|
|
char_coords_get {
|
|
const;
|
|
return int;
|
|
params {
|
|
@in Evas_Coord x; /*@ in */
|
|
@in Evas_Coord y; /*@ in */
|
|
@out Evas_Coord cx; /*@ out */
|
|
@out Evas_Coord cy; /*@ out */
|
|
@out Evas_Coord cw; /*@ out */
|
|
@out Evas_Coord ch; /*@ out */
|
|
}
|
|
}
|
|
char_pos_get {
|
|
/*@
|
|
Retrieve position and dimension information of a character within a text @c Evas_Object.
|
|
|
|
This function is used to obtain the X, Y, width and height of the character
|
|
located at @p pos within the @c Evas_Object @p obj. @p obj must be a text object
|
|
as created with evas_object_text_add(). Any of the @c Evas_Coord parameters (@p cx,
|
|
@p cy, @p cw, @p ch) may be @c NULL in which case no value will be assigned to that
|
|
parameter.
|
|
|
|
@return @c EINA_FALSE on success, @c EINA_TRUE on error. */
|
|
|
|
const;
|
|
return Eina_Bool;
|
|
params {
|
|
@in int pos; /*@ The character position to request co-ordinates for. */
|
|
@out Evas_Coord cx; /*@ A pointer to an @c Evas_Coord to store the X value in (can be NULL). */
|
|
@out Evas_Coord cy; /*@ A pointer to an @c Evas_Coord to store the Y value in (can be NULL). */
|
|
@out Evas_Coord cw; /*@ A pointer to an @c Evas_Coord to store the Width value in (can be NULL). */
|
|
@out Evas_Coord ch; /*@ A pointer to an @c Evas_Coord to store the Height value in (can be NULL). */
|
|
}
|
|
}
|
|
}
|
|
implements {
|
|
Eo_Base::constructor;
|
|
Eo_Base::destructor;
|
|
Eo_Base::dbg_info_get;
|
|
Evas_Object::size::set;
|
|
}
|
|
}
|