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