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