docs/reference/cspi/tmpl/spi_main.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 SPI main loop and initialization
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9
  10 </para>
  11
  12 <!-- ##### SECTION See_Also ##### -->
  13 <para>
  14
  15 </para>
  16
  17 <!-- ##### SECTION Stability_Level ##### -->
  18
  19
  20 <!-- ##### FUNCTION SPI_init ##### -->
  21 <para>
  22
  23 </para>
  24
  25 @Returns:
  26
  27
  28 <!-- ##### FUNCTION SPI_event_main ##### -->
  29 <para>
  30
  31 </para>
  32
  33
  34
  35 <!-- ##### FUNCTION SPI_event_quit ##### -->
  36 <para>
  37
  38 </para>
  39
  40
  41
  42 <!-- ##### FUNCTION SPI_eventIsReady ##### -->
  43 <para>
  44
  45 </para>
  46
  47 @Returns:
  48
  49
  50 <!-- ##### FUNCTION SPI_nextEvent ##### -->
  51 <para>
  52
  53 </para>
  54
  55 @waitForEvent:
  56 @Returns:
  57
  58
  59 <!-- ##### FUNCTION SPI_exit ##### -->
  60 <para>
  61
  62 </para>
  63
  64 @Returns:
  65
  66
  67 <!-- ##### FUNCTION SPI_freeString ##### -->
  68 <para>
  69
  70 </para>
  71
  72 @s:
  73
  74
  75 <!-- ##### FUNCTION SPIAccessibleException_getSource ##### -->
  76 <para>
  77
  78 </para>
  79
  80 @err:
  81 @Returns:
  82
  83
  84 <!-- ##### FUNCTION SPIException_getDescription ##### -->
  85 <para>
  86
  87 </para>
  88
  89 @err:
  90 @Returns:
  91
  92
  93 <!-- ##### FUNCTION SPIException_getExceptionCode ##### -->
  94 <para>
  95
  96 </para>
  97
  98 @err:
  99 @Returns:
 100
 101
 102 <!-- ##### FUNCTION SPIException_getSourceType ##### -->
 103 <para>
 104
 105 </para>
 106
 107 @err:
 108 @Returns:
 109
 110
 111 <!-- ##### STRUCT SPIException ##### -->
 112 <para>
 113
 114 </para>
 115
 116 @type:
 117 @source:
 118 @ev:
 119 @code:
 120 @desc:
 121
 122 <!-- ##### ENUM SPIExceptionCode ##### -->
 123 <para>
 124
 125 </para>
 126
 127 @SPI_EXCEPTION_UNSPECIFIED:
 128 @SPI_EXCEPTION_DISCONNECT:
 129 @SPI_EXCEPTION_NO_IMPL:
 130 @SPI_EXCEPTION_IO:
 131 @SPI_EXCEPTION_BAD_DATA:
 132
 133 <!-- ##### ENUM SPIExceptionType ##### -->
 134 <para>
 135
 136 </para>
 137
 138 @SPI_EXCEPTION_SOURCE_UNSPECIFIED:
 139 @SPI_EXCEPTION_SOURCE_ACCESSIBLE:
 140 @SPI_EXCEPTION_SOURCE_REGISTRY:
 141 @SPI_EXCEPTION_SOURCE_DEVICE:
 142
 143 <!-- ##### USER_FUNCTION SPIExceptionHandler ##### -->
 144 <para>
 145
 146 </para>
 147
 148 @err:
 149 @is_fatal:
 150 @Returns:
 151
 152
 153 <!-- ##### STRUCT SPIRect ##### -->
 154 <para>
 155
 156 </para>
 157
 158
 159 <!-- ##### FUNCTION SPI_freeRect ##### -->
 160 <para>
 161
 162 </para>
 163
 164 @r:
 165
 166
 167 <!-- ##### FUNCTION SPI_dupString ##### -->
 168 <para>
 169
 170 </para>
 171
 172 @s:
 173 @Returns:
 174
 175
 176 <!-- ##### FUNCTION SPI_exceptionHandlerPush ##### -->
 177 <para>
 178
 179 </para>
 180
 181 @handler:
 182 @Returns:
 183
 184
 185 <!-- ##### FUNCTION SPI_exceptionHandlerPop ##### -->
 186 <para>
 187
 188 </para>
 189
 190 @Returns:
 191
 192