doc/index.doxy

   1 /**
   2  * @page infralist Infrastructure list
   3  *
   4  * Elementary is mostly composed of widgets, but it also contains some
   5  * infrastructure modules that facilitate the use of widgets. These are the
   6  * infrastructure modules:
   7  * @li @ref Caches
   8  * @li @ref Cursors
   9  * @li @ref Debug
  10  * @li @ref Config
  11  * @li @ref Engine
  12  * @li @ref Fonts
  13  * @li @ref Profile
  14  * @li @ref Fingers
  15  * @li @ref Focus
  16  * @li @ref General
  17  * @li @ref Elm_Gesture_Layer
  18  * @li @ref Password_last_show
  19  * @li @ref Start
  20  * @li @ref Scrolling
  21  * @li @ref Scrollhints
  22  * @li @ref UI-Mirroring
  23  * @li @ref Scaling
  24  * @li @ref Styles
  25  * @li @ref Theme
  26  * @li @ref Transit
  27  * @li @ref WidgetNavigation
  28  *
  29  * The other two main groups in Elementary are:
  30  * @li @ref widgetslist - These are the widgets you'll compose your UI out of.
  31  * @li @ref containerslist - These are the containers in which the widgets will
  32  *                           be laid out.
  33  *
  34  * Also see other generic EFL programming guides:
  35  * @li @ref threading
  36  */
  37 /**
  38  * @page widgetslist Widget list
  39  *
  40  * Here is a list of the widgets and some images to give you an idea of what
  41  * they are:
  42  * @li @ref Actionslider
  43  *
  44  * @image html img/widget/actionslider/preview-00.png
  45  * @image latex img/widget/actionslider/preview-00.eps
  46  * @li @ref Anchorview
  47  *
  48  * @image html img/widget/anchorview/preview-00.png
  49  * @image latex img/widget/anchorview/preview-00.eps
  50  * @li @ref Anchorblock
  51  *
  52  * @image html img/widget/anchorblock/preview-00.png
  53  * @image latex img/widget/anchorblock/preview-00.eps
  54  * @li @ref Bg
  55  *
  56  * @image html img/widget/bg/preview-00.png
  57  * @image latex img/widget/bg/preview-00.eps
  58  * @li @ref Bubble
  59  *
  60  * @image html img/widget/bubble/preview-00.png
  61  * @image latex img/widget/bubble/preview-00.eps
  62  * @li @ref Button
  63  *
  64  * @image html img/widget/button/preview-00.png
  65  * @image latex img/widget/button/preview-00.eps
  66  * @li @ref Calendar
  67  *
  68  * @image html img/widget/calendar/preview-00.png
  69  * @image latex img/widget/calendar/preview-00.eps
  70  * @li @ref Check
  71  *
  72  * @image html img/widget/check/preview-00.png
  73  * @image latex img/widget/check/preview-00.eps
  74  * @li @ref Clock
  75  *
  76  * @image html img/widget/clock/preview-00.png
  77  * @image latex img/widget/clock/preview-00.eps
  78  *
  79  * @li @ref Colorselector
  80  *
  81  * @image html img/widget/colorselector/preview-00.png
  82  * @image latex img/widget/colorselector/preview-00.eps
  83  * @li @ref Ctxpopup
  84  *
  85  * @image html img/widget/ctxpopup/preview-00.png
  86  * @image latex img/widget/ctxpopup/preview-00.eps
  87  * @li @ref Diskselector
  88  *
  89  * @image html img/widget/diskselector/preview-00.png
  90  * @image latex img/widget/diskselector/preview-00.eps
  91  * @li @ref Entry
  92  *
  93  * @image html img/widget/entry/preview-02.png
  94  * @image latex img/widget/entry/preview-02.eps
  95  * @li @ref File_Selector_Button
  96  *
  97  * @image html img/widget/fileselector_button/preview-00.png
  98  * @image latex img/widget/fileselector_button/preview-00.eps
  99  * @li @ref File_Selector_Entry
 100  *
 101  * @image html img/widget/fileselector_entry/preview-00.png
 102  * @image latex img/widget/fileselector_entry/preview-00.eps
 103  * @li @ref Fileselector
 104  *
 105  * @image html img/widget/fileselector/preview-00.png
 106  * @image latex img/widget/fileselector/preview-00.eps
 107  * @li @ref Flip
 108  *
 109  * @image html img/widget/flip/preview-00.png
 110  * @image latex img/widget/flip/preview-00.eps
 111  * @li @ref Flipselector
 112  *
 113  * @image html img/widget/flipselector/preview-00.png
 114  * @image latex img/widget/flipselector/preview-00.eps
 115  * @li @ref Frame
 116  *
 117  * @image html img/widget/frame/preview-00.png
 118  * @image latex img/widget/frame/preview-00.eps
 119  * @li @ref Gengrid
 120  *
 121  * @image html img/widget/gengrid/preview-00.png
 122  * @image latex img/widget/gengrid/preview-00.eps
 123  *
 124  * @li @ref Genlist
 125  * @image html img/widget/genlist/preview-00.png
 126  * @image latex img/widget/genlist/preview-00.eps
 127  * @image html img/genlist.png
 128  * @image latex img/genlist.eps
 129  *
 130  * @li @ref GLView
 131  * @li @ref Hover
 132  *
 133  * @image html img/widget/hover/preview-00.png
 134  * @image latex img/widget/hover/preview-00.eps
 135  * @li @ref Hoversel
 136  *
 137  * @image html img/widget/hoversel/preview-00.png
 138  * @image latex img/widget/hoversel/preview-00.eps
 139  * @li @ref Icon
 140  *
 141  * @image html img/widget/icon/preview-00.png
 142  * @image latex img/widget/icon/preview-00.eps
 143  * @li @ref Image
 144  *
 145  * @image html img/widget/image/preview-00.png
 146  * @image latex img/widget/image/preview-00.eps
 147  * @li @ref Index
 148  *
 149  * @image html img/widget/index/preview-00.png
 150  * @image latex img/widget/index/preview-00.eps
 151  * @li @ref Inwin
 152  *
 153  * @image html img/widget/inwin/preview-00.png
 154  * @image latex img/widget/inwin/preview-00.eps
 155  * @li @ref List
 156  *
 157  * @image html img/widget/list/preview-00.png
 158  * @image latex img/widget/list/preview-00.eps
 159  * @image html img/list.png
 160  * @image latex img/list.eps
 161  * @li @ref Label
 162  *
 163  * @image html img/widget/label/preview-00.png
 164  * @image latex img/widget/label/preview-00.eps
 165  * @li @ref Map
 166  *
 167  * @image html img/widget/map/preview-00.png
 168  * @image latex img/widget/map/preview-00.eps
 169  * @li @ref Mapbuf
 170  *
 171  * @image html img/widget/mapbuf/preview-00.png
 172  * @image latex img/widget/mapbuf/preview-00.eps
 173  * @li @ref Menu
 174  *
 175  * @image html img/widget/menu/preview-00.png
 176  * @image latex img/widget/menu/preview-00.eps
 177  * @li @ref Notify
 178  *
 179  * @image html img/widget/notify/preview-00.png
 180  * @image latex img/widget/notify/preview-00.eps
 181  * @li @ref Pager
 182  *
 183  * @image html img/widget/pager/preview-00.png
 184  * @image latex img/widget/pager/preview-00.eps
 185  * @li @ref Panel
 186  *
 187  * @image html img/widget/panel/preview-00.png
 188  * @image latex img/widget/panel/preview-00.eps
 189  * @li @ref Photo
 190  * @li @ref Photocam
 191  *
 192  * @image html img/widget/photocam/preview-00.png
 193  * @image latex img/widget/photocam/preview-00.eps
 194  * @li @ref Progressbar
 195  *
 196  * @image html img/widget/progressbar/preview-00.png
 197  * @image latex img/widget/progressbar/preview-00.eps
 198  * @li @ref Radio
 199  *
 200  * @image html img/widget/radio/preview-00.png
 201  * @image latex img/widget/radio/preview-00.eps
 202  * @li @ref Route
 203  * @li @ref SegmentControl
 204  *
 205  * @image html img/widget/segment_control/preview-00.png
 206  * @image latex img/widget/segment_control/preview-00.eps
 207  * @image html img/segment_control.png
 208  * @image latex img/segment_control.eps
 209  * @li @ref Separator
 210  *
 211  * @image html img/widget/separator/preview-00.png
 212  * @image latex img/widget/separator/preview-00.eps
 213  * @li @ref Slider
 214  *
 215  * @image html img/widget/slider/preview-00.png
 216  * @image latex img/widget/slider/preview-00.eps
 217  * @li @ref Slideshow
 218  *
 219  * @image html img/widget/slideshow/preview-00.png
 220  * @image latex img/widget/slideshow/preview-00.eps
 221  * @li @ref Spinner
 222  *
 223  * @image html img/widget/spinner/preview-00.png
 224  * @image latex img/widget/spinner/preview-00.eps
 225  * @li @ref Thumb
 226
 227  * @image html img/widget/thumb/preview-00.png
 228  * @image latex img/widget/thumb/preview-00.eps
 229  * @li @ref Toggle
 230  *
 231  * @image html img/widget/toggle/preview-00.png
 232  * @image latex img/widget/toggle/preview-00.eps
 233  * @li @ref Toolbar
 234  *
 235  * @image html img/widget/toolbar/preview-00.png
 236  * @image latex img/widget/toolbar/preview-00.eps
 237  * @image html img/toolbar.png
 238  * @image latex img/toolbar.eps
 239  * @li @ref Tooltips
 240  * @li @ref Video
 241  * @li @ref Web
 242  *
 243  * @image html img/widget/web/preview-00.png
 244  * @image latex img/widget/web/preview-00.eps
 245  * @li @ref Win
 246  *
 247  * @image html img/widget/win/preview-00.png
 248  * @image latex img/widget/win/preview-00.eps
 249  *
 250  * The other two main groups in Elementary are:
 251  * @li @ref infralist - These are modules that deal with Elementary as a whole.
 252  * @li @ref containerslist - These are the containers in which the widgets will be
 253  *                           layouted.
 254  */
 255 /**
 256  * @page containerslist Containers List
 257  *
 258  * Elementary is about displaying its widgets in a nice layout, for this purpose
 259  * it provides a number of containers. It's important to note that as containers
 260  * widgets don't have their own visual identity, so here we show one use for
 261  * them and a diagram showing their component parts:
 262  * @li @ref Box
 263  *
 264  * @image html img/widget/box/preview-00.png
 265  * @image latex img/widget/box/preview-00.eps
 266  * @image html img/box.png
 267  * @image latex img/box.eps
 268  * @li @ref Conformant
 269  *
 270  * @image html img/widget/conformant/preview-00.png
 271  * @image latex img/widget/conformant/preview-00.eps
 272  * @image html img/conformant.png
 273  * @image latex img/conformant.eps
 274  * @li @ref Grid
 275  * @li @ref Layout
 276  *
 277  * @image html img/widget/layout/preview-00.png
 278  * @image latex img/widget/layout/preview-00.eps
 279  * @image html img/layout-predefined.png
 280  * @image latex img/layout-predefined.eps
 281  * @li @ref Panes
 282  *
 283  * @image html img/widget/panes/preview-00.png
 284  * @image latex img/widget/panes/preview-00.eps
 285  * @image html img/panes.png
 286  * @image latex img/panes.eps
 287  * @li @ref Scroller
 288  *
 289  * @image html img/widget/scroller/preview-00.png
 290  * @image latex img/widget/scroller/preview-00.eps
 291  * @li @ref Table
 292  *
 293  * @image html img/widget/table/preview-00.png
 294  * @image latex img/widget/table/preview-00.eps
 295  *
 296  * The other two main groups in Elementary are:
 297  * @li @ref infralist - These are modules that deal with Elementary as a whole.
 298  * @li @ref widgetslist - These are the widgets you'll compose your UI out of.
 299  */
 300 /**
 301  * @page threading Threading
 302  *
 303  * You may use threads with EFL, but only in specific ways. If you plan on
 304  * using threads it is very important you see the following example guides.
 305  * See the following
 306  *
 307  * @ref efl_thread_1
 308  *
 309  * @ref efl_thread_2
 310  *
 311  * @ref efl_thread_3
 312  *
 313  * @ref efl_thread_4
 314  *
 315  * @ref efl_thread_5
 316  *
 317  * @ref efl_thread_6
 318  *
 319  */