summaryrefslogtreecommitdiff
path: root/doc/elementary/background.rst
blob: e02534ac95fe1c9395f8c4e8b4d8d2eaf094f154 (plain) (blame)
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
.. currentmodule:: efl.elementary

Background
##########

.. image:: /images/background-preview.png


Widget description
==================

The background widget is used for setting a solid color, image or Edje group
as a background to a window (unless it has transparency enabled) or any
container object.

It works just like an image, but has some properties useful to a
background, like setting it to tiled, centered, scaled or stretched.


Layout content parts
====================

- ``overlay`` - overlay of the bg


Enumerations
============

.. _Elm_Bg_Option:

Background display modes
------------------------

.. data:: ELM_BG_OPTION_CENTER

    Center

.. data:: ELM_BG_OPTION_SCALE

    Scale

.. data:: ELM_BG_OPTION_STRETCH

    Stretch

.. data:: ELM_BG_OPTION_TILE

    Tile


Inheritance diagram
===================

.. inheritance-diagram:: Background
    :parts: 2


.. autoclass:: Background