efl/src/lib/evas/canvas/evas_text.eo

class Evas.Text (Evas.Object, Efl.Text, Efl.Text_Properties)
{
   legacy_prefix: evas_object_text;
   eo_prefix: evas_obj_text;
   methods {
      @property 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 {
            r: int; /*@ The red component of the given color. */
            g: int; /*@ The green component of the given color. */
            b: int; /*@ The blue component of the given color. */
            a: int; /*@ The alpha component of the given color. */
         }
      }
      @property 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. The ellipsis is -1.0.
            @see evas_object_text_ellipsis_set.
            @since 1.8 */
         }
         values {
            ellipsis: double(-1); /*@ the ellipsis. */
         }
      }
      @property 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 {
            delim: const(char)*; /*@ A null terminated string of delimiters, e.g ",|". */
         }
      }
      @property 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 {
            r: int; /*@ The red component of the given color. */
            g: int; /*@ The green component of the given color. */
            b: int; /*@ The blue component of the given color. */
            a: int; /*@ The alpha component of the given color. */
         }
      }
      @property 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 {
            r: int; /*@ The red component of the given color. */
            g: int; /*@ The green component of the given color. */
            b: int; /*@ The blue component of the given color. */
            a: int; /*@ The alpha component of the given color. */
         }
      }
      @property 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 {
            style: Evas_Text_Style_Type; /*@ a style type. */
         }
      }
      @property 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 {
            r: int; /*@ The red component of the given color. */
            g: int; /*@ The green component of the given color. */
            b: int; /*@ The blue component of the given color. */
            a: int; /*@ The alpha component of the given color. */
         }
      }
      @property 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.

            @since 1.9
            @note EXPERIMENTAL FEATURE. This is an unstable API,
            please use only for testing purposes.
            @see @ref evasfiltersref "Evas filters reference"
            */
            legacy: null;
         }
         values {
            program: const(char)*; /*@ The program code, as defined
              by the @ref evasfiltersref "Evas filters script language".
              Pass NULL to remove the former program and switch back
              to the standard text effect */
         }
      }
      @property 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).

            @since 1.9
            @note EXPERIMENTAL FEATURE. This is an unstable API,
            please use only for testing purposes.
            @see @ref evasfiltersref "Evas filters reference" */
            legacy: null;
         }
         values {
            name: const(char)*; /*@ Object name as used in the program code */
            eobj: Eo*; /*@ Eo object to use through proxy rendering */
         }
      }
      @property max_descent {
         get {
            return: Evas_Coord;
         }
      }
      @property style_pad {
         get {
            /*@
            Gets the text style pad of a text object. */
         }
         values {
            l: int; /*@ The left pad (or @c NULL). */
            r: int; /*@ The right pad (or @c NULL). */
            t: int; /*@ The top pad (or @c NULL). */
            b: int; /*@ The bottom pad (or @c NULL). */
         }
      }
      @property 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;
         }
      }
      @property ascent {
         get {
            return: Evas_Coord;
         }
      }
      @property horiz_advance {
         get {
            return: Evas_Coord;
         }
      }
      @property inset {
         get {
            return: Evas_Coord;
         }
      }
      @property max_ascent {
         get {
            return: Evas_Coord;
         }
      }
      @property vert_advance {
         get {
            return: Evas_Coord;
         }
      }
      @property descent {
         get {
            return: Evas_Coord;
         }
      }
      last_up_to_pos @const {
         /*@ 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. */
         return: int(-1);
         params {
            @in x: Evas_Coord; /*@ in */
            @in y: Evas_Coord; /*@ in */
         }
      }
      char_coords_get @const {
         return: int;
         params {
            @in x: Evas_Coord; /*@ in */
            @in y: Evas_Coord; /*@ in */
            @out cx: Evas_Coord; /*@ out */
            @out cy: Evas_Coord; /*@ out */
            @out cw: Evas_Coord; /*@ out */
            @out ch: Evas_Coord; /*@ out */
         }
      }
      char_pos_get @const {
         /*@
         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. */
         return: bool;
         params {
            @in pos: int; /*@ The character position to request co-ordinates for. */
            @out cx: Evas_Coord; /*@ A pointer to an @c Evas_Coord to store the X value in (can be NULL). */
            @out cy: Evas_Coord; /*@ A pointer to an @c Evas_Coord to store the Y value in (can be NULL). */
            @out cw: Evas_Coord; /*@ A pointer to an @c Evas_Coord to store the Width value in (can be NULL). */
            @out ch: Evas_Coord; /*@ 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;
      Efl.Gfx.Base.size.set;
      Efl.Text.text.set;
      Efl.Text.text.get;
      Efl.Text_Properties.font.get;
      Efl.Text_Properties.font.set;
      Efl.Text_Properties.font_source.get;
      Efl.Text_Properties.font_source.set;
   }
}