/usr/include/elementary-1/elm_bg_legacy.h is in libelementary-dev 1.8.5-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 | /**
* Add a new background to the parent
*
* @param parent The parent object
* @return The new object or @c NULL if it cannot be created
*
* @ingroup Bg
*/
EAPI Evas_Object *elm_bg_add(Evas_Object *parent);
/**
* Set the file (image or edje collection) to give life for the
* background
*
* @param obj The background object handle
* @param file The file path
* @param group Optional key (group in Edje) within the file
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
*
* This sets the image file used in the background object. If the
* image comes from an Edje group, it will be stretched to completely
* fill the background object. If it comes from a traditional image file, it
* will by default be centered in this widget's are (thus retaining
* its aspect), what could lead to some parts being not visible. You
* may change the mode of exhibition for a real image file with
* elm_bg_option_set().
*
* @note Once the image of @p obj is set, a previously set one will be
* deleted, even if @p file is @c NULL.
*
* @note This will only affect the contents of one of the background's
* swallow spots, namely @c "elm.swallow.background". If you want to
* achieve the @c Layout's file setting behavior, you'll have to call
* that method on this object.
*
* @ingroup Bg
*/
EAPI Eina_Bool elm_bg_file_set(Evas_Object *obj, const char *file, const char *group);
/**
* Get the file (image or edje collection) set on a given background
* widget
*
* @param obj The background object handle
* @param file Where to store the requested file's path
* @param group Where to store the optional key within @a file, @b if
* it's an Edje file
*
* @note Use @c NULL pointers on the file components you're not
* interested in: they'll be ignored by the function.
*
* @ingroup Bg
*/
EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group);
/**
* Set the mode of display for a given background widget's image
*
* @param obj The background object handle
* @param option The desired background option (see #Elm_Bg_Option)
*
* This sets how the background widget will display its image. This
* will only work if the elm_bg_file_set() was previously called with
* an image file on @a obj. The image can be display tiled, scaled,
* centered or stretched.
*
* @see elm_bg_option_get()
*
* @ingroup Bg
*/
EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option);
/**
* Get the mode of display for a given background widget's image
*
* @param obj The background object handle
* @return The image displaying mode in use for @a obj or #ELM_BG_OPTION_LAST,
* on errors.
*
* @see elm_bg_option_set() for more details
*
* @ingroup Bg
*/
EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj);
/**
* Set the color on a given background widget
*
* @param obj The background object handle
* @param r The red color component's value
* @param g The green color component's value
* @param b The blue color component's value
*
* This sets the color used for the background rectangle, in RGB
* format. Each color component's range is from 0 to 255.
*
* @note You probably only want to use this function if you haven't
* previously called elm_bg_file_set(), so that you just want a solid
* color background.
*
* @note You can reset the color by setting @r, @g, @b as -1, -1, -1.
*
* @see elm_bg_color_get()
*
* @ingroup Bg
*/
EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b);
/**
* Get the color set on a given background widget
*
* @param obj The background object handle
* @param r Where to store the red color component's value
* @param g Where to store the green color component's value
* @param b Where to store the blue color component's value
*
* @note Use @c NULL pointers on the file components you're not
* interested in: they'll be ignored by the function.
*
* @see elm_bg_color_get() for more details
*
* @ingroup Bg
*/
EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b);
/**
* Set the size of the pixmap representation of the image set on a
* given background widget.
*
* @param obj The background object handle
* @param w The new width of the image pixmap representation.
* @param h The new height of the image pixmap representation.
*
* @warning This function just makes sense if an image file was set on
* @p obj, with elm_bg_file_set().
*
* This function sets a new size for pixmap representation of the
* given bg image. It allows for the image to be loaded already in the
* specified size, reducing the memory usage and load time (for
* example, when loading a big image file with its load size set to a
* smaller size)
*
* @note This is just a hint for the underlying system. The real size
* of the pixmap may differ depending on the type of image being
* loaded, being bigger than requested.
*
* @ingroup Bg
*/
EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
|