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